Skip to content

Commit a00857a

Browse files
tekka007tekka007
authored
Update Debug message tables (#962)
1 parent e685aa1 commit a00857a

File tree

4 files changed

+119
-120
lines changed

4 files changed

+119
-120
lines changed

‎core/MyOTAFirmwareUpdate.h

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,19 @@
3434
*
3535
* MyOTAFirmwareUpdate debug log messages:
3636
*
37-
* |E| SYS | SUB | Message | Comment
38-
* |-|------|-------|-------------------------------------------|----------------------------------------------------------------------------
39-
* | | OTA | FWP | UPDATE | FW update initiated
40-
* |!| OTA | FWP | FLASH INIT FAIL | Failed to initialise flash
41-
* | | OTA | FWP | UPDATE SKIPPED | FW update skipped, no newer version available
42-
* | | OTA | FWP | RECV B=%04X | Received FW block (B)
43-
* |!| OTA | FWP | WRONG FWB | Wrong FW block received
44-
* | | OTA | FWP | FW END | FW received, proceed to CRC verification
45-
* | | OTA | FWP | CRC OK | FW CRC verification OK
46-
* |!| OTA | FWP | CRC FAIL | FW CRC verification failed
47-
* | | OTA | FRQ | FW REQ,T=%04X,V=%04X,B=%04X | Request FW update, FW type (T), version (V), block (B)
48-
* |!| OTA | FRQ | FW UPD FAIL | FW update failed
49-
* | | OTA | CRC | B=%04X,C=%04X,F=%04X | FW CRC verification. FW blocks (B), calculated CRC (C), FW CRC (F)
37+
* |E| SYS | SUB | Message | Comment
38+
* |-|-----|-----|-----------------------------|----------------------------------------------------------------------------
39+
* | | OTA | FWP | UPDATE | FW update initiated
40+
* |!| OTA | FWP | FLASH INIT FAIL | Failed to initialise flash
41+
* | | OTA | FWP | UPDATE SKIPPED | FW update skipped, no newer version available
42+
* | | OTA | FWP | RECV B=%04X | Received FW block (B)
43+
* |!| OTA | FWP | WRONG FWB | Wrong FW block received
44+
* | | OTA | FWP | FW END | FW received, proceed to CRC verification
45+
* | | OTA | FWP | CRC OK | FW CRC verification OK
46+
* |!| OTA | FWP | CRC FAIL | FW CRC verification failed
47+
* | | OTA | FRQ | FW REQ,T=%04X,V=%04X,B=%04X | Request FW update, FW type (T), version (V), block (B)
48+
* |!| OTA | FRQ | FW UPD FAIL | FW update failed
49+
* | | OTA | CRC | B=%04X,C=%04X,F=%04X | FW CRC verification. FW blocks (B), calculated CRC (C), FW CRC (F)
5050
*
5151
*
5252
* @brief API declaration for MyOTAFirmwareUpdate

‎core/MySensorsCore.cpp

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@
3131
#define CORE_DEBUG(x,...) //!< debug NULL
3232
#endif
3333

34-
3534
// message buffers
3635
MyMessage _msg; // Buffer for incoming messages
3736
MyMessage _msgTmp; // Buffer for temporary messages (acks and nonces among others)

‎core/MySensorsCore.h

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -37,26 +37,26 @@
3737
*
3838
* MySensorsCore debug log messages:
3939
*
40-
* |E| SYS | SUB | Message | Comment
41-
* |-|-------|-------|-----------------------------------------------|----------------------------------------------------------------------------
42-
* |!| MCO | BGN | HW ERR | Error HW initialization (e.g. ext. EEPROM)
43-
* | | MCO | BGN | INIT %%s,CP=%%s,LIB=%%s | Core initialization, capabilities (CP), library version (VER)
44-
* | | MCO | BGN | BFR | Callback before()
45-
* | | MCO | BGN | STP | Callback setup()
46-
* | | MCO | BGN | INIT OK,TSP=%%d | Core initialised, transport status (TSP), 1=initialised, 0=not initialised, NA=not available
47-
* | | MCO | BGN | NODE UNLOCKED | Node successfully unlocked (see signing chapter)
48-
* |!| MCO | BGN | TSP FAIL | Transport initialization failed
49-
* | | MCO | REG | REQ | Registration request
50-
* | | MCO | REG | NOT NEEDED | No registration needed (i.e. GW)
51-
* |!| MCO | SND | NODE NOT REG | Node is not registered, cannot send message
52-
* | | MCO | PIM | NODE REG=%%d | Registration response received, registration status (REG)
53-
* | | MCO | SLP | MS=%%lu,SMS=%%d,I1=%%d,M1=%%d,I2=%%d,M2=%%d | Sleep node, time (MS), smartSleep (SMS), Int1/M1, Int2/M2
54-
* | | MCO | SLP | WUP=%%d | Node woke-up, reason/IRQ (WUP)
55-
* |!| MCO | SLP | FWUPD | Sleeping not possible, FW update ongoing
56-
* |!| MCO | SLP | REP | Sleeping not possible, repeater feature enabled
57-
* |!| MCO | SLP | TNR | Transport not ready, attempt to reconnect until timeout (MY_SLEEP_TRANSPORT_RECONNECT_TIMEOUT_MS)
58-
* | | MCO | NLK | NODE LOCKED. UNLOCK: GND PIN %%d AND RESET | Node locked during booting, see signing chapter for additional information
59-
* | | MCO | NLK | TSL | Set transport to sleep
40+
* |E| SYS | SUB | Message | Comment
41+
* |-|-----|-----|---------------------------------------------|----------------------------------------------------------------------------
42+
* |!| MCO | BGN | HW ERR | Error HW initialization (e.g. ext. EEPROM)
43+
* | | MCO | BGN | INIT %%s,CP=%%s,LIB=%%s | Core initialization, capabilities (CP), library version (LIB)
44+
* | | MCO | BGN | BFR | Callback before()
45+
* | | MCO | BGN | STP | Callback setup()
46+
* | | MCO | BGN | INIT OK,TSP=%%d | Core initialised, transport status (TSP): 0=not initialised, 1=initialised, NA=not available
47+
* | | MCO | BGN | NODE UNLOCKED | Node successfully unlocked (see signing chapter)
48+
* |!| MCO | BGN | TSP FAIL | Transport initialization failed
49+
* | | MCO | REG | REQ | Registration request
50+
* | | MCO | REG | NOT NEEDED | No registration needed (i.e. GW)
51+
* |!| MCO | SND | NODE NOT REG | Node is not registered, cannot send message
52+
* | | MCO | PIM | NODE REG=%%d | Registration response received, registration status (REG)
53+
* | | MCO | SLP | MS=%%lu,SMS=%%d,I1=%%d,M1=%%d,I2=%%d,M2=%%d | Sleep node, time (MS), smartSleep (SMS), Int1/M1, Int2/M2
54+
* | | MCO | SLP | WUP=%%d | Node woke-up, reason/IRQ (WUP)
55+
* |!| MCO | SLP | FWUPD | Sleeping not possible, FW update ongoing
56+
* |!| MCO | SLP | REP | Sleeping not possible, repeater feature enabled
57+
* |!| MCO | SLP | TNR | Transport not ready, attempt to reconnect until timeout (MY_SLEEP_TRANSPORT_RECONNECT_TIMEOUT_MS)
58+
* | | MCO | NLK | NODE LOCKED. UNLOCK: GND PIN %%d AND RESET | Node locked during booting, see signing chapter for additional information
59+
* | | MCO | NLK | TSL | Set transport to sleep
6060
*
6161
*
6262
* @brief API declaration for MySensorsCore
@@ -73,17 +73,17 @@
7373
#include <stddef.h>
7474
#include <stdarg.h>
7575

76-
#define GATEWAY_ADDRESS ((uint8_t)0) //!< Node ID for GW sketch
77-
#define NODE_SENSOR_ID ((uint8_t)255) //!< Node child is always created/presented when a node is started
78-
#define MY_CORE_VERSION ((uint8_t)2) //!< core version
79-
#define MY_CORE_MIN_VERSION ((uint8_t)2) //!< min core version required for compatibility
80-
81-
#define MY_WAKE_UP_BY_TIMER ((int8_t)-1) //!< Sleeping wake up by timer
82-
#define MY_SLEEP_NOT_POSSIBLE ((int8_t)-2) //!< Sleeping not possible
83-
#define INTERRUPT_NOT_DEFINED ((uint8_t)255) //!< _sleep() param: no interrupt defined
84-
#define MODE_NOT_DEFINED ((uint8_t)255) //!< _sleep() param: no mode defined
85-
#define VALUE_NOT_DEFINED ((uint8_t)255) //!< Value not defined
86-
#define FUNCTION_NOT_SUPPORTED ((uint16_t)0) //!< Function not supported
76+
#define GATEWAY_ADDRESS ((uint8_t)0) //!< Node ID for GW sketch
77+
#define NODE_SENSOR_ID ((uint8_t)255) //!< Node child is always created/presented when a node is started
78+
#define MY_CORE_VERSION ((uint8_t)2) //!< core version
79+
#define MY_CORE_MIN_VERSION ((uint8_t)2) //!< min core version required for compatibility
80+
81+
#define MY_WAKE_UP_BY_TIMER ((int8_t)-1) //!< Sleeping wake up by timer
82+
#define MY_SLEEP_NOT_POSSIBLE ((int8_t)-2) //!< Sleeping not possible
83+
#define INTERRUPT_NOT_DEFINED ((uint8_t)255) //!< _sleep() param: no interrupt defined
84+
#define MODE_NOT_DEFINED ((uint8_t)255) //!< _sleep() param: no mode defined
85+
#define VALUE_NOT_DEFINED ((uint8_t)255) //!< Value not defined
86+
#define FUNCTION_NOT_SUPPORTED ((uint16_t)0) //!< Function not supported
8787

8888
/**
8989
* @brief Controller configuration

‎core/MyTransport.h

Lines changed: 75 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@
3131
* - <b>TSF</b>: messages emitted by transport support functions
3232
* - SUB SYSTEMS:
3333
* - Transport state machine (<b>TSM</b>)
34-
* - TSM:INIT from <b>stInit</b> Initialize transport and radio
35-
* - TSM:FPAR from <b>stParent</b> Find parent
34+
* - TSM:INIT from <b>stInit</b> Initialize transport and radio
35+
* - TSM:FPAR from <b>stParent</b> Find parent
3636
* - TSM:ID from <b>stID</b> Check/request node ID, if dynamic node ID set
3737
* - TSM:UPL from <b>stUplink</b> Verify uplink connection by pinging GW
38-
* - TSM:READY from <b>stReady</b> Transport is ready and fully operational
39-
* - TSM:FAIL from <b>stFailure</b> Failure in transport link or transport HW
38+
* - TSM:READY from <b>stReady</b> Transport is ready and fully operational
39+
* - TSM:FAIL from <b>stFailure</b> Failure in transport link or transport HW
4040
* - Transport support function (<b>TSF</b>)
4141
* - TSF:CKU from @ref transportCheckUplink(), checks connection to GW
4242
* - TSF:SID from @ref transportAssignNodeID(), assigns node ID
@@ -55,77 +55,77 @@
5555
*
5656
* Transport debug log messages:
5757
*
58-
* |E| SYS | SUB | Message | Comment
59-
* |-|-------|-----------|---------------------------|---------------------------------------------------------------------
60-
* | | TSM | INIT | | <b>Transition to stInit state</b>
61-
* | | TSM | INIT | STATID=%%d | Node ID is static
62-
* | | TSM | INIT | TSP OK | Transport device configured and fully operational
63-
* | | TSM | INIT | TSP PSM | Transport passive mode set
64-
* | | TSM | INIT | GW MODE | Node is set up as GW, thus omitting ID and findParent states
65-
* |!| TSM | INIT | TSP FAIL | Transport device initialization failed
66-
* | | TSM | FPAR | | <b>Transition to stParent state</b>
67-
* | | TSM | FPAR | STATP=%%d | Static parent set, skip finding parent
68-
* | | TSM | FPAR | OK | Parent node identified
69-
* |!| TSM | FPAR | NO REPLY | No potential parents replied to find parent request
70-
* |!| TSM | FPAR | FAIL | Finding parent failed
71-
* | | TSM | ID | | <b>Transition to stID state</b>
72-
* | | TSM | ID | OK,ID=%%d | Node ID is valid
73-
* | | TSM | ID | REQ | Request node ID from controller
74-
* |!| TSM | ID | FAIL,ID=%%d | ID verification failed, ID invalid
75-
* | | TSM | UPL | | <b>Transition to stUplink state</b>
76-
* | | TSM | UPL | OK | Uplink OK, GW returned ping
77-
* | | TSF | UPL | DGWC,O=%%d,N=%%d | Uplink check revealed changed network topology, old distance (O), new distance (N)
78-
* |!| TSM | UPL | FAIL | Uplink check failed, i.e. GW could not be pinged
79-
* | | TSM | READY | SRT | Save routing table
80-
* | | TSM | READY | ID=%%d,PAR=%%d,DIS=%%d | <b>Transition to stReady</b> Transport ready, node ID (ID), parent node ID (PAR), distance to GW (DIS)
81-
* |!| TSM | READY | UPL FAIL,SNP | Too many failed uplink transmissions, search new parent
82-
* |!| TSM | READY | FAIL,STATP | Too many failed uplink transmissions, static parent enforced
83-
* | | TSM | FAIL | CNT=%%d | <b>Transition to stFailure state</b>, consecutive failure counter (CNT)
84-
* | | TSM | FAIL | DIS | Disable transport
85-
* | | TSM | FAIL | RE-INIT | Attempt to re-initialize transport
86-
* | | TSF | CKU | OK | Uplink OK
87-
* | | TSF | CKU | OK,FCTRL | Uplink OK, flood control prevents pinging GW in too short intervals
88-
* | | TSF | CKU | DGWC,O=%%d,N=%%d | Uplink check revealed changed network topology, old distance (O), new distance (N)
89-
* | | TSF | CKU | FAIL | No reply received when checking uplink
90-
* | | TSF | SID | OK,ID=%%d | Node ID assigned
91-
* |!| TSF | SID | FAIL,ID=%%d | Assigned ID is invalid
92-
* | | TSF | PNG | SEND,TO=%%d | Send ping to destination (TO)
93-
* | | TSF | WUR | MS=%%lu | Wait until transport ready, timeout (MS)
94-
* | | TSF | MSG | ACK REQ | ACK message requested
95-
* | | TSF | MSG | ACK | ACK message, do not proceed but forward to callback
96-
* | | TSF | MSG | FPAR RES,ID=%%d,D=%%d | Response to find parent received from node (ID) with distance (D) to GW
97-
* | | TSF | MSG | FPAR PREF FOUND | Preferred parent found, i.e. parent defined via MY_PARENT_NODE_ID
98-
* | | TSF | MSG | FPAR OK,ID=%%d,D=%%d | Find parent response from node (ID) is valid, distance (D) to GW
99-
* | | TSF | MSG | FPAR INACTIVE | Find parent response received, but no find parent request active, skip response
100-
* | | TSF | MSG | FPAR REQ,ID=%%d | Find parent request from node (ID)
101-
* | | TSF | MSG | PINGED,ID=%%d,HP=%%d | Node pinged by node (ID) with (HP) hops
102-
* | | TSF | MSG | PONG RECV,HP=%%d | Pinged node replied with (HP) hops
103-
* | | TSF | MSG | BC | Broadcast message received
104-
* | | TSF | MSG | GWL OK | Link to GW ok
105-
* | | TSF | MSG | FWD BC MSG | Controlled broadcast message forwarding
106-
* | | TSF | MSG | REL MSG | Relay message
107-
* | | TSF | MSG | REL PxNG,HP=%%d | Relay PING/PONG message, increment hop counter (HP)
108-
* |!| TSF | MSG | LEN,%%d!=%%d | Invalid message length, (actual!=expected)
109-
* |!| TSF | MSG | PVER,%%d!=%%d | Message protocol version mismatch (actual!=expected)
110-
* |!| TSF | MSG | SIGN VERIFY FAIL | Signing verification failed
111-
* |!| TSF | MSG | REL MSG,NORP | Node received a message for relaying, but node is not a repeater, message skipped
112-
* |!| TSF | MSG | SIGN FAIL | Signing message failed
113-
* |!| TSF | MSG | GWL FAIL | GW uplink failed
114-
* |!| TSF | MSG | ID TK INVALID | Token for ID request invalid
115-
* | | TSF | SAN | OK | Sanity check passed
116-
* |!| TSF | SAN | FAIL | Sanity check failed, attempt to re-initialize radio
117-
* | | TSF | CRT | OK | Clearing routing table successful
118-
* | | TSF | LRT | OK | Loading routing table successful
119-
* | | TSF | SRT | OK | Saving routing table successful
120-
* |!| TSF | RTE | FPAR ACTIVE | Finding parent active, message not sent
121-
* |!| TSF | RTE | DST %%d UNKNOWN | Routing for destination (DST) unknown, send message to parent
122-
* | | TSF | RRT | ROUTE N=%%d,R=%%d | Routing table, messages to node (N) are routed via node (R)
123-
* |!| TSF | SND | TNR | Transport not ready, message cannot be sent
124-
* | | TSF | TDI | TSL | Set transport to sleep
125-
* | | TSF | TDI | TPD | Power down transport
126-
* | | TSF | TRI | TRI | Reinitialise transport
127-
* | | TSF | TRI | TSB | Set transport to standby
128-
* | | TSF | SIR | CMD=%d,VAL=%d | Get signal report
58+
* |E| SYS | SUB | Message | Comment
59+
* |-|-----|-------|---------------------------|---------------------------------------------------------------------
60+
* | | TSM | INIT | | <b>Transition to stInit state</b>
61+
* | | TSM | INIT | STATID=%%d | Node ID is static
62+
* | | TSM | INIT | TSP OK | Transport device configured and fully operational
63+
* | | TSM | INIT | TSP PSM | Transport passive mode set
64+
* | | TSM | INIT | GW MODE | Node is set up as GW, thus omitting ID and findParent states
65+
* |!| TSM | INIT | TSP FAIL | Transport device initialization failed
66+
* | | TSM | FPAR | | <b>Transition to stParent state</b>
67+
* | | TSM | FPAR | STATP=%%d | Static parent set, skip finding parent
68+
* | | TSM | FPAR | OK | Parent node identified
69+
* |!| TSM | FPAR | NO REPLY | No potential parents replied to find parent request
70+
* |!| TSM | FPAR | FAIL | Finding parent failed
71+
* | | TSM | ID | | <b>Transition to stID state</b>
72+
* | | TSM | ID | OK,ID=%%d | Node ID is valid
73+
* | | TSM | ID | REQ | Request node ID from controller
74+
* |!| TSM | ID | FAIL,ID=%%d | ID verification failed, ID invalid
75+
* | | TSM | UPL | | <b>Transition to stUplink state</b>
76+
* | | TSM | UPL | OK | Uplink OK, GW returned ping
77+
* | | TSF | UPL | DGWC,O=%%d,N=%%d | Uplink check revealed changed network topology, old distance (O), new distance (N)
78+
* |!| TSM | UPL | FAIL | Uplink check failed, i.e. GW could not be pinged
79+
* | | TSM | READY | SRT | Save routing table
80+
* | | TSM | READY | ID=%%d,PAR=%%d,DIS=%%d | <b>Transition to stReady</b> Transport ready, node ID (ID), parent node ID (PAR), distance to GW (DIS)
81+
* |!| TSM | READY | UPL FAIL,SNP | Too many failed uplink transmissions, search new parent
82+
* |!| TSM | READY | FAIL,STATP | Too many failed uplink transmissions, static parent enforced
83+
* | | TSM | FAIL | CNT=%%d | <b>Transition to stFailure state</b>, consecutive failure counter (CNT)
84+
* | | TSM | FAIL | DIS | Disable transport
85+
* | | TSM | FAIL | RE-INIT | Attempt to re-initialize transport
86+
* | | TSF | CKU | OK | Uplink OK
87+
* | | TSF | CKU | OK,FCTRL | Uplink OK, flood control prevents pinging GW in too short intervals
88+
* | | TSF | CKU | DGWC,O=%%d,N=%%d | Uplink check revealed changed network topology, old distance (O), new distance (N)
89+
* | | TSF | CKU | FAIL | No reply received when checking uplink
90+
* | | TSF | SID | OK,ID=%%d | Node ID assigned
91+
* |!| TSF | SID | FAIL,ID=%%d | Assigned ID is invalid
92+
* | | TSF | PNG | SEND,TO=%%d | Send ping to destination (TO)
93+
* | | TSF | WUR | MS=%%lu | Wait until transport ready, timeout (MS)
94+
* | | TSF | MSG | ACK REQ | ACK message requested
95+
* | | TSF | MSG | ACK | ACK message, do not proceed but forward to callback
96+
* | | TSF | MSG | FPAR RES,ID=%%d,D=%%d | Response to find parent received from node (ID) with distance (D) to GW
97+
* | | TSF | MSG | FPAR PREF FOUND | Preferred parent found, i.e. parent defined via MY_PARENT_NODE_ID
98+
* | | TSF | MSG | FPAR OK,ID=%%d,D=%%d | Find parent response from node (ID) is valid, distance (D) to GW
99+
* | | TSF | MSG | FPAR INACTIVE | Find parent response received, but no find parent request active, skip response
100+
* | | TSF | MSG | FPAR REQ,ID=%%d | Find parent request from node (ID)
101+
* | | TSF | MSG | PINGED,ID=%%d,HP=%%d | Node pinged by node (ID) with (HP) hops
102+
* | | TSF | MSG | PONG RECV,HP=%%d | Pinged node replied with (HP) hops
103+
* | | TSF | MSG | BC | Broadcast message received
104+
* | | TSF | MSG | GWL OK | Link to GW ok
105+
* | | TSF | MSG | FWD BC MSG | Controlled broadcast message forwarding
106+
* | | TSF | MSG | REL MSG | Relay message
107+
* | | TSF | MSG | REL PxNG,HP=%%d | Relay PING/PONG message, increment hop counter (HP)
108+
* |!| TSF | MSG | LEN,%%d!=%%d | Invalid message length, (actual!=expected)
109+
* |!| TSF | MSG | PVER,%%d!=%%d | Message protocol version mismatch (actual!=expected)
110+
* |!| TSF | MSG | SIGN VERIFY FAIL | Signing verification failed
111+
* |!| TSF | MSG | REL MSG,NORP | Node received a message for relaying, but node is not a repeater, message skipped
112+
* |!| TSF | MSG | SIGN FAIL | Signing message failed
113+
* |!| TSF | MSG | GWL FAIL | GW uplink failed
114+
* |!| TSF | MSG | ID TK INVALID | Token for ID request invalid
115+
* | | TSF | SAN | OK | Sanity check passed
116+
* |!| TSF | SAN | FAIL | Sanity check failed, attempt to re-initialize radio
117+
* | | TSF | CRT | OK | Clearing routing table successful
118+
* | | TSF | LRT | OK | Loading routing table successful
119+
* | | TSF | SRT | OK | Saving routing table successful
120+
* |!| TSF | RTE | FPAR ACTIVE | Finding parent active, message not sent
121+
* |!| TSF | RTE | DST %%d UNKNOWN | Routing for destination (DST) unknown, send message to parent
122+
* | | TSF | RRT | ROUTE N=%%d,R=%%d | Routing table, messages to node (N) are routed via node (R)
123+
* |!| TSF | SND | TNR | Transport not ready, message cannot be sent
124+
* | | TSF | TDI | TSL | Set transport to sleep
125+
* | | TSF | TDI | TPD | Power down transport
126+
* | | TSF | TRI | TRI | Reinitialise transport
127+
* | | TSF | TRI | TSB | Set transport to standby
128+
* | | TSF | SIR | CMD=%d,VAL=%d | Get signal report
129129
*
130130
*
131131
* Incoming / outgoing messages:

0 commit comments

Comments
 (0)