aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorKaufman Home Automation <[email protected]>2023-05-23 09:37:54 -0700
committerGitHub <[email protected]>2023-05-23 09:37:54 -0700
commitd55a1c0f36823c1b219dcd1aa18ed0e1b0666625 (patch)
tree3280dba08a951cc31c44f9a733e2d3084ee9c67d
parenta3e6206fd729276c820d17afb6012cd8a7aea981 (diff)
downloadPLF12-d55a1c0f36823c1b219dcd1aa18ed0e1b0666625.tar.gz
PLF12-d55a1c0f36823c1b219dcd1aa18ed0e1b0666625.zip
binary size error info
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
index 176c26a..3b2deab 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,18 @@ packages:
wifi:
ssid: !secret wifi_ssid
password: !secret wifi_password
+
+##########################
+## Re: Binary Size Error
+## ESPHome now adds API encryption by default. When the plug firmware is compiled, API encrytion
+## makes the binary file too big to OTA update. We recommend that you remove API encryption
+## by commenting out or removing the following lines to allow easy OTA. Otherwise, you can keep API
+## encryption by changing the package line above to kauf-plf12-minimal.yaml as an intermediate
+## firmware before immediately switching back to kauf-plf12.yaml.
+##########################
+# api:
+# encryption:
+# key: ...
```
## Repo Contents
@@ -123,6 +135,19 @@ Holding the plug's button for 30 seconds will clear any programmed Wi-Fi credent
## Troubleshooting
+### Binary Size Error
+
+ESPHome began adding API encryption by default, which makes the plug binary files too big to OTA update. If you are getting the message `ERROR Error binary size: Error: ESP does not have enough space to store OTA file. Please try flashing a minimal firmware (remove everything except ota)`, then you need to remove API encryption by commenting it out or deleting the following lines:
+
+```
+# api:
+# encryption:
+# key: ...
+```
+If you want to keep API encryption, you can flash first with the kauf-plf12-minimal.yaml file each time you need to update or upgrade, and then revert back to the kauf-plf12.yaml.
+
+### Additional Troubleshooting
+
General troubleshooting ideas applicable to all products are located in the [Common repo's readme](https://github.com/KaufHA/common/blob/main/README.md#troubleshooting).
## Recommended Tasmota Template