Skip to content

Commit 42a7456

Browse files
Yveauxhenrikekblad
authored andcommitted
Transport doc (#1291)
* Added getSleepRemaining to core * Test plantuml * Initial transport statechart * Fixed spaces at line endings * Fix render as class * Plantuml update * Update MyTransport.h
1 parent c689274 commit 42a7456

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

Documentation/plantuml.jar

-1.6 MB
Binary file not shown.

core/MyTransport.h

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,46 @@
153153
* - <b>ft</b>=failed uplink transmission counter
154154
* - <b>st</b>=send status, OK=success, NACK=no radio ACK received
155155
*
156+
* @startuml
157+
* state top as "Transport" {
158+
* state Init
159+
* state Failure
160+
* state Ready
161+
* state Parent
162+
* state ID
163+
* state Uplink
164+
* }
165+
*
166+
* [*] --> Init
167+
* Init : entry / Read config from eeprom
168+
* Init --> Failure : [! transportInit()\n|| ID == 0\n|| ID == 255 ]
169+
* Init --> Ready : [MY_GATEWAY_FEATURE]
170+
* Init --> Parent : [else]
171+
*
172+
* Parent : entry / Broadcast Find Parent
173+
* Parent --> ID : [MY_PARENT_NODE_IS_STATIC\n|| MY_PASSIVE_NODE\n|| Parent found]
174+
* Parent --> Parent : [timeout\n&& retries left]
175+
* Parent --> Failure : [timeout\n&& no retries left]
176+
*
177+
* ID : entry / Request Node ID
178+
* ID --> Uplink : [ID valid]
179+
* ID --> ID : [timeout\n&& retries left]
180+
* ID --> Failure : [timeout\n&& no retries left]
181+
*
182+
* Uplink : entry / Check uplink (PING)
183+
* Uplink --> Uplink : [timeout\n&& retries left]
184+
* Uplink --> Parent : [timeout\n&& no retries left]
185+
* Uplink --> Ready : [MY_TRANSPORT_UPLINK_CHECK_DISABLED\n|| Uplink ok (PONG)]
186+
*
187+
* Ready : entry / Transport ready callback
188+
* Ready : MY_GATEWAY_FEATURE && Network discovery required / Send discovery
189+
* Ready --> Parent : [!MY_PARENT_NODE_IS_STATIC\n&& Uplink failure overflow]
190+
*
191+
* Failure : entry / Disable transport
192+
* Failure --> Init : [timeout]
193+
* top --> Failure : [MY_TRANSPORT_SANITY_CHECK\n&& !transportSanityCheck]
194+
* @enduml
195+
*
156196
* @brief API declaration for MyTransport
157197
*
158198
*/

0 commit comments

Comments
 (0)