class

PlaceOS::Client::APIWrapper::Drivers

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(name : String, role : Role, commit : String, file_name : String, module_name : String, repository_id : String, default_uri : String | Nil = nil, default_port : Int32 | Nil = nil, description : String | Nil = nil, ignore_connected : Bool | Nil = nil)
Source
recompile(id : String, timeout : Time::Span = 10.minutes)
Source
search(q : String | Nil = nil, limit : Int = 20, offset : Int = 0)

List or search for drivers.

Results maybe filtered by specifying a query - q - to search across driver 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 drivers will be returned, with a paging based on offset.

Source
update(id : String, name : String | Nil = nil, role : Role | Nil = nil, commit : String | Nil = nil, file_name : String | Nil = nil, module_name : String | Nil = nil, default_uri : String | Nil = nil, default_port : Int32 | Nil = nil, description : String | Nil = nil, ignore_connected : Bool | Nil = nil)
Source