Skip to content

Latest commit

 

History

History
232 lines (207 loc) · 15.2 KB

PJON-protocol-specification-v1.1.md

File metadata and controls

232 lines (207 loc) · 15.2 KB
  • PJON (Padded Jittering Operative Network) Protocol specification: v1.1
  • Acknowledge specification: v0.1
  • Dynamic addressing specification: v0.1
  • PJDL (Padded Jittering Data Link) specification: PJDL v1.1 - PJDLR v1.1
/*
Milan, Italy - 28/03/2017
The PJON™ protocol layer specification is an invention
and intellectual property of Giovanni Blu Mitolo
Copyright 2010-2017 All rights reserved

Related work: https://github.com/gioblu/PJON/
Compliant implementation versions: PJON 6.0 and following

Header driven configuration proposed by Fred Larsen

Changelog:
- Avoid sending NAK
- Added unacceptable header configuration list
*/

PJON™ Protocol specification v1.1

With this release, the PJON protocol layer has been vastly extended and generalized aiming to interoperability and to offer a real and complete alternative to the actual set of standards used for networking today. The strong plus of the approach used by the protocol mechanism is high efficiency and low overhead thanks to the configuration driven packet format, enabling easy constrain to application needs.

Network protocol stack model

In the graph below is shown the protocol stack model proposed. The differences between the OSI model and the PJON stack is the presence or absence of some features and how they are distributed in its layers. Those engineering choices are made to offer a scalable and low overhead stack of protocols able to be used as a set or individually. This stack has been engineered "bottom to top" and was originally applied as an alternative to 1-Wire or i2c, with this release features has been extended enabling many use cases where the OSI model is generally applied.

 -----------------------------------------------
| 7 Application layer                           |
| APIs, data sharing, remote access             |
|-----------------------------------------------|
| 6 Presentation layer                          |
| Encryption, encoding, data compression        |
|-----------------------------------------------|
| 5 Session layer                               |
| Session                                       |
|-----------------------------------------------|
| 4 Transport layer                             |
| Routing, segmentation                         |
|-----------------------------------------------|
| 3 Network layer: PJON                         |
| Addressing, reliable packet transmission,     |
| multiplexing, traffic control,                |
| asynchronous acknowledgement                  |
|-----------------------------------------------|
| 2 Data link layer: PJDL/PJDLR                 |
| Data link, collision avoidance,               |
| synchronous acknowledgement                   |
|-----------------------------------------------|
| 1 Physical layer: Cables, transceivers ecc.   |
|_______________________________________________|

Basic concepts

  • Transmission occurs only if the communication medium is not in use
  • Packet transmission is regulated by a 1, 2 or 3 byte header
  • Devices communicate through packets with a maximum length of 255 or 65535 bytes
  • Every device has an equal right to transmit and receive
  • Every device has a unique 1 byte id
  • Every device can obtain an id if available (see Dynamic addressing specification v0.1)
  • Every bus has a unique 4 bytes id
  • Every device can be connected to n PJON buses
  • Many buses can coexist on the same medium
  • Synchronous and or asynchronous acknowledgement can be requested (see Acknowledge specification v0.1)

The PJON protocol v1.1 handles internal bus connectivity and unique addressing for 254 devices, through bus communication with unique bus addressing for 4.294.967.295 buses and supports up to 1.090.921.692.930 devices. It regulates the exchange of packets with a configurable set of features driven by its header. Depending on the packet configuration a certain overhead is added to information varying from 4 up to 19 bytes.

Bus

A PJON bus is made by a group of up to 254 devices transmitting and receiving on the same medium. Communication between devices occurs through packets and it is based on democracy: every device has the right to transmit on the common medium for up to (1000 / devices number) milliseconds / second.

 _______     _______     _______     _______     _______
|       |   |       |   |       |   |       |   |       |
| ID 0  |   | ID 1  |   | ID 2  |   | ID 3  |   | ID 4  |
|_______|   |_______|   |_______|   |_______|   |_______|
____|___________|___________|___________|___________|___
       ___|___     ___|___     ___|___     ___|___
      |       |   |       |   |       |   |       |
      | ID 5  |   | ID 6  |   | ID 7  |   | ID 8  |
      |_______|   |_______|   |_______|   |_______|

Bus network

A PJON bus network is the result of n PJON buses sharing the same medium and or being interconnected to other PJON buses through routers. In a shared medium scenario it is suggested to use the 4 byte bus id to isolate devices from outcoming communication of other buses nearby, enabling many to coexist on the same communication medium.

   TWO BUSES SHARING THE SAME MEDIUM

       BUS ID 0.0.0.1                  BUS ID 0.0.0.2
    _______     _______              _______     _______
   |       |   |       |            |       |   |       |
   | ID 0  |   | ID 1  |            | ID 0  |   | ID 1  |
   |_______|   |_______|            |_______|   |_______|
 ______|___________|___________________|___________|______
          ___|___                          ___|___
         |       |                        |       |
         | ID 2  |                        | ID 2  |
         |_______|                        |_______|

