REST API

PUT /api/v1/enabled_apps/{version_id}/{resource}

Set the configuration json for an app. Body of request should contain the json

Parameters:
  • version_id (string) – Version ID of the app or the word current

  • resource (string) – Only config may be written

Status Codes:
GET /api/v1/enabled_apps/{version_id}/{resource}

Get a resource from an enabled app

Parameters:
  • version_id (string) – Version ID of the app or the word current

  • resource (string) – One of info, config, user_guide

Status Codes:
POST /api/v1/enabled_apps/{version_id}

start or stop an app

Parameters:
  • version_id (string) – The version ID of the app or the word current

Status Codes:
GET /api/v1/enabled_apps

returns a list of enabled apps

Status Codes:
  • 200 OK – list of enabled apps

PUT /api/v1/nodes/connected/feedbacks/{fb_index}/vibrate

Send an on/off signal to a wireless feedback node

Parameters:
  • fb_index (integer) – Index of feedback node (0-based indexing)

Query Parameters:
  • time (number) – duration of feedback in seconds (Required)

  • event (string) – on or off signal to node (Required)

Status Codes:
GET /api/v1/installed_apps/{version_id}/{resource}
Parameters:
  • version_id (string) – Version ID of the app

  • resource (string) – Either info or user_guide

Status Codes:
PUT /api/v1/nodes/connected/{node_type}/{node_index}/led

Control the LED on a wireless sensor or feedback node

Parameters:
  • node_type (string) – Either feedbacks or sensors

  • node_index (integer) – Node index (0-based indexing)

Query Parameters:
  • event (string) – Either on or off (Required)

Status Codes:
GET /api/v1/nodes/available

Return a list of available nodes in range.

Status Codes:
  • 200 OK – List of accessable nodes

  • 400 Bad Request – Unexpected response from system

  • 480 – Inquiry timeout was reached

PUT /api/v1/nodes/connected

Wirelessly connect to specified nodes

Status Codes:
  • 200 OK – Connection succeeded

GET /api/v1/system_status
Status Codes:
  • 200 OK – The system status json

PUT /api/v1/remote_install

This API endpoint is used to install a list of app repositories.

Query Parameters:
  • version_id (string) – Your personal GitHub token to download a private repository.

  • repos (array) – List of all remote repositories that you would like to install. (Required)

Status Codes: