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

Managing Resources via the Octave Dashboard

This topic describes how to work with Resources via the Resources screen in the Octave dashboard.

The Resources screen on the Octave Dashboard user interface (accessible by navigating to Device > Resources) allows you to view and manage the Resources on your device.

Notable User Interface Elements

The following screenshot shows some key user interface elements on the Resources screen that help you to manage your Resources:

  1. The period property indicates how often (in seconds) to read a sensor and update the Data Hub.
  2. The trigger specifies when to make a measurement outside of the periodic reading defined in (1).
  3. "M" indicates that the property can be manually set.
  4. The edit icon allows you to temporarily change a value via the command button.
  5. The eye icon with indicates if there are one or more Observations on the device to monitor that Resource. If a number appears to the left of the icon, it indicates the total number of existing Observations for that Resource. You can click the icon to add another Observation for that Resource.
  6. The Report Date indicates how long ago the device reported a value to the cloud for that Resource.
  7. The checkmark indicates that a value has been set for the Resource. Clearing the checkmark will clear the value. Note that you will then need to click Apply to commit the clearing of the value.

📘

Notes

  • The Resource screen is not updated in real time.
  • In Developer Mode, values for all Resources are updated every minute.
  • In normal (non-developer mode), only Resources with Observations will be updated.
  • When using Blueprints, all devices will end up with same configured default values for their Resources at startup.

Identifying an Element as a Resource or a Property

With all of the elements shown on the Resources screen, it can sometimes be difficult to quickly distinguish which elements represent Resources and which elements represent properties of Resources. Below are two quick tips to help you make this distinction.

A Parent Element Is a Resource if it's an Object

If a parent in the hierarchy is an object, then it is a Resource and the child element is a property. For example, in the following image, a is a property of a Resource named value (its full path is /virtual/a_resource/value):

A Property Doesn't Have a Send Command

If an element is a property, then no Send button/icon will be displayed for that element, since commands can only be sent for Resources. The following example highlights the lack of a send button for the a property:

Filtering Resources

The search field on the Resources screen, allows you to filter the list of Resources shown:

In the screenshot above, gpio was entered to filter the list to show all Resource tree items representing GPIO entries. The filter can also be used to find all tree items with a given property. For example, entering enable will filter the list to show all tree entries that have the property enable.

Setting a Resource's Value

There are a number of options for changing the values of Resources, both temporarily and permanently (i.e., modifying the default device configuration values), as described in Controlling Device Properties.

Updated 10 days ago

Managing Resources via the Octave Dashboard


This topic describes how to work with Resources via the Resources screen in the Octave dashboard.

Suggested Edits are limited on API Reference Pages

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