Fawkes API  Fawkes Development Version
fawkes::Roomba500Interface Class Reference

Roomba500Interface Fawkes BlackBoard Interface. More...

#include <>>

Inheritance diagram for fawkes::Roomba500Interface:

Classes

class  DockMessage
 DockMessage Fawkes BlackBoard Interface Message. More...
 
class  DriveMessage
 DriveMessage Fawkes BlackBoard Interface Message. More...
 
class  DriveStraightMessage
 DriveStraightMessage Fawkes BlackBoard Interface Message. More...
 
class  SetModeMessage
 SetModeMessage Fawkes BlackBoard Interface Message. More...
 
class  SetMotorsMessage
 SetMotorsMessage Fawkes BlackBoard Interface Message. More...
 
class  StopMessage
 StopMessage Fawkes BlackBoard Interface Message. More...
 

Public Types

enum  Mode { MODE_OFF = 0, MODE_PASSIVE = 1, MODE_SAFE = 2, MODE_FULL = 3 }
 Open Interface mode. More...
 
enum  InfraredCharacter {
  IR_NONE = 0, IR_REMOTE_LEFT = 129, IR_REMOTE_FORWARD = 130, IR_REMOTE_RIGHT = 131,
  IR_REMOTE_SPOT = 132, IR_REMOTE_MAX = 133, IR_REMOTE_SMALL = 134, IR_REMOTE_MEDIUM = 135,
  IR_REMOTE_LARGE_CLEAN = 136, IR_REMOTE_STOP = 137, IR_REMOTE_POWER = 138, IR_REMOTE_ARC_LEFT = 139,
  IR_REMOTE_ARC_RIGHT = 140, IR_REMOTE_STOP2 = 141, IR_SCHED_REMOTE_DOWNLOAD = 142, IR_SCHED_REMOTE_SEEK_DOCK = 143,
  IR_DISC_DOCK_RESERVED = 240, IR_DISC_DOCK_RED_BUOY = 248, IR_DISC_DOCK_GREEN_BUOY = 244, IR_DISC_DOCK_FORCE_FIELD = 242,
  IR_DISC_DOCK_RED_GREEN_BUOY = 252, IR_DISC_DOCK_RED_BUOY_FORCE_FIELD = 250, IR_DISC_DOCK_GREEN_BUOY_FORCE_FIELD = 246, IR_DISC_DOCK_RED_GREEN_BUOY_FORCE_FIELD = 254,
  IR_DOCK_RESERVED = 160, IR_DOCK_RED_BUOY = 168, IR_DOCK_GREEN_BUOY = 164, IR_DOCK_FORCE_FIELD = 161,
  IR_DOCK_RED_GREEN_BUOY = 172, IR_DOCK_RED_BUOY_FORCE_FIELD = 169, IR_DOCK_GREEN_BUOY_FORCE_FIELD = 165, IR_DOCK_RED_GREEN_BUOY_FORCE_FIELD = 173,
  IR_VIRTUAL_WALL = 162
}
 Infrared character values. More...
 
enum  ChargingState {
  CHARGING_NO = 0, CHARGING_RECONDITIONING = 1, CHARGING_FULL = 2, CHARGING_TRICKLE = 3,
  CHARGING_WAITING = 4, CHARGING_ERROR = 5
}
 Current charging state. More...
 
enum  BrushState { BRUSHSTATE_OFF, BRUSHSTATE_FORWARD, BRUSHSTATE_BACKWARD }
 State of the brushes. More...
 

Public Member Functions

const char * tostring_Mode (Mode value) const
 Convert Mode constant to string. More...
 
const char * tostring_InfraredCharacter (InfraredCharacter value) const
 Convert InfraredCharacter constant to string. More...
 
const char * tostring_ChargingState (ChargingState value) const
 Convert ChargingState constant to string. More...
 
const char * tostring_BrushState (BrushState value) const
 Convert BrushState constant to string. More...
 
virtual bool message_valid (const Message *message) const
 Check if message is valid and can be enqueued. More...
 
Mode mode () const
 Get mode value. More...
 
void set_mode (const Mode new_mode)
 Set mode value. More...
 
size_t maxlenof_mode () const
 Get maximum length of mode value. More...
 
bool is_wheel_drop_left () const
 Get wheel_drop_left value. More...
 
void set_wheel_drop_left (const bool new_wheel_drop_left)
 Set wheel_drop_left value. More...
 
size_t maxlenof_wheel_drop_left () const
 Get maximum length of wheel_drop_left value. More...
 
bool is_wheel_drop_right () const
 Get wheel_drop_right value. More...
 
void set_wheel_drop_right (const bool new_wheel_drop_right)
 Set wheel_drop_right value. More...
 
size_t maxlenof_wheel_drop_right () const
 Get maximum length of wheel_drop_right value. More...
 
bool is_bump_left () const
 Get bump_left value. More...
 
void set_bump_left (const bool new_bump_left)
 Set bump_left value. More...
 
size_t maxlenof_bump_left () const
 Get maximum length of bump_left value. More...
 
bool is_bump_right () const
 Get bump_right value. More...
 
void set_bump_right (const bool new_bump_right)
 Set bump_right value. More...
 
size_t maxlenof_bump_right () const
 Get maximum length of bump_right value. More...
 
bool is_wall () const
 Get wall value. More...
 
void set_wall (const bool new_wall)
 Set wall value. More...
 
size_t maxlenof_wall () const
 Get maximum length of wall value. More...
 
bool is_cliff_left () const
 Get cliff_left value. More...
 
void set_cliff_left (const bool new_cliff_left)
 Set cliff_left value. More...
 
size_t maxlenof_cliff_left () const
 Get maximum length of cliff_left value. More...
 
bool is_cliff_front_left () const
 Get cliff_front_left value. More...
 
void set_cliff_front_left (const bool new_cliff_front_left)
 Set cliff_front_left value. More...
 
size_t maxlenof_cliff_front_left () const
 Get maximum length of cliff_front_left value. More...
 
bool is_cliff_front_right () const
 Get cliff_front_right value. More...
 
void set_cliff_front_right (const bool new_cliff_front_right)
 Set cliff_front_right value. More...
 
size_t maxlenof_cliff_front_right () const
 Get maximum length of cliff_front_right value. More...
 
bool is_cliff_right () const
 Get cliff_right value. More...
 
void set_cliff_right (const bool new_cliff_right)
 Set cliff_right value. More...
 
size_t maxlenof_cliff_right () const
 Get maximum length of cliff_right value. More...
 
bool is_virtual_wall () const
 Get virtual_wall value. More...
 
void set_virtual_wall (const bool new_virtual_wall)
 Set virtual_wall value. More...
 
size_t maxlenof_virtual_wall () const
 Get maximum length of virtual_wall value. More...
 
bool is_overcurrent_side_brush () const
 Get overcurrent_side_brush value. More...
 
void set_overcurrent_side_brush (const bool new_overcurrent_side_brush)
 Set overcurrent_side_brush value. More...
 
size_t maxlenof_overcurrent_side_brush () const
 Get maximum length of overcurrent_side_brush value. More...
 
bool is_overcurrent_main_brush () const
 Get overcurrent_main_brush value. More...
 
void set_overcurrent_main_brush (const bool new_overcurrent_main_brush)
 Set overcurrent_main_brush value. More...
 
size_t maxlenof_overcurrent_main_brush () const
 Get maximum length of overcurrent_main_brush value. More...
 
bool is_overcurrent_left_wheel () const
 Get overcurrent_left_wheel value. More...
 
void set_overcurrent_left_wheel (const bool new_overcurrent_left_wheel)
 Set overcurrent_left_wheel value. More...
 
size_t maxlenof_overcurrent_left_wheel () const
 Get maximum length of overcurrent_left_wheel value. More...
 
bool is_overcurrent_right_wheel () const
 Get overcurrent_right_wheel value. More...
 
void set_overcurrent_right_wheel (const bool new_overcurrent_right_wheel)
 Set overcurrent_right_wheel value. More...
 
size_t maxlenof_overcurrent_right_wheel () const
 Get maximum length of overcurrent_right_wheel value. More...
 
bool is_dirt_detect () const
 Get dirt_detect value. More...
 
void set_dirt_detect (const bool new_dirt_detect)
 Set dirt_detect value. More...
 
size_t maxlenof_dirt_detect () const
 Get maximum length of dirt_detect value. More...
 
InfraredCharacter ir_opcode_omni () const
 Get ir_opcode_omni value. More...
 
void set_ir_opcode_omni (const InfraredCharacter new_ir_opcode_omni)
 Set ir_opcode_omni value. More...
 
size_t maxlenof_ir_opcode_omni () const
 Get maximum length of ir_opcode_omni value. More...
 
bool is_button_clean () const
 Get button_clean value. More...
 
void set_button_clean (const bool new_button_clean)
 Set button_clean value. More...
 
size_t maxlenof_button_clean () const
 Get maximum length of button_clean value. More...
 
bool is_button_spot () const
 Get button_spot value. More...
 
void set_button_spot (const bool new_button_spot)
 Set button_spot value. More...
 
size_t maxlenof_button_spot () const
 Get maximum length of button_spot value. More...
 
bool is_button_dock () const
 Get button_dock value. More...
 
void set_button_dock (const bool new_button_dock)
 Set button_dock value. More...
 
size_t maxlenof_button_dock () const
 Get maximum length of button_dock value. More...
 
bool is_button_minute () const
 Get button_minute value. More...
 
void set_button_minute (const bool new_button_minute)
 Set button_minute value. More...
 
size_t maxlenof_button_minute () const
 Get maximum length of button_minute value. More...
 
bool is_button_hour () const
 Get button_hour value. More...
 
void set_button_hour (const bool new_button_hour)
 Set button_hour value. More...
 
size_t maxlenof_button_hour () const
 Get maximum length of button_hour value. More...
 
bool is_button_day () const
 Get button_day value. More...
 
void set_button_day (const bool new_button_day)
 Set button_day value. More...
 
size_t maxlenof_button_day () const
 Get maximum length of button_day value. More...
 
bool is_button_schedule () const
 Get button_schedule value. More...
 
void set_button_schedule (const bool new_button_schedule)
 Set button_schedule value. More...
 
size_t maxlenof_button_schedule () const
 Get maximum length of button_schedule value. More...
 
bool is_button_clock () const
 Get button_clock value. More...
 
void set_button_clock (const bool new_button_clock)
 Set button_clock value. More...
 
size_t maxlenof_button_clock () const
 Get maximum length of button_clock value. More...
 
int16_t distance () const
 Get distance value. More...
 
void set_distance (const int16_t new_distance)
 Set distance value. More...
 
size_t maxlenof_distance () const
 Get maximum length of distance value. More...
 
int16_t angle () const
 Get angle value. More...
 
void set_angle (const int16_t new_angle)
 Set angle value. More...
 
size_t maxlenof_angle () const
 Get maximum length of angle value. More...
 
ChargingState charging_state () const
 Get charging_state value. More...
 
void set_charging_state (const ChargingState new_charging_state)
 Set charging_state value. More...
 
size_t maxlenof_charging_state () const
 Get maximum length of charging_state value. More...
 
uint16_t voltage () const
 Get voltage value. More...
 
