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:
200 OK – Interaction success
400 Bad Request – Invalid parameter
- 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:
200 OK – The resource
400 Bad Request – Invalid parameter
- 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:
400 Bad Request – Invalid parameters
200 OK – App control request delivered
- 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:
200 OK – Signal delivered
404 Not Found – Invalid feedback node index
400 Bad Request – Invalid query parameter
- 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:
404 Not Found – No app found with this version ID
400 Bad Request – Invalid resource
200 OK – Resource
- 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:
404 Not Found – Invalid node index
400 Bad Request – Invalid event type
200 OK – LED control request delivered
- 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
- 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:
200 OK – Success. This will return a json list of each repository and the installation status.
405 Method Not Allowed – Bad Request
400 Bad Request – Invalid parameter