LEDs

All LED overrides

GET /v1/leds

Groups that are null show the robot's own status. The groups and their LEDs are on LEDs.

Token: required · Lease: not needed

curl -H "Authorization: Bearer $TOKEN" http://$ROBOT:7702/v1/leds

Replace all LED overrides

PUT /v1/leds

Groups left out or null go back to the robot.

Token: required · Lease: required (Nao-Lease header)

Request body (application/json)

LedOverrides. Every LED group's override. null (or absent) hands the group back to the robot.

{"chest":"#00ff00","left_ear":[1,1,1,1,1,0,0,0,0,0],"left_foot":"#0050ff","right_foot":"#0050ff"}

Hand all LEDs back

DELETE /v1/leds

The robot's own status LEDs return.

Token: required · Lease: required (Nao-Lease header)

curl -X DELETE -H "Authorization: Bearer $TOKEN" -H "Nao-Lease: $LEASE" http://$ROBOT:7702/v1/leds

Running LED animations

GET /v1/leds/animations

Token: required · Lease: not needed

curl -H "Authorization: Bearer $TOKEN" http://$ROBOT:7702/v1/leds/animations

List LED presets

GET /v1/leds/presets

Token: required · Lease: not needed

curl -H "Authorization: Bearer $TOKEN" http://$ROBOT:7702/v1/leds/presets

Apply an LED preset

PUT /v1/leds/presets/{name}

Sets every group at once.

Token: required · Lease: required (Nao-Lease header)

curl -X PUT -H "Authorization: Bearer $TOKEN" -H "Nao-Lease: $LEASE" http://$ROBOT:7702/v1/leds/presets/blue

Set one LED group

PUT /v1/leds/{group}

Eyes take color or colors (8), ears brightness or levels (10), chest and feet color. eyes, ears and feet set both sides.

Token: required · Lease: required (Nao-Lease header)

Request body (application/json)

LedSetting. What to show on a group or a single LED. Exactly one field: eyes take color or colors (8), ears take brightness or levels (10), chest and feet take color; a single LED takes color (eye) or brightness (ear).

{"color":"#ff8800"}

curl -X PUT -H "Authorization: Bearer $TOKEN" -H "Nao-Lease: $LEASE" -H 'Content-Type: application/json' \
  -d '{"color": "#0055ff"}' http://$ROBOT:7702/v1/leds/eyes

Hand one LED group back

DELETE /v1/leds/{group}

Token: required · Lease: required (Nao-Lease header)

curl -X DELETE -H "Authorization: Bearer $TOKEN" -H "Nao-Lease: $LEASE" http://$ROBOT:7702/v1/leds/eyes

Animate an LED group

PUT /v1/leds/{group}/animation

Breathe, blink, rainbow (not ears) or progress, computed on the robot at 20 Hz. Replaces an animation on an overlapping group. Any LED write to the group cancels it, and it ends with the lease. Animation frames are no heartbeat: keep sending heartbeats.

Token: required · Lease: required (Nao-Lease header)

Request body (application/json)

LedAnimation. An animation for one group.

{"color":"#0050ff","kind":"breathe","period_ms":3000}

curl -X PUT -H "Authorization: Bearer $TOKEN" -H "Nao-Lease: $LEASE" -H 'Content-Type: application/json' \
  -d '{"kind": "breathe", "color": "#0050ff", "period_ms": 3000}' http://$ROBOT:7702/v1/leds/eyes/animation

Stop an LED animation

DELETE /v1/leds/{group}/animation

The group keeps its last frame; DELETE /v1/leds/{group} hands it back to the robot.

Token: required · Lease: required (Nao-Lease header)

curl -X DELETE -H "Authorization: Bearer $TOKEN" -H "Nao-Lease: $LEASE" http://$ROBOT:7702/v1/leds/eyes/animation

Set a single LED

PUT /v1/leds/{group}/{index}

One eye segment (color, index 0 to 7 from the top, clockwise as seen from the front) or one ear segment (brightness, index 0 to 9). The index order is on LEDs.

Token: required · Lease: required (Nao-Lease header)

Request body (application/json)

LedSetting. What to show on a group or a single LED. Exactly one field: eyes take color or colors (8), ears take brightness or levels (10), chest and feet take color; a single LED takes color (eye) or brightness (ear).

{"color":"#ff8800"}

curl -X PUT -H "Authorization: Bearer $TOKEN" -H "Nao-Lease: $LEASE" -H 'Content-Type: application/json' \
  -d '{"color": "#ff0000"}' http://$ROBOT:7702/v1/leds/left_eye/0