void set_voltage (const uint16_t new_voltage)
 Set voltage value. More...
 
size_t maxlenof_voltage () const
 Get maximum length of voltage value. More...
 
int16_t current () const
 Get current value. More...
 
void set_current (const int16_t new_current)
 Set current value. More...
 
size_t maxlenof_current () const
 Get maximum length of current value. More...
 
int8_t temperature () const
 Get temperature value. More...
 
void set_temperature (const int8_t new_temperature)
 Set temperature value. More...
 
size_t maxlenof_temperature () const
 Get maximum length of temperature value. More...
 
uint16_t battery_charge () const
 Get battery_charge value. More...
 
void set_battery_charge (const uint16_t new_battery_charge)
 Set battery_charge value. More...
 
size_t maxlenof_battery_charge () const
 Get maximum length of battery_charge value. More...
 
uint16_t battery_capacity () const
 Get battery_capacity value. More...
 
void set_battery_capacity (const uint16_t new_battery_capacity)
 Set battery_capacity value. More...
 
size_t maxlenof_battery_capacity () const
 Get maximum length of battery_capacity value. More...
 
uint16_t wall_signal () const
 Get wall_signal value. More...
 
void set_wall_signal (const uint16_t new_wall_signal)
 Set wall_signal value. More...
 
size_t maxlenof_wall_signal () const
 Get maximum length of wall_signal value. More...
 
uint16_t cliff_left_signal () const
 Get cliff_left_signal value. More...
 
void set_cliff_left_signal (const uint16_t new_cliff_left_signal)
 Set cliff_left_signal value. More...
 
size_t maxlenof_cliff_left_signal () const
 Get maximum length of cliff_left_signal value. More...
 
uint16_t cliff_front_left_signal () const
 Get cliff_front_left_signal value. More...
 
void set_cliff_front_left_signal (const uint16_t new_cliff_front_left_signal)
 Set cliff_front_left_signal value. More...
 
size_t maxlenof_cliff_front_left_signal () const
 Get maximum length of cliff_front_left_signal value. More...
 
uint16_t cliff_front_right_signal () const
 Get cliff_front_right_signal value. More...
 
void set_cliff_front_right_signal (const uint16_t new_cliff_front_right_signal)
 Set cliff_front_right_signal value. More...
 
size_t maxlenof_cliff_front_right_signal () const
 Get maximum length of cliff_front_right_signal value. More...
 
uint16_t cliff_right_signal () const
 Get cliff_right_signal value. More...
 
void set_cliff_right_signal (const uint16_t new_cliff_right_signal)
 Set cliff_right_signal value. More...
 
size_t maxlenof_cliff_right_signal () const
 Get maximum length of cliff_right_signal value. More...
 
bool is_home_base_charger_available () const
 Get home_base_charger_available value. More...
 
void set_home_base_charger_available (const bool new_home_base_charger_available)
 Set home_base_charger_available value. More...
 
size_t maxlenof_home_base_charger_available () const
 Get maximum length of home_base_charger_available value. More...
 
bool is_internal_charger_available () const
 Get internal_charger_available value. More...
 
void set_internal_charger_available (const bool new_internal_charger_available)
 Set internal_charger_available value. More...
 
size_t maxlenof_internal_charger_available () const
 Get maximum length of internal_charger_available value. More...
 
uint8_t song_number () const
 Get song_number value. More...
 
void set_song_number (const uint8_t new_song_number)
 Set song_number value. More...
 
size_t maxlenof_song_number () const
 Get maximum length of song_number value. More...
 
bool is_song_playing () const
 Get song_playing value. More...
 
void set_song_playing (const bool new_song_playing)
 Set song_playing value. More...
 
size_t maxlenof_song_playing () const
 Get maximum length of song_playing value. More...
 
int16_t velocity () const
 Get velocity value. More...
 
void set_velocity (const int16_t new_velocity)
 Set velocity value. More...
 
size_t maxlenof_velocity () const
 Get maximum length of velocity value. More...
 
int16_t radius () const
 Get radius value. More...
 
void set_radius (const int16_t new_radius)
 Set radius value. More...
 
size_t maxlenof_radius () const
 Get maximum length of radius value. More...
 
int16_t velocity_right () const
 Get velocity_right value. More...
 
void set_velocity_right (const int16_t new_velocity_right)
 Set velocity_right value. More...
 
size_t maxlenof_velocity_right () const
 Get maximum length of velocity_right value. More...
 
int16_t velocity_left () const
 Get velocity_left value. More...
 
void set_velocity_left (const int16_t new_velocity_left)
 Set velocity_left value. More...
 
size_t maxlenof_velocity_left () const
 Get maximum length of velocity_left value. More...
 
uint16_t encoder_counts_left () const
 Get encoder_counts_left value. More...
 
void set_encoder_counts_left (const uint16_t new_encoder_counts_left)
 Set encoder_counts_left value. More...
 
size_t maxlenof_encoder_counts_left () const
 Get maximum length of encoder_counts_left value. More...
 
uint16_t encoder_counts_right () const
 Get encoder_counts_right value. More...
 
void set_encoder_counts_right (const uint16_t new_encoder_counts_right)
 Set encoder_counts_right value. More...
 
size_t maxlenof_encoder_counts_right () const
 Get maximum length of encoder_counts_right value. More...
 
bool is_bumper_left () const
 Get bumper_left value. More...
 
void set_bumper_left (const bool new_bumper_left)
 Set bumper_left value. More...
 
size_t maxlenof_bumper_left () const
 Get maximum length of bumper_left value. More...
 
bool is_bumper_front_left () const
 Get bumper_front_left value. More...
 
void set_bumper_front_left (const bool new_bumper_front_left)
 Set bumper_front_left value. More...
 
size_t maxlenof_bumper_front_left () const
 Get maximum length of bumper_front_left value. More...
 
bool is_bumper_center_left () const
 Get bumper_center_left value. More...
 
void set_bumper_center_left (const bool new_bumper_center_left)
 Set bumper_center_left value. More...
 
size_t maxlenof_bumper_center_left () const
 Get maximum length of bumper_center_left value. More...
 
bool is_bumper_center_right () const
 Get bumper_center_right value. More...
 
void set_bumper_center_right (const bool new_bumper_center_right)
 Set bumper_center_right value. More...
 
size_t maxlenof_bumper_center_right () const
 Get maximum length of bumper_center_right value. More...
 
bool is_bumper_front_right () const
 Get bumper_front_right value. More...
 
void set_bumper_front_right (const bool new_bumper_front_right)
 Set bumper_front_right value. More...
 
size_t maxlenof_bumper_front_right () const
 Get maximum length of bumper_front_right value. More...
 
bool is_bumper_right () const
 Get bumper_right value. More...
 
void set_bumper_right (const bool new_bumper_right)
 Set bumper_right value. More...
 
size_t maxlenof_bumper_right () const
 Get maximum length of bumper_right value. More...
 
uint16_t light_bump_left () const
 Get light_bump_left value. More...
 
void set_light_bump_left (const uint16_t new_light_bump_left)
 Set light_bump_left value. More...
 
size_t maxlenof_light_bump_left () const
 Get maximum length of light_bump_left value. More...
 
uint16_t light_bump_front_left () const
 Get light_bump_front_left value. More...
 
void set_light_bump_front_left (const uint16_t new_light_bump_front_left)
 Set light_bump_front_left value. More...
 
size_t maxlenof_light_bump_front_left () const
 Get maximum length of light_bump_front_left value. More...
 
uint16_t light_bump_center_left () const
 Get light_bump_center_left value. More...
 
void set_light_bump_center_left (const uint16_t new_light_bump_center_left)
 Set light_bump_center_left value. More...
 
size_t maxlenof_light_bump_center_left () const
 Get maximum length of light_bump_center_left value. More...
 
uint16_t light_bump_center_right () const
 Get light_bump_center_right value. More...
 
void set_light_bump_center_right (const uint16_t new_light_bump_center_right)
 Set light_bump_center_right value. More...
 
size_t maxlenof_light_bump_center_right () const
 Get maximum length of light_bump_center_right value. More...
 
uint16_t light_bump_front_right () const
 Get light_bump_front_right value. More...
 
void set_light_bump_front_right (const uint16_t new_light_bump_front_right)
 Set light_bump_front_right value. More...
 
size_t maxlenof_light_bump_front_right () const
 Get maximum length of light_bump_front_right value. More...
 
uint16_t light_bump_right () const
 Get light_bump_right value. More...
 
void set_light_bump_right (const uint16_t new_light_bump_right)
 Set light_bump_right value. More...
 
size_t maxlenof_light_bump_right () const
 Get maximum length of light_bump_right value. More...
 
InfraredCharacter ir_opcode_left () const
 Get ir_opcode_left value. More...
 
void set_ir_opcode_left (const InfraredCharacter new_ir_opcode_left)
 Set ir_opcode_left value. More...
 
size_t maxlenof_ir_opcode_left () const
 Get maximum length of ir_opcode_left value. More...
 
InfraredCharacter ir_opcode_right () const
 Get ir_opcode_right value. More...
 
void set_ir_opcode_right (const InfraredCharacter new_ir_opcode_right)
 Set ir_opcode_right value. More...
 
size_t maxlenof_ir_opcode_right () const
 Get maximum length of ir_opcode_right value. More...
 
int16_t left_motor_current () const
 Get left_motor_current value. More...
 
void set_left_motor_current (const int16_t new_left_motor_current)
 Set left_motor_current value. More...
 
size_t maxlenof_left_motor_current () const
 Get maximum length of left_motor_current value. More...
 
int16_t right_motor_current () const
 Get right_motor_current value. More...
 
void set_right_motor_current (const int16_t new_right_motor_current)
 Set right_motor_current value. More...
 
size_t maxlenof_right_motor_current () const
 Get maximum length of right_motor_current value. More...
 
int16_t main_brush_current () const
 Get main_brush_current value. More...
 
void set_main_brush_current (const int16_t new_main_brush_current)
 Set main_brush_current value. More...
 
size_t maxlenof_main_brush_current () const
 Get maximum length of main_brush_current value. More...
 
int16_t side_brush_current () const
 Get side_brush_current value. More...
 
void set_side_brush_current (const int16_t new_side_brush_current)
 Set side_brush_current value. More...
 
size_t maxlenof_side_brush_current () const
 Get maximum length of side_brush_current value. More...
 
bool is_caster_stasis () const
 Get caster_stasis value. More...
 
void set_caster_stasis (const bool new_caster_stasis)
 Set caster_stasis value. More...
 
size_t maxlenof_caster_stasis () const
 Get maximum length of caster_stasis value. More...
 
virtual Messagecreate_message (const char *type) const
 Create message based on type name. More...
 
virtual void copy_values (const Interface *other)
 Copy values from other interface. More...
 
virtual const char * enum_tostring (const char *enumtype, int val) const
 Convert arbitrary enum value to string. More...
 
- Public Member Functions inherited from fawkes::Interface
virtual ~Interface ()
 Destructor. More...
 
bool oftype (const char *interface_type) const
 Check if interface is of given type. More...
 
const void * datachunk () const
 Get data chunk. More...
 
unsigned int datasize () const
 Get data size. More...
 
const char * type () const
 Get type of interface. More...
 
