Skip to content

Commit a8181af

Browse files
authored
Fix ESPhome -> ESPHome (#1278)
1 parent be13a67 commit a8181af

File tree

24 files changed

+119
-119
lines changed

24 files changed

+119
-119
lines changed

src/components/DeviceLink.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ export function MadeForESPHomeLogo({width}) {
6363

6464
export function DifficultyLookup({ difficulty }) {
6565
const levels = {
66-
1: "Comes with ESPhome",
66+
1: "Comes with ESPHome",
6767
2: "Plug-n-flash",
6868
3: "Disassembly required",
6969
4: "Soldering required",

src/docs/adding-devices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ standard: uk, us
3636
| `board` | Type of board used in product | `esp8266`, `esp32`, `rp2040`, `bk72xx`, `rtl87xx` | No (but required to show on Boards page) |
3737
| `project-url` | URL for product or GitHub. This should point directly to a working Yaml file or page where the yaml file is easily accessible (ie. a Github Repo) Repo | | No |
3838
| `made-for-esphome` | Has the manufacturer certified the device for ESPHome | `True`, `False` | No |
39-
| `difficulty` | Difficulty rating | `1`: Comes with ESPhome, `2`: Plug-n-flash, `3`: Disassembly required, `4`: Soldering required, `5`: Chip needs replacement | No |
39+
| `difficulty` | Difficulty rating | `1`: Comes with ESPHome, `2`: Plug-n-flash, `3`: Disassembly required, `4`: Soldering required, `5`: Chip needs replacement | No |
4040

4141
## Images
4242

src/docs/devices/Aubess-WiFi-Smart-Switch/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ Also on Aliexpress.
1414

1515
## GPIO Pinout
1616

17-
| Pin | Function |
18-
| ------ | ------------------- |
19-
| P8 | Button |
20-
| P26 | External Switch |
21-
| p24 | Relay |
22-
| P7 | Status Led |
17+
| Pin | Function |
18+
| --- | --------------- |
19+
| P8 | Button |
20+
| P26 | External Switch |
21+
| p24 | Relay |
22+
| P7 | Status Led |
2323

2424
## Basic Configuration
2525

@@ -54,7 +54,7 @@ substitutions:
5454

5555
## ---------------- ##
5656
## Status LED ##
57-
## Если есть ошибка в ESPhome, то диод мигает. Eсли все хорошо, то индикатором можно управлять из HA
57+
## Если есть ошибка в ESPHome, то диод мигает. Eсли все хорошо, то индикатором можно управлять из HA
5858
## ---------------- ##
5959

6060
light:

src/docs/devices/DETA-Grid-Connect-Smart-Double-Touch-Power-Point/index.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,21 @@ You may be able to simply dig at it enough that the 3v3 pin is accessible.
3333

3434
## GPIO pinout
3535

36-
| GPIO # | Component |
37-
|:------:|------------:|
38-
| GPIO00 | None |
39-
| GPIO01 | None |
40-
| GPIO02 | None |
41-
| GPIO03 | None |
42-
| GPIO04 | Status LED |
43-
| GPIO05 | None |
44-
| GPIO09 | None |
45-
| GPIO10 | None |
46-
| GPIO12 | Button 2n |
47-
| GPIO13 | Relay 1 |
48-
| GPIO14 | Relay 2 |
49-
| GPIO15 | None |
50-
| GPIO16 | Button 1n |
36+
| GPIO # | Component |
37+
| :----: | ---------: |
38+
| GPIO00 | None |
39+
| GPIO01 | None |
40+
| GPIO02 | None |
41+
| GPIO03 | None |
42+
| GPIO04 | Status LED |
43+
| GPIO05 | None |
44+
| GPIO09 | None |
45+
| GPIO10 | None |
46+
| GPIO12 | Button 2n |
47+
| GPIO13 | Relay 1 |
48+
| GPIO14 | Relay 2 |
49+
| GPIO15 | None |
50+
| GPIO16 | Button 1n |
5151

5252
## Basic Configuration
5353

@@ -95,7 +95,7 @@ sensor:
9595

9696
text_sensor:
9797
- platform: version
98-
name: ${device_name} ESPhome Version
98+
name: ${device_name} ESPHome Version
9999
- platform: wifi_info
100100
ip_address:
101101
name: ${device_name} IP

src/docs/devices/DETA-Grid-Connect-Smart-Inline-Switch/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ sensor:
9696

9797
text_sensor:
9898
- platform: version
99-
name: ${device_name} ESPhome Version
99+
name: ${device_name} ESPHome Version
100100
- platform: wifi_info
101101
ip_address:
102102
name: ${device_name} IP

src/docs/devices/DETA-Grid-Connect-Smart-Plug-Base/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ The DETA [Smart Plug Base](https://www.bunnings.com.au/deta-smart-plug-base-with
1313

1414
## GPIO Pinout
1515

16-
| Pin | Function |
17-
| --- | -------- |
18-
| GPIO1 | Button |
16+
| Pin | Function |
17+
| ------ | -------- |
18+
| GPIO1 | Button |
1919
| GPIO13 | Blue LED |
20-
| GPIO14 | Relay |
20+
| GPIO14 | Relay |
2121

2222
## Getting it up and running
2323

@@ -96,7 +96,7 @@ sensor:
9696

9797
text_sensor:
9898
- platform: version
99-
name: ${device_name} ESPhome Version
99+
name: ${device_name} ESPHome Version
100100
- platform: wifi_info
101101
ip_address:
102102
name: ${device_name} IP

src/docs/devices/DIY-Smart_Switch/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ These devices are sold under many brands on Aliexpress.
1818

1919
## GPIO Pinout
2020

21-
| Pin | Function |
22-
| ------ | -------------------------- |
23-
| P6 | Rocker switch INPUT_PULLUP |
24-
| P7 | Relay (H) |
25-
| P8 | RF input ? |
26-
| P23 | Button INPUT_PULLUP |
27-
| P26 | Blue Status LED (H) |
21+
| Pin | Function |
22+
| --- | -------------------------- |
23+
| P6 | Rocker switch INPUT_PULLUP |
24+
| P7 | Relay (H) |
25+
| P8 | RF input ? |
26+
| P23 | Button INPUT_PULLUP |
27+
| P26 | Blue Status LED (H) |
2828

2929
## Configuration
3030

@@ -46,7 +46,7 @@ bk72xx:
4646
board: generic-bk7231n-qfn32-tuya
4747
## ---------------- ##
4848
## Status LED ##
49-
## If there is an error in ESPhome, the diode blinks. If everything is fine, the indicator can be controlled from HA
49+
## If there is an error in ESPHome, the diode blinks. If everything is fine, the indicator can be controlled from HA
5050
## ---------------- ##
5151

5252
light:

src/docs/devices/ESP32-Relay-X1/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ They are available from aliexpress.
2424

2525
This board has headers for every GPIO pin on its ESP32 via 2 sets of 2x10 headers, and an additional 6 pin header below the ESP32 for flashing. The micro USB is for power only, no serial connection.
2626

27-
I was able to flash it using the ESPhome web tool and an FTDI connector. I was able to use the 5V pin with the FTDI set to 5V as well and connected to the GPIO pins, but 3.3V should be used if possible (it would not flash for me at 3.3V). I was unable to flash with a USB cable.
27+
I was able to flash it using the ESPHome web tool and an FTDI connector. I was able to use the 5V pin with the FTDI set to 5V as well and connected to the GPIO pins, but 3.3V should be used if possible (it would not flash for me at 3.3V). I was unable to flash with a USB cable.
2828

29-
| GPIO | Connected onboard to
30-
| ----- | --------------------- |
29+
| GPIO | Connected onboard to |
30+
| ------ | -------------------- |
3131
| GPIO0 | Button |
3232
| GPIO16 | Relay |
3333
| GPIO23 | LED |

src/docs/devices/Feit-DIMSMART-3-CAN/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ I don't like to solder onto that pad because it can pull the pad off. This makes
2727
ltchiptool flash read beken-72xx ./dimmer1
2828
```
2929

30-
## Installing ESPhome
30+
## Installing ESPHome
3131

3232
I used ltchiptool's UPK2ESPHome to parse the firmware. The result is the configuration below. Put that config into a .yml file and compile the firmware:
3333

src/docs/devices/Feit-PLUG3-WIFI-WP-2-N/index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ The SmartPlug leverages a Generic BK7231N module based on the BK7231N chip (a va
2121

2222
## GPIO Pinout
2323

24-
| Pin | Function |
25-
| --- | --------------------|
26-
| P26 | (PWM0) Pushbutton |
27-
| P17 | (PWM1) Status LED |
28-
| P15 | (PWM2) Relay |
29-
| P10 | (RXD1) UART 1 RX |
30-
| P11 | (TXD1) UART 1 TX |
24+
| Pin | Function |
25+
| --- | ----------------- |
26+
| P26 | (PWM0) Pushbutton |
27+
| P17 | (PWM1) Status LED |
28+
| P15 | (PWM2) Relay |
29+
| P10 | (RXD1) UART 1 RX |
30+
| P11 | (TXD1) UART 1 TX |
3131

3232
Disassembly is straightforward but DO NOT open the device while it is plugged into mains power as that presents a safety hazard. There are six phillips head screws on the bottom; they are all the same size. Remove those screws and set aside.
3333
![Bottom Image](bottom.jpg "Bottom of device")
@@ -40,15 +40,15 @@ Next, use a USB FTDI adapter (I used [this](https://www.amazon.com/HiLetgo-FT232
4040

4141
## Preparing to flash
4242

43-
Using ESPhome, create a new device and give it a name. On the "Installation" screen, click 'SKIP THIS STEP' at the bottom. For the device type, you can select "Generic - BK7231N (Tuya QFN32)". Copy the encryption key if you plan on using it otherwise click 'skip'. Now you should see that device in the list; click on 'EDIT' just below and copy over the config with the one below. Make sure to update with your Wifi credentials and encryption key if using. Then click 'INSTALL' and then choose the 'Manual download' option. The reason for this is we need to use a special tool for the initial flash; ESPhome OTA updates will work as expected after the initial installation. Once it's compiled, select the top button to download the uf2 file.
43+
Using ESPHome, create a new device and give it a name. On the "Installation" screen, click 'SKIP THIS STEP' at the bottom. For the device type, you can select "Generic - BK7231N (Tuya QFN32)". Copy the encryption key if you plan on using it otherwise click 'skip'. Now you should see that device in the list; click on 'EDIT' just below and copy over the config with the one below. Make sure to update with your Wifi credentials and encryption key if using. Then click 'INSTALL' and then choose the 'Manual download' option. The reason for this is we need to use a special tool for the initial flash; ESPHome OTA updates will work as expected after the initial installation. Once it's compiled, select the top button to download the uf2 file.
4444

4545
Using a Windows computer, [download](https://github.com/libretiny-eu/ltchiptool/releases) and run LTCHIPTOOL and be sure you are on the 'Flashing' tab. Plug in your USB FTDI adapter and select it from the 'Device port' list, set the baud rate of 115200, and set the 'Chip family' to 'Beken 72xx'. It is recommended to read through the [Beken BK72xx](https://docs.libretiny.eu/docs/platform/beken-72xx/) info page to better understand the following steps.
4646

4747
## Dumping original firmware
4848

4949
If you'd like to dump the original firmware, obviously you need to do this before flashing. If you have no interest in ever returning to the stock firmware skip to the next section. In the 'Output file' box, select the location you would like to save the file to. Select "Read flash" and then click 'Start'. Now is when you need that jumper wire you attached to ground earlier. Use it to tap the CEN pin briefly while LTCHIPTOOL is trying to read the device. This will reboot the BK7231N where it very briefly goes into program mode before continuing to its regular routine. You should see the progress of the read begin. You may have to try this a couple times to get it right. It will take a minute or two to dowload the flash. If you'd like to download the ROM for whatever reason (contains the bootloader/download mode), you can also do that now using the same method but selecting 'Read ROM' before hitting 'Start' again.
5050

51-
## Installing ESPhome
51+
## Installing ESPHome
5252

5353
On the 'Flashing' tab within LTCHIPTOOL, choose 'Write flash / identify file' option and then browse to the uF2 file you compiled earlier and then press 'Start'. You will again need to tickle the CEN pin on the BK7231N module with your ground wire to get it to start flashing. Once it completes, it should reboot and join your WiFi network. You can now disconnect your temporary wire connections to the PCB, carefully reseat the PCB on to the pegs. Place the top cover back onto the base ensuring that the cord and outlet seals are all seated properly. Secure it all shut with the 6 screws and you're done!!
5454

0 commit comments

Comments
 (0)