data-structures.md

Documentation index

• Addressing
  • set_id device_id get_bus_id set_bus_id get_mac set_mac
• Configuration
  • set_communication_mode set_shared_network set_router include_sender_info set_crc_32 set_packet_auto_deletion set_acknowledge set_packet_id include_port include_mac
• Data reception
  • set_receiver receive
• Data structures
  • PJON_Endpoint PJON_Packet_Info
• Data transmission
  • begin reply reply_blocking send send_packet send_packet_blocking send_repeatedly reply reply_blocking forward forward_blocking
• Error handling
  • set_error
• Routing
  • PJONSimpleSwitch PJONSwitch PJONRouter PJONDynamicRouter PJONInteractiveRouter
• IO setup
  • strategy

---

Data structures

PJON_Endpoint

PJON_Endpoint contains the device id, bus id and MAC address of a device:

struct PJON_Endpoint {
  uint8_t id = PJON_NOT_ASSIGNED;
  uint8_t bus_id[4] = {0, 0, 0, 0};
  uint8_t mac[6] = {0, 0, 0, 0, 0, 0};
};

PJON_Endpoint contains mac if PJON_INCLUDE_MAC is defined. The conditional inclusion is present to reduce the footprint of programs where the MAC address is not used.

PJON_Packet_Info

PJON_Packet_Info contains all meta-data supported by the PJON packet format. The tx and rx data structures of type PJON_Endpoint contain the transmitter and receiver information.

struct PJON_Packet_Info {
  PJON_Endpoint tx;
  PJON_Endpoint rx;
  void *custom_pointer;
  uint8_t header = PJON_NO_HEADER;
  uint8_t hops = 0;
  uint16_t id = 0;
  uint16_t port = PJON_BROADCAST;
};

PJON_Packet_Info contains port if PJON_INCLUDE_PORT is defined and id if PJON_INCLUDE_PACKET_ID is defined. The conditional inclusion is present to reduce the footprint of programs where the port and the packet id are not used.

The custom_pointer can be used to link other classes or instances passing any sort of data structure. To understand how to use it see the ClassMemberCallback example.