const char * id () const
 Get identifier of interface. More...
 
const char * uid () const
 Get unique identifier of interface. More...
 
unsigned short serial () const
 Get instance serial of interface. More...
 
unsigned int mem_serial () const
 Get memory serial of interface. More...
 
bool operator== (Interface &comp) const
 Check equality of two interfaces. More...
 
const unsigned char * hash () const
 Get interface hash. More...
 
size_t hash_size () const
 Get size of interface hash. More...
 
const char * hash_printable () const
 Get printable interface hash. More...
 
bool is_writer () const
 Check if this is a writing instance. More...
 
void set_validity (bool valid)
 Mark this interface invalid. More...
 
bool is_valid () const
 Check validity of interface. More...
 
const char * owner () const
 Get owner of interface. More...
 
void set_from_chunk (void *chunk)
 Set from a raw data chunk. More...
 
void resize_buffers (unsigned int num_buffers)
 Resize buffer array. More...
 
unsigned int num_buffers () const
 Get number of buffers. More...
 
void copy_shared_to_buffer (unsigned int buffer)
 Copy data from private memory to buffer. More...
 
void copy_private_to_buffer (unsigned int buffer)
 Copy data from private memory to buffer. More...
 
void read_from_buffer (unsigned int buffer)
 Copy data from buffer to private memory. More...
 
int compare_buffers (unsigned int buffer)
 Compare buffer to private memory. More...
 
Time buffer_timestamp (unsigned int buffer)
 Get time of a buffer. More...
 
void buffer_timestamp (unsigned int buffer, Time *timestamp)
 Get time of a buffer. More...
 
void read ()
 Read from BlackBoard into local copy. More...
 
void write ()
 Write from local copy into BlackBoard memory. More...
 
bool has_writer () const
 Check if there is a writer for the interface. More...
 
unsigned int num_readers () const
 Get the number of readers. More...
 
std::string writer () const
 Get owner name of writing interface instance. More...
 
std::list< std::string > readers () const
 Get owner names of reading interface instances. More...
 
bool changed () const
 Check if data has been changed. More...
 
const Timetimestamp () const
 Get timestamp of last write. More...
 
void set_auto_timestamping (bool enabled)
 Enable or disable automated timestamping. More...
 
void set_timestamp (const Time *t=NULL)
 Set timestamp. More...
 
void set_clock (Clock *clock)
 Set clock to use for timestamping. More...
 
void mark_data_changed ()
 Mark data as changed. More...
 
std::list< const char * > get_message_types ()
 Obtain a list of textual representations of the message types available for this interface. More...
 
unsigned int msgq_enqueue (Message *message)
 Enqueue message at end of queue. More...
 
unsigned int msgq_enqueue_copy (Message *message)
 Enqueue copy of message at end of queue. More...
 
void msgq_remove (Message *message)
 Remove message from queue. More...
 
void msgq_remove (unsigned int message_id)
 Remove message from queue. More...
 
unsigned int msgq_size ()
 Get size of message queue. More...
 
void msgq_flush ()
 Flush all messages. More...
 
void msgq_lock ()
 Lock message queue. More...
 
bool msgq_try_lock ()
 Try to lock message queue. More...
 
void msgq_unlock ()
 Unlock message queue. More...
 
void msgq_pop ()
 Erase first message from queue. More...
 
Messagemsgq_first ()
 Get the first message from the message queue. More...
 
bool msgq_empty ()
 Check if queue is empty. More...
 
void msgq_append (Message *message)
 Enqueue message. More...
 
template<class MessageType >
bool msgq_first_is ()
 Check if first message has desired type. More...
 
template<class MessageType >
MessageType * msgq_first ()
 Get first message casted to the desired type. More...
 
template<class MessageType >
MessageType * msgq_first (MessageType *&msg)
 Get first message casted to the desired type. More...
 
template<class MessageType >
MessageType * msgq_first_safe (MessageType *&msg) throw ()
 Get first message casted to the desired type without exceptions. More...
 
MessageQueue::MessageIterator msgq_begin ()
 Get start iterator for message queue. More...
 
MessageQueue::MessageIterator msgq_end ()
 Get end iterator for message queue. More...
 
InterfaceFieldIterator fields ()
 Get iterator over all fields of this interface instance. More...
 
InterfaceFieldIterator fields_end ()
 Invalid iterator. More...
 
unsigned int num_fields ()
 Get the number of fields in the interface. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from fawkes::Interface
static void parse_uid (const char *uid, std::string &type, std::string &id)
 Parse UID to type and ID strings. More...
 
- Protected Member Functions inherited from fawkes::Interface
 Interface ()
 Constructor. More...
 
void set_hash (unsigned char *ihash)
 Set hash. More...
 
void add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0, const interface_enum_map_t *enum_map=0)
 Add an entry to the field info list. More...
 
void add_messageinfo (const char *name)
 Add an entry to the message info list. More...
 
- Protected Attributes inherited from fawkes::Interface
void * data_ptr
 Pointer to local memory storage. More...
 
unsigned int data_size
 Minimal data size to hold data storage. More...
 
bool data_changed
 Indicator if data has changed. More...
 
interface_data_ts_tdata_ts
 Pointer to data casted to timestamp struct. More...
 

Detailed Description

Roomba500Interface Fawkes BlackBoard Interface.

Roomba 500 hardware interface.

Definition at line 33 of file Roomba500Interface.h.

Member Enumeration Documentation

◆ BrushState

State of the brushes.

Enumerator
BRUSHSTATE_OFF 

Brush is off.

BRUSHSTATE_FORWARD 

Brush is turning forward.

BRUSHSTATE_BACKWARD 

Brush is turning backward.

Definition at line 124 of file Roomba500Interface.h.

◆ ChargingState

Current charging state.

Enumerator
CHARGING_NO 

Not charging.

CHARGING_RECONDITIONING 

Reconditioning battery.

CHARGING_FULL 

Full charging cycle.

CHARGING_TRICKLE 

Trickle charging.

CHARGING_WAITING 

Waiting.

CHARGING_ERROR 

Fault condition.

Definition at line 113 of file Roomba500Interface.h.

◆ InfraredCharacter

Infrared character values.

Enumerator
IR_NONE 

No valid IR signal.

IR_REMOTE_LEFT 

IR Remote Control: left button.

IR_REMOTE_FORWARD 

IR Remote Control: forward button.

IR_REMOTE_RIGHT 

IR Remote Control: right button.

IR_REMOTE_SPOT 

IR Remote Control: spot button.

IR_REMOTE_MAX 

IR Remote Control: max button.

IR_REMOTE_SMALL 

IR Remote Control: small button.

IR_REMOTE_MEDIUM 

IR Remote Control: medium button.

IR_REMOTE_LARGE_CLEAN 

IR Remote Control: large/clean button.

IR_REMOTE_STOP 

IR Remote Control: stop button.

IR_REMOTE_POWER 

IR Remote Control: power button.

IR_REMOTE_ARC_LEFT 

IR Remote Control: left arc button.

IR_REMOTE_ARC_RIGHT 

IR Remote Control: right arc button.

IR_REMOTE_STOP2 

IR Remote Control: stop button.

IR_SCHED_REMOTE_DOWNLOAD 

IR scheduling remote: download button.

IR_SCHED_REMOTE_SEEK_DOCK 

IR scheduling remote: seek dock button.

IR_DISC_DOCK_RESERVED 

Roomba Discovery dock: reserved.

IR_DISC_DOCK_RED_BUOY 

Roomba Discovery dock: red buoy.

IR_DISC_DOCK_GREEN_BUOY 

Roomba Discovery dock: green buoy.

IR_DISC_DOCK_FORCE_FIELD 

Roomba Discovery dock: red and green buoy.

IR_DISC_DOCK_RED_GREEN_BUOY 

Roomba Discovery dock: red buoy and force field.

IR_DISC_DOCK_RED_BUOY_FORCE_FIELD 

Roomba Discovery dock: green buoy and force field.

IR_DISC_DOCK_GREEN_BUOY_FORCE_FIELD 

Roomba Discovery dock: green buoy and force field.

IR_DISC_DOCK_RED_GREEN_BUOY_FORCE_FIELD 

Roomba Discovery dock: red and green buoy and force field.

IR_DOCK_RESERVED 

Roomba 500 dock: reserved.

IR_DOCK_RED_BUOY 

Roomba 500 dock: red buoy.

IR_DOCK_GREEN_BUOY 

Roomba 500 dock: green buoy.

IR_DOCK_FORCE_FIELD 

Roomba 500 dock: red and green buoy.

IR_DOCK_RED_GREEN_BUOY 

Roomba 500 dock: red buoy and force field.

IR_DOCK_RED_BUOY_FORCE_FIELD 

Roomba 500 dock: green buoy and force field.

IR_DOCK_GREEN_BUOY_FORCE_FIELD 

Roomba 500 dock: green buoy and force field.

IR_DOCK_RED_GREEN_BUOY_FORCE_FIELD 

Roomba 500 dock: red and green buoy and force field.

IR_VIRTUAL_WALL 

IR Virtual Wall.

Definition at line 54 of file Roomba500Interface.h.

◆ Mode

Open Interface mode.

Enumerator
MODE_OFF 

No connection.

MODE_PASSIVE 

Passive mode, no control, only listening.

MODE_SAFE 

Control acquired, safety measures in place.

MODE_FULL 

Control acquired, safety measures disabled.

Definition at line 42 of file Roomba500Interface.h.

Member Function Documentation

◆ angle()

int16_t fawkes::Roomba500Interface::angle ( ) const

Get angle value.

Turned angle in radians.

Returns
angle value

Definition at line 1083 of file Roomba500Interface.cpp.

◆ battery_capacity()

uint16_t fawkes::Roomba500Interface::battery_capacity ( ) const

Get battery_capacity value.

Battery capacity in mAh.

Returns
battery_capacity value

Definition at line 1269 of file Roomba500Interface.cpp.

◆ battery_charge()

uint16_t fawkes::Roomba500Interface::battery_charge ( ) const

Get battery_charge value.

Battery charge in mAh.

Returns
battery_charge value

Definition at line 1238 of file Roomba500Interface.cpp.

◆ charging_state()

Roomba500Interface::ChargingState fawkes::Roomba500Interface::charging_state ( ) const

Get charging_state value.

Charging state.

Returns
charging_state value

Definition at line 1114 of file Roomba500Interface.cpp.

◆ cliff_front_left_signal()

uint16_t fawkes::Roomba500Interface::cliff_front_left_signal ( ) const

Get cliff_front_left_signal value.

Raw front left cliff signal.

Returns
cliff_front_left_signal value

Definition at line 1363 of file Roomba500Interface.cpp.

◆ cliff_front_right_signal()

uint16_t fawkes::Roomba500Interface::cliff_front_right_signal ( ) const

Get cliff_front_right_signal value.

Raw front right cliff signal.

Returns
cliff_front_right_signal value

Definition at line 1396 of file Roomba500Interface.cpp.

◆ cliff_left_signal()

uint16_t fawkes::Roomba500Interface::cliff_left_signal ( ) const

Get cliff_left_signal value.

Raw left cliff signal.

Returns
cliff_left_signal value

Definition at line 1331 of file Roomba500Interface.cpp.

