class

PlaceOS::APIWrapper

Inherits PlaceOS::API::Models < Reference < Object

Low-level wrapper for the PlaceOS API.

Each method maps one-to-one with an API endpoint. All invocations will either provide a type-safe response object, or raise an PlaceOS::API::Error.

It's possible to use this class directly if you require the extra flexibility, however in most cases the abstractions provided by the higher-level PlaceOS::Client may be the better choice.

Constructors

new(base_url)

Source

Instance methods

auth=(token_provider : OAuth2::AccessToken | OAuth2::Session)

Sets the authentication used by the API client.

All client instances must be authenticated prior to interaction with protected endpoints.

Source

authority

Gets the authority metadata for the attached instance.

Source

before_request(*args, **options)

Source

before_request(*args, **options, &)

Source

connect_timeout=(arg)

Source

count(id : String, mod : String)

Gets the number of mod instances available in system id.

Source

Creates a new module.

Source

Creates a new system.

Systems must be given a unique name within the PlaceOS instance they are running from. Additionally, a system must be a member of at least one zone. All other attributes are optional at the time of creation.

Source

create_zone(name : String, description : String | Nil = nil, tags : String | Nil = nil, settings : Settings | Nil = nil, triggers : Array(String) | Nil = nil)

Creates a new zone.

Source

delete_module(id : String)

Removes a module.

Source

delete_system(id : String)

Removes a system.

This will also stop, and remove any modules that do not belong to other systems.

Source

delete_zone(id : String)

Removes a zone.

Source

exec(id : String, mod : String, method : String, index : Int = 1, *args : Array(JSON::Any::Type))

Executes a behaviour exposed by a module within the passed system id.

Source

funcs(id : String, mod : String, index : Int = 1)

Queries the behaviour exposed by a module within system id.

Source

ping(id : String)

Performs a connectivity check with the associated device or service.

Source

read_timeout=(arg)

Source

retrieve_module(id : String)

Retrieves all metadata associated with a module.

Source

retrieve_system(id : String)

Retrieves all metadata associated with a system.

Source

retrieve_zone(id : String)

Retrieves all metadata associated with a zone.

Source

search_modules(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, system_id : String | Nil = nil, dependency_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:

Operator	Action
`+`	Matches both terms
`	`
`-`	Negates a single token
`"`	Wraps tokens to form a phrase
`(` `)`	Provides precedence
`~N`	Specifies edit distance (fuzziness) after a word
`~N`	Specifies 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 dependency_id, or any combination of these.

Source

search_systems(q : String | Nil = nil, limit : Int = 20, offset : Int = 0)

List or search for systems.

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

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

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

Source

search_zones(q : String | Nil = nil, limit : Int = 20, offset : Int = 0, tags : String | Nil = nil)

List or search for zones.

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

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

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

Results my also also be limited to those associated with specific tags.

Source

start_module(id : String)

Starts a module.

Source

start_system(id : String)

Start all modules within a system.

Source

state(id : String, mod : String, index : Int = 1, lookup : String | Nil = nil)

Queries the state exposed by a module within the passed system id.

Source

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

Queries the state exposed by a module.

Source

stop_module(id : String)

Stops a module.

Source

stop_system(id : String)

Stops all modules within a system.

Source

types(id : String)

Queries the types of modules available in system id.

Source

Updates module attributes or configuration.

Source

Requests a change to an existing system.

In addition to specifying the ID of the system to update, you must reference the the current system metadata version for the update to be allowed. This must match the current version attribute of the system and will be incrememented following a successful update.

Source

Updates zone attributes or configuration.

Source

Macros

delete(path, params = nil, headers = nil, body = nil, as model = nil)

Executes a DELETE request on the client connection.

The response status will be automatically checked and a PlaceOS::Client::Error raised if unsuccessful.

Macro expansion allows this to obtain context from a surround method and use method arguments to build an appropriate request structure. Pass from_args to to either params or body for the magic to happen. Alternatively, you may specify a NamedTuple for the contents of either of these.