README.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

---

Documentation

PJON implements a totally software-defined network protocol stack in around 1500 lines of code, thanks to the strategies abstraction it can operate transparently on different media, physical layers and other protocols. Thanks to the interfaces abstraction PJON can be easily ported on any MCU or architecture. The graph below shows the implementation's architecture.

       ___________________________________________________
      | Layer 3 Network                                   |
      | PJON                                              |
   ___| send, send_packet, send_repeatedly ...            |
  |   |___________________________________________________|
  |   | Layer 2 data link or strategy                     |
  |   | AnalogSampling, OverSampling, SoftwareBitBang ... |
  --->| can_start, send_string, receive_byte ...          |___   
      |___________________________________________________|   |
      | Interfaces to system calls                        |   |
   ___| PJON_MICROS, PJON_RANDOM, PJON_IO_MODE ...        |<---
  |   |___________________________________________________|
  |   | Layer 1 physical-layer                            |
  |   | System calls:                                     |
  --->| micros, random, delayMicroseconds ...             |
      |___________________________________________________|