ReferenceREST API
REST API: Wake and rest. Generated from the OpenAPI document.
No motion in this phase
nao-rs doesn't drive the motors yet, and the robot must not move during bring-up without a person present. These operations exist and are documented for completeness; don't use them on a robot.
Power state
GET /v1/power
The robot's primary state from the latest state.
Token: required · Lease: not needed
| Status | Meaning | Body |
|---|---|---|
| 200 | Current primary state | PowerStatus |
| 401 | Missing or wrong token | ErrorBody |
Wake or rest
PUT /v1/power
wake makes the robot stiff and ready to move, rest unstiff. The death switch overrides stiffness whatever is requested.
Token: required · Lease: required (Nao-Lease header)
Request body (application/json)
| Field | Type | Required | Meaning |
|---|---|---|---|
state | PowerState | yes |
| Status | Meaning | Body |
|---|---|---|
| 202 | Requested; watch primary_state for the result | PowerRequest |
| 409 | Not the active lease | ErrorBody |
| 422 | Invalid input | ErrorBody |
| 428 | No Nao-Lease header | ErrorBody |