robopipe.io
SolutionShopAbout UsDocumentationSupport
  • Welcome
  • Getting started
    • Setup
    • Hello world
  • Examples
    • Capsule counting
  • API
    • REST API Reference
      • Cameras
      • Streams
      • Neural Network
      • Controller
      • Analog I/O
      • Digital I/O
      • Led
    • WebSocket API Reference
      • Video Stream
      • NN Inference
    • Configuration
  • Other
    • Supported devices
    • Generic Devices
    • Troubleshooting
  • Resources
    • Robopipe Reddit
    • Robopipe GitHub
    • Luxonis
    • Unipi
Powered by GitBook
On this page
Edit on GitHub
  1. API
  2. REST API Reference

Led

PreviousDigital I/ONextWebSocket API Reference

Last updated 4 months ago

API Reference

List All Leds

get
Responses
200
Successful Response
application/json
get
GET /controller/led HTTP/1.1
Host: robopipe-1.local
Accept: */*
200

Successful Response

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

Get Led

get
Path parameters
circuitstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /controller/led/{circuit} HTTP/1.1
Host: robopipe-1.local
Accept: */*
{
  "dev": "text",
  "circuit": "text",
  "value": 1
}
  • API Reference
  • GETList All Leds
  • GETGet Led
  • POSTSet Led
  • POSTSet All Leds

Set Led

post
Path parameters
circuitstringRequired
Body
valueinteger · max: 1Required

Value must be between 0 and 1

Responses
200
Successful Response
application/json
422
Validation Error
application/json
post
POST /controller/led/{circuit} HTTP/1.1
Host: robopipe-1.local
Content-Type: application/json
Accept: */*
Content-Length: 11

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

Set All Leds

post
Body
valueinteger · max: 1Required

Value must be between 0 and 1

Responses
200
Successful Response
application/json
422
Validation Error
application/json
post
POST /controller/led HTTP/1.1
Host: robopipe-1.local
Content-Type: application/json
Accept: */*
Content-Length: 11

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