mirror of https://github.com/sqfmi/Watchy.git
Formatted Setup
parent
728c005164
commit
84da3f8c8c
|
@ -1,12 +1,49 @@
|
|||
## Setup
|
||||
1. In the Arduino IDE Boards Manager, [install support for the ESP32][ESP32].
|
||||
* Arduino > Preferences > Additional Board Manager URLs
|
||||
* ```https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json```
|
||||
2. Install this library (search for **Watchy** in the library manager), and any other dependencies when prompted
|
||||
3. Check out the examples under ```Examples``` -> ```Watchy```
|
||||
4. Compile & Upload with these board settings:
|
||||
* Board: "ESP32 Dev Module"
|
||||
* Partition Scheme: "Minimal SPIFFS"
|
||||
* All Other Settings: leave to default
|
||||
|
||||
You may also have to install the [CP2104 USB to Serial drivers][Drivers] if the port is not automatically detected.
|
||||
# Setup
|
||||
|
||||
## Board
|
||||
|
||||
In the **Arduino IDE Boards Manager** you will <br>
|
||||
need to **[Install Support][ESP32]** for the **ESP32** board.
|
||||
|
||||
##### Navigate To
|
||||
|
||||
<kbd>**Arduino**</kbd> **›** <kbd>**Preferences**</kbd> **›** <kbd>**Additional Board Manager URLs**</kbd>
|
||||
|
||||
##### Insert
|
||||
|
||||
```
|
||||
https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
|
||||
```
|
||||
|
||||
## Library
|
||||
|
||||
In the **Library Manager**, search for `Watchy` <br>
|
||||
and install it and any of its dependencies.
|
||||
|
||||
## Example
|
||||
|
||||
Check out the examples under
|
||||
|
||||
<kbd>**Examples**</kbd> **›** <kbd>**Watchy**</kbd>
|
||||
|
||||
## Compile / Upload
|
||||
|
||||
Use the following settings when building <br>
|
||||
and leave any other ones at their default.
|
||||
|
||||
Setting | |
|
||||
:------:|:------:|
|
||||
Board | `ESP Dev Module`
|
||||
Partition Scheme | `Minimal SPIFFS`
|
||||
|
||||
## Port
|
||||
|
||||
In case your port isn't automatically detected, you may <br>
|
||||
also need to install the [CP2104 USB To Serial Drivers][Drivers].
|
||||
|
||||
|
||||
<!----------------------------------------------------------------------------->
|
||||
|
||||
[Drivers]: https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers
|
||||
[ESP32]: https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html
|
Loading…
Reference in New Issue