OSTIP_EXARI v0.1.0 Swagger.Client.Api.ApiDocsdeviceStatesFormat View Source

API calls for all endpoints tagged ApiDocsdeviceStatesFormat.

Link to this section Summary

Destroy a device-state controlled by ARI

Retrieve the current state of a device

List all ARI controlled device states

Change the state of a device controlled by ARI. (Note - implicitly creates the device state)

delete(connection, device_name, opts \\ [])

delete(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Destroy a device-state controlled by ARI.

{:ok, %{}} on success {:error, info} on failure

get(connection, device_name, opts \\ [])

get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Retrieve the current state of a device.

{:ok, %{}} on success {:error, info} on failure

list(connection, opts \\ [])

list(Tesla.Env.client(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}

List all ARI controlled device states.

{:ok, %{}} on success {:error, info} on failure

update(connection, device_name, device_state, opts \\ [])

update(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Change the state of a device controlled by ARI. (Note - implicitly creates the device state).

{:ok, %{}} on success {:error, info} on failure