Jump to Content
OctaveGuidesAPI ReferenceForum
HomeGuides
GuidesAPI ReferenceForumLoginOctave
Guides
Login
Cloud API Reference

Octave Overview

  • Introducing Octave
    • Key Components
    • Key Concepts
    • High-Level Data Flow
    • Supported browsers
    • Pricing Model
  • Getting started
    • Octave Edge Devices
    • Getting Started with the mangOH Red
    • Getting Started with the FX30
    • Getting Started with the mangOH Yellow

Connect to your Asset

  • Introduction to Edge Services
  • General Purpose Input/Output (GPIO)
    • mangOH Red Digital Outputs
    • mangOH Red Digital Inputs
    • IoT Expansion Cards Digital Outputs
    • IoT Expansion Cards Digital Inputs
    • FX30 Digitial Outputs
    • FX30 Digital Inputs
  • Analog to Digital Converter Inputs (ADC)
    • Physically Connecting Digital Output to an IoT Expansion Breadboard
  • Octave Resource Protocol Guides
  • Modbus Guides
  • CANopen Guides
  • Universal Serial Parser (USP) Guide
    • Universal Serial Parser (USP) - How-to with USB to UART

Control Your Device Dataflows

  • Introduction
  • Configuring Resources and Sensors to Emit Events
    • Sensors
    • Inputs
    • Virtual Resources
    • Utilitary (/util/...) resources
  • Commanding Actuators
    • Setting a Value Via the User Interface
    • Setting a Value From a Cloud Action
    • Setting a Value From an Edge Action
    • Setting a Value From an Observation
    • Setting a Value From a REST API Call
  • Observations: Filter & Process Events
    • Buffering Data
    • Filtering Emitted Events by Rules
    • Applying Functions to Observation Buffers
    • Throttling
  • Observations: Route Events
    • Sending Events to the Cloud Immediately
    • Storing and Forwarding Events
    • Sending Events to an Edge Action
    • Sending Events to Another Resource
    • Storing Events
  • Edge Processing using JavaScript with the Action Runner
    • Basic Transformation and Analysis
    • Accessing Data from Other Resources

Orchestrate Data in the Cloud

  • Introduction
    • Cloud Action Overview
    • Adding a new Stream
    • Cloud Actions
    • Simple Forwarding
    • Transforming
    • Using Events from Other Streams
    • Aggregating Events with Tag Actions
  • Flowing Data Outside of Octave
    • Consuming Events via WebSocket
    • POSTing Data via Webhooks
    • Pushing Data from Octave to IoT Central
  • Flowing Data Into Octave
    • Using a Task to Periodically Pull in External Data
    • Issuing REST Requests from Within Cloud Actions
    • Using the REST API in an External System
    • Controlling GPIO as an Output and Controlling Values From the Cloud

Control your Device Communication

  • Introduction
  • Configuring and Understanding Heartbeat
  • Configuring and managing Store and Forward
  • Configuring Developer Mode
  • Controlling Ultra Low Power Mode
  • Initiating Communications from the Cloud
  • Configuring Connectivity Watchdog
  • Minimizing Messages

Upgrade your Device

  • Upgrade a FX30/FX30S with latest Firmware
  • Upgrade a mangOH red with latest Firmware
  • Upgrade a mangOH yellow with latest Firmware
  • Upgrade a WP7702 with latest Firmware
  • Upgrade a Device Over the Air

Manage Configuration on your Devices

  • Introduction
  • Organizing Devices with Tags
  • Creating and Managing Blueprints
  • Applying Blueprints

Monitor your Devices

  • Introduction
    • Modes
    • Filtering the Device List
  • Viewing Octave Activity
    • Filtering the Activity List
  • Monitoring Usage

Octave Reference implementations

  • Introduction
  • Telemetry, Edge Action and Command from the Cloud
  • Report multiple Resources independently to the Cloud
  • Synchronize & schedule Resource reporting with Store and Forward
  • Report multiple Resources in a single Event and Stream
  • Return updated device Cloud properties as Commands

Technical References

  • Edge
    • Resources
    • Observations
    • Edge Actions
    • Edge Action Runner Reference
    • Edge Services Architecture
    • Octave Resource Protocol
    • Octave Resource Protocol Software Tools
  • Device-to-Cloud Communications
    • HeartBeat
    • Cloud Initiated
    • Store and Forward Timer
  • Cloud Action Runner Reference
  • Cloud API Reference
  • Structure and Permissions

Cloud API Reference

Suggest Edits

You can access the Octave API reference guide at the following link:

Octave API reference

Object Reference

The following links take you to topics in the Octave API reference guide for commonly-used objects:

  1. Stream
  2. Event
  3. Device
  4. Local Action
  5. Cloud Action
  6. Group
  7. Token
  8. Share
  9. Identity
  10. Company
  11. Blueprint

Updated over 5 years ago


  • Table of Contents
    • Object Reference
© Sierra Wireless. All rights reserved.