Commanding Connectivity Modules
You can instruct your devices to run certain preconfigured functions
You can send commands to Connectivity Modules to perform certain actions. Some commands like Restart, Ping are valid across all Connectivity modules, and some commands are only applicable to certain Connectivity Modules and applications running on them.
You will always use physical-devices
endpoint to send these instructions to Connectivity Modules so you need to retrieve corresponding id_physical_device
using Physical device endpoint.
List of Standard commands
The following standard commands below works with corresponding Connectivity Modules regardless of the application it is running.
Endpoint Name | Description | Modules |
---|---|---|
| It will ping the Connectivity Module | GO/CORE/PLUS |
| Restarts Connectivity Module | GO/CORE/PLUS |
| Provides a list of information about the module | GO/CORE/PLUS |
| Forces Module to request measurement from all assets connected to it | GO/CORE/PLUS |
| Scan, connect or disconnect from a WiFi Access point | PLUS/CORE |
Ping IoT connectivity module
GET
https://dashboard.bace-iot.com/api/v2/physical-device/{id}/ping
Pinging IoT connectivity module will tell if it is online or offline
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | Gateway's id_physical_device |
Restart IoT connectivity module
POST
https://dashboard.bace-iot.com/api/v2/physical-device/{id}/restart
Sends a command to restart IoT connectivity module
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | Gateway's id_physical_device |
Performs Self-test for IoT connectivity module
GET
https://dashboard.bace-iot.com/api/v2/physical-device/{id}/status
Sends a command to perform self-test for IoT connectivity module. Response could help support troubleshooting connectivity related problems.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | Gateway's id_physical_device |
Request measurement from connected assets
PUT
https://dashboard.bace-iot.com/api/v2/physical-device/{id}/request-measurement
Instructs IoT connectivity module to request the latest measurements from all connected assets or sensors.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | Gateway's id_physical_device |
Scan nearby WiFi Access Points
GET
https://dashboard.bace-iot.com/api/v2/physical-device/{id}/wifi
WiFi endpoint is used for retrieving nearby WiFi Access points.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | Gateway's id_physical_device |
Connect to a WiFi Access Point
PUT
https://dashboard.bace-iot.com/api/v2/physical-device/{id}/wifi
WiFi endpoint is used for connecting to nearby WiFi Access point.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | Gateway's id_physical_device |
Request Body
Name | Type | Description |
---|---|---|
ssid* | string | name of the ssid |
password | string | test |
Disconnects from the current WiFi Access Point
DELETE
https://dashboard.bace-iot.com/api/v2/physical-device/{id}/wifi
Delete method will disconnect gateway from the WiFi Access point
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | Gateway's id_physical_device |
List of Application Specific Commands
For some projects, a project specific application is developed to control connected assets in a certain way. Some examples of these types of Application Specific Commands are:
Instructing Connectivity Module to run a measurement routine, do some math calculations and control relays connected to it.
Send counter reset command to a flow meter connected to Connectivity module via RS232.
Reset main counter
PUT
https://dashboard.bace-iot.com/api/v2/physical-device/:id/reset-main-counter
Command used to restart flow meter main counter
Reset daily counter
PUT
https://dashboard.bace-iot.com/api/v2/physical-device/:id/reset-daily-counter
Command used to restart flow meter daily counter
Last updated