Watchy/Documentation/Setup.md

92 lines
1.4 KiB
Markdown
Raw Normal View History

2022-04-07 11:45:02 -04:00
2022-04-07 11:48:47 -04:00
<h1 align = 'center'>Setup</h1>
2022-04-07 11:45:02 -04:00
2022-04-07 11:48:47 -04:00
<br>
2022-04-07 11:48:06 -04:00
<br>
2022-04-07 11:45:02 -04:00
## Board
In the **Arduino IDE Boards Manager** you will <br>
need to **[Install Support][ESP32]** for the **ESP32** board.
2022-04-07 11:48:06 -04:00
<br>
2022-04-07 11:45:02 -04:00
##### Navigate To
<kbd>**Arduino**</kbd>****<kbd>**Preferences**</kbd>****<kbd>**Additional Board Manager URLs**</kbd>
2022-04-07 11:48:06 -04:00
<br>
2022-04-07 11:45:02 -04:00
##### Insert
```
https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
```
2022-04-07 11:48:06 -04:00
<br>
<br>
---
<br>
<br>
2022-04-07 11:45:02 -04:00
## Library
In the **Library Manager**, search for `Watchy` <br>
and install it and any of its dependencies.
2022-04-07 11:48:06 -04:00
<br>
<br>
---
<br>
<br>
2022-04-07 11:45:02 -04:00
## Example
Check out the examples under
<kbd>**Examples**</kbd>****<kbd>**Watchy**</kbd>
2022-04-07 11:48:06 -04:00
<br>
<br>
---
<br>
<br>
2022-04-07 11:45:02 -04:00
## Compile / Upload
Use the following settings when building <br>
and leave any other ones at their default.
2022-04-07 11:48:06 -04:00
<br>
2022-04-07 11:45:02 -04:00
Setting | |
:------:|:------:|
Board | `ESP Dev Module`
Partition Scheme | `Minimal SPIFFS`
2022-04-07 11:48:06 -04:00
<br>
<br>
---
<br>
<br>
2022-04-07 11:45:02 -04:00
## Port
In case your port isn't automatically detected, you may <br>
also need to install the [CP2104 USB To Serial Drivers][Drivers].
2022-04-07 11:48:06 -04:00
<br>
2022-04-07 11:45:02 -04:00
<!----------------------------------------------------------------------------->
[Drivers]: https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers
2022-04-07 11:48:06 -04:00
[ESP32]: https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html