Router

A router is a device connected to n PJON buses with n dedicated, potentially different, data links on n dedicated media, able to route a packet from a bus to another. Thanks to this rule is not only possible to share the same medium with neighbours, but also network with them and enhance connectivity.

TWO BUSES CONNECTED THROUGH A ROUTER

   BUS ID 0.0.0.1                   BUS ID 0.0.0.2
 _______     _______               _______     _______
|       |   |       |             |       |   |       |
| ID 0  |   | ID 1  |             | ID 0  |   | ID 1  |
|_______|   |_______|   ________  |_______|   |_______|
_____|___________|_____| ROUTER |_____|___________|____
       ___|___         |  ID 3  |        ___|___
      |       |        |________|       |       |
      | ID 2  |                         | ID 2  |
      |_______|                         |_______|

Header configuration

HEADER BITMASK
    1      2     3     4     5     6     7     8
 ______ ______ _____ _____ _____ _____ _____ _____
|EXT.  |EXT.  |CRC  |ADDR.|ACK  |ACK  |TX   |MODE |
|HEADER|LENGTH|     |     |MODE |     |INFO |     |
|______|______|_____|_____|_____|_____|_____|_____|
|EXT.  |ROUT. |SEGM.|SESS.|PAR. |ENCO |DATA |ENCRY|
|HEADER|      |     |     |     |DING |COMP.|PTION|
|______|______|_____|_____|_____|_____|_____|_____|
|      |      |     |     |     |     |     |     |
| N/A  | N/A  | N/A | N/A | N/A | N/A | N/A | N/A |
|______|______|_____|_____|_____|_____|_____|_____|

Header byte 1 bits roles

  • EXT. HEADER or extended header bit informs if the header is composed by 1 (value 0) or 2 bytes (value 1)
  • EXT. LENGTH or extended length bit informs if the packet contains 1 (value 0) or 2 (value 1) bytes length
  • CRC bit informs the receiver which CRC was used as check for the packet, CRC 8 (value 0) or CRC 32 (value 1)
  • ADDR. or addressing bit informs if the packet is part of an addressing procedure (value 1) or not (value 0)
  • ACK MODE or acknowledge mode bit requests synchronous (value 0) or asynchronous (value 1) acknowledge mode
  • ACK or acknowledge bit informs if acknowledge is requested (value 1) or not (value 0)
  • TX INFO or transmitter info bit informs if the sender info are included (value 1) or not (value 0)
  • MODE bit informs if the packet is a shared mode (value 1) or if local mode formatted (value 0)

Unacceptable header configuration states for standard transmission

  • ----1-0- or ACK MODE bit up, and TX INFO down (asynchronous acknowledgement needs transmitter info)
  • -10----- or EXT. LENGTH bit up and CRC down (CRC32 forced for packet length > 15)

Unacceptable header configuration states sending a BROADCAST

  • -----1-- or ACK bit up (no acknowledgement supported if BROADCAST)
  • ----1--- or ACK MODE bit up (no acknowledgement supported if BROADCAST)
  • -10----- or EXT. LENGTH bit up and CRC down (CRC32 forced for packet length > 15)

- symbol means irrelevant bit value

Header byte 2 bits roles

  • EXT. HEADER bit informs if the header is composed by 2 (value 0) or 3 bytes (value 1)
  • ROUT. or routing bit informs if routing meta-data is included (value 1) or not (value 0)
  • SEGM. or segmentation bit informs if part of a segmented transmission (value 1) or not (value 0)
  • SESS. or session bit informs if session meta-data is included (value 1) or not (value 0)
  • PAR. or parity bit informs if parity information for auto-correction is included (value 1) or not (value 0)
  • ENCODING bit informs if encoding meta-data is included (value 1) or not (value 0)
  • DATA COMP. or data compression bit informs if data compression meta-data is included (value 1) or not (value 0)
  • ENCRYPTION bit informs if encryption meta-data is included (value 1) or not (value 0)

Packet transmission

A packet transmission is an exchange of a string to one or many of the devices connected to the bus with optional correct reception certainty. The simplest form of packet is constructed by a recipient id, a header, length, content and CRC. In the graph below is shown a packet transmission in a local bus to device id 12 containing the string @ (decimal 64) with no acknowledgement request:

 ID 12       HEADER 1  LENGTH 5     CONTENT 64  CRC 72
 __________  ________  ___________  __________  ____________
| Byte     || Byte   || Byte      || Byte     || Byte       |
|     __   ||        ||      _   _||  _       ||  _    _    |
|    |  |  ||        ||     | | | || | |      || | |  | |   |
|0000|11|00||00000000||00000|1|0|1||0|1|000000||0|1|00|1|000|
|____|__|__||________||_____|_|_|_||_|_|______||_|_|__|_|___|

A default local packet transmission is an optionally bidirectional communication between two devices that can be divided in 3 different phases: channel analysis, transmission and optional response. The packet transmission procedure is regulated by its header.

Channel analysis       Transmission             Response
 _____  ________________________________________  _____
| C-A || ID |  HEADER  | LENGTH | CONTENT | CRC || ACK |
|-----||----|----------|--------|---------|-----||-----|
|  0  || 12 | 00000100 |   5    |    64   |  72 ||  6  |
|_____||____|__________|________|_________|_____||_____|

In the first phase the bus is analyzed by transmitter reading 10 logical bits, if no logical 1 is detected the channel is considered free and transmission phase starts in which the packet is entirely transmitted. Receiver calculates CRC and starts the response phase transmitting a single byte, PJON_ACK (decimal 6) in case of correct reception. If transmitter receives no answer the packet sending is scheduled with a delay of ATTEMPTS * ATTEMPTS * ATTEMPTS * ATTEMPTS with a maximum of 42 ATTEMPTS to obtain data transmission 4rd degree polynomial back-off.

Below is shown the same local transmission used as an example before, formatted to be sent over a shared medium, where device id 12 of bus 0.0.0.1 sends @ (decimal 64) to device id 11 in bus id 0.0.0.1. The packet's content is prepended with the bus id of the recipient, and optionally the sender's bus and device id:

Channel analysis            Transmission           Response
 ___  _______________________________________________  ___
|C-A||ID| HEADER |LENGTH|BUS ID|BUS ID|ID|CONTENT|CRC||ACK|
|---||--|--------|------|------|------|--|-------|---||---|
| 0 ||12|00000111|  14  | 0001 | 0001 |11|  64   |   || 6 |
|___||__|________|______|______|______|__|_______|___||___|
                        |RXINFO| TX INFO |

Configuring the header it is possible to leverage of the extended features of the protocol:

Channel analysis            Transmission                       Response
 ___  ___________________________________________________________  ___
|C-A||ID| HEADER |LENGTH 1|LENGTH 2|BUS ID|BUS ID|ID|CONT| CRC32 ||ACK|
|---||--|--------|--------|--------|------|------|--|----|-------||---|
| 0 ||12|01100111| byte 1 | byte 2 | 0001 | 0001 |11|    |1|2|3|4|| 6 |
|___||__|________|________|________|______|______|__|____|_|_|_|_||___|
                                   |RXINFO| TX INFO |

The graph above shows a packet transmission where the length is of 2 bytes supporting up to 65.535kB packet length. Receiver is able to parse the packet correctly reading the header, where B01000000 up signals a 2 bytes length format and B00100000 up signals CRC32 use.

Channel analysis            Transmission                  Response
 ___  ______________________________________________________  ___
|C-A||ID| HEADER |LENGTH|BUS ID|BUS ID|ID|PACKET ID|CONT|CRC||ACK|
|---||--|--------|------|------|------|--|---------|----|---||---|
| 0 ||12|00001111|  16  | 0002 | 0001 |11|   999   | 64 |   || 6 |
|___||__|________|______|______|______|__|_________|____|___||___|
                        |RXINFO| TX INFO |

The graph above shows a packet transmission where the recursive acknowledgement pattern is applied: device 11 sends to device 12 of bus 0.0.0.2 a packet with header ACK MODE bit up requesting an asynchronous acknowledgement response, and so identifying the packet with the unique id 999 and ACK bit up requesting a synchronous acknowledgement response. 12 receives the packet and replies with a synchronous acknowledgement, or sending PJON_ACK (decimal 6), subsequently 12 sends also an asynchronous acknowledgement, that is instead an entire packet, back to device 11 containing only packet id 999 and the necessary configuration, that will be also synchronously acknowledged by device 11:

Channel analysis            Transmission               Response
 ___  ___________________________________________________  ___
|C-A||ID| HEADER |LENGTH|BUS ID|BUS ID|ID|PACKET ID| CRC ||ACK|
|---||--|--------|------|------|------|--|---------|-----||---|
| 0 ||11|00001111|  15  | 0001 | 0002 |12|   999   |     || 6 |
|___||__|________|______|______|______|__|_________|_____||___|
                        |RXINFO| TX INFO |

See the Acknowledge specification v0.1 to have more detailed info of its procedure.