From 5419aedf256b5f02a80a655e5940c52ff9b596ca Mon Sep 17 00:00:00 2001 From: Alexander Entinger Date: Mon, 15 Feb 2021 10:05:56 +0100 Subject: [PATCH 1/3] Document limitations of examples shipped with this library --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 7a956c63..1a4e3aee 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ 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 libary are to be considered minimal examples to get you started working with [UAVCAN](https://uavcan.org/). They are by no means a full implementation of a UAVCAN node, have a look at the reference implementations instead. ```C++ #include /* ... */ From 2528a43e7b11e9f48f450d89b01414d84b37da3b Mon Sep 17 00:00:00 2001 From: Alexander Entinger Date: Mon, 15 Feb 2021 10:07:34 +0100 Subject: [PATCH 2/3] Fixing typo. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a4e3aee..3a5c790f 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ 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 libary are to be considered minimal examples to get you started working with [UAVCAN](https://uavcan.org/). They are by no means a full implementation of a UAVCAN node, have a look at the reference implementations instead. +**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 by no means a full implementation of a UAVCAN node, have a look at the reference implementations instead. ```C++ #include /* ... */ From 5c6cb0e116793322c18c44a611416a28e7061755 Mon Sep 17 00:00:00 2001 From: Alexander Entinger Date: Mon, 15 Feb 2021 10:28:55 +0100 Subject: [PATCH 3/3] Update README.md Co-authored-by: Pavel Kirienko --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3a5c790f..ef1bec3f 100644 --- a/README.md +++ b/README.md @@ -24,7 +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 by no means a full implementation of a UAVCAN node, have a look at the reference implementations instead. +**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 /* ... */