◆ cliff_right_signal()

uint16_t fawkes::Roomba500Interface::cliff_right_signal ( ) const

Get cliff_right_signal value.

Raw right cliff signal.

Returns
cliff_right_signal value

Definition at line 1428 of file Roomba500Interface.cpp.

◆ copy_values()

void fawkes::Roomba500Interface::copy_values ( const Interface other)
virtual

Copy values from other interface.

Parameters
otherother interface to copy values from

Implements fawkes::Interface.

Definition at line 2396 of file Roomba500Interface.cpp.

References fawkes::Interface::type().

◆ create_message()

Message * fawkes::Roomba500Interface::create_message ( const char *  type) const
virtual

Create message based on type name.

This will create a new message of the given type. The type must be given without the InterfaceName:: prefix but just the plain class name of the message.

Parameters
typemessage type
Returns
message of the given type, empty
Exceptions
UnknownTypeExceptionthrown if this interface cannot create a message of the given type.

Implements fawkes::Interface.

Definition at line 2371 of file Roomba500Interface.cpp.

◆ current()

int16_t fawkes::Roomba500Interface::current ( ) const

Get current value.

Current in mA.

Returns
current value

Definition at line 1176 of file Roomba500Interface.cpp.

◆ distance()

int16_t fawkes::Roomba500Interface::distance ( ) const

Get distance value.

Travelled distance in m.

Returns
distance value

Definition at line 1052 of file Roomba500Interface.cpp.

◆ encoder_counts_left()

uint16_t fawkes::Roomba500Interface::encoder_counts_left ( ) const

Get encoder_counts_left value.

Encoder count left.

Returns
encoder_counts_left value

Definition at line 1711 of file Roomba500Interface.cpp.

◆ encoder_counts_right()

uint16_t fawkes::Roomba500Interface::encoder_counts_right ( ) const

Get encoder_counts_right value.

Encoder count right.

Returns
encoder_counts_right value

Definition at line 1742 of file Roomba500Interface.cpp.

◆ enum_tostring()

const char * fawkes::Roomba500Interface::enum_tostring ( const char *  enumtype,
int  val 
) const
virtual

Convert arbitrary enum value to string.

Given the string representation of the enum type and the value this method returns the string representation of the specific value, or the string UNKNOWN if the value is not defined. An exception is thrown if the enum type is invalid.

Parameters
enumtypeenum type as string
valvalue to convert
Returns
string representation of value
Exceptions
UnknownTypeExceptionthrown if enumtype is not specified for interface.

Implements fawkes::Interface.

Definition at line 2407 of file Roomba500Interface.cpp.

◆ ir_opcode_left()

Roomba500Interface::InfraredCharacter fawkes::Roomba500Interface::ir_opcode_left ( ) const

Get ir_opcode_left value.

Left receiver opcode.

Returns
ir_opcode_left value

Definition at line 2154 of file Roomba500Interface.cpp.

◆ ir_opcode_omni()

Roomba500Interface::InfraredCharacter fawkes::Roomba500Interface::ir_opcode_omni ( ) const

Get ir_opcode_omni value.

Omni IR receiver code.

Returns
ir_opcode_omni value

Definition at line 773 of file Roomba500Interface.cpp.

◆ ir_opcode_right()

Roomba500Interface::InfraredCharacter fawkes::Roomba500Interface::ir_opcode_right ( ) const

Get ir_opcode_right value.

Right receiver opcode.

Returns
ir_opcode_right value

Definition at line 2187 of file Roomba500Interface.cpp.

◆ is_bump_left()

bool fawkes::Roomba500Interface::is_bump_left ( ) const

Get bump_left value.

Bump on left.

Returns
bump_left value

Definition at line 370 of file Roomba500Interface.cpp.

Referenced by RoombaJoystickThread::loop().

◆ is_bump_right()

bool fawkes::Roomba500Interface::is_bump_right ( ) const

Get bump_right value.

Bump on right.

Returns
bump_right value

Definition at line 401 of file Roomba500Interface.cpp.

Referenced by RoombaJoystickThread::loop().

◆ is_bumper_center_left()

bool fawkes::Roomba500Interface::is_bumper_center_left ( ) const

Get bumper_center_left value.

Center left bumper active?

Returns
bumper_center_left value

Definition at line 1835 of file Roomba500Interface.cpp.

◆ is_bumper_center_right()

bool fawkes::Roomba500Interface::is_bumper_center_right ( ) const

Get bumper_center_right value.

Center right bumper active?

Returns
bumper_center_right value

Definition at line 1866 of file Roomba500Interface.cpp.

◆ is_bumper_front_left()

bool fawkes::Roomba500Interface::is_bumper_front_left ( ) const

Get bumper_front_left value.

Front left bumper active?

Returns
bumper_front_left value

Definition at line 1804 of file Roomba500Interface.cpp.

◆ is_bumper_front_right()

bool fawkes::Roomba500Interface::is_bumper_front_right ( ) const

Get bumper_front_right value.

Front right bumper active?

Returns
bumper_front_right value

Definition at line 1897 of file Roomba500Interface.cpp.

◆ is_bumper_left()

bool fawkes::Roomba500Interface::is_bumper_left ( ) const

Get bumper_left value.

Left bumper active?

Returns
bumper_left value

Definition at line 1773 of file Roomba500Interface.cpp.

◆ is_bumper_right()

bool fawkes::Roomba500Interface::is_bumper_right ( ) const

Get bumper_right value.

Right bumper active?

Returns
bumper_right value

Definition at line 1928 of file Roomba500Interface.cpp.

◆ is_button_clean()

bool fawkes::Roomba500Interface::is_button_clean ( ) const

Get button_clean value.

Clean button pressed.

Returns
button_clean value

Definition at line 804 of file Roomba500Interface.cpp.

◆ is_button_clock()

bool fawkes::Roomba500Interface::is_button_clock ( ) const

Get button_clock value.

Clock button pressed.

Returns
button_clock value

Definition at line 1021 of file Roomba500Interface.cpp.

◆ is_button_day()

bool fawkes::Roomba500Interface::is_button_day ( ) const

Get button_day value.

Day button pressed.

Returns
button_day value

Definition at line 959 of file Roomba500Interface.cpp.

◆ is_button_dock()

bool fawkes::Roomba500Interface::is_button_dock ( ) const

Get button_dock value.

Dock button pressed.

Returns
button_dock value

Definition at line 866 of file Roomba500Interface.cpp.

◆ is_button_hour()

bool fawkes::Roomba500Interface::is_button_hour ( ) const

Get button_hour value.

Hour button pressed.

Returns
button_hour value

Definition at line 928 of file Roomba500Interface.cpp.

◆ is_button_minute()

bool fawkes::Roomba500Interface::is_button_minute ( ) const

Get button_minute value.

Minute button pressed.

Returns
button_minute value

Definition at line 897 of file Roomba500Interface.cpp.

◆ is_button_schedule()

bool fawkes::Roomba500Interface::is_button_schedule ( ) const

Get button_schedule value.

Schedule button pressed.

Returns
button_schedule value

Definition at line 990 of file Roomba500Interface.cpp.

◆ is_button_spot()

bool fawkes::Roomba500Interface::is_button_spot ( ) const

Get button_spot value.

Spot button pressed.

Returns
button_spot value

Definition at line 835 of file Roomba500Interface.cpp.

◆ is_caster_stasis()

bool fawkes::Roomba500Interface::is_caster_stasis ( ) const

Get caster_stasis value.

Caster wheel stasis.

Returns
caster_stasis value

Definition at line 2343 of file Roomba500Interface.cpp.

◆ is_cliff_front_left()

bool fawkes::Roomba500Interface::is_cliff_front_left ( ) const

Get cliff_front_left value.

Cliff detected front left.

Returns
cliff_front_left value

Definition at line 494 of file Roomba500Interface.cpp.

◆ is_cliff_front_right()

bool fawkes::Roomba500Interface::is_cliff_front_right ( ) const

Get cliff_front_right value.

Cliff detected front right.

Returns
cliff_front_right value

Definition at line 525 of file Roomba500Interface.cpp.

◆ is_cliff_left()

bool fawkes::Roomba500Interface::is_cliff_left ( ) const

Get cliff_left value.

Cliff detected left.

Returns
cliff_left value

Definition at line 463 of file Roomba500Interface.cpp.

◆ is_cliff_right()

bool fawkes::Roomba500Interface::is_cliff_right ( ) const

Get cliff_right value.

Cliff detected right.

Returns
cliff_right value

Definition at line 556 of file Roomba500Interface.cpp.

◆ is_dirt_detect()

bool fawkes::Roomba500Interface::is_dirt_detect ( ) const

Get dirt_detect value.

Dirt detected?

Returns
dirt_detect value

Definition at line 742 of file Roomba500Interface.cpp.

◆ is_home_base_charger_available()

bool fawkes::Roomba500Interface::is_home_base_charger_available ( ) const

Get home_base_charger_available value.

Home base charger available?

Returns
home_base_charger_available value

Definition at line 1460 of file Roomba500Interface.cpp.

◆ is_internal_charger_available()

bool fawkes::Roomba500Interface::is_internal_charger_available ( ) const

Get internal_charger_available value.

Internal charger available?

Returns
internal_charger_available value

Definition at line 1493 of file Roomba500Interface.cpp.

◆ is_overcurrent_left_wheel()

bool fawkes::Roomba500Interface::is_overcurrent_left_wheel ( ) const

Get overcurrent_left_wheel value.

Overcurrent on left wheel.

Returns
overcurrent_left_wheel value

Definition at line 680 of file Roomba500Interface.cpp.

◆ is_overcurrent_main_brush()

bool fawkes::Roomba500Interface::is_overcurrent_main_brush ( ) const

Get overcurrent_main_brush value.

Overcurrent on main brush.

Returns
overcurrent_main_brush value

Definition at line 649 of file Roomba500Interface.cpp.

◆ is_overcurrent_right_wheel()

bool fawkes::Roomba500Interface::is_overcurrent_right_wheel ( ) const

Get overcurrent_right_wheel value.

Overcurrent on right wheel.

Returns
overcurrent_right_wheel value

Definition at line 711 of file Roomba500Interface.cpp.

◆ is_overcurrent_side_brush()

bool fawkes::Roomba500Interface::is_overcurrent_side_brush ( ) const

Get overcurrent_side_brush value.

Overcurrent on side brush.

Returns
overcurrent_side_brush value

Definition at line 618 of file Roomba500Interface.cpp.

◆ is_song_playing()

bool fawkes::Roomba500Interface::is_song_playing ( ) const

Get song_playing value.

Song playing?

Returns
song_playing value

Definition at line 1556 of file Roomba500Interface.cpp.

◆ is_virtual_wall()

bool fawkes::Roomba500Interface::is_virtual_wall ( ) const

Get virtual_wall value.

Virtual wall detected.

Returns
virtual_wall value

Definition at line 587 of file Roomba500Interface.cpp.

◆ is_wall()

bool fawkes::Roomba500Interface::is_wall ( ) const

Get wall value.

Wall sensor.

Returns
wall value

Definition at line 432 of file Roomba500Interface.cpp.

◆ is_wheel_drop_left()

