Solution Shop About Us Documentation Support

Led

API Reference

PreviousDigital I/O NextWebSocket API Reference

Last updated 1 month ago

List All Leds

get

/controller/led

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://robopipe-1.local/controller/led'

200

[
  {
    "dev": "text",
    "circuit": "text",
    "value": 1
  }
]

Successful Response

Get Led

get

/controller/led/{circuit}

Path parameters

circuitCircuitrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://robopipe-1.local/controller/led/{circuit}'

200

422

{
  "dev": "text",
  "circuit": "text",
  "value": 1
}

Successful Response

Set Led

post

/controller/led/{circuit}

Path parameters

circuitCircuitrequired

Body

valueValuerequired

Value must be between 0 and 1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://robopipe-1.local/controller/led/{circuit}' \
  --header 'Content-Type: application/json' \
  --data '{"value":1}'

200

422

{
  "dev": "text",
  "circuit": "text",
  "value": 1
}

Successful Response

Set All Leds

post

/controller/led

Body

valueValuerequired

Value must be between 0 and 1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://robopipe-1.local/controller/led' \
  --header 'Content-Type: application/json' \
  --data '{"value":1}'

200

422

[
  {
    "dev": "text",
    "circuit": "text",
    "value": 1
  }
]

Successful Response