The Octave Developer Hub

Welcome to the Octave developer hub. You'll find comprehensive guides and documentation to help you start working with Octave as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Adding and Removing Devices

Adding an Octave Edge Device to Your Deployment

Follow the steps below to add an Octave edge device to your Octave deployment:

  1. Access the Activate a Device screen using one of the following methods:
  • Navigate to Build > Device > Details, click on the Device dropdown, and click Add Device:
  • Navigate to Deploy & Monitor > Devices and click Add Device:
  1. Follow the steps on the Activate a Device screen:

Add Multiple Devices to Your Deployment in Bulk

Follow the steps below to add multiple Octave edge devices to your Octave deployment in bulk:

  1. Navigate to Deploy & Monitor > Devices, click the dropdown beside Add Device, and select Import devices:
  1. Perform one of the following steps:
  • Manually enter the information for each device and click Import:
  • Drag or click to upload a CSV file containing the information for up to 500 devices to import and then click Import:

The CSV file must be formatted as shown in the following example:

IMEI

FSN

NAME

DISPLAY_NAME

BLUEPRINT_ID

BLUEPRINT_VERSION

DEPLOY_FIRMWARE

TAG. (multiple unique allowed)

METADATA. (multiple unique allowed)

321873090217545

VU810385211123

asset_1

mangOH_Red1

b5c12379220721249d5c8ffa3

5

true

(column name: TAGS.location
(field value: nyc)

(column name: METADATA.foo.bar)
(field value: "[ ""hello"", ""world"" ]")

The following table describes each column in the CSV file:

Column Name

Type

Required

Unique Value Required

Description

IMEI

String

Yes

Yes

The IMEI of the device in IMEI Standard Format.

Note: The IMEI and FSN together must form a unique pair of values that don't already existing in the deployment.

FSN

String

Yes

Yes

The device's serial number.

The value must consist of 6 to 20 upper-case characters.

Note: The IMEI and FSN together must form a unique pair of values that don't already existing in the deployment.

NAME

String

Yes

Yes

The name of the device. The name must be lowercase and contain only alphanumerical chars and underscores.

DISPLAY_NAME

String

No

Yes

The display name for the device.

BLUEPRINT_ID

String

No

No

The ID of a Blueprint to apply, if present.

BLUEPRINT_VERSION

Integer

No

No

The version of the Blueprint identified by BLUEPRINT_ID.

If a BLUEPRINT_ID is specified but BLUEPRINT_VERSION, is absent, Octave will use the latest version.

DEPLOY_FIRMWARE

Bool

No

No

If true, Octave will perform a FOTA of any firmware attached to the Blueprint. The default is true.

TAG. (multiple unique allowed)

String

No

No

Defines a Tag for the device. Multiple unique values are allowed.

METADATA. (multiple unique allowed)

String

No

No

Defines metadata for the device.

📘

Notes

Octave allows you to display certain devices in your deployment on the import screen which can be useful when putting together the list of devices to import and avoids the need to return to the main device listing screen:

  • Use the filter field near the top-right corner of the screen to display all existing devices in the deployment which have a name containing the value entered in the filter field.
  • Enable Only devices with errors to show all devices in the deployment which have some sort of error (e.g., inconsistent format, duplicate names, etc…).

Remove an Octave Edge Device from Your Deployment

Follow the steps below to remove an Octave edge device to your Octave deployment:

  1. Navigate to Build > Device > Details.
  2. Select the device to delete from the Device dropdown.
  3. Click on the gateway icon to display a dropdown showing the device's properties.
  4. Click Remove device.

📘

Note

After removing a device you can always add the device back in.

Adding and Removing Devices Programmatically

You can use the following endpoints from Octave's REST API to programmatically add and remove devices:

Updated about 3 hours ago

Adding and Removing Devices


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.