Skip to content
This repository was archived by the owner on Jun 29, 2023. It is now read-only.

Node manifest

Chris Grimmett edited this page Feb 18, 2016 · 6 revisions

When a D3vice node starts, it must connect to the game server and submit it's hardware features. This way, the gameserver maintains hardare inventory, and is able to display to the field admin the available game input/output features.

The node must also submit to the gameserver a unique ID. The gameserver then stores this game ID and can later use the ID to specify that the specific device should fulfil some role.

Manifest example

The manifest is simply JSON sent within a POST request.

{
  "meta": {
    "version": 1
  },
  "nodeID": "29834afe83",
  "defaultProfile": "sector",
  "hardware": [
    {"type": "button", "name": "green button", "gpio": 3},
    {"type": "button", "name": "red button", "gpio": 5},
    {"type": "neopixel", "name": "neopixel display", "gpio": 8}
  ]
}

Clone this wiki locally