class

PlaceOS::Client::APIWrapper::Modules

Inherits PlaceOS::Client::APIWrapper::Endpoint::Destroy < PlaceOS::Client::APIWrapper::Endpoint::Fetch < PlaceOS::Client::APIWrapper::Endpoint < Reference < Object

Instance methods

base

The base route for the endpoint

Source
create(driver_id : String, control_system_id : String | Nil = nil, ip : String | Nil = nil, udp : Bool | Nil = nil, port : Int | Nil = nil, makebreak : Bool | Nil = nil, uri : String | Nil = nil, custom_name : String | Nil = nil, settings : Settings | Nil = nil, notes : String | Nil = nil, ignore_connected : Bool | Nil = nil, ignore_startstop : Bool | Nil = nil)

Creates a new module.

Source
ping(id : String)

Performs a connectivity check with the associated device or service.

Source
search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, control_system_id : String | Nil = nil, driver_id : String | Nil = nil)

List or search for modules.

Results maybe filtered by specifying a query - q - to search across module attributes. A small query language is supported within this:

OperatorAction
+Matches both terms
``
-Negates a single token
"Wraps tokens to form a phrase
( )Provides precedence
~NSpecifies edit distance (fuzziness) after a word
~NSpecifies slop amount (deviation) after a phrase

Up to limit systems will be returned, with a paging based on offset.

Results my also also be limited to those associated with a specific system_id, that are instances of a driver_id, or any combination of these.

Source
start(id : String)

Starts a module.

Source
state(id : String, lookup : String | Nil = nil)

Queries the state exposed by a module.

Source
stop(id : String)

Stops a module.

Source
update(id : String, control_system_id : String | Nil = nil, ip : String | Nil = nil, udp : Bool | Nil = nil, port : Int | Nil = nil, makebreak : Bool | Nil = nil, uri : String | Nil = nil, custom_name : String | Nil = nil, settings : Settings | Nil = nil, notes : String | Nil = nil, ignore_connected : Bool | Nil = nil, ignore_startstop : Bool | Nil = nil)

Updates module attributes or configuration.

Source