Dave Williams | DitroniX | G8PUO
97 lines
4.4 KiB
Markdown
97 lines
4.4 KiB
Markdown
|
|
## Home Assistant Development and Integration
|
|
|
|
This repository is for integration of DitroniX boards into Home Assistant using the ESPHome Components.
|
|
|
|
The development and integration repository is work in progress as various projects evolve. It will also expand on route.
|
|
|
|
#### User contributions
|
|
|
|
User contributions to the HA integration is welcome and of course, acknowledgements would be included.
|
|
|
|
If you have a contribution, or example you wish to discuss, please feel free to contact me on support@ditronix.net
|
|
|
|
### How Does It Work?
|
|
|
|
Using Home Assistant, with integrated ESPHome, you are easily able to create a new 'Device', then flash the board so it will then appear in your Dashboard > Devices.
|
|
|
|
Home Assistant (ESPHome), devices use .yaml code, which is initially flashed to the board via USB cable.
|
|
|
|
Once flashed (so the board is 'talking' to Home Assistant'), you can then subsequently easily reflash to the board using OTA, Over-The-Air, via Wi-Fi. USB re-flashing remains an option if needed.
|
|
|
|
|
|
|
|
### Home Assistant (ESPHome) Devices
|
|
|
|
Home Assistant (ESPHome), uses '[Components](https://developers.home-assistant.io/docs/creating_component_code_review/)', which configures and tells Home Assistant about the device which you are trying to add.
|
|
|
|
Two 'flavours' of components are available (as far as I am aware):
|
|
* Internal Components (embedded into HA)
|
|
* External Components (This is a custom component, not currently embedded into HA)
|
|
|
|
### DitroniX Component Development
|
|
|
|
During DitroniX Home Assistant Code Development, the required device 'Component', is simply connected to the DitroniX git repository, as an external component.
|
|
|
|
|
|
You could of course, always 'clone' this component and make your own.
|
|
|
|
The below is an example of the source pointing to the git repository.
|
|
|
|
- source:
|
|
type: git
|
|
url: [https://github.com/DitroniX/Home-Assistant-Dev]
|
|
(https://github.com/DitroniX/Home-Assistant-Dev)
|
|
### Example of yaml code pasted in ESPHome
|
|
|
|
|
|
### Example of added Device Info
|
|
|
|
|
|
## Home Assistant - ESPHome Components
|
|
|
|
- [**ATM90E36**](https://github.com/DitroniX/Home-Assistant-Dev/tree/main/components/ATM90E36 "ATM90E36")
|
|
- This is the initial development component for use on the [EPEM ATM90E36](https://github.com/DitroniX/EPEM-Ethernet-Power-Energy-Monitor) Ethernet Power Energy Monitor
|
|
|
|
|
|
## Versions
|
|
|
|
|
|
260529 - Refresh Information
|
|
251217 - Initial upload of the ATM90E36 Component for EPEM E36. Could also be adapted for IPEM E36
|
|
|
|
|
|
## **Further Information**
|
|
|
|
Additional information, and other technical details on this project, maybe found in the related repository pages.
|
|
|
|
**Repository Folders**
|
|
|
|
- **Components** *(Code examples for Home Assistant - ESPHome)*
|
|
- **Datasheets and Information** *(Component Datasheets, Schematics, Board Layouts, Photos, Technical Documentation)*
|
|
|
|
**Repository Tabs**
|
|
|
|
- **Wiki** *(Related Repository Wiki pages and Technical User Information)*
|
|
- **Discussions** *(Related Repository User Discussion Forum)*
|
|
- **Issues** *(Related Repository Technical Issues and Fixes)*
|
|
|
|
***
|
|
|
|
We value our Customers, Users of our designs and STEM Communities, all over the World . Should you have any other questions, or feedback to share to others, please feel free to:
|
|
|
|
* Visit the related [Project](https://github.com/DitroniX?tab=repositories) *plus the related* **Discussions** and **Wiki** Pages. See tab in each separate repository.
|
|
* **Project Community Information** can be found at https://www.hackster.io/DitroniX
|
|
* [DitroniX.net Website - Contact Us](https://ditronix.net/contact/)
|
|
* **Twitter**: [https://twitter.com/DitroniX](https://twitter.com/DitroniX)
|
|
* [Supporting the STEM Projects - BuyMeACoffee](https://www.buymeacoffee.com/DitroniX)
|
|
* **LinkedIN**: [https://www.linkedin.com/in/g8puo/](https://www.linkedin.com/in/g8puo/)
|
|
|
|
***Dave Williams, Maidstone, UK.***
|
|
|
|
Electronics Engineer | Software Developer | R&D Support | RF Engineering | Product Certification and Testing | STEM Ambassador
|
|
|
|
## STEM
|
|
|
|
**Supporting [STEM Learning](https://www.stem.org.uk/)**
|