Topics
Topics are used as communication pathways for the IoT Services. For example, hubs, devices, mobile applications, and even web applications use topics to communicate with hubs or devices on the network. Some topics are defined out of the box when you get a provisioned hub, or if you are creating your own, you will name the topic. Topics look a lot like URLs that are missing the domain name.
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 | Permissions | Packet Format |
---|---|---|
hub/:appId/:hubId | Read / Write - By owner only | |
hub/double/:appId/:hubId | Read / Write - By owner only | Any* |
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 Path | Permissions | 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