bool fawkes::Roomba500Interface::is_wheel_drop_left ( ) const

Get wheel_drop_left value.

Left wheel drop sensor.

Returns
wheel_drop_left value

Definition at line 308 of file Roomba500Interface.cpp.

◆ is_wheel_drop_right()

bool fawkes::Roomba500Interface::is_wheel_drop_right ( ) const

Get wheel_drop_right value.

Right wheel drop sensor.

Returns
wheel_drop_right value

Definition at line 339 of file Roomba500Interface.cpp.

◆ left_motor_current()

int16_t fawkes::Roomba500Interface::left_motor_current ( ) const

Get left_motor_current value.

Left motor current in mA.

Returns
left_motor_current value

Definition at line 2219 of file Roomba500Interface.cpp.

◆ light_bump_center_left()

uint16_t fawkes::Roomba500Interface::light_bump_center_left ( ) const

Get light_bump_center_left value.

Raw center left bumper signal.

Returns
light_bump_center_left value

Definition at line 2024 of file Roomba500Interface.cpp.

Referenced by RoombaJoystickThread::loop().

◆ light_bump_center_right()

uint16_t fawkes::Roomba500Interface::light_bump_center_right ( ) const

Get light_bump_center_right value.

Raw center right bumper signal.

Returns
light_bump_center_right value

Definition at line 2057 of file Roomba500Interface.cpp.

Referenced by RoombaJoystickThread::loop().

◆ light_bump_front_left()

uint16_t fawkes::Roomba500Interface::light_bump_front_left ( ) const

Get light_bump_front_left value.

Raw front left bumper signal.

Returns
light_bump_front_left value

Definition at line 1991 of file Roomba500Interface.cpp.

Referenced by RoombaJoystickThread::loop().

◆ light_bump_front_right()

uint16_t fawkes::Roomba500Interface::light_bump_front_right ( ) const

Get light_bump_front_right value.

Raw front right bumper signal.

Returns
light_bump_front_right value

Definition at line 2090 of file Roomba500Interface.cpp.

Referenced by RoombaJoystickThread::loop().

◆ light_bump_left()

uint16_t fawkes::Roomba500Interface::light_bump_left ( ) const

Get light_bump_left value.

Raw left bumper signal.

Returns
light_bump_left value

Definition at line 1959 of file Roomba500Interface.cpp.

Referenced by RoombaJoystickThread::loop().

◆ light_bump_right()

uint16_t fawkes::Roomba500Interface::light_bump_right ( ) const

Get light_bump_right value.

Raw right bumper signal.

Returns
light_bump_right value

Definition at line 2122 of file Roomba500Interface.cpp.

Referenced by RoombaJoystickThread::loop().

◆ main_brush_current()

int16_t fawkes::Roomba500Interface::main_brush_current ( ) const

Get main_brush_current value.

Main brush current in mA.

Returns
main_brush_current value

Definition at line 2281 of file Roomba500Interface.cpp.

◆ maxlenof_angle()

size_t fawkes::Roomba500Interface::maxlenof_angle ( ) const

Get maximum length of angle value.

Returns
length of angle value, can be length of the array or number of maximum number of characters for a string

Definition at line 1093 of file Roomba500Interface.cpp.

◆ maxlenof_battery_capacity()

size_t fawkes::Roomba500Interface::maxlenof_battery_capacity ( ) const

Get maximum length of battery_capacity value.

Returns
length of battery_capacity value, can be length of the array or number of maximum number of characters for a string

Definition at line 1279 of file Roomba500Interface.cpp.

◆ maxlenof_battery_charge()

size_t fawkes::Roomba500Interface::maxlenof_battery_charge ( ) const

Get maximum length of battery_charge value.

Returns
length of battery_charge value, can be length of the array or number of maximum number of characters for a string

Definition at line 1248 of file Roomba500Interface.cpp.

◆ maxlenof_bump_left()

size_t fawkes::Roomba500Interface::maxlenof_bump_left ( ) const

Get maximum length of bump_left value.

Returns
length of bump_left value, can be length of the array or number of maximum number of characters for a string

Definition at line 380 of file Roomba500Interface.cpp.

◆ maxlenof_bump_right()

size_t fawkes::Roomba500Interface::maxlenof_bump_right ( ) const

Get maximum length of bump_right value.

Returns
length of bump_right value, can be length of the array or number of maximum number of characters for a string

Definition at line 411 of file Roomba500Interface.cpp.

◆ maxlenof_bumper_center_left()

size_t fawkes::Roomba500Interface::maxlenof_bumper_center_left ( ) const

Get maximum length of bumper_center_left value.

Returns
length of bumper_center_left value, can be length of the array or number of maximum number of characters for a string

Definition at line 1845 of file Roomba500Interface.cpp.

◆ maxlenof_bumper_center_right()

size_t fawkes::Roomba500Interface::maxlenof_bumper_center_right ( ) const

Get maximum length of bumper_center_right value.

Returns
length of bumper_center_right value, can be length of the array or number of maximum number of characters for a string

Definition at line 1876 of file Roomba500Interface.cpp.

◆ maxlenof_bumper_front_left()

size_t fawkes::Roomba500Interface::maxlenof_bumper_front_left ( ) const

Get maximum length of bumper_front_left value.

Returns
length of bumper_front_left value, can be length of the array or number of maximum number of characters for a string

Definition at line 1814 of file Roomba500Interface.cpp.

◆ maxlenof_bumper_front_right()

size_t fawkes::Roomba500Interface::maxlenof_bumper_front_right ( ) const

Get maximum length of bumper_front_right value.

Returns
length of bumper_front_right value, can be length of the array or number of maximum number of characters for a string

Definition at line 1907 of file Roomba500Interface.cpp.

◆ maxlenof_bumper_left()

size_t fawkes::Roomba500Interface::maxlenof_bumper_left ( ) const

Get maximum length of bumper_left value.

Returns
length of bumper_left value, can be length of the array or number of maximum number of characters for a string

Definition at line 1783 of file Roomba500Interface.cpp.

◆ maxlenof_bumper_right()

size_t fawkes::Roomba500Interface::maxlenof_bumper_right ( ) const

Get maximum length of bumper_right value.

Returns
length of bumper_right value, can be length of the array or number of maximum number of characters for a string

Definition at line 1938 of file Roomba500Interface.cpp.

◆ maxlenof_button_clean()

size_t fawkes::Roomba500Interface::maxlenof_button_clean ( ) const

Get maximum length of button_clean value.

Returns
length of button_clean value, can be length of the array or number of maximum number of characters for a string

Definition at line 814 of file Roomba500Interface.cpp.

◆ maxlenof_button_clock()

size_t fawkes::Roomba500Interface::maxlenof_button_clock ( ) const

Get maximum length of button_clock value.

Returns
length of button_clock value, can be length of the array or number of maximum number of characters for a string

Definition at line 1031 of file Roomba500Interface.cpp.

◆ maxlenof_button_day()

size_t fawkes::Roomba500Interface::maxlenof_button_day ( ) const

Get maximum length of button_day value.

Returns
length of button_day value, can be length of the array or number of maximum number of characters for a string

Definition at line 969 of file Roomba500Interface.cpp.

◆ maxlenof_button_dock()

size_t fawkes::Roomba500Interface::maxlenof_button_dock ( ) const

Get maximum length of button_dock value.

Returns
length of button_dock value, can be length of the array or number of maximum number of characters for a string

Definition at line 876 of file Roomba500Interface.cpp.

◆ maxlenof_button_hour()

size_t fawkes::Roomba500Interface::maxlenof_button_hour ( ) const

Get maximum length of button_hour value.

Returns
length of button_hour value, can be length of the array or number of maximum number of characters for a string

Definition at line 938 of file Roomba500Interface.cpp.

◆ maxlenof_button_minute()

size_t fawkes::Roomba500Interface::maxlenof_button_minute ( ) const

Get maximum length of button_minute value.

Returns
length of button_minute value, can be length of the array or number of maximum number of characters for a string

Definition at line 907 of file Roomba500Interface.cpp.

◆ maxlenof_button_schedule()

size_t fawkes::Roomba500Interface::maxlenof_button_schedule ( ) const

Get maximum length of button_schedule value.

Returns
length of button_schedule value, can be length of the array or number of maximum number of characters for a string

Definition at line 1000 of file Roomba500Interface.cpp.

◆ maxlenof_button_spot()

size_t fawkes::Roomba500Interface::maxlenof_button_spot ( ) const

Get maximum length of button_spot value.

Returns
length of button_spot value, can be length of the array or number of maximum number of characters for a string

Definition at line 845 of file Roomba500Interface.cpp.

◆ maxlenof_caster_stasis()

size_t fawkes::Roomba500Interface::maxlenof_caster_stasis ( ) const

Get maximum length of caster_stasis value.

Returns
length of caster_stasis value, can be length of the array or number of maximum number of characters for a string

Definition at line 2353 of file Roomba500Interface.cpp.

◆ maxlenof_charging_state()

size_t fawkes::Roomba500Interface::maxlenof_charging_state ( ) const

Get maximum length of charging_state value.

Returns
length of charging_state value, can be length of the array or number of maximum number of characters for a string

Definition at line 1124 of file Roomba500Interface.cpp.

◆ maxlenof_cliff_front_left()

size_t fawkes::Roomba500Interface::maxlenof_cliff_front_left ( ) const

Get maximum length of cliff_front_left value.

Returns
length of cliff_front_left value, can be length of the array or number of maximum number of characters for a string

Definition at line 504 of file Roomba500Interface.cpp.

◆ maxlenof_cliff_front_left_signal()

size_t fawkes::Roomba500Interface::maxlenof_cliff_front_left_signal ( ) const

Get maximum length of cliff_front_left_signal value.

Returns
length of cliff_front_left_signal value, can be length of the array or number of maximum number of characters for a string

Definition at line 1373 of file Roomba500Interface.cpp.

◆ maxlenof_cliff_front_right()

size_t fawkes::Roomba500Interface::maxlenof_cliff_front_right ( ) const

Get maximum length of cliff_front_right value.

Returns
length of cliff_front_right value, can be length of the array or number of maximum number of characters for a string

Definition at line 535 of file Roomba500Interface.cpp.

◆ maxlenof_cliff_front_right_signal()

size_t fawkes::Roomba500Interface::maxlenof_cliff_front_right_signal ( ) const

Get maximum length of cliff_front_right_signal value.

Returns
length of cliff_front_right_signal value, can be length of the array or number of maximum number of characters for a string

Definition at line 1406 of file Roomba500Interface.cpp.

◆ maxlenof_cliff_left()

size_t fawkes::Roomba500Interface::maxlenof_cliff_left ( ) const

Get maximum length of cliff_left value.

Returns
length of cliff_left value, can be length of the array or number of maximum number of characters for a string

Definition at line 473 of file Roomba500Interface.cpp.

◆ maxlenof_cliff_left_signal()

size_t fawkes::Roomba500Interface::maxlenof_cliff_left_signal ( ) const

Get maximum length of cliff_left_signal value.

Returns
length of cliff_left_signal value, can be length of the array or number of maximum number of characters for a string

Definition at line 1341 of file Roomba500Interface.cpp.

◆ maxlenof_cliff_right()

