JaiaBot  1.19.0
JaiaBot micro-AUV software
jaiabot::comms::XBeeDevice Class Reference

#include <jaiabot/comms/xbee/xbee.h>

Public Member Functions

 XBeeDevice ()
 
void startup (const std::string &port_name, const int baud_rate, const NodeId &my_node_id, const uint16_t network_id, const std::string &xbee_info_location, const bool &use_encryption, const std::string &encryption_password, const std::string &mesh_unicast_retries, const std::string &unicast_mac_retries, const std::string &network_delay_slots, const std::string &broadcast_multi_transmits, int fleet, unsigned subnet_mask)
 
void shutdown ()
 
void send_packet (const NodeId &dest, const std::string &s)
 
void send_test_links (const NodeId &dest, const NodeId &com_dest)
 
std::vector< std::string > get_packets ()
 
void do_work ()
 
void add_peer (const NodeId node_id, NodeType type, int bot_or_hub_id, int fleet_id)
 
void add_peer (const NodeId node_id, NodeType type, int bot_or_hub_id)
 
void send_diagnostic_commands ()
 

Public Attributes

uint16_t max_payload_size
 

Static Public Attributes

static const NodeId broadcast
 

Detailed Description

Definition at line 83 of file xbee.h.

Constructor & Destructor Documentation

◆ XBeeDevice()

jaiabot::comms::XBeeDevice::XBeeDevice ( )

Member Function Documentation

◆ add_peer() [1/2]

void jaiabot::comms::XBeeDevice::add_peer ( const NodeId  node_id,
NodeType  type,
int  bot_or_hub_id 
)
inline

Definition at line 108 of file xbee.h.

◆ add_peer() [2/2]

void jaiabot::comms::XBeeDevice::add_peer ( const NodeId  node_id,
NodeType  type,
int  bot_or_hub_id,
int  fleet_id 
)

◆ do_work()

void jaiabot::comms::XBeeDevice::do_work ( )

◆ get_packets()

std::vector<std::string> jaiabot::comms::XBeeDevice::get_packets ( )

◆ send_diagnostic_commands()

void jaiabot::comms::XBeeDevice::send_diagnostic_commands ( )

◆ send_packet()

void jaiabot::comms::XBeeDevice::send_packet ( const NodeId dest,
const std::string &  s 
)

◆ send_test_links()

void jaiabot::comms::XBeeDevice::send_test_links ( const NodeId dest,
const NodeId com_dest 
)

◆ shutdown()

void jaiabot::comms::XBeeDevice::shutdown ( )

◆ startup()

void jaiabot::comms::XBeeDevice::startup ( const std::string &  port_name,
const int  baud_rate,
const NodeId my_node_id,
const uint16_t  network_id,
const std::string &  xbee_info_location,
const bool &  use_encryption,
const std::string &  encryption_password,
const std::string &  mesh_unicast_retries,
const std::string &  unicast_mac_retries,
const std::string &  network_delay_slots,
const std::string &  broadcast_multi_transmits,
int  fleet,
unsigned  subnet_mask 
)

Member Data Documentation

◆ broadcast

const NodeId jaiabot::comms::XBeeDevice::broadcast
static

Definition at line 102 of file xbee.h.

◆ max_payload_size

uint16_t jaiabot::comms::XBeeDevice::max_payload_size

Definition at line 104 of file xbee.h.


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