zigpy / bellows

A Python 3 project to implement EZSP for EmberZNet devices
GNU General Public License v3.0
177 stars 86 forks source link

Move bellows CLI instructions from README.md to seperate CLI.md or TOOLS.md file? #613

Open Hedda opened 4 months ago

Hedda commented 4 months ago

Suggest moving bellows CLI instructions from its README.md file to a separate CLI.md or TOOLS.md file similar to the zigpy-znp project:

https://github.com/zigpy/zigpy-znp/blob/dev/TOOLS.md

Maybe also add more clarifying comments that CLI functionalities (like ZCL, ZDO, network formation tools, backups, etc.) are deprecated in bellows as they been moved to the main zigpy library and to zigpy-cli as part of refactoring to be reimplemented and maintained there now instead?

This is related to several questions over the years about using radio libraries as stand-alone libs or a CLI tools without zigpy or zigpy-cli.

https://github.com/zigpy/bellows/blob/dev/README.md#project-status

That includes NVRAM Backup and restore:

https://github.com/zigpy/bellows/blob/dev/README.md#nvram-backup-and-restore

This is especially understandable if someone happens to stumble on this library named "bellows" when looking for EmberZNet Zigbee:

https://github.com/zigpy/bellows/blob/dev/README.md

PS: Regardless, it should probably be further clarified in README.md for bellows that it is no longer meant to be used stand-alone.

https://github.com/zigpy/bellows/blob/dev/README.md#bellows

The project can be used as a stand-alone library, however, the main goal of this project is to add native support for EmberZNet Zigbee radio based USB stick devices (a.k.a. "Ember" and "Mighty Gecko" based adapters/dongles/modules) to Home Assistant's built-in ZHA (Zigbee Home Automation) integration component, allowing Home Assistant with such hardware to nativly support direct control of compatible Zigbee devices, such as; Philips HUE, GE, Ledvance, Osram Lightify, Xiaomi/Aqara, IKEA Tradfri, Samsung SmartThings, and many more.