You can use the FireBoard REST API to access information from the FireBoard Cloud, including devices, sessions, and temperature channels. Requests are in JSON format and require a token authentication method.
The FireBoard utilizes a Bluetooth 4.0 (Bluetooth Low Energy) Profile to communicate between the mobile app and the FireBoard. With a BLE connection, the pairing process of entering a password is no longer needed. The mobile app will automatically scan and find FireBoard devices via BLE. FireBoard App & Cloud FAQ. Check out our How To: The FireBoard App playlist on our YouTube channel for helpful videos! Why won’t the app send me alerts and notifications? To receive Email/SMS notifications, make sure you have an active email and/or phone number defined in your account settings. Add to Wishlist FireBoard® is a Cloud Connected Smart Thermometer, designed for remote monitoring in both hot and cold environments. Easy to setup and install on your wireless network, the. The FireBoard utilizes a Bluetooth 4.0 (Bluetooth Low Energy) Profile to communicate between the mobile app and the FireBoard. With a BLE connection, the pairing process where you entered a passcode is not needed anymore. The FireBoard App will automatically scan and find FireBoard devices via BLE. How to create and run Drive Programs through the FireBoard App. Additional information on our Knowledge Base: https://docs.fireboard.io/drive/programs.html0.
The current FireBoard REST API version is v1.
Requirements
To use the FireBoard REST API, you must have a FireBoard account.
Authentication
The FireBoard REST API uses a simple token-based HTTP Authentication scheme. The unique account token can be retrieved through the login endpoint.
Sample response:
Retrieve Authentication Token
POST https://fireboard.io/api/rest-auth/login/
JSON Request Parameters
| Parameter | Description |
|---|---|
| username | Your fireboard.io username or email address required |
| password | Your fireboard.io account password required |
Using the Authentication Token
The FireBoard API expects the authentication token to be included in the Authorization HTTP header for all request. The key should be prefixed by the string literal “Token”, with whitespace separating the two strings. For example:
Authorization: Token 9944bb9966cc22cc9418ad846dd0e4bbdfc6ee4b
Device API
The device API allows you to retrieve information about any FireBoard in the authenticated account.
Device properties
| Attribute | Type | Description |
|---|---|---|
| id | integer | Unique identifier resource. |
| UUID | string | Alternative unique identifier resource. |
| title | string | The name of the FireBoard. |
| created | date-time | The date the FireBoard was added to the account. |
| hardware_id | string | The serial number of the FireBoard. |
| latest_temps | array | An array of the latest temperature readings from this FireBoard. Temperature readings older than 60 seconds are not included. |
| device_log | object | Most recent log information from the FireBoard. |
| channels | array | An array representing each channel/port on the FireBoard. Channels include labels, alert values, and notification settings. |
| last_templog | date-time | The date of the last known temperature recorded by this FireBoard. |
List All Devices
The Devices endpoint allows you to view all FireBoards in your account.
GET https://fireboard.io/api/v1/devices.json
Retrieve a Specific Device
Retrieve detailed information about a specific device by referencing the Device’s UUID.
GET https://fireboard.io/api/v1/devices/<UUID>.json
Get Real-Time Temperature From the Device
Get the latest temperature values per channel from the device using the Temps endpoint. Temperature values are included if they are less than a minute old, otherwise nothing is returned for the channel.
GET https://fireboard.io/api/v1/devices/<UUID>/temps.json
Get Real-Time Drive data From the Device
Fireboard App
Get the latest FireBoard Drive log information for your device using the Drivelog endpoint. Drive log information is returned if less than a minute old.
GET https://fireboard.io/api/v1/devices/<UUID>/drivelog.json
Session API
The session API allows you to retrieve information about any current or historical session in the authenticated account.
Session Properties
| Attribute | Type | Description |
|---|---|---|
| id | integer | Unique identifier resource. |
| title | string | The name of the session. |
| duration | string | String representation of the total duration of this session (e.g. 5 hours, 30 minutes). |
| created | date-time | The date the session was created in the FireBoard Cloud. |
| start_time | date-time | The configurable start time for the session. |
| start_time | date-time | The configurable end time for the session. |
| description | string | A string contained notes entered by the user pertaining to the session. |
| owner | object | An object representation of the owner’s account information. |
| devices | array | An array of FireBoard devices that were used during the session. |
List All Sessions
The Sessions endpoint allows you to view all sessions in your account
GET https://fireboard.io/api/v1/sessions.json
Retrieve a Specific Session
Retrieve detailed information about a specific session by referencing the session’s id.
GET https://fireboard.io/api/v1/sessions/<id>.json
Retrieve Session Data for Charting
The Chart endpoint provides all temperature data from the session in a format suitable for many charting frameworks. The optional drive parameter can be used to include FireBoard Drive data in the output.
Fireboard App
| Parameter | Description |
|---|---|
| drive | Pass this parameter in the query string with a value of 1 to include Drive data from your session e.g ?drive=1optional |
GET https://fireboard.io/api/v1/sessions/<id>/chart.json
The chart data is an array of objects representing a specific channel on a specific device.
| Attribute | Type | Description |
|---|---|---|
| x | array | Array of unix timestamps |
| y | array | Array of temperature values or Drive % |
| degreetype | integer | Integer representing the degree type: 1=C°, 2=F° |
| device | string | The UUID identifier of the device |
| label | string | The configurable label of the channel |
Rate Limits
Users will be limited to 200 API calls per hour, if this rate limit is exceeded then user access will be blocked for 30 minutes.
Best Practices:
- When the time limit has been reached, stop making API calls. Continuing to make calls will continue to increase your call count, which will increase the time before calls will be successful again.
- Spread out queries evenly to avoid traffic spikes.
- Avoid calls that request overlapping data.
Limits subject to change at discretion of FireBoard