Watchy/README.md

39 lines
1.5 KiB
Markdown
Raw Normal View History

2021-01-05 00:06:20 -05:00
# Watchy - Fully Open Source E-Paper Watch
2019-11-16 23:19:59 -05:00
2022-04-07 11:07:53 -04:00
![Preview]
2019-11-16 23:29:47 -05:00
2022-04-07 11:07:53 -04:00
**Buy Watchy at [Crowd Supply] and [Mouser]!**
2021-12-12 20:51:25 -05:00
2022-04-07 11:07:53 -04:00
[**Watchy Case & Accessories**][Shop]
2021-12-12 20:51:25 -05:00
2022-04-07 11:07:53 -04:00
Visit [**https://watchy.sqfmi.com**][Website] for documentation, hardware design files, and more!
2019-11-16 23:54:41 -05:00
## Setup
2022-04-07 11:07:53 -04:00
1. In the Arduino IDE Boards Manager, [install support for the ESP32][ESP32].
2022-01-22 12:11:56 -05:00
* Arduino > Preferences > Additional Board Manager URLs
2021-11-29 02:41:09 -05:00
* ```https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json```
2022-01-22 12:11:56 -05:00
2. Install this library (search for **Watchy** in the library manager), and any other dependencies when prompted
2019-11-16 23:19:59 -05:00
3. Check out the examples under ```Examples``` -> ```Watchy```
4. Compile & Upload with these board settings:
2021-01-05 00:03:49 -05:00
* Board: "ESP32 Dev Module"
* Partition Scheme: "Minimal SPIFFS"
2019-11-16 23:19:59 -05:00
* All Other Settings: leave to default
2021-01-05 00:03:49 -05:00
2022-04-07 11:07:53 -04:00
You may also have to install the [CP2104 USB to Serial drivers][Drivers] if the port is not automatically detected.
2021-01-05 00:03:49 -05:00
### Have Fun! :)
2021-12-30 23:16:03 -05:00
2022-04-07 11:07:53 -04:00
<!----------------------------------------------------------------------------->
[Preview]: https://watchy.sqfmi.com/img/watchy_render.png
[Crowd Supply]: https://www.crowdsupply.com/sqfmi/watchy
[Mouser]: https://www.mouser.com/ProductDetail/SQFMI/SQFMI-WATCHY-10?qs=DRkmTr78QARN9VSJRzqRxw%3D%3D
[Website]: https://watchy.sqfmi.com
[Shop]: https://shop.sqfmi.com
[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
2021-12-30 23:16:03 -05:00