esphome-ratgdo/README.md


# ratgdo for ESPHome

This is a port of the ratgdo software for the v2 board to ESPHome.

[Visit the github.io page to purchase boards](https://paulwieland.github.io/ratgdo/#order)

This project is not affiliated with ratgdo or Paul Wieland. Please buy his boards to support his excellent work.

## Moving from stock ratgdo

If you have not used the stock ratgdo firmware, and are starting with a fresh install of the ESPHome based firmware, [skip these steps](#fresh-install-when-the-stock-ratgdo-firmware-was-not-used-before).

- Use the [`Logs & Console`](https://paulwieland.github.io/ratgdo/flash.html) to view and make note of the current rolling code
- Flash the new ESPHome based firmware using the [Web Installer](https://esphome-ratgdo.github.io/esphome-ratgdo/)
- Use the `number` entity in Home Assistant or the built-in ESPHome web-server to set the rolling code.

<img width="560" alt="number_entity" src="https://github.com/ESPHome-RATGDO/esphome-ratgdo/assets/663432/e177029e-f42f-46a8-a87a-81fa04caaa57">

## Fresh install when the stock ratgdo firmware was not used before

- Flash the new ESPHome based firmware using the [Web Installer](https://esphome-ratgdo.github.io/esphome-ratgdo/)

## First use

The ESPHome firmware will allow you to open the door to any position after calibration. To calibrate the door, open and close it once without stopping.

<img width="560" alt="position_demo" src="https://github.com/ESPHome-RATGDO/esphome-ratgdo/assets/663432/22a9873e-67bb-4b2f-bb32-70047cfe666d">

## Updating from versions older than 2023.07.07

When updating from older versions, save the rolling counter value and restore it via the number entity after flashing the new firmware. If you forget to save the code, check the Home Assistant history.

## ESPHome config

- [ESPHome config for v2 board with ESP8266 D1 Mini lite](https://github.com/ESPHome-RATGDO/esphome-ratgdo/blob/main/static/v2board_esp8266_d1_mini_lite.yaml)
- [ESPHome config for v2 board with ESP32 D1 Mini](https://github.com/ESPHome-RATGDO/esphome-ratgdo/blob/main/static/v2board_esp32_d1_mini.yaml)
- [Web Installer](https://esphome-ratgdo.github.io/esphome-ratgdo/)

![Home Assistant Screen Shot](static/hass.png)
Update README.md 2023-06-06 01:56:06 +00:00
Update README.md 2023-06-26 19:59:08 +00:00			`# ratgdo for ESPHome`
init 2023-06-05 16:48:15 +00:00
Update README.md 2023-06-26 19:59:08 +00:00			`This is a port of the ratgdo software for the v2 board to ESPHome.`
init 2023-06-05 16:48:15 +00:00
Update README.md 2023-06-13 23:05:32 +00:00			`[Visit the github.io page to purchase boards](https://paulwieland.github.io/ratgdo/#order)`
init 2023-06-05 16:48:15 +00:00
Update README.md 2023-06-13 23:05:02 +00:00			`This project is not affiliated with ratgdo or Paul Wieland. Please buy his boards to support his excellent work.`
init 2023-06-05 16:48:15 +00:00
Update docs for recent changes (#23) 2023-06-26 19:50:06 +00:00			`## Moving from stock ratgdo`

Update README.md 2023-07-17 10:22:02 +00:00			`If you have not used the stock ratgdo firmware, and are starting with a fresh install of the ESPHome based firmware, [skip these steps](#fresh-install-when-the-stock-ratgdo-firmware-was-not-used-before).`
Update README.md 2023-07-17 10:19:31 +00:00
Update docs for recent changes (#23) 2023-06-26 19:50:06 +00:00			- Use the [`Logs & Console`](https://paulwieland.github.io/ratgdo/flash.html) to view and make note of the current rolling code
			`- Flash the new ESPHome based firmware using the [Web Installer](https://esphome-ratgdo.github.io/esphome-ratgdo/)`
			- Use the `number` entity in Home Assistant or the built-in ESPHome web-server to set the rolling code.

			`<img width="560" alt="number_entity" src="https://github.com/ESPHome-RATGDO/esphome-ratgdo/assets/663432/e177029e-f42f-46a8-a87a-81fa04caaa57">`

Update README.md 2023-07-17 10:21:36 +00:00			`## Fresh install when the stock ratgdo firmware was not used before`
Update README.md 2023-07-17 10:20:46 +00:00
			`- Flash the new ESPHome based firmware using the [Web Installer](https://esphome-ratgdo.github.io/esphome-ratgdo/)`

			`## First use`
Update docs for recent changes (#23) 2023-06-26 19:50:06 +00:00
			`The ESPHome firmware will allow you to open the door to any position after calibration. To calibrate the door, open and close it once without stopping.`

			`<img width="560" alt="position_demo" src="https://github.com/ESPHome-RATGDO/esphome-ratgdo/assets/663432/22a9873e-67bb-4b2f-bb32-70047cfe666d">`

Make storing persistent state the resposibility of ratgdo_number (#30) Co-authored-by: J. Nick Koston <nick@koston.org> 2023-07-07 22:56:12 +00:00			`## Updating from versions older than 2023.07.07`

			`When updating from older versions, save the rolling counter value and restore it via the number entity after flashing the new firmware. If you forget to save the code, check the Home Assistant history.`

Update README.md 2023-07-17 10:20:46 +00:00			`## ESPHome config`
Update README.md 2023-06-07 22:37:05 +00:00
adjust 2023-06-13 21:41:30 +00:00			`- [ESPHome config for v2 board with ESP8266 D1 Mini lite](https://github.com/ESPHome-RATGDO/esphome-ratgdo/blob/main/static/v2board_esp8266_d1_mini_lite.yaml)`
Revert "remove esp32 (#2)" This reverts commit 3edf018212156fbd7c1991c10fb1215bffb466f2. 2023-06-17 14:50:54 +00:00			`- [ESPHome config for v2 board with ESP32 D1 Mini](https://github.com/ESPHome-RATGDO/esphome-ratgdo/blob/main/static/v2board_esp32_d1_mini.yaml)`
adjust 2023-06-13 21:41:30 +00:00			`- [Web Installer](https://esphome-ratgdo.github.io/esphome-ratgdo/)`
add screen shots 2023-06-10 15:32:13 +00:00
			`![Home Assistant Screen Shot](static/hass.png)`