Public Member Functions | Public Attributes | List of all members
kobuki::Command::Data Struct Reference

Data structure containing data for commands. More...

#include <command.hpp>

Public Member Functions

 Data ()
 

Public Attributes

Name command
 
unsigned int d_gain
 
unsigned char duration
 
unsigned char frame_id
 
uint16_t gp_out
 
unsigned int i_gain
 
uint16_t note
 
unsigned int p_gain
 
int16_t radius
 
uint16_t request_flags
 
unsigned char reserved
 
unsigned char segment_name
 
int16_t speed
 
unsigned char type
 

Detailed Description

Data structure containing data for commands.

It is important to keep this state as it will have to retain knowledge of the last known command in some instances - e.g. for gp_out commands, quite often the incoming command is only to set the output for a single led while keeping the rest of the current gp_out values as is.

For generating individual commands we modify the data here, then copy the command class (avoid doing mutexes) and spin it off for sending down to the device.

Definition at line 78 of file command.hpp.

Constructor & Destructor Documentation

◆ Data()

kobuki::Command::Data::Data ( )
inline

Definition at line 80 of file command.hpp.

Member Data Documentation

◆ command

Name kobuki::Command::Data::command

Definition at line 86 of file command.hpp.

◆ d_gain

unsigned int kobuki::Command::Data::d_gain

Definition at line 117 of file command.hpp.

◆ duration

unsigned char kobuki::Command::Data::duration

Definition at line 94 of file command.hpp.

◆ frame_id

unsigned char kobuki::Command::Data::frame_id

Definition at line 105 of file command.hpp.

◆ gp_out

uint16_t kobuki::Command::Data::gp_out

Definition at line 111 of file command.hpp.

◆ i_gain

unsigned int kobuki::Command::Data::i_gain

Definition at line 116 of file command.hpp.

◆ note

uint16_t kobuki::Command::Data::note

Definition at line 93 of file command.hpp.

◆ p_gain

unsigned int kobuki::Command::Data::p_gain

Definition at line 115 of file command.hpp.

◆ radius

int16_t kobuki::Command::Data::radius

Definition at line 90 of file command.hpp.

◆ request_flags

uint16_t kobuki::Command::Data::request_flags

Definition at line 102 of file command.hpp.

◆ reserved

unsigned char kobuki::Command::Data::reserved

Definition at line 120 of file command.hpp.

◆ segment_name

unsigned char kobuki::Command::Data::segment_name

Definition at line 99 of file command.hpp.

◆ speed

int16_t kobuki::Command::Data::speed

Definition at line 89 of file command.hpp.

◆ type

unsigned char kobuki::Command::Data::type

Definition at line 114 of file command.hpp.


The documentation for this struct was generated from the following file:


kobuki_driver
Author(s): Daniel Stonier , Younghun Ju , Jorge Santos Simon
autogenerated on Wed Mar 2 2022 00:26:14