Skip to content

Latest commit

 

History

History
97 lines (57 loc) · 8.17 KB

README.md

File metadata and controls

97 lines (57 loc) · 8.17 KB
Raw

common

This repo contains common files generally usable by any KAUF product.

components directory - Custom components needed to compile KAUF firmwares. These don't need to be downloaded, the yaml files automatically grab them by reference to this github repo. Every subfolder not starting with kauf_* is copied from stock ESPHome and edited for our products. Except that the ddp directory is a new component we wrote and are trying to get put into ESPHome.

esphome-webserver directory - "fork" of the esphome/esphome-webserver repo used to generate custom web_server and captive_portal pages.

HTTP API

Our products use ESPHome's HTTP API, documented here: https://esphome.io/web-api/index.html

Some example curl commands to utilize the HTTP API are shown below. You'll need to change the IP address to that of the device you are trying to control. If you flash your own custom firmware and change the name, then the name will need to be changed accordingly as well.

  • Turn on plug:
    • curl -X POST "https://192.168.1.16/switch/kauf_plug/turn_on"
  • Turn off plug:
    • curl -X POST "https://192.168.1.16/switch/kauf_plug/turn_off"
  • Turn on light to RGB mode and set color:
    • curl -X POST "https://192.168.1.16/light/kauf_bulb/turn_on?color_mode=rgb&r=255&g=255&b=0"
  • Turn on light to color temp mode and set temp in mired (integer from 150-350):
    • curl -X POST "https://192.168.1.16/light/kauf_bulb/turn_on?color_mode=color_temp&color_temp=250"
  • Turn on light and set brightness (integer from 1-255):
    • curl -X POST "https://192.168.1.16/light/kauf_bulb/turn_on?brightness=150"
  • Turn off light:
    • curl -X POST "https://192.168.1.16/light/kauf_bulb/turn_off"

In addition you can flash a firmware with the following curl command. Sometimes this works better than going through a web browser.

curl -v -X POST -H "Content-Type: multipart/form-data" -F update=@firmware_filename.bin.gz "https://192.168.1.16/update"

Troubleshooting

Binary Size Error

ESPHome began adding API encryption by default, which makes most of our binary files too big to OTA update our devices. 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 might try flashing first with the *-minimal.yaml, and then reverting back to the main yaml with API encryption.

Other Issues Building Firmware in ESPHome Dashboard

Any build errors can usually be resolved by upgrading the ESPHome dashboard to the latest version. On the days when ESPHome updates are released, it may take us up to 24 hours to make necessary changes to our custom components during which time you may see build errors with the new version. Please be patient.

If you are still getting errors after upgrading the ESPHome dashboard to the latest version, try cleaning build files for the device and manually deleting the .esphome/packages and .esphome/external_components subfolders from within the ESPHome config directory. As a last resort, you can try using our lite or minimal yaml files instead of the default package files.

If you are stuck on ESPHome version 2022.3.1, you need to uninstall the Home Assistant Add-On, then reinstall using the Official Add-On Repo.

Device Not Being Detected by Home Assistant

The ESPHome integration in Home Assistant requires that zeroconf be enabled to automatically detect ESPHome devices on the network. Zeroconf is enabled by default, but may not be enabled if you are not using the default config. Add zeroconf: to your configuration.yaml file to enable zeroconf.

You can also manually add a device to Home Assistant once the device is connected to Wi-Fi on the same network as your Home Assistant server. You will need to figure out the IP address of the device by logging into your router or by using a network scanning app.

From Home Assistant’s Integrations configuration page, press the add integration button (marked 1 in the figure), and then select ESPHome (2). Enter the IP address of the device in the resulting popup (3).

Can’t Connect to Device’s WiFi AP

If you see a device’s WiFi AP being broadcast, but are having trouble connecting, there is another option. Each KAUF device is pre-programmed to try to connect to a WiFi network with the SSID being either initial_ap or initial_ap2, and the password being asdfasdfasdfasdf. Currently, initial_ap is more likely to be right. If you set up a temporary WiFi network with those credentials, the plug or bulb will connect to it instead of broadcasting its own AP. Then you can simply determine the IP address of the device, browse to the IP address, and flash a new firmware from there. Either Tasmota or your own build of ESPHome with your local network credentials built in would work.

Not Seeing a Device’s WiFi AP

If you are not seeing a device broadcast a WiFi AP as it should, there are ways to re-enable the WiFi AP that may work.

Latest Updates: If the device has a button, holding the button for 30 seconds will clear the current Wi-Fi credentials and cause the device to put its Wi-Fi AP back up. For bulbs, power cycling 5 times in row with the bulb having power from between 2-10 seconds each time will do the same. The bulb will turn on yellow 3 times in a row, and then turn on red when the credentials are cleared.

Older Firmware: For the bulbs, you have to power cycle the bulb without the bulb connecting to WiFi. Let the bulb power on for at least 10-15 seconds before removing power. After powering up a second time, the WiFi AP will be re-enabled. For the plug, hold down the button for at least 5 seconds and the plug will reboot with the WiFi AP enabled. If the device is connecting to your local WiFi network, then these procedures will not work. You will need to clear the existing credentials by pressing the “Clear WiFi Credentials” button. This can be done by browsing to the device’s IP address in a web browser.

Captive Portal not Showing SSID and Password Fields

When you are connected to a KAUF product’s WiFi AP, you should be able to access a captive portal web page with fields to enter your local network’s WiFi SSID and Password. In some cases, typically if there are an extreme number of networks found, the page may not fully load and the fields to enter your credentials won’t be displayed. The following URL can be used to configure WiFi credentials if you are connected to the KAUF WiFi AP but the captive portal web page is not loading properly. Replace YOUR_SSID with your local network’s WiFi SSID and replace YOUR_PASSWORD with your local network’s WiFi password.

https://192.168.4.1/wifisave?ssid=YOUR_SSID&psk=YOUR_PASSWORD

To configure credentials from a Linux command line, use the curl command like so:

curl 'https://192.168.4.1/wifisave?ssid=YOUR_SSID&psk=YOUR_PASSWORD'

Device not Connecting to Wi-Fi Network with Hidden SSID

ESPHome requires the fast_connect option to be enabled in order to connect to hidden networks. Some of our devices are still shipping with older firmware versions that did not have fast_connect enabled. If you want to connect a device to a Wi-Fi network with a hidden SSID, you may need to connect to a different network first to update the bulb.

Device-Specific Troubleshooting

Some device repos have troubleshooting tips specifically for those devices: