feat: add docs for MDNS and REST API

This commit is contained in:
ZanzyTHEbar 2023-01-28 14:36:04 +00:00
parent ae82ded545
commit 6f69ae61b3

View File

@ -18,8 +18,8 @@ For basic `GET` requests, you can use your browser of choice.
The REST API follows the following standard: The REST API follows the following standard:
´´´bash ´´´
http://<device_name>.local:81/control/command/<endpoint>?<param>=<value>&<param>=<value> <http://<device_name>.local:81/control/command/<endpoint>?<param>=<value>&<param>=<value>>
´´´ ´´´
> For example, if the name of the device is `esp32`, you can connect to the device using `http://esp32.local:81/control/command/<endpoint>`. > For example, if the name of the device is `esp32`, you can connect to the device using `http://esp32.local:81/control/command/<endpoint>`.
@ -76,6 +76,7 @@ We allow you to store up to 3 wifi networks in memory. If you try to add more th
You must follow the following format for the `power` param: You must follow the following format for the `power` param:
Using the following enum, you pass the _number_ to the right of the `=` sign that corresponds with the power in `dBm` that you wish to use. Using the following enum, you pass the _number_ to the right of the `=` sign that corresponds with the power in `dBm` that you wish to use.
```cpp ```cpp
typedef enum { typedef enum {
WIFI_POWER_19_5dBm = 78,// 19.5dBm WIFI_POWER_19_5dBm = 78,// 19.5dBm
@ -92,6 +93,7 @@ typedef enum {
WIFI_POWER_MINUS_1dBm = -4// -1dBm WIFI_POWER_MINUS_1dBm = -4// -1dBm
} wifi_power_t; } wifi_power_t;
``` ```
::: :::
#### /setDevice #### /setDevice