resin.io dependent device edge-node-manager written in Go.
- Sign up on resin.io
- Work through the getting started guide
- Create a new application
- Set these variables in the
Fleet Configurationapplication side tabRESIN_SUPERVISOR_DELTA=1RESIN_UI_ENABLE_DEPENDENT_APPLICATIONS=1
- Clone this repository to your local workspace
- Add the dependent application
resin remoteto your local workspace - Provision a gateway device
- Push code to resin as normal :)
- Follow the readme of the supported dependent device you would like to use
More info about environment variables can be found in the documentation. If you don't set environment variables the default will be used.
| Environment Variable | Default | Description |
|---|---|---|
| ENM_LOG_LEVEL | info |
the edge-node-manager log level |
| DEPENDENT_LOG_LEVEL | info |
the dependent device log level |
| ENM_SUPERVISOR_CHECK_DELAY | 1 |
the time delay in seconds between each supervisor check at startup |
| ENM_HOTSPOT_DELETE_DELAY | 10 |
the time delay in seconds between hotspot deletion and creation |
| ENM_CONFIG_LOOP_DELAY | 10 |
the time delay in seconds between each application process loop |
| ENM_CONFIG_PAUSE_DELAY | 10 |
the time delay in seconds between each pause check |
| ENM_HOTSPOT_SSID | resin-hotspot |
the SSID used for the hotspot |
| ENM_HOTSPOT_PASSWORD | resin-hotspot |
the password used for the hotspot |
| ENM_BLUETOOTH_SHORT_TIMEOUT | 1 |
the timeout in seconds for instantaneous bluetooth operations |
| ENM_BLUETOOTH_LONG_TIMEOUT | 10 |
the timeout in seconds for long running bluetooth operations |
| ENM_AVAHI_TIMEOUT | 10 |
the timeout in seconds for Avahi scan operations |
| ENM_UPDATE_RETRIES | 1 |
the number of times the firmware update process should be retried |
| ENM_ASSETS_DIRECTORY | /data/assets |
the root directory used to store the dependent device firmware |
| ENM_DB_DIRECTORY | /data/database |
the root directory used to store the database |
| ENM_DB_FILE | enm.db |
the database file name |
| ENM_API_VERSION | v1 |
the proxyvisor API version |
| RESIN_SUPERVISOR_ADDRESS | http://127.0.0.1:4000 |
the address used to communicate with the proxyvisor |
| RESIN_SUPERVISOR_API_KEY | na |
the api key used to communicate with the proxyvisor |
| ENM_LOCK_FILE_LOCATION | /tmp/resin/resin-updates.lock |
the lock file location |
The edge-node-manager provides an API that allows the user to set the target status of the main process. This is useful to free up the on-board radios allowing user code to interact directly with the dependent devices e.g. to collect sensor data.
Warning - Do not try and interact with the on-board radios whilst the edge-node-manager is running (this leads to inconsistent, unexpected behaviour).
Set the edge-node-manager process status.
curl -i -H "Content-Type: application/json" -X PUT --data \
'{"targetStatus":"Paused"}' localhost:1337/v1/enm/status
curl -i -H "Content-Type: application/json" -X PUT --data \
'{"targetStatus":"Running"}' localhost:1337/v1/enm/status
HTTP/1.1 200 OK
Get the edge-node-manager process status.
curl -i -X GET localhost:1337/v1/enm/status
HTTP/1.1 200 OK
{
"currentStatus":"Running",
"targetStatus":"Paused",
}
Get all dependent devices.
curl -i -X GET localhost:1337/v1/devices
HTTP/1.1 200 OK
[{
"ApplicationUUID": 511898,
"BoardType": "esp8266",
"Name": "holy-sunset",
"LocalUUID": "1265892",
"ResinUUID": "64a1ae375b213d7e5af8409da3ad63108df4c8462089a05aa9af358c3f0df1",
"Commit": "16b5cd4df8085d2872a6f6fc0c378629a185d78b",
"TargetCommit": "16b5cd4df8085d2872a6f6fc0c378629a185d78b",
"Status": "Idle",
"Config": null,
"TargetConfig": {
"RESIN_HOST_TYPE": "esp8266",
"RESIN_SUPERVISOR_DELTA": "1"
},
"Environment": null,
"TargetEnvironment": {},
"RestartFlag": false,
"DeleteFlag": false
}]
Get a dependent device.
curl -i -X GET localhost:1337/v1/devices/1265892
HTTP/1.1 200 OK
{
"ApplicationUUID": 511898,
"BoardType": "esp8266",
"Name": "holy-sunset",
"LocalUUID": "1265892",
"ResinUUID": "64a1ae375b213d7e5af8409da3ad63108df4c8462089a05aa9af358c3f0df1",
"Commit": "16b5cd4df8085d2872a6f6fc0c378629a185d78b",
"TargetCommit": "16b5cd4df8085d2872a6f6fc0c378629a185d78b",
"Status": "Idle",
"Config": null,
"TargetConfig": {
"RESIN_HOST_TYPE": "esp8266",
"RESIN_SUPERVISOR_DELTA": "1"
},
"Environment": null,
"TargetEnvironment": {},
"RestartFlag": false,
"DeleteFlag": false
}
The edge-node-manager is an example of a gateway application designed to bridge the gap between Resin OS capable single board computers (e.g. the Raspberry Pi) and non Resin OS capable devices (e.g. micro-controllers). It has been designed to make it as easy as possible to add new supported dependent device types and to run alongside your user application.
The following functionality is implemented:
- Dependent device detection
- Dependent device provisioning
- Dependent device restart
- Dependent device over-the-air (OTA) updating
- Dependent device logging and information updating
- API
A dependent application is a Resin application that targets devices not capable of interacting directly with the Resin API.
The dependent application is scoped under a Resin application, which gets the definition of gateway application.
A dependent application follows the same development cycle as a conventional Resin application:
- It binds to your git workspace via the
resin remote - It consists of a Docker application
- It offers the same environment and configuration variables management
There are some key differences:
- It does not support Dockerfile templating
- The Dockerfile must target an x86 base image
- The actual firmware must be stored in the
/assetsfolder within the built docker image
A dependent device is a device not capable of interacting directly with the Resin API - the reasons can be several, the most common are:
- No direct Internet capabilities
- Not able to run the Resin OS (being a microcontroller, for example)
The gateway application is responsible for detecting, provisioning and managing dependent devices belonging to one of its dependent applications. This is possible leveraging a new set of endpoints exposed by the Resin Supervisor.
The edge-node-manager (this repository) is an example of a gateway application.
The gateway device runs the gateway application and has the needed on-board radios to communicate with the managed dependent devices, for example:
- Bluetooth
- WiFi
- LoRa
- ZigBee
Throughout development a Raspberry Pi 3 has been used as the gateway device.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent