From da96112e23882bfe8f4ef7591c5c1324f7cf3260 Mon Sep 17 00:00:00 2001 From: Lexi Beavil Date: Sat, 6 Apr 2024 17:08:57 +0100 Subject: [PATCH] Update installation details in README.md (#35) --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6b8aa91..9667731 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,29 @@ A HomeAssistant device controller built into a cute 1.28" dial. ## Installation *The software is only compatible with the [M5Dial by M5Stack](https://shop.m5stack.com/products/m5stack-dial-esp32-s3-smart-rotary-knob-w-1-28-round-touch-screen), but it would be relatively trivial to port it to other ESP32-based dials and knobs.* -- Pre-built binaries are not currently available, see building. +- Download the latest binary (firmware_merged.bin) from [Releases](https://github.com/aeroniemi/circlehome/releases +- Open a ESPTool instance (such as [this online one from Adafruit](https://adafruit.github.io/Adafruit_WebSerial_ESPTool/)) +- Erase your ESP32 +- Write ``firmware_merged.bin`` at ``0x0`` +- Restart your ESP + +You should now be good to setup your device! + +## Setup +After installing the firmware, you need to set the WiFi credentials, home assistant credentials and more. To make this as easy as possible CircleHome will create a WiFi hotspot for you to join: +- On initial startup, you'll see a green configuration message. Click "Setup" +- Connect to the open WiFi network ``M5Dial`` +- Navigate to ``http://192.168.0.1`` +- Fill out the details in the form. + - Note that timezone is case sensitive, and must be one of the values found [here](https://github.com/rzeldent/micro-timezonedb/blob/main/include/timezonedb.h) +- Press submit on the form +- Wait a few moments, then click ``restart`` on your dial. + +The device should now be configured. + +## Operation +The interface of CircleHome should be fairly intuitive, but here's a few tips: +- To return to the main menu, long press the dial. ## Building - The repository contains all the details you'll need to build the project using Platform-IO.