Archives/Farm-Data-Relay-System
2
0
Fork 0
mirror of https://github.com/timmbogner/Farm-Data-Relay-System synced 2024-11-08 13:10:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Node.md

Browse Source
This commit is contained in:
Timm Bogner 2022-09-26 17:34:00 -05:00 committed by GitHub
parent ee9fe8ac2d
commit a137c63993
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
extras/Node.md
View File

@ -69,8 +69,12 @@ If enabled, device will enter deep-sleep when the sleepFDRS() command is used. I
### ```#define POWER_CTRL (pin)```
If defined, power control will bring a GPIO pin high when FDRS is initialized. This is useful for powering sensors while running on battery.
##The Callback
When incoming data arrives with an ID that the controller is subscribed to, the callback function is executed, interrupting all other tasks. Inside of this function, the user has access to the DataReading that has just arrived. This function should ONLY contain the code needed to save the data to a more permanent location. Any interpretation or display of the data should occur outside of the callback function. Intermediate users may also like to know that if the controller is subscribed to multiple IDs, the callback may be called multiple times before returning to the loop().
## Callback function
The callback function is executed when data arrives with an ID that the controller is subscribed to, interrupting all other tasks. Inside of this function, the user has access to the incoming DataReading.
This function should **ONLY** contain the code needed to save the data to a more permanent location. *Any interpretation or display of the data should occur outside of the callback function*.
Intermediate users may also like to know that if the controller is subscribed to multiple IDs, the callback may be called multiple times before returning to the loop().
## Type Definitions
For the moment, my thought is to reserve the first two bits of the type. I might use them in the future to indicate the data size or type (bool, char,  int, float, etc?). This leaves us with 64 possible type definitions. If you have more types to add, please get in touch!
@ -110,4 +114,4 @@ typedef struct __attribute__((packed)) DataReading {
  uint8_t t;
} DataReading;
```
Each node in the system sends its data inside of a structure called a DataReading. Its global sensor address is represented by an integer 'id', and each type of reading is represented by a single byte 't'.  If a sensor or gateway needs to send multiple DataReadings, then they are sent in an array. A single DataReading.id may have readings of multiple types ('t') associated with it.
Each node in the system sends its data inside of a structure called a DataReading. Its global sensor address is represented by an integer 'id', and each type of reading is represented by a single byte 't'.  If a sensor or gateway needs to send multiple DataReadings, then they are sent in an array. A single DataReading.id may have readings of multiple types ('t') associated with it.