size_t fawkes::Roomba500Interface::maxlenof_cliff_right ( ) const

Get maximum length of cliff_right value.

Returns
length of cliff_right value, can be length of the array or number of maximum number of characters for a string

Definition at line 566 of file Roomba500Interface.cpp.

◆ maxlenof_cliff_right_signal()

size_t fawkes::Roomba500Interface::maxlenof_cliff_right_signal ( ) const

Get maximum length of cliff_right_signal value.

Returns
length of cliff_right_signal value, can be length of the array or number of maximum number of characters for a string

Definition at line 1438 of file Roomba500Interface.cpp.

◆ maxlenof_current()

size_t fawkes::Roomba500Interface::maxlenof_current ( ) const

Get maximum length of current value.

Returns
length of current value, can be length of the array or number of maximum number of characters for a string

Definition at line 1186 of file Roomba500Interface.cpp.

◆ maxlenof_dirt_detect()

size_t fawkes::Roomba500Interface::maxlenof_dirt_detect ( ) const

Get maximum length of dirt_detect value.

Returns
length of dirt_detect value, can be length of the array or number of maximum number of characters for a string

Definition at line 752 of file Roomba500Interface.cpp.

◆ maxlenof_distance()

size_t fawkes::Roomba500Interface::maxlenof_distance ( ) const

Get maximum length of distance value.

Returns
length of distance value, can be length of the array or number of maximum number of characters for a string

Definition at line 1062 of file Roomba500Interface.cpp.

◆ maxlenof_encoder_counts_left()

size_t fawkes::Roomba500Interface::maxlenof_encoder_counts_left ( ) const

Get maximum length of encoder_counts_left value.

Returns
length of encoder_counts_left value, can be length of the array or number of maximum number of characters for a string

Definition at line 1721 of file Roomba500Interface.cpp.

◆ maxlenof_encoder_counts_right()

size_t fawkes::Roomba500Interface::maxlenof_encoder_counts_right ( ) const

Get maximum length of encoder_counts_right value.

Returns
length of encoder_counts_right value, can be length of the array or number of maximum number of characters for a string

Definition at line 1752 of file Roomba500Interface.cpp.

◆ maxlenof_home_base_charger_available()

size_t fawkes::Roomba500Interface::maxlenof_home_base_charger_available ( ) const

Get maximum length of home_base_charger_available value.

Returns
length of home_base_charger_available value, can be length of the array or number of maximum number of characters for a string

Definition at line 1470 of file Roomba500Interface.cpp.

◆ maxlenof_internal_charger_available()

size_t fawkes::Roomba500Interface::maxlenof_internal_charger_available ( ) const

Get maximum length of internal_charger_available value.

Returns
length of internal_charger_available value, can be length of the array or number of maximum number of characters for a string

Definition at line 1503 of file Roomba500Interface.cpp.

◆ maxlenof_ir_opcode_left()

size_t fawkes::Roomba500Interface::maxlenof_ir_opcode_left ( ) const

Get maximum length of ir_opcode_left value.

Returns
length of ir_opcode_left value, can be length of the array or number of maximum number of characters for a string

Definition at line 2164 of file Roomba500Interface.cpp.

◆ maxlenof_ir_opcode_omni()

size_t fawkes::Roomba500Interface::maxlenof_ir_opcode_omni ( ) const

Get maximum length of ir_opcode_omni value.

Returns
length of ir_opcode_omni value, can be length of the array or number of maximum number of characters for a string

Definition at line 783 of file Roomba500Interface.cpp.

◆ maxlenof_ir_opcode_right()

size_t fawkes::Roomba500Interface::maxlenof_ir_opcode_right ( ) const

Get maximum length of ir_opcode_right value.

Returns
length of ir_opcode_right value, can be length of the array or number of maximum number of characters for a string

Definition at line 2197 of file Roomba500Interface.cpp.

◆ maxlenof_left_motor_current()

size_t fawkes::Roomba500Interface::maxlenof_left_motor_current ( ) const

Get maximum length of left_motor_current value.

Returns
length of left_motor_current value, can be length of the array or number of maximum number of characters for a string

Definition at line 2229 of file Roomba500Interface.cpp.

◆ maxlenof_light_bump_center_left()

size_t fawkes::Roomba500Interface::maxlenof_light_bump_center_left ( ) const

Get maximum length of light_bump_center_left value.

Returns
length of light_bump_center_left value, can be length of the array or number of maximum number of characters for a string

Definition at line 2034 of file Roomba500Interface.cpp.

◆ maxlenof_light_bump_center_right()

size_t fawkes::Roomba500Interface::maxlenof_light_bump_center_right ( ) const

Get maximum length of light_bump_center_right value.

Returns
length of light_bump_center_right value, can be length of the array or number of maximum number of characters for a string

Definition at line 2067 of file Roomba500Interface.cpp.

◆ maxlenof_light_bump_front_left()

size_t fawkes::Roomba500Interface::maxlenof_light_bump_front_left ( ) const

Get maximum length of light_bump_front_left value.

Returns
length of light_bump_front_left value, can be length of the array or number of maximum number of characters for a string

Definition at line 2001 of file Roomba500Interface.cpp.

◆ maxlenof_light_bump_front_right()

size_t fawkes::Roomba500Interface::maxlenof_light_bump_front_right ( ) const

Get maximum length of light_bump_front_right value.

Returns
length of light_bump_front_right value, can be length of the array or number of maximum number of characters for a string

Definition at line 2100 of file Roomba500Interface.cpp.

◆ maxlenof_light_bump_left()

size_t fawkes::Roomba500Interface::maxlenof_light_bump_left ( ) const

Get maximum length of light_bump_left value.

Returns
length of light_bump_left value, can be length of the array or number of maximum number of characters for a string

Definition at line 1969 of file Roomba500Interface.cpp.

◆ maxlenof_light_bump_right()

size_t fawkes::Roomba500Interface::maxlenof_light_bump_right ( ) const

Get maximum length of light_bump_right value.

Returns
length of light_bump_right value, can be length of the array or number of maximum number of characters for a string

Definition at line 2132 of file Roomba500Interface.cpp.

◆ maxlenof_main_brush_current()

size_t fawkes::Roomba500Interface::maxlenof_main_brush_current ( ) const

Get maximum length of main_brush_current value.

Returns
length of main_brush_current value, can be length of the array or number of maximum number of characters for a string

Definition at line 2291 of file Roomba500Interface.cpp.

◆ maxlenof_mode()

size_t fawkes::Roomba500Interface::maxlenof_mode ( ) const

Get maximum length of mode value.

Returns
length of mode value, can be length of the array or number of maximum number of characters for a string

Definition at line 287 of file Roomba500Interface.cpp.

◆ maxlenof_overcurrent_left_wheel()

size_t fawkes::Roomba500Interface::maxlenof_overcurrent_left_wheel ( ) const

Get maximum length of overcurrent_left_wheel value.

Returns
length of overcurrent_left_wheel value, can be length of the array or number of maximum number of characters for a string

Definition at line 690 of file Roomba500Interface.cpp.

◆ maxlenof_overcurrent_main_brush()

size_t fawkes::Roomba500Interface::maxlenof_overcurrent_main_brush ( ) const

Get maximum length of overcurrent_main_brush value.

Returns
length of overcurrent_main_brush value, can be length of the array or number of maximum number of characters for a string

Definition at line 659 of file Roomba500Interface.cpp.

◆ maxlenof_overcurrent_right_wheel()

size_t fawkes::Roomba500Interface::maxlenof_overcurrent_right_wheel ( ) const

Get maximum length of overcurrent_right_wheel value.

Returns
length of overcurrent_right_wheel value, can be length of the array or number of maximum number of characters for a string

Definition at line 721 of file Roomba500Interface.cpp.

◆ maxlenof_overcurrent_side_brush()

size_t fawkes::Roomba500Interface::maxlenof_overcurrent_side_brush ( ) const

Get maximum length of overcurrent_side_brush value.

Returns
length of overcurrent_side_brush value, can be length of the array or number of maximum number of characters for a string

Definition at line 628 of file Roomba500Interface.cpp.

◆ maxlenof_radius()

size_t fawkes::Roomba500Interface::maxlenof_radius ( ) const

Get maximum length of radius value.

Returns
length of radius value, can be length of the array or number of maximum number of characters for a string

Definition at line 1628 of file Roomba500Interface.cpp.

◆ maxlenof_right_motor_current()

size_t fawkes::Roomba500Interface::maxlenof_right_motor_current ( ) const

Get maximum length of right_motor_current value.

Returns
length of right_motor_current value, can be length of the array or number of maximum number of characters for a string

Definition at line 2260 of file Roomba500Interface.cpp.

◆ maxlenof_side_brush_current()

size_t fawkes::Roomba500Interface::maxlenof_side_brush_current ( ) const

Get maximum length of side_brush_current value.

Returns
length of side_brush_current value, can be length of the array or number of maximum number of characters for a string

Definition at line 2322 of file Roomba500Interface.cpp.

◆ maxlenof_song_number()

size_t fawkes::Roomba500Interface::maxlenof_song_number ( ) const

Get maximum length of song_number value.

Returns
length of song_number value, can be length of the array or number of maximum number of characters for a string

Definition at line 1535 of file Roomba500Interface.cpp.

◆ maxlenof_song_playing()

size_t fawkes::Roomba500Interface::maxlenof_song_playing ( ) const

Get maximum length of song_playing value.

Returns
length of song_playing value, can be length of the array or number of maximum number of characters for a string

Definition at line 1566 of file Roomba500Interface.cpp.

◆ maxlenof_temperature()

size_t fawkes::Roomba500Interface::maxlenof_temperature ( ) const

Get maximum length of temperature value.

Returns
length of temperature value, can be length of the array or number of maximum number of characters for a string

Definition at line 1217 of file Roomba500Interface.cpp.

◆ maxlenof_velocity()

size_t fawkes::Roomba500Interface::maxlenof_velocity ( ) const

Get maximum length of velocity value.

Returns
length of velocity value, can be length of the array or number of maximum number of characters for a string

Definition at line 1597 of file Roomba500Interface.cpp.

◆ maxlenof_velocity_left()

size_t fawkes::Roomba500Interface::maxlenof_velocity_left ( ) const

Get maximum length of velocity_left value.

Returns
length of velocity_left value, can be length of the array or number of maximum number of characters for a string

Definition at line 1690 of file Roomba500Interface.cpp.

◆ maxlenof_velocity_right()

size_t fawkes::Roomba500Interface::maxlenof_velocity_right ( ) const

Get maximum length of velocity_right value.

Returns
length of velocity_right value, can be length of the array or number of maximum number of characters for a string

Definition at line 1659 of file Roomba500Interface.cpp.

◆ maxlenof_virtual_wall()

size_t fawkes::Roomba500Interface::maxlenof_virtual_wall ( ) const

Get maximum length of virtual_wall value.

Returns
length of virtual_wall value, can be length of the array or number of maximum number of characters for a string

Definition at line 597 of file Roomba500Interface.cpp.

◆ maxlenof_voltage()

size_t fawkes::Roomba500Interface::maxlenof_voltage ( ) const

Get maximum length of voltage value.

Returns
length of voltage value, can be length of the array or number of maximum number of characters for a string

