Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jkfran/lanbonhaintegration

Custom integration for Home Assistant that provides MQTT-based discovery and control for LANBON switches
https://github.com/jkfran/lanbonhaintegration

Last synced: about 1 month ago
JSON representation

Custom integration for Home Assistant that provides MQTT-based discovery and control for LANBON switches

Awesome Lists containing this project

README 

        
# LanbonHAIntegration



**LanbonHAIntegration** is a custom integration for [Home Assistant](https://www.home-assistant.io/) that supports automatic discovery and control of LANBON devices using MQTT. Designed for all LANBON devices that can connect to an MQTT server, this integration includes a workaround for the known issue with 4-gang switch models (`L8-HS4`).



---



## Features



- **Automatic Device Discovery**: Seamlessly detects LANBON devices connected via MQTT and adds them to Home Assistant.

- **Broad Compatibility**: Supports all LANBON devices configurable to work with an MQTT server.

- **4-Gang Switch Fix**: Resolves a hardware issue with the `L8-HS4` model, ensuring reliable management of `gang4` switches by momentarily toggling `gang1`.

- **State Persistence**: Stores device configurations and topics for consistent operation after Home Assistant restarts.

- **State Synchronization**: Automatically requests device states at startup to ensure synchronization.



---



## Installation



### HACS Installation (Recommended)



1. Open the HACS panel in Home Assistant.

2. Click on the `Integrations` tab and then click `+ Explore & Download Repositories`.

3. Search for `LanbonHAIntegration` and install the integration.

4. Restart Home Assistant.



### Manual Installation



1. Download the latest release from the [Releases](https://github.com/your-username/LanbonHAIntegration/releases) page.

2. Extract the files to the `custom_components/lanbon_switch` directory in your Home Assistant configuration folder.

3. Restart Home Assistant.



---



## Configuration



This integration requires no manual configuration for discovery. LANBON devices will automatically appear in Home Assistant once connected to the MQTT server.



### MQTT Configuration for LANBON Devices



Ensure your LANBON devices are configured to publish MQTT messages with the following topic structure:



```

homeassistant//switch//state

```



Example:



- **State Topic**: `homeassistant/D6925E1A7741/switch/08F9E003F138-01/state`

- **Command Topic**: `homeassistant/D6925E1A7741/switch/08F9E003F138-01/set`



---



## Known Issues



### 4-Gang Switch Fix (`L8-HS4`)



- Due to hardware constraints, controlling `gang4` requires temporarily toggling `gang1`. This workaround ensures `gang4` operates correctly without impacting the rest of the device's functionality.



---



## Troubleshooting



### Devices Not Detected



- Confirm that your LANBON devices are publishing MQTT messages using the correct topic format.

- Check the MQTT broker logs to ensure messages are being received.

- Restart Home Assistant to force a discovery sync.



### Incorrect or Missing States



- Verify that the devices are powered on and correctly configured.

- Check the `state` topic for accurate status updates.



---



## Contributing



Contributions are welcome! If you encounter issues or have feature requests, feel free to open an issue or pull request in the [GitHub repository](https://github.com/your-username/LanbonHAIntegration).



---



## License



This project is licensed under the [MIT License](LICENSE).



---



## Acknowledgments



- Thanks to the Home Assistant and MQTT communities for providing inspiration and support.

- Inspired by the need for reliable integration of LANBON devices into smart home setups.