Conversation
|
Thanks, readme could always be improved.
The partitions.csv is needed. You will get a validation error if it is not correct.
I think it is up-to-date. Please remove the batches on top, two are useless anyway and the 3rd is not really helping. |
Removed GitHub badges from README and added important documentation about the mandatory partitions_zb.csv file that must be included in ESP32 configurations when using this component. The new section explains that this file is required for proper Zigbee operations and can be found in the component directory, defining the memory partitions needed for Zigbee functionality.
|
Thanks! I've updated removing the badges and referring to the csv file! Let me know if you find anything else that can be improved! |
luar123
left a comment
luar123
left a comment
There was a problem hiding this comment.
Overall looks nice, just some information got lost. Can you include the missing pieces?
| ### ToDo List (Short-Mid term) | ||
| * Light effects (through identify cluster commands) | ||
| * more components to support basic mode | ||
|
|
||
| ### Not planed (feel free to submit a PR) | ||
| * Coordinator devices | ||
| * Binding config in yaml | ||
| * Reporting config in yaml | ||
| * Control device support like switches ([workaround](https://github.com/luar123/zigbee_esphome/discussions/18#discussioncomment-11875376)) |
| ## Basic Mode | ||
|
|
||
| ### Basic mode | ||
| By adding `components: all` the endpoint definition is generated automatically. Currently sensor, binary_sensor, light and switch components are supported. Because this is an external component the whole implementation is a bit hacky and likely to fail with some setups. Also it is not possible to tweak the generated definitions. Each entity creates a new endpoint. Lights are using the light clusters, switches on_off or binary_output clusters, binary sensors using binary_input clusters and sensors are using either special clusters (e.g. temperature) or analog_input clusters. For sensors also the unit/type is set. Please note that these definitions are not complete. Feel free to open an issue or pull request (see zigbee_ep.py) |
There was a problem hiding this comment.
Please also keep the second half of this paragraph.
There was a problem hiding this comment.
You mean "Also it is not possible to tweak the generated definitions. Each entity creates a new endpoint. Lights are using the light clusters, switches on_off or binary_output clusters, binary sensors using binary_input clusters and sensors are using either special clusters (e.g. temperature) or analog_input clusters. For sensors also the unit/type is set. Please note that these definitions are not complete. Feel free to open an issue or pull request (see zigbee_ep.py)"?
2 participants
Hello!
I was looking for something for using ESP Home with zigbee, I found out this repository which was kinda easy to include and build with it, but it was kinda of a exploration of the readme and the example. I'd like to submit a pull request to enhance the readability of the README while preserving all the original information (to the best of my understanding).
Before proceeding, I have a few questions to ensure the changes align with the project's goals:
Thank you for your excellent work on this project! I was also curious—did you consider submitting a feature proposal to the original ESP Home project for Zigbee integration?
Cheers