search

itead / Sonoff_Zigbee_Dongle_Firmware

204 stars 22 forks source link

Propose adding firmware settings and changelog to README.md #16

Closed Hedda closed 1 year ago

Hedda commented 1 year ago

@Daniel-zhan-itead in the spirit of openness and helping the community it would be great if you look at this proposed example and improve it to add more detailed firmware settings/configuration and changelog to README.md as requested by dev in https://github.com/itead/Sonoff_Zigbee_Dongle_Firmware/issues/10

Please see these examples from some different but similar README.md files for community firmware build images as reference:

https://github.com/MattWestb/EFR32-FW/blob/main/Soff_EZSP/README.md

https://github.com/zha-ng/EZSP-Firmware/blob/master/Elelabs-ELU013/README.md

https://github.com/xsp1989/zigbeeFirmware/blob/master/firmware/Zigbee3.0_Dongle-NoSigned/EZSP/README.md

https://github.com/grobasoz/zigbee-firmware/blob/master/EFR32%20Series%202/EFR32MG21A020F1024/README.md

@Daniel-zhan-itead Also check out related discussions which have some questions about settings/configuration for Dongle-E:

https://github.com/grobasoz/zigbee-firmware/issues/28

https://github.com/xsp1989/zigbeeFirmware/issues/31

https://github.com/home-assistant/core/issues/82004

PS: ZHA and Zigbee2MQTT developers need to know all these settings and more for troubleshooting in order to rule out stuff.

Hedda commented 1 year ago

Example of more Ember configuration parameters which values in that firmware that can sometimes be useful when troubleshooting:

aioue commented 1 year ago

@guozi7788 @iteadsw please could we merge?

liangjia2019 commented 1 year ago

thanks you for submitting