mirror of
https://gitlab.com/wirelos/sprocket-lib.git
synced 2025-12-17 21:56:40 +01:00
move webserver stuff to plugin
This commit is contained in:
12
README.md
12
README.md
@@ -1,8 +1,12 @@
|
||||
# Sprocket-Core
|
||||
Library to build a mesh network of single purpose nodes.
|
||||
# Sprocket-Lib
|
||||
Library to build a mesh network of Sprockets.
|
||||
|
||||
## Lifecycle
|
||||
TODO docs
|
||||
sprocket.init -> Serial.begin & SPIFFS.begin
|
||||
sprocket.join(network) -> network.init & sprocket.activate -> plugins.activate
|
||||
network->onReceive -> sprocket.dispatch -> plugins.onMessage &sprocket.onMessage
|
||||
|
||||
## WTF is a sprocket?
|
||||
A sprocket is a device that has a single purpose, for example a PIR sensor node that notifies other nodes if there is motion or an LED node that lights up when a message is received.
|
||||
|
||||
# Useful commands
|
||||
```sh
|
||||
|
||||
Reference in New Issue
Block a user