Echolo

The Echolo Developer Hub

Welcome to the Echolo developer hub. You'll find comprehensive guides and documentation to help you start working with Echolo's IoT Platform as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Shared Topics

Shared Topics are write-only, meaning no one can subscribe and read from this topic. Often times the shared topics are used for Echolo IoT Platform proposes only.

Topic Path
Description
Packet Format

share/hub/bt/scans

Used for Bluetooth Low Energy scans.

share/hub/lora/scans

Used for LoRa scans.

share/hub/rf/scans

Used for RF wireless scan data.

Hub Topics

Each Hub has its own private topic that only the appId Application owner can read and write too. Please also review the Hub Double Automatic Updates, they are closely tied to the hub topic when updated.

Topic Path
Premissions
Packet Format

hub/:appId/:hubId

Read / Write - By owner only

Any*

hub/double/:appId/:hubId

Read / Write - By owner only

Any*

*If your Hub was provisioned by Echolo please see the Provisioning Service section to view other available services.

Quick Example

Given the following information; my appId is abc12345600 and I created a hub with the hubId of echolo-hub-01.

Hub Topic Path: hub/abc12345600/echolo-hub-01

User Topics

User Topics are created via the REST API Topic. Users are allowed to create a Topic with any URL safe name, on creation the Application automatically has both publish and subscribe permissions. Any authenticated Hub can both read and write to that newly created topic. The topic path always starts with user and also includes appId then followed by the name of the topic.

Topic API Endpoints

Review the REST API Topic endpoints.

Topic Path
Premissions
Packet Format

user/:appId/:name

Read / Write - By appId Only

Any

Quick Example

Given the following information; my appId is abc12345600 and I created a new topic with the name of my-topic.

User Topic Path: user/abc12345600/my-topic


Topics


Suggested Edits are limited on API Reference Pages

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