Skip to content

Latest commit

 

History

History
56 lines (32 loc) · 2.11 KB

RESERVED_KEYS.md

File metadata and controls

56 lines (32 loc) · 2.11 KB
Raw

Reserved Keys

PAY ATTENTION: NOT EVERYTHING DESCRIBED BELLOW IN THIS PARAGRAPH IS YET AVAILABLE

Arancino Library uses some reserved keys to store environmental data into Redis. Values stored in those keys can be used for multiple scopes in user space. By default the Arancino Library uses those reserved keys to communicate in a synchronous way but it can do also in an asynchronous way.

Following the list of reserved keys:

Reserved Key/Channel Version Description
___MONITOR___ >=v0.1.0 Used by print and println API
___MODVERS___ * Used to get the running version number of the Arancino Daemon
___MODLOGLVL___ >=v2.0.0 Actual Log level of the Arancino Deamon
___MODENV___ >=2.0.0. Used to get the running environment of Arancino Daemon
___BLINK_ID___ >=v2.0.0 Used by DeviceIdentification of ArancinoTasks for identify the microcontroller

It is not possible to access directly data stored at Reserved Keys. There are generic private encapsulators (getReserved, setReserved) only used by the library itself to get and set values. But there are specific method for some Reserved Keys that can be used to retrieve Reserved Keys values in the user space:

  • getModuleVersion()
  • getModuleLogLevel()
  • getModuleEnvironment()

see API chapter for more details

To access data stored at reserved keys you have to use the Redis get command for Sync mode and Redis Subscribe for Asynch mode (in Async mode the key name represents the channel name).

By default the Arancino Library uses the Sync mode, but you can change it to work in Async mode or Both (Sync and Async at the same time). To do that you have to define a variable called RSVD_COMM at the beginning of your program, with three possible values:

  • 0 → Sync
  • 1 → Async
  • 2 → Both

Example:

#include <Arancino.h>

void setup() {
  Arancino.begin();
  Arancino.setReservedCommunicationMode(BOTH);
}

void loop() {
  //do something
}