Definition at line 1155 of file Roomba500Interface.cpp.

◆ maxlenof_wall()

size_t fawkes::Roomba500Interface::maxlenof_wall ( ) const

Get maximum length of wall value.

Returns
length of wall value, can be length of the array or number of maximum number of characters for a string

Definition at line 442 of file Roomba500Interface.cpp.

◆ maxlenof_wall_signal()

size_t fawkes::Roomba500Interface::maxlenof_wall_signal ( ) const

Get maximum length of wall_signal value.

Returns
length of wall_signal value, can be length of the array or number of maximum number of characters for a string

Definition at line 1310 of file Roomba500Interface.cpp.

◆ maxlenof_wheel_drop_left()

size_t fawkes::Roomba500Interface::maxlenof_wheel_drop_left ( ) const

Get maximum length of wheel_drop_left value.

Returns
length of wheel_drop_left value, can be length of the array or number of maximum number of characters for a string

Definition at line 318 of file Roomba500Interface.cpp.

◆ maxlenof_wheel_drop_right()

size_t fawkes::Roomba500Interface::maxlenof_wheel_drop_right ( ) const

Get maximum length of wheel_drop_right value.

Returns
length of wheel_drop_right value, can be length of the array or number of maximum number of characters for a string

Definition at line 349 of file Roomba500Interface.cpp.

◆ message_valid()

bool fawkes::Roomba500Interface::message_valid ( const Message message) const
virtual

Check if message is valid and can be enqueued.

Parameters
messageMessage to check
Returns
true if the message is valid, false otherwise.

Implements fawkes::Interface.

Definition at line 3444 of file Roomba500Interface.cpp.

◆ mode()

Roomba500Interface::Mode fawkes::Roomba500Interface::mode ( ) const

Get mode value.

Open Interface mode.

Returns
mode value

Definition at line 277 of file Roomba500Interface.cpp.

Referenced by RoombaJoystickThread::loop().

◆ radius()

int16_t fawkes::Roomba500Interface::radius ( ) const

Get radius value.

Requested radius in mm.

Returns
radius value

Definition at line 1618 of file Roomba500Interface.cpp.

◆ right_motor_current()

int16_t fawkes::Roomba500Interface::right_motor_current ( ) const

Get right_motor_current value.

Right motor current in mA.

Returns
right_motor_current value

Definition at line 2250 of file Roomba500Interface.cpp.

◆ set_angle()

void fawkes::Roomba500Interface::set_angle ( const int16_t  new_angle)

Set angle value.

Turned angle in radians.

Parameters
new_anglenew angle value

Definition at line 1103 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_battery_capacity()

void fawkes::Roomba500Interface::set_battery_capacity ( const uint16_t  new_battery_capacity)

Set battery_capacity value.

Battery capacity in mAh.

Parameters
new_battery_capacitynew battery_capacity value

Definition at line 1289 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_battery_charge()

void fawkes::Roomba500Interface::set_battery_charge ( const uint16_t  new_battery_charge)

Set battery_charge value.

Battery charge in mAh.

Parameters
new_battery_chargenew battery_charge value

Definition at line 1258 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_bump_left()

void fawkes::Roomba500Interface::set_bump_left ( const bool  new_bump_left)

Set bump_left value.

Bump on left.

Parameters
new_bump_leftnew bump_left value

Definition at line 390 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_bump_right()

void fawkes::Roomba500Interface::set_bump_right ( const bool  new_bump_right)

Set bump_right value.

Bump on right.

Parameters
new_bump_rightnew bump_right value

Definition at line 421 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_bumper_center_left()

void fawkes::Roomba500Interface::set_bumper_center_left ( const bool  new_bumper_center_left)

Set bumper_center_left value.

Center left bumper active?

Parameters
new_bumper_center_leftnew bumper_center_left value

Definition at line 1855 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_bumper_center_right()

void fawkes::Roomba500Interface::set_bumper_center_right ( const bool  new_bumper_center_right)

Set bumper_center_right value.

Center right bumper active?

Parameters
new_bumper_center_rightnew bumper_center_right value

Definition at line 1886 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_bumper_front_left()

void fawkes::Roomba500Interface::set_bumper_front_left ( const bool  new_bumper_front_left)

Set bumper_front_left value.

Front left bumper active?

Parameters
new_bumper_front_leftnew bumper_front_left value

Definition at line 1824 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_bumper_front_right()

void fawkes::Roomba500Interface::set_bumper_front_right ( const bool  new_bumper_front_right)

Set bumper_front_right value.

Front right bumper active?

Parameters
new_bumper_front_rightnew bumper_front_right value

Definition at line 1917 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_bumper_left()

void fawkes::Roomba500Interface::set_bumper_left ( const bool  new_bumper_left)

Set bumper_left value.

Left bumper active?

Parameters
new_bumper_leftnew bumper_left value

Definition at line 1793 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_bumper_right()

void fawkes::Roomba500Interface::set_bumper_right ( const bool  new_bumper_right)

Set bumper_right value.

Right bumper active?

Parameters
new_bumper_rightnew bumper_right value

Definition at line 1948 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_button_clean()

void fawkes::Roomba500Interface::set_button_clean ( const bool  new_button_clean)

Set button_clean value.

Clean button pressed.

Parameters
new_button_cleannew button_clean value

Definition at line 824 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_button_clock()

void fawkes::Roomba500Interface::set_button_clock ( const bool  new_button_clock)

Set button_clock value.

Clock button pressed.

Parameters
new_button_clocknew button_clock value

Definition at line 1041 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_button_day()

void fawkes::Roomba500Interface::set_button_day ( const bool  new_button_day)

Set button_day value.

Day button pressed.

Parameters
new_button_daynew button_day value

Definition at line 979 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_button_dock()

void fawkes::Roomba500Interface::set_button_dock ( const bool  new_button_dock)

Set button_dock value.

Dock button pressed.

Parameters
new_button_docknew button_dock value

Definition at line 886 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_button_hour()

void fawkes::Roomba500Interface::set_button_hour ( const bool  new_button_hour)

Set button_hour value.

Hour button pressed.

Parameters
new_button_hournew button_hour value

Definition at line 948 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_button_minute()

void fawkes::Roomba500Interface::set_button_minute ( const bool  new_button_minute)

Set button_minute value.

Minute button pressed.

Parameters
new_button_minutenew button_minute value

Definition at line 917 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_button_schedule()

void fawkes::Roomba500Interface::set_button_schedule ( const bool  new_button_schedule)

Set button_schedule value.

Schedule button pressed.

Parameters
new_button_schedulenew button_schedule value

Definition at line 1010 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_button_spot()

void fawkes::Roomba500Interface::set_button_spot ( const bool  new_button_spot)

Set button_spot value.

Spot button pressed.

Parameters
new_button_spotnew button_spot value

Definition at line 855 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_caster_stasis()

void fawkes::Roomba500Interface::set_caster_stasis ( const bool  new_caster_stasis)

Set caster_stasis value.

Caster wheel stasis.

Parameters
new_caster_stasisnew caster_stasis value

Definition at line 2363 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_charging_state()

void fawkes::Roomba500Interface::set_charging_state ( const ChargingState  new_charging_state)

Set charging_state value.

Charging state.

Parameters
new_charging_statenew charging_state value

Definition at line 1134 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_cliff_front_left()

void fawkes::Roomba500Interface::set_cliff_front_left ( const bool  new_cliff_front_left)

Set cliff_front_left value.

Cliff detected front left.

Parameters
new_cliff_front_leftnew cliff_front_left value

Definition at line 514 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_cliff_front_left_signal()

void fawkes::Roomba500Interface::set_cliff_front_left_signal ( const uint16_t  new_cliff_front_left_signal)

Set cliff_front_left_signal value.

Raw front left cliff signal.

Parameters
new_cliff_front_left_signalnew cliff_front_left_signal value

Definition at line 1384 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_cliff_front_right()

void fawkes::Roomba500Interface::set_cliff_front_right ( const bool  new_cliff_front_right)

Set cliff_front_right value.

Cliff detected front right.

Parameters
new_cliff_front_rightnew cliff_front_right value

Definition at line 545 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_cliff_front_right_signal()

void fawkes::Roomba500Interface::set_cliff_front_right_signal ( const uint16_t  new_cliff_front_right_signal)

Set cliff_front_right_signal value.

Raw front right cliff signal.

Parameters
new_cliff_front_right_signalnew cliff_front_right_signal value

Definition at line 1417 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_cliff_left()

void fawkes::Roomba500Interface::set_cliff_left ( const bool  new_cliff_left)

Set cliff_left value.

Cliff detected left.

Parameters
new_cliff_leftnew cliff_left value

Definition at line 483 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_cliff_left_signal()

void fawkes::Roomba500Interface::set_cliff_left_signal ( const uint16_t  new_cliff_left_signal)

Set cliff_left_signal value.

Raw left cliff signal.

Parameters
new_cliff_left_signalnew cliff_left_signal value

Definition at line 1351 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_cliff_right()

void fawkes::Roomba500Interface::set_cliff_right ( const bool  new_cliff_right)

Set cliff_right value.

Cliff detected right.

Parameters
new_cliff_rightnew cliff_right value

Definition at line 576 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_cliff_right_signal()

void fawkes::Roomba500Interface::set_cliff_right_signal ( const uint16_t  new_cliff_right_signal)

Set cliff_right_signal value.

Raw right cliff signal.

Parameters
new_cliff_right_signalnew cliff_right_signal value

Definition at line 1448 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_current()

void fawkes::Roomba500Interface::set_current ( const int16_t  new_current)

Set current value.

Current in mA.

Parameters
new_currentnew current value

Definition at line 1196 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_dirt_detect()

void fawkes::Roomba500Interface::set_dirt_detect ( const bool  new_dirt_detect)

Set dirt_detect value.

Dirt detected?

Parameters
new_dirt_detectnew dirt_detect value

Definition at line 762 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_distance()

void fawkes::Roomba500Interface::set_distance ( const int16_t  new_distance)

Set distance value.

Travelled distance in m.

Parameters
new_distancenew distance value

Definition at line 1072 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_encoder_counts_left()

void fawkes::Roomba500Interface::set_encoder_counts_left ( const uint16_t  new_encoder_counts_left)

Set encoder_counts_left value.

Encoder count left.

Parameters
new_encoder_counts_leftnew encoder_counts_left value

Definition at line 1731 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_encoder_counts_right()

void fawkes::Roomba500Interface::set_encoder_counts_right ( const uint16_t  new_encoder_counts_right)

Set encoder_counts_right value.

Encoder count right.

Parameters
new_encoder_counts_rightnew encoder_counts_right value

Definition at line 1762 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_home_base_charger_available()

void fawkes::Roomba500Interface::set_home_base_charger_available ( const bool  new_home_base_charger_available)

Set home_base_charger_available value.

Home base charger available?

Parameters
new_home_base_charger_availablenew home_base_charger_available value

Definition at line 1481 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_internal_charger_available()

void fawkes::Roomba500Interface::set_internal_charger_available ( const bool  new_internal_charger_available)

Set internal_charger_available value.

Internal charger available?

Parameters
new_internal_charger_availablenew internal_charger_available value

Definition at line 1514 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_ir_opcode_left()

