-
Notifications
You must be signed in to change notification settings - Fork 17
API v2
Version: 0.2
Summary: Restore settings to default
Responses
| Code | Description |
|---|---|
| 200 | ok |
Summary: Delete a program
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| data | body | No | object |
Responses
| Code | Description |
|---|---|
| 200 | ok |
Summary: Get the list of all the saved programs
Responses
| Code | Description |
|---|---|
| 200 | ok |
Summary: Get the program with the specified name
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| name | query | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | ok |
Summary: Save a new activity
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| data | body | No | object |
Responses
| Code | Description |
|---|---|
| 200 | ok |
| 400 | Failed to save the activity |
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| file_to_upload | formData | Yes | file |
Responses
| Code | Description |
|---|---|
| 200 | ok |
| 400 | upload failed |
Summary: Delete an activity
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| data | body | No | object |
Responses
| Code | Description |
|---|---|
| 200 | ok |
Summary: Get the list of all the saved activities
Responses
| Code | Description |
|---|---|
| 200 | ok |
Summary: Get the activity with the specified name
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| name | query | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | ok |
Summary: Save a new program
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| overwrite | query | No | string | |
| data | body | No | object |
Responses
| Code | Description |
|---|---|
| 200 | ok |
| 400 | Failed to save the program |
Summary: Execute the given program
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| data | body | No | object |
Responses
| Code | Description |
|---|---|
| 200 | ok |
Summary: Bot general informations and execution status
Responses
| Code | Description |
|---|---|
| 200 | Bot status |
Summary: Bot general informations and execution status
Responses
| Code | Description |
|---|---|
| 200 | Bot status |
Summary: Stops the bot motors
Responses
| Code | Description |
|---|---|
| 200 | Successfully stopped the motors |
Summary: Moves the bot forward or backward.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| data | body | Movement speed and duration | No | object |
Responses
| Code | Description |
|---|---|
| 200 | Sent command to the bot GPIO. |
Summary: Make a turn with the motors
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| data | body | Turn | No | object |
Responses
| Code | Description |
|---|---|
| 200 | Sent command to the bot GPIO. |