(0.0.1)

Download OpenAPI specification:Download

@openapi:info

Admin

Shut down the raspberry pi.

Shut down the raspberry pi.

Responses

Reboot the raspberry pi.

Reboot the raspberry pi.

Responses

Reload reef-pi.

Reload reef-pi to apply any capability changes or other modules that are registered at startup.

Responses

Upgrade reef-pi.

Upgrade reef-pi.

Responses

Get system summary.

Get system summary.

Responses

AnalogInput

List all Analog Inputs.

List all Analog Inputs in reef-pi.

Responses

Get an Analog Input by id.

Get an existing Analog Input.

path Parameters
id
required
string

The Id of the analog input

Responses

Update an Analog Input.

Update an existing Analog Input.

path Parameters
id
required
string

The Id of the analog input to update

Request Body schema: application/json

The analog input to update

driver
string
id
string
name
string
pin
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "driver": "string",
  • "id": "string",
  • "name": "string",
  • "pin": 0
}

Delete an Analog Input.

Delete an existing Analog Input.

path Parameters
id
required
string

The Id of the analog input to delete

Responses

Read an Analog Input.

Read an Analog Input.

path Parameters
id
required
string

The Id of the analog input to read

Responses

Create an analog input.

Create a new analog input.

Request Body schema: application/json

The analog input to create

driver
string
id
string
name
string
pin
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "driver": "string",
  • "id": "string",
  • "name": "string",
  • "pin": 0
}

ATO

List all ATOs.

List all ATOs in reef-pi.

Responses

Create an ATO.

Create a new ATO.

Request Body schema: application/json

The ato to create

control
boolean
disable_on_alert
boolean
enable
boolean
id
string
inlet
string
is_macro
boolean
name
string
object (Notify)
period
integer <int64> (Duration)

A Duration represents the elapsed time between two instants as an int64 nanosec