Note

You are viewing the legacy Cascade documentation, which only applies to some Rigado customers. To view the current Cascade documentation, click here.

3. Edge Connect Reference Docs

3.1. Overview

Rigado Edge Connect is an optimized BLE connectivity app that runs on a Rigado Gateway. Edge Connect scans for BLE data and makes it available to BLE Pipelines. This is achieved with filters and pipelines via Configuration.

Edge Connect also provides an API, only accessible from other applications running on the Gateway. This API can be used to get health and metrics about BLE, or to reprogram the Firmware.

3.2. Configuration

Note

The documentation here exists as a supplement to that found in Edge Connect Configuration.

Configuration information is provided in a JSON file, which can be input into either the rigado gateway configure CLI command (docs) or to the /v1/gateways/{serial}/configure API endpoint (docs).

The format of the JSON blob should be

{
   "apps": {
      "rigado-edge-connect": {
         "values": <<EdgeConnectConfiguration>>
      }
   }
}

where <<EdgeConnectConfiguration>> is a payload like the ones in Example Configurations.

Important

A Gateway must be online to receive configuration commands. A configuration command—and its payload—will only be sent to a Gateway once. If the Gateway is offline, it will not receive the new configuration.

3.3. API Reference

Specification for the Rigado Edge Connect API is here: https://docs.rigado.com/projects/edge-connect-api/en/latest/

Note

You are viewing the legacy Cascade documentation, which only applies to some Rigado customers. To view the current Cascade documentation, click here.