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

Working with Data in the Cloud

A key aspect of Octave is the ability to write cloud-side logic, and this is done by implementing a Cloud Action.

A Cloud Action transforms Events and routes them between Streams or to your own cloud endpoint. Transformations are done via JavaScript that you embed your Cloud Actions.

Cloud Actions work similarly to Edge Actions, in that their logic exists as JavaScript functions, but the "trigger" is an Event being created in a Cloud Stream. The underlying Stream source for a Cloud Action can be a "single Stream" (i.e., from a device or manually created), or a Tag + a stream name. The latter is used for processing data from multiple tagged devices in the same fashion, and is a key way to aggregate device data before sending it to a third-party cloud service.

Just as an Edge Action can read data from the Resources in the edge context, Cloud Actions can read, process, and write data in the cloud context. In the cloud, they have access to read and write data from other Streams as well as the ability to publish or consume data from external services using REST requests (i.e., making HTTP GET/POST requests to read/write using third-party APIs).

A Cloud Action can return events to a static Stream (e.g., to track the status of a process) or to a dynamically-generated Stream (typically a specific device command Stream to send data to a given device).

The following topics describe how to manage, transform, and work with data from an Octave Edge Device in the cloud:

  1. Creating a Cloud Action: write cloud-side logic to handle Events.
  2. Adding a new Stream: create a stream to store data on the cloud side.
  3. Setting a Value From a Cloud Action: set the value on an Octave edge device from the cloud.
  4. Simple Forwarding: forward/create events in another Stream.
  5. Transforming Events: create a new Event using the data from an existing Event.
  6. Using Events from Other Streams: methods to find information about one or more events.
  7. Aggregating Events with Tag Actions: use the same Cloud Action logic on a given stream across multiple Octave edge devices.
  8. Cloud Initiated Streams: sending new Events in Streams from the cloud.

Updated 5 days ago

Working with Data in the Cloud


Suggested Edits are limited on API Reference Pages

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