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

Introduction to Octave Design Patterns

Through implementing Octave for different use cases, we've captured some recurring patterns for efficient designs, that you may wish to use in your Octave implementations. These Octave Design Patterns are detailed in the following use-case topics:

👍

Abbreviations used in these sections:

CA: Cloud Action
EA: Edge Action
CS: Cloud Stream
S&F: Store and Forward
ST: Storage
VR: Virtual Resource

Recommended steps in designing your Octave solution

We recommend you to follow three main steps:

Define how you will interface your Asset with the Octave Edge device:

  • GPIOs,
  • Modbus,
  • USP,
  • ORP, ...

Define your Edge side architecture and configuration based on:

  • Periodicity of measure acquisitions
  • Edge side processing logic and Edge side required states (Virtual Resources)
  • Periodicity of data reporting to the Cloud (Define Observations, Store and Forward, Edge Actions output)

Define Cloud side integrations:

  • Edge to Cloud Stream structure
  • Cloud Actions / Connectors / Tasks
  • Calls from your cloud to Octave API

Updated 29 days ago

Introduction to Octave Design Patterns


Suggested Edits are limited on API Reference Pages

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