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:
Modules
Model
Attribute
Type
Description
id
string
A universally unique ID for this module.
dependency_id
string
ID of the driver that defines this module.
control_system_id
string
ID of the system this module is bound to (logic modules only).
edge_id
string
ID of the preferred engine node to run on.
ip
string
IP address or resolvable hostname of the device this module connects to.
tls
boolean
True if the device communicates securely.
udp
boolean
Protocol uses UDP rather that TCP.
port
integer
The TCP or UDP port that the associated device communicates on.
makebreak
boolean
If enabled, provides an ephemeral connection that disconnects during idle periods.
uri
string
The based URI of the remote service (service modules only).
custom_name
string
The modules class name (Display, Lighting etc) if it should differ from the default defined in the dependency.
settings
object
A JSON object containing module configuration.
updated_at
integer
Timestamp of last update.
created_at
integer
Timestamp of creation.
role
integer
The module type. One of:
0 ssh
1 device
2 service
3 logic
notes
string
Markdown formatted text that describes this module.
connected
boolean
Flag for connectivity state.
running
boolean
Module start/stop state.
ignore_connected
boolean
If enabled, system metrics ignore connectivity state.
ignore_startstop
boolean
If enabled, system level start and stop actions are ignored. This is recommended for modules shared by many systems (e.g. a lighting gateway).
get
https://example.com
/api/control/modules
Search
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.
​
( and )
Provide precedence.
​
~N
Specifies edit distance (fuzziness) after a word.
​
~N
Specifies slop amount (deviation) after a phrase.
​
Management
post
https://example.com
/api/control/modules
Create
get
https://example.com
/api/control/modules/{id}
Retrieve
put
https://example.com
/api/control/modules/{id}
Update
delete
https://example.com
/api/control/modules/{id}
Delete
Interaction
post
https://example.com
/api/control/modules/{id}/start
Start
post
https://example.com
/api/control/modules/{id}/stop
Stop
post
https://example.com
/api/control/modules/{id}/ping
Ping
get
https://example.com
/api/control/modules/{id}/state
State

Systems

Dependencies

Last modified 1yr ago

Copy link

Contents