Modules
The /modules endpoint provides creation, management and direct interaction with modules outside of a system context. For more information on the role that modules play, see:
Attribute | Type | Description |
id |
| A universally unique ID for this module. |
dependency_id |
| ID of the driver that defines this module. |
control_system_id |
| ID of the system this module is bound to (logic modules only). |
edge_id |
| ID of the preferred engine node to run on. |
ip |
| IP address or resolvable hostname of the device this module connects to. |
tls |
| True if the device communicates securely. |
udp |
| Protocol uses UDP rather that TCP. |
port |
| The TCP or UDP port that the associated device communicates on. |
makebreak |
| If enabled, provides an ephemeral connection that disconnects during idle periods. |
uri |
| The based URI of the remote service (service modules only). |
custom_name |
| The modules class name ( |
settings |
| A JSON object containing module configuration. |
updated_at |
| Timestamp of last update. |
created_at |
| Timestamp of creation. |
role |
| The module type. One of:
|
notes |
| Markdown formatted text that describes this module. |
connected |
| Flag for connectivity state. |
running |
| Module start/stop state. |
ignore_connected |
| If enabled, system metrics ignore connectivity state. |
ignore_startstop |
| If enabled, system level start and stop actions are ignored. This is recommended for modules shared by many systems (e.g. a lighting gateway). |
getSearch
{"total": 1,"results": [{"dependency_id": "dep-wJHShR4Ffa","control_system_id": null,"edge_id": "edge-E9vIruSZ","ip": "10.45.6.3","tls": false,"udp": false,"port": 8192,"makebreak": false,"uri": null,"custom_name": null,"settings": {},"updated_at": 1572412023,"created_at": 1572392714,"role": 1,"connected": true,"running": true,"notes": null,"ignore_connected": false,"ignore_startstop": false,"id": "mod-wJHYeHm6Yn"}]}
Queries default to searching for any of the entered terms (words). A small query language provides the ability to structure complex queries.
Operator | Action | ​ |
| Matches both terms. | ​ |
` | ` | Matches either terms. |
| Negates a single token. | ​ |
| Wraps tokens to form a phrase. | ​ |
| Provide precedence. | ​ |
| Specifies edit distance (fuzziness) after a word. | ​ |
| Specifies slop amount (deviation) after a phrase. | ​ |
postCreate
{"dependency_id": "dep-wJHShR4Ffa","control_system_id": null,"edge_id": "edge-E9vIruSZ","ip": "10.45.6.3","tls": false,"udp": false,"port": 8192,"makebreak": false,"uri": null,"custom_name": null,"settings": {},"updated_at": 1572412023,"created_at": 1572412023,"role": 1,"connected": true,"running": true,"notes": null,"ignore_connected": false,"ignore_startstop": false,"id": "mod-wJHYeHm6Yn"}
{"dependency_id": ["can't be blank"]}
getRetrieve
{"dependency_id": "dep-wJHShR4Ffa","control_system_id": null,"edge_id": "edge-E9vIruSZ","ip": "10.45.6.3","tls": false,"udp": false,"port": 8192,"makebreak": false,"uri": null,"custom_name": null,"settings": {},"updated_at": 1572412023,"created_at": 1572412023,"role": 1,"connected": true,"running": true,"notes": null,"ignore_connected": false,"ignore_startstop": false,"id": "mod-wJHYeHm6Yn"}
​
putUpdate
{"dependency_id": "dep-wJHShR4Ffa","control_system_id": null,"edge_id": "edge-E9vIruSZ","ip": "10.45.6.3","tls": false,"udp": false,"port": 8192,"makebreak": false,"uri": null,"custom_name": null,"settings": {},"updated_at": 1572412023,"created_at": 1572414543,"role": 1,"connected": true,"running": true,"notes": null,"ignore_connected": false,"ignore_startstop": false,"id": "mod-wJHYeHm6Yn"}
​
​
​
deleteDelete
​
​
​
postStart
​
​
​
​
postStop
​
​
​
postPing
{"host": "10.45.5.2","pingable": true,"warning": null,"exception": null}
​
getState
{"foo": "abc","bar": 42}
