mirror of
https://github.com/Koenkk/Z-Stack-firmware.git
synced 2024-09-27 11:32:36 +02:00
Update docs.
This commit is contained in:
Koen Kanters
parent
e58e911745
commit
6c564b2538
71
coordinator/README.md
Normal file
71
coordinator/README.md
Normal file
@ -0,0 +1,71 @@
|
||||
# Z-Stack coordinator firmwares
|
||||
This repository contains various Z-Stack coordinator firmwares.
|
||||
|
||||
## Overiew
|
||||
<table>
|
||||
<tr>
|
||||
<td><b>Z-Stack</b></td>
|
||||
<td><b>Device</b></td>
|
||||
<td><b>Zigbee</b></td>
|
||||
<td><b>Direct children</b></td>
|
||||
<td><b>Source routing</b></td>
|
||||
<td><b># of 3.0 devices</b></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="4">Z-Stack_Home_1.2</td>
|
||||
<td>CC2531</td>
|
||||
<td>1.2 HA</td>
|
||||
<td>25</td>
|
||||
<td>No</td>
|
||||
<td>-</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CC2530</td>
|
||||
<td>1.2 HA</td>
|
||||
<td>21</td>
|
||||
<td>No</td>
|
||||
<td>-</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CC2530 + CC2591</td>
|
||||
<td>1.2 HA</td>
|
||||
<td>21</td>
|
||||
<td>No</td>
|
||||
<td>-</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CC2530 + CC2592</td>
|
||||
<td>1.2 HA</td>
|
||||
<td>21</td>
|
||||
<td>No</td>
|
||||
<td>-</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Z-Stack_3.0.x</td>
|
||||
<td>CC2531</td>
|
||||
<td>3.0</td>
|
||||
<td>15</td>
|
||||
<td>No</td>
|
||||
<td>40</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Z-Stack_3.x.0</td>
|
||||
<td>CC2652R</td>
|
||||
<td>3.0</td>
|
||||
<td>TODO</td>
|
||||
<td>TODO</td>
|
||||
<td>TODO</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### Legend
|
||||
- *Z-Stack:* Z-Stack is the Zigbee stack for Texas Instruments Zigbee devices
|
||||
- *Device:* The Zigbee hardware
|
||||
- *Zigbee:* Zigbee version, for more information read [What's New in Zigbee 3.0](http://www.ti.com/lit/an/swra615/swra615.pdf)
|
||||
- *Direct children:* Number of children that directly can join the coordinator. Note that this is **not** the maximum network size. For more information, read [the Zigbee2mqtt FAQ about device limit](http://www.zigbee2mqtt.io/information/FAQ.html#i-read-that-zigbee2mqtt-has-a-limit-of-15-devices-is-this-true)
|
||||
- *Source routing:* Allows the coordinator to remember the routes to the devices. Improves performance for larger (40+ nodes) networks. For more information read [Large ZigBee Networks and Source Routing
|
||||
](http://cms.digi.com/resources/documentation/digidocs/90001537/references/r_large_zigbee_networks-source_routing.htm?TocPath=Working%20with%20Zigbee%7C_____14)
|
||||
- *# of 3.0 devices:* Number of Zigbee 3.0 devices that can join the network. Does not apply to Zigbee 1.2 coordinator (no limit).
|
||||
|
||||
## Compiling the firmware
|
||||
In case you want to compile the firmware yourself, you can find a `COMPILE.md` for each firmware.
|
||||
@ -1,2 +1,2 @@
|
||||
# 20190424
|
||||
# 20190425
|
||||
- Initial version.
|
||||
@ -8,14 +8,15 @@
|
||||
|
||||
## Compiling
|
||||
1. Copy `firmware.patch` to `Z-Stack 3.0.2`
|
||||
2. Open Git Bash, go to `Z-Stack 3.0.2` and apply the patch using `git apply firmware.patch`.
|
||||
2. Open Git Bash, go to `Z-Stack 3.0.2` and apply the patch using `git apply firmware.patch --ignore-space-change`.
|
||||
3. Open `Z-Stack 3.0.2\Projects\zstack\ZNP\CC253x\znp.eww` with IAR Embedded workbench for 8051.
|
||||
4. Select the correct target:
|
||||
- For CC2531 select *CC2531 - ZNP-with-SBL*
|
||||
- For CC2530 or CC2530_CC2591 select *CC2530 - ZNP-with-SBL*
|
||||
- For CC2530, CC2530_CC2591, CC2530_CC2592 select *CC2530 - ZNP-with-SBL* (not available yet)
|
||||
5. Right-click on your target and press options. Go to C/C++ compiler -> preprocessor. Depending on what you want to compile, add one of the following symbols to *Defined symbols*:
|
||||
- `FIRMWARE_CC2530` (TODO)
|
||||
- `FIRMWARE_CC2530_CC2531` (TODO)
|
||||
- `FIRMWARE_CC2530` (not available yet)
|
||||
- `FIRMWARE_CC2530_CC2591` (not available yet)
|
||||
- `FIRMWARE_CC2530_CC2592` (not available yet)
|
||||
- `FIRMWARE_CC2531`
|
||||
6. Go to General Options -> Stack/Heap -> Stack sizes -> and change `XDATA` to `0x400`.
|
||||
7. Press OK.
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
# Z-Stack 3.0.2 coordinator firmwares
|
||||
This directory contains CC2530 (TODO), CC2530_CC2591 (TODO) and CC2531 Z-Stack 3.0.2 coordinator firmware.
|
||||
|
||||
## Description
|
||||
This firmware supports Zigbee 3.0 and allows for 10 **directly** connected devices to the coordinator.
|
||||
|
||||
## Compiling the firmware
|
||||
In case you want to compile the firmware yourself, read [COMPILE.md](./COMPILE.md).
|
||||
@ -1,12 +0,0 @@
|
||||
# Z-Stack 3.10.00.53 coordinator firmwares
|
||||
This directory contains the CC2652R Z-Stack 3.10.00.53 coordinator firmware.
|
||||
|
||||
## Description
|
||||
- Zigbee 3.0
|
||||
- Allow for 30 **directly** connected devices
|
||||
- Allows for max 40 Zigbee 3.0 devices
|
||||
- MTO concentrator (stores up-to 100 routes to devices)
|
||||
- To be used with Zigbee2mqtt
|
||||
|
||||
## Compiling the firmware
|
||||
In case you want to compile the firmware yourself, read [COMPILE.md](./COMPILE.md).
|
||||
@ -1,3 +1,9 @@
|
||||
# 20190425
|
||||
- Unified firmwares, only one firmware for every device
|
||||
- Increased direct children to 25 for CC2531 and 21 for CC2530
|
||||
- Disabled source routing
|
||||
- Decreased XDATA size
|
||||
|
||||
# 20190315
|
||||
- Restructured repo
|
||||
- Added `MAX_STABILITY` firmware
|
||||
|
||||
@ -8,29 +8,16 @@
|
||||
|
||||
## Compiling
|
||||
1. Copy `firmware.patch` to `Z-Stack Home 1.2.2a.44539`
|
||||
2. Open Git Bash, go to `Z-Stack Home 1.2.2a.44539` and apply the patch using `git apply firmware.patch`.
|
||||
2. Open Git Bash, go to `Z-Stack Home 1.2.2a.44539` and apply the patch using `git apply firmware.patch --ignore-space-change`.
|
||||
3. Open `Z-Stack Home 1.2.2a.44539\Projects\zstack\ZNP\CC253x\znp.eww` with IAR Embedded workbench for 8051.
|
||||
4. You will get a warning: *The project file 'CC253(0/1).ewp' is in an old format. Would you like to convert it for use with this version?*. Press **yes** for both.
|
||||
5. Select the correct target:
|
||||
- For CC2531 select *CC2531 - X*
|
||||
- For CC2530, CC2530_CC2591, CC2530_CC2592 select *CC2530 - X*
|
||||
- Depending if you want to compile the `.hex` or SBL firmware select *- ProdHex* or *- ProdSBL*
|
||||
|
||||
|
||||
|
||||
6. Right-click on your target and press options. Go to C/C++ compiler -> preprocessor. Depending on what you want to compile, add the following symbols to *Defined symbols*:
|
||||
6. Right-click on your target and press options. Go to C/C++ compiler -> preprocessor. **Remove** all *Defined symbols* and depending on what you want to compile, add the following symbols to *Defined symbols*:
|
||||
- Device type: `FIRMWARE_CC2530`, `FIRMWARE_CC2530_CC2591`, `FIRMWARE_CC2531` or `FIRMWARE_CC2530_CC2592`
|
||||
- Firmware type: `FIRMWARE_DEFAULT`, `FIRMWARE_MAX_STABILITY` or `FIRMWARE_MAX_DEVICES`.
|
||||
- In case you want to compile the SBL firmware, also add `FIRMWARE_SBL`.
|
||||
|
||||
To compile e.g the default CC2531 firmware, use:
|
||||
```c
|
||||
FIRMWARE_CC2531
|
||||
FIRMWARE_DEFAULT
|
||||
```
|
||||
|
||||
*NOTE: `FIRMWARE_MAX_DEVICES` is only available in combination with `FIRMWARE_CC2531`.*
|
||||
|
||||
7. Press OK.
|
||||
8. Right-click on your target and click *Rebuild all*.
|
||||
9. Once finished, you can find the `CC253(0|1)ZNP-Prod.(hex|bin)` file in `Z-Stack Home 1.2.2a.44539\Projects\zstack\ZNP\CC253x\dev`.
|
||||
|
||||
@ -1,25 +0,0 @@
|
||||
# Z-Stack 1.2.2.a.44539 coordinator firmwares
|
||||
This directory contains various CC2530, CC2530_CC2591 and CC2531 coordinator firmwares. There are 3 flavours available: `DEFAULT`, `MAX_DEVICES` and `MAX_STABILITY`.
|
||||
|
||||
## What firmware to choose?
|
||||
As mentioned above, there are 3 different kind of flavours to choose from. What firmware to choose highly depends on what Zigbee network you are planning to use it with. If you don't know what to choose, it's good to start with the `DEFAULT` firmware. Later you can always reflash your device with a different firmware.
|
||||
|
||||
In order to make a good choice, it's recommended to first read [the Zigbee2mqtt FAQ about device limit](http://www.zigbee2mqtt.io/information/FAQ.html#i-read-that-zigbee2mqtt-has-a-limit-of-15-devices-is-this-true) and [Zigbee network](http://www.zigbee2mqtt.io/information/zigbee_network.html).
|
||||
|
||||
### Default
|
||||
- Allows for 15 **directly** connected devices to the coordinator
|
||||
- Should be fine for networks till +- 30/35 devices.
|
||||
|
||||
### Max stability
|
||||
- Allows for 5 **directly** connected devices to the coordinator
|
||||
- Reported to work fine for 50+ devices (limit not known yet)
|
||||
- Should be used when experiencing stability issues with the `DEFAULT` firmware.
|
||||
|
||||
### Max devices
|
||||
- Allows for 44 **directly** connected devices to the coordinator
|
||||
- Should only be used when:
|
||||
- All devices will be in close range of the coordinator
|
||||
- You won't have routers in your network (or almost none)
|
||||
|
||||
## Compiling the firmware
|
||||
In case you want to compile the firmware yourself, read [COMPILE.md](./COMPILE.md).
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 18 KiB |
Loading…
Reference in New Issue
Block a user