Skip to content

Commit e75d1fc

Browse files
committed
add migration guide
1 parent 56bb6fa commit e75d1fc

2 files changed

Lines changed: 19 additions & 0 deletions

File tree

MIGRATION.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Migration to v0.5 (HA v0.115)
2+
Before version 0.5 we used fixed network options, now we are using network options from the config.
3+
4+
If you want to upgrade from 0.4 to 0.5 you have two options:
5+
1. Repair you devices
6+
2. Add network options to config
7+
8+
```yaml
9+
zha:
10+
zigpy_config:
11+
network:
12+
channel: 11
13+
channels: [11]
14+
pan_id: 0x1A62
15+
extended_pan_id: "DD:DD:DD:DD:DD:DD:DD:DD"
16+
```

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ zigpy-cc allows Zigpy to interact with Texas Instruments ZNP (Zigbee Network Pro
1313

1414
The zigpy-cc library itself initially began as a code port from the [zigbee-herdsman](https://github.com/Koenkk/zigbee-herdsman/tree/v0.12.24) project (version 0.12.24) for the [Zigbee2mqtt](https://www.zigbee2mqtt.io/) project by Koen Kanters (a.k.a. Koenkk GitHub). The zigbee-herdsman library itself in turn was originally a fork and rewrite of the [zigbee-shepherd](https://github.com/zigbeer/zigbee-shepherd) library by the [Zigbeer](https://github.com/zigbeer) project. Therefore, if the upstream code improvements or bug-fixes gets commited to the [zigbee-herdsman](https://github.com/Koenkk/zigbee-herdsman) library then it could, in theory, also be possible to downport some or many of those upstream code improvements to this zigpy-cc library for its benifit.
1515

16+
## Migration to v0.5 (HA v0.115)
17+
See: [Migration guide](./MIGRATION.md)
18+
1619
## WARNING!!! - Work in progress
1720
Disclaimer: This software is provided "AS IS", without warranty of any kind. The zigpy-cc project is under development as WIP (work in progress), it is not fully working yet.
1821

0 commit comments

Comments
 (0)