void fawkes::Roomba500Interface::set_ir_opcode_left ( const InfraredCharacter  new_ir_opcode_left)

Set ir_opcode_left value.

Left receiver opcode.

Parameters
new_ir_opcode_leftnew ir_opcode_left value

Definition at line 2175 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_ir_opcode_omni()

void fawkes::Roomba500Interface::set_ir_opcode_omni ( const InfraredCharacter  new_ir_opcode_omni)

Set ir_opcode_omni value.

Omni IR receiver code.

Parameters
new_ir_opcode_omninew ir_opcode_omni value

Definition at line 793 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_ir_opcode_right()

void fawkes::Roomba500Interface::set_ir_opcode_right ( const InfraredCharacter  new_ir_opcode_right)

Set ir_opcode_right value.

Right receiver opcode.

Parameters
new_ir_opcode_rightnew ir_opcode_right value

Definition at line 2208 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_left_motor_current()

void fawkes::Roomba500Interface::set_left_motor_current ( const int16_t  new_left_motor_current)

Set left_motor_current value.

Left motor current in mA.

Parameters
new_left_motor_currentnew left_motor_current value

Definition at line 2239 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_light_bump_center_left()

void fawkes::Roomba500Interface::set_light_bump_center_left ( const uint16_t  new_light_bump_center_left)

Set light_bump_center_left value.

Raw center left bumper signal.

Parameters
new_light_bump_center_leftnew light_bump_center_left value

Definition at line 2045 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_light_bump_center_right()

void fawkes::Roomba500Interface::set_light_bump_center_right ( const uint16_t  new_light_bump_center_right)

Set light_bump_center_right value.

Raw center right bumper signal.

Parameters
new_light_bump_center_rightnew light_bump_center_right value

Definition at line 2078 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_light_bump_front_left()

void fawkes::Roomba500Interface::set_light_bump_front_left ( const uint16_t  new_light_bump_front_left)

Set light_bump_front_left value.

Raw front left bumper signal.

Parameters
new_light_bump_front_leftnew light_bump_front_left value

Definition at line 2012 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_light_bump_front_right()

void fawkes::Roomba500Interface::set_light_bump_front_right ( const uint16_t  new_light_bump_front_right)

Set light_bump_front_right value.

Raw front right bumper signal.

Parameters
new_light_bump_front_rightnew light_bump_front_right value

Definition at line 2111 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_light_bump_left()

void fawkes::Roomba500Interface::set_light_bump_left ( const uint16_t  new_light_bump_left)

Set light_bump_left value.

Raw left bumper signal.

Parameters
new_light_bump_leftnew light_bump_left value

Definition at line 1979 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_light_bump_right()

void fawkes::Roomba500Interface::set_light_bump_right ( const uint16_t  new_light_bump_right)

Set light_bump_right value.

Raw right bumper signal.

Parameters
new_light_bump_rightnew light_bump_right value

Definition at line 2142 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_main_brush_current()

void fawkes::Roomba500Interface::set_main_brush_current ( const int16_t  new_main_brush_current)

Set main_brush_current value.

Main brush current in mA.

Parameters
new_main_brush_currentnew main_brush_current value

Definition at line 2301 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_mode()

void fawkes::Roomba500Interface::set_mode ( const Mode  new_mode)

Set mode value.

Open Interface mode.

Parameters
new_modenew mode value

Definition at line 297 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_overcurrent_left_wheel()

void fawkes::Roomba500Interface::set_overcurrent_left_wheel ( const bool  new_overcurrent_left_wheel)

Set overcurrent_left_wheel value.

Overcurrent on left wheel.

Parameters
new_overcurrent_left_wheelnew overcurrent_left_wheel value

Definition at line 700 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_overcurrent_main_brush()

void fawkes::Roomba500Interface::set_overcurrent_main_brush ( const bool  new_overcurrent_main_brush)

Set overcurrent_main_brush value.

Overcurrent on main brush.

Parameters
new_overcurrent_main_brushnew overcurrent_main_brush value

Definition at line 669 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_overcurrent_right_wheel()

void fawkes::Roomba500Interface::set_overcurrent_right_wheel ( const bool  new_overcurrent_right_wheel)

Set overcurrent_right_wheel value.

Overcurrent on right wheel.

Parameters
new_overcurrent_right_wheelnew overcurrent_right_wheel value

Definition at line 731 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_overcurrent_side_brush()

void fawkes::Roomba500Interface::set_overcurrent_side_brush ( const bool  new_overcurrent_side_brush)

Set overcurrent_side_brush value.

Overcurrent on side brush.

Parameters
new_overcurrent_side_brushnew overcurrent_side_brush value

Definition at line 638 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_radius()

void fawkes::Roomba500Interface::set_radius ( const int16_t  new_radius)

Set radius value.

Requested radius in mm.

Parameters
new_radiusnew radius value

Definition at line 1638 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_right_motor_current()

void fawkes::Roomba500Interface::set_right_motor_current ( const int16_t  new_right_motor_current)

Set right_motor_current value.

Right motor current in mA.

Parameters
new_right_motor_currentnew right_motor_current value

Definition at line 2270 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_side_brush_current()

void fawkes::Roomba500Interface::set_side_brush_current ( const int16_t  new_side_brush_current)

Set side_brush_current value.

Side brush current in mA.

Parameters
new_side_brush_currentnew side_brush_current value

Definition at line 2332 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_song_number()

void fawkes::Roomba500Interface::set_song_number ( const uint8_t  new_song_number)

Set song_number value.

Song number.

Parameters
new_song_numbernew song_number value

Definition at line 1545 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_song_playing()

void fawkes::Roomba500Interface::set_song_playing ( const bool  new_song_playing)

Set song_playing value.

Song playing?

Parameters
new_song_playingnew song_playing value

Definition at line 1576 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_temperature()

void fawkes::Roomba500Interface::set_temperature ( const int8_t  new_temperature)

Set temperature value.

Temperature in degree Celsius.

Parameters
new_temperaturenew temperature value

Definition at line 1227 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_velocity()

void fawkes::Roomba500Interface::set_velocity ( const int16_t  new_velocity)

Set velocity value.

Requested velocity in mm/s.

Parameters
new_velocitynew velocity value

Definition at line 1607 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_velocity_left()

void fawkes::Roomba500Interface::set_velocity_left ( const int16_t  new_velocity_left)

Set velocity_left value.

Requested right velocity in mm/s.

Parameters
new_velocity_leftnew velocity_left value

Definition at line 1700 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_velocity_right()

void fawkes::Roomba500Interface::set_velocity_right ( const int16_t  new_velocity_right)

Set velocity_right value.

Requested left velocity in mm/s.

Parameters
new_velocity_rightnew velocity_right value

Definition at line 1669 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_virtual_wall()

void fawkes::Roomba500Interface::set_virtual_wall ( const bool  new_virtual_wall)

Set virtual_wall value.

Virtual wall detected.

Parameters
new_virtual_wallnew virtual_wall value

Definition at line 607 of file Roomba500Interface.cpp.

◆ set_voltage()

void fawkes::Roomba500Interface::set_voltage ( const uint16_t  new_voltage)

Set voltage value.

Voltage in mV.

Parameters
new_voltagenew voltage value

Definition at line 1165 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_wall()

void fawkes::Roomba500Interface::set_wall ( const bool  new_wall)

Set wall value.

Wall sensor.

Parameters
new_wallnew wall value

Definition at line 452 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_wall_signal()

void fawkes::Roomba500Interface::set_wall_signal ( const uint16_t  new_wall_signal)

Set wall_signal value.

Raw wall signal

Parameters
new_wall_signalnew wall_signal value

Definition at line 1320 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_wheel_drop_left()

void fawkes::Roomba500Interface::set_wheel_drop_left ( const bool  new_wheel_drop_left)

Set wheel_drop_left value.

Left wheel drop sensor.

Parameters
new_wheel_drop_leftnew wheel_drop_left value

Definition at line 328 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_wheel_drop_right()

void fawkes::Roomba500Interface::set_wheel_drop_right ( const bool  new_wheel_drop_right)

Set wheel_drop_right value.

Right wheel drop sensor.

Parameters
new_wheel_drop_rightnew wheel_drop_right value

Definition at line 359 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ side_brush_current()

int16_t fawkes::Roomba500Interface::side_brush_current ( ) const

Get side_brush_current value.

Side brush current in mA.

Returns
side_brush_current value

Definition at line 2312 of file Roomba500Interface.cpp.

◆ song_number()

uint8_t fawkes::Roomba500Interface::song_number ( ) const

Get song_number value.

Song number.

Returns
song_number value

Definition at line 1525 of file Roomba500Interface.cpp.

◆ temperature()

int8_t fawkes::Roomba500Interface::temperature ( ) const

Get temperature value.

Temperature in degree Celsius.

Returns
temperature value

Definition at line 1207 of file Roomba500Interface.cpp.

◆ tostring_BrushState()

const char * fawkes::Roomba500Interface::tostring_BrushState ( BrushState  value) const

Convert BrushState constant to string.

Parameters
valuevalue to convert to string
Returns
constant value as string.

Definition at line 262 of file Roomba500Interface.cpp.

◆ tostring_ChargingState()

const char * fawkes::Roomba500Interface::tostring_ChargingState ( ChargingState  value) const

Convert ChargingState constant to string.

Parameters
valuevalue to convert to string
Returns
constant value as string.

Definition at line 245 of file Roomba500Interface.cpp.

◆ tostring_InfraredCharacter()

const char * fawkes::Roomba500Interface::tostring_InfraredCharacter ( InfraredCharacter  value) const

Convert InfraredCharacter constant to string.

Parameters
valuevalue to convert to string
Returns
constant value as string.

Definition at line 201 of file Roomba500Interface.cpp.

◆ tostring_Mode()

const char * fawkes::Roomba500Interface::tostring_Mode ( Mode  value) const

Convert Mode constant to string.

Parameters
valuevalue to convert to string
Returns
constant value as string.

Definition at line 186 of file Roomba500Interface.cpp.

◆ velocity()

int16_t fawkes::Roomba500Interface::velocity ( ) const

Get velocity value.

Requested velocity in mm/s.

Returns
velocity value

Definition at line 1587 of file Roomba500Interface.cpp.

◆ velocity_left()

int16_t fawkes::Roomba500Interface::velocity_left ( ) const

Get velocity_left value.

Requested right velocity in mm/s.

Returns
velocity_left value

Definition at line 1680 of file Roomba500Interface.cpp.

◆ velocity_right()

int16_t fawkes::Roomba500Interface::velocity_right ( ) const

Get velocity_right value.

Requested left velocity in mm/s.

Returns
velocity_right value

Definition at line 1649 of file Roomba500Interface.cpp.

◆ voltage()

uint16_t fawkes::Roomba500Interface::voltage ( ) const

Get voltage value.

Voltage in mV.

Returns
voltage value

Definition at line 1145 of file Roomba500Interface.cpp.

◆ wall_signal()

uint16_t fawkes::Roomba500Interface::wall_signal ( ) const

Get wall_signal value.

Raw wall signal

Returns
wall_signal value

Definition at line 1300 of file Roomba500Interface.cpp.


The documentation for this class was generated from the following files: