> For the complete documentation index, see [llms.txt](https://robopipe.gitbook.io/doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://robopipe.gitbook.io/doc/api/rest-api-reference/led.md).

# Led

## API Reference

## GET /controller/led

> List All Leds

```json
{"openapi":"3.1.0","info":{"title":"Robopipe API","version":"0.2.1.dev12"},"servers":[{"url":"http://localhost:8080","description":"Locally running server"}],"paths":{"/controller/led":{"get":{"tags":["controller"],"summary":"List All Leds","operationId":"List_all_leds_controller_led_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Led"},"type":"array","title":"Response List All Leds Controller Led Get"}}}}}}}},"components":{"schemas":{"Led":{"properties":{"dev":{"type":"string","title":"Dev"},"circuit":{"type":"string","title":"Circuit"},"value":{"type":"integer","maximum":1,"minimum":0,"title":"Value","description":"Value must be between 0 and 1"}},"type":"object","required":["dev","circuit","value"],"title":"Led"}}}}
```

## GET /controller/led/{circuit}

> Get Led

```json
{"openapi":"3.1.0","info":{"title":"Robopipe API","version":"0.2.1.dev12"},"servers":[{"url":"http://localhost:8080","description":"Locally running server"}],"paths":{"/controller/led/{circuit}":{"get":{"tags":["controller"],"summary":"Get Led","operationId":"Get_led_controller_led__circuit__get","parameters":[{"name":"circuit","in":"path","required":true,"schema":{"type":"string","title":"Circuit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Led"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Led":{"properties":{"dev":{"type":"string","title":"Dev"},"circuit":{"type":"string","title":"Circuit"},"value":{"type":"integer","maximum":1,"minimum":0,"title":"Value","description":"Value must be between 0 and 1"}},"type":"object","required":["dev","circuit","value"],"title":"Led"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /controller/led/{circuit}

> Set Led

```json
{"openapi":"3.1.0","info":{"title":"Robopipe API","version":"0.2.1.dev12"},"servers":[{"url":"http://localhost:8080","description":"Locally running server"}],"paths":{"/controller/led/{circuit}":{"post":{"tags":["controller"],"summary":"Set Led","operationId":"Set_led_controller_led__circuit__post","parameters":[{"name":"circuit","in":"path","required":true,"schema":{"type":"string","title":"Circuit"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Led"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"LedUpdate":{"properties":{"value":{"type":"integer","maximum":1,"minimum":0,"title":"Value","description":"Value must be between 0 and 1"}},"type":"object","required":["value"],"title":"LedUpdate"},"Led":{"properties":{"dev":{"type":"string","title":"Dev"},"circuit":{"type":"string","title":"Circuit"},"value":{"type":"integer","maximum":1,"minimum":0,"title":"Value","description":"Value must be between 0 and 1"}},"type":"object","required":["dev","circuit","value"],"title":"Led"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /controller/led

> Set All Leds

```json
{"openapi":"3.1.0","info":{"title":"Robopipe API","version":"0.2.1.dev12"},"servers":[{"url":"http://localhost:8080","description":"Locally running server"}],"paths":{"/controller/led":{"post":{"tags":["controller"],"summary":"Set All Leds","operationId":"Set_all_leds_controller_led_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedUpdate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Led"},"type":"array","title":"Response Set All Leds Controller Led Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"LedUpdate":{"properties":{"value":{"type":"integer","maximum":1,"minimum":0,"title":"Value","description":"Value must be between 0 and 1"}},"type":"object","required":["value"],"title":"LedUpdate"},"Led":{"properties":{"dev":{"type":"string","title":"Dev"},"circuit":{"type":"string","title":"Circuit"},"value":{"type":"integer","maximum":1,"minimum":0,"title":"Value","description":"Value must be between 0 and 1"}},"type":"object","required":["dev","circuit","value"],"title":"Led"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```