search

zigpy / zigpy-znp

TI CC2531, CC13x2, CC26x2 radio support for Zigpy and ZHA
GNU General Public License v3.0
145 stars 40 forks source link

Update README.md with beginner instructions for NVRAM backup and restore #66

Closed Hedda closed 3 years ago

Hedda commented 3 years ago

Update README.md for zigpy-znp with beginner oriented instructions for NVRAM backup and restore for both Windows, Linux and macOS.

Reason for this is feedback about TI NVRAM backup and restore from discussion in https://community.home-assistant.io/t/zzh-short-for-zig-a-zig-ah-open-source-hardware-licensed-zigbee-usb-stick-based-on-ti-cc2652r/195064

PS: Text credit for most of those beginner friendly instructions goes to omerk as copied much from his electrolama zig-a-zig-ah project here https://electrolama.com/projects/zig-a-zig-ah/

tube0013 commented 3 years ago

FYI @walthowd created a docker image with everything installed and ready to go. https://github.com/walthowd/znp-firmware

MattWestb commented 3 years ago

How do one novice MAC / Window user coming to the:

(venv) $

And the "Then from the same command-line/prompt run the command sudo pip3 install pyserial intelhex or pip3 install pyserial intelhex from Windows." shall not being executed in the in the virtual environment or not ??

puddly commented 3 years ago

You only need to make a virtual environment if you don't have global write permissions or don't want to pollute your global Python packages directory. You can similarly run pip install --user ... but that has similar dependency issues so the virtual env is preferred.

Once you enter the virtual env (source bench/bin/activate and venv\Scripts\activate.bat or something on windows), just run pip install zigpy-znp. There is no need to download any ZIP files or install any other packages manually.

MattWestb commented 3 years ago

I have struggling around and getting it working but if one user dont have coming so long in the evolution its better not writing the(venv) $ or writing the command to getting / installing it.

I was only thinking the level of one guide shall not being to low and also not to high but enough for one "normal" user to do the thing that is described.

Or writing one real guide in the Zigpy (-ZNP) Wiki and linking to it from the main Zigpy-ZNP page. Then the Zigpy-ZNP is being less crowded and the user can easy finding the information then its need it.

I have putting little information on https://github.com/zigpy/zigpy/wiki/Coordinator-Firmware-Updates#instructions-for-znp-radios but i only have 2 CC2531 and is normally not using them but some with more deep knowledge and experience need putting the right information for TIs coordinators there.

puddly commented 3 years ago

I will make a detailed wiki entry later then for installing everything. If there is too much information in the README, nobody reads it...

MattWestb commented 3 years ago

Thats i like !!! The Zigpy is needing the same more deep in the Wiki and only "orientation" on the main page. One example from the Zigpy is all info of firmware its enough saying "see Wiki for dialed information for your (perhaps)supported device" and linking the right wiki page / section.

codecov-io commented 3 years ago

Codecov Report

Merging #66 (c2117c8) into dev (4b11545) will increase coverage by 0.00%. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##              dev      #66   +/-   ##
=======================================
  Coverage   98.86%   98.86%           
=======================================
  Files          37       38    +1     
  Lines        3255     3260    +5     
=======================================
+ Hits         3218     3223    +5     
  Misses         37       37
Impacted Files Coverage Δ
zigpy_znp/__init__.py 100.00% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 4b11545...c2117c8. Read the comment docs.

Hedda commented 3 years ago

I will make a detailed wiki entry later then for installing everything. If there is too much information in the README, nobody reads it...

That sounds better! I think unified radio command line interface unified like https://github.com/zigpy/zigpy/issues/557 will make make documentating simpler.

puddly commented 3 years ago

High-level network backups are currently functional and replace NVRAM backups, as they contain effectively the same data but in a firmware-agnostic format.

I've added platform-specific installation instructions for getting zigpy-znp running and added more info about both NVRAM and network backups to a separate TOOLS.md document: https://github.com/zigpy/zigpy-znp/blob/dev/TOOLS.md#backup-and-restore

MattWestb commented 3 years ago

Updating the Wiki with the new recommendations ? https://github.com/zigpy/zigpy/wiki/Coordinator-Backup-and-Migration And its one link there 2 https://github.com/zigpy/zigpy/wiki/Coordinator-Firmware-Updates#instructions-for-znp-radios

And ass normal great work done but i have not "finding" one new ZCL V8 for you ;-)