2021-04-11 04:03:19 -07:00
|
|
|
---
|
2021-04-11 18:29:30 -07:00
|
|
|
id: api
|
2021-04-11 04:03:19 -07:00
|
|
|
title: APIs
|
|
|
|
|
sidebar_label: APIs
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## General
|
|
|
|
|
|
|
|
|
|
:::note
|
|
|
|
|
|
2021-05-09 12:23:30 -07:00
|
|
|
Currently there are three methods of interfacing with devices: `HTTP`, `BLE`, and `Serial`.
|
2021-04-11 04:03:19 -07:00
|
|
|
|
|
|
|
|
Whilst each method has it's own ways sending and receiving data, the underlying protobuf transport medium remains the same.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
## HTTP
|
|
|
|
|
|
|
|
|
|
### Endpoints
|
|
|
|
|
|
|
|
|
|
#### `PUT` /api/v1/toradio
|
|
|
|
|
|
|
|
|
|
#### `GET` /api/v1/fromradio&all=`boolean`
|
|
|
|
|
|
|
|
|
|
## BLE
|
|
|
|
|
|
|
|
|
|
:::important
|
|
|
|
|
UUID for the service: `6ba1b218-15a8-461f-9fa8-5dcae273eafd`
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
## Serial
|
|
|
|
|
|
|
|
|
|
:::important
|
|
|
|
|
|
|
|
|
|
You can communicate with devices with a baud rate of `921600`bps
|
|
|
|
|
|
|
|
|
|
:::
|
