ThroughSerial

Medium: Hardware/Software Serial port | Pins used: 1 or 2

With ThroughSerial strategy, PJON can run through a software or hardware Serial port working out of the box with many Arduino compatible serial transceivers, like RS485 or radio modules like HC-12 (HCMODU0054). Take a look at the video introduction for a brief showcase of its features. It complies with TSDL v2.0.

Why PJON over Serial?

Serial communication is fast and reliable but it is often useless without all the features PJON contains. ThroughSerial has been developed to enable PJON communication through a serial data link. Adding PJON on top of Serial it is possible to leverage of the PJON protocol layer features like acknowledge, addressing, multiplexing, packet handling, 8 or 32-bit CRC and traffic control.

How to use ThroughSerial

Pass the ThroughSerial type as PJON template parameter to instantiate a PJON object ready to communicate through this Strategy.

PJON<ThroughSerial> bus;

Call the begin method on the Serial or SoftwareSerial object you want to use for PJON communication and pass it to the set_serial method:

/* Set 5 milliseconds (default) as the maximum timeframe for
   byte reception. Always set:
   TX_MAX_RESPONSE_TIME > (byte transmission time + latency) */
#define TS_BYTE_TIME_OUT      5000

/* Set 10 milliseconds as the maximum timeframe between
   transmission and synchronous acknowledgement response.
   This value is strictly related to the maximum time needed
   by receiver to receive and compute the packet.
   Higher if necessary. */
#define TS_RESPONSE_TIME_OUT 10000

/* Set the back-off exponential degree (default 4) */
#define TS_BACK_OFF_DEGREE 4

/* Set the maximum sending attempts (default 20) */
#define TS_MAX_ATTEMPTS   20

#include <PJON.h>

PJON<ThroughSerial> bus;

void setup() {
  Serial.begin(9600);
  bus.strategy.set_serial(&Serial);
}

For a simple use with RS485 serial modules a transmission enable pin setter has been added:

bus.strategy.set_enable_RS485_pin(11);

If separate enable setters are needed use:

// Set RS485 reception enable pin
bus.strategy.set_RS485_rxe_pin(11);
// Set RS485 transmission enable pin
bus.strategy.set_RS485_txe_pin(12);

See RS485-Blink and RS485-AsyncAck examples.

HC-12 wireless module supports both synchronous and asynchronous acknowledgement, see HC-12-Blink, HC-12 LocalChat and HC-12-AsyncAck examples.

All the other necessary information is present in the general Documentation.

Known issues

  • Being PJON not an interrupt driven, its communication can be affected and potentially disrupted by long delays added in the user's sketch. Try to reduce as possible the interval between every receive call.

This document is automatically generated from the github repository. If you have noticed an error or an inconsistency, please report it opening an issue here