Skip to content

Commit

Permalink
Document limitations of examples shipped with this library (#95)
Browse files Browse the repository at this point in the history
* Document limitations of examples shipped with this library

* Fixing typo.

* Update README.md

Co-authored-by: Pavel Kirienko <pavel.kirienko@gmail.com>

Co-authored-by: Pavel Kirienko <pavel.kirienko@gmail.com>
  • Loading branch information
aentinger and pavel-kirienko committed Feb 15, 2021
1 parent 34580fc commit c7a3265
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ This library works for
* [UAVCAN-ToF-Distance-Sensor-Node](https://github.com/107-systems/UAVCAN-ToF-Distance-Sensor-Node): Demo firmware for UAVCAN ToF Distance Sensor Node utilizing 107-Arduino-UAVCAN.

### Example
**Note**: Please be advised that the [examples](https://github.com/107-systems/107-Arduino-UAVCAN/tree/master/examples) shipped with this library are to be considered minimal examples to get you started working with [UAVCAN](https://uavcan.org/).
They are known to violate section **2.1.2.2 Regulation** of the UAVCAN Specification due to their reliance on hard-coded port identifiers.
A compliant implementation would instead provide configurable port-IDs and support the Register Interface (section **5.3 Application-layer functions**).
Fully compliant examples that implement reconfigurable port-IDs are shipped separately; e.g., [UAVCAN-GNSS-Node](https://github.com/107-systems/UAVCAN-GNSS-Node).
```C++
#include <ArduinoUAVCAN.h>
/* ... */
Expand Down

0 comments on commit c7a3265

Please sign in to comment.