Readme with firmware files

[dmulcahey]

Please add readme files with each image that contain all of the settings in the firmware that you have modified. It is very challenging to support all of the issues from your products without this information.

[Hedda]

FYI there is a related discussion in grobasoz/zigbee-firmware#28 with some info from Daniel-zhan-itead about the config they use.

Please add readme files with each image that contain all of the settings in the firmware that you have modified.

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 can you maybe at least confirm ZBDongle-E Configuration Parameter values Table that was posted there?

Configuration Parameter	Value
EMBER_APS_UNICAST_MESSAGE_COUNT	32
EMBER_PACKET_BUFFER_COUNT	250
EMBER_NEIGHBOR_TABLE_SIZE	26
EMBER_SOURCE_ROUTE_TABLE_SIZE	200
EMBER_ADDRESS_TABLE_SIZE	32

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

• EMBER_APS_UNICAST_MESSAGE_COUNT
• EMBER_SOURCE_ROUTE_TABLE_SIZE
• EMBER_ROUTE_TABLE_SIZE
• EMBER_ADDRESS_TABLE_SIZE
• EMBER_PACKET_BUFFER_COUNT
• EMBER_NEIGHBOR_TABLE_SIZE
• EMBER_APS_ACK_TIMEOUT
• EMBER_TRUST_CENTER_ADDRESS_CACHE_SIZE
• EMBER_MULTICAST_TABLE_SIZE
• EMBER_MAX_END_DEVICE_CHILDREN
• EMBER_CTUNE_VALUE
• EMBER_SUPPORTED_NETWORKS
• EMBER_BINDING_TABLE_SIZE
• EMBER_MAX_END_DEVICE_CHILDREN

[akauppi]

@dmulcahey wrote:

Please add readme files with each image that contain all of the settings in the firmware that you have modified. It is very challenging to support all of the issues from your products without this information.

I can provide such a table of settings, by:

• flashing a spare E dongle I happen to have
• using the universal-silabs-flasher utility

Today, I used this to write down the factory configs just-in-case:

$ universal-silabs-flasher --device /dev/ttyACM0 probe` command
[...]
INFO Dumping EmberZNet Config
CONFIG_PACKET_BUFFER_COUNT=250
CONFIG_NEIGHBOR_TABLE_SIZE=26
CONFIG_APS_UNICAST_MESSAGE_COUNT=32
CONFIG_BINDING_TABLE_SIZE=32
CONFIG_ADDRESS_TABLE_SIZE=32
CONFIG_MULTICAST_TABLE_SIZE=8
CONFIG_ROUTE_TABLE_SIZE=16
[...]
CONFIG_NEW_BROADCAST_ENTRY_THRESHOLD=29
CONFIG_TRANSIENT_KEY_TIMEOUT_S=300
CONFIG_BROADCAST_MIN_ACKS_NEEDED=255
CONFIG_TC_REJOINS_USING_WELL_KNOWN_KEY_TIMEOUT_S=300
CONFIG_CTUNE_VALUE=133
CONFIG_ASSUME_TC_CONCENTRATOR_TYPE=1

Are these the kind of configs you mean? If so, we can likely just extract them from the .gbl without even needing to flash.

[dmulcahey]

@dmulcahey wrote:

Please add readme files with each image that contain all of the settings in the firmware that you have modified. It is very challenging to support all of the issues from your products without this information.

I can provide such a table of settings, by:

• flashing a spare E dongle I happen to have
• using the universal-silabs-flasher utility

Today, I used this to write down the factory configs just-in-case:

$ universal-silabs-flasher --device /dev/ttyACM0 probe` command
[...]
INFO Dumping EmberZNet Config
CONFIG_PACKET_BUFFER_COUNT=250
CONFIG_NEIGHBOR_TABLE_SIZE=26
CONFIG_APS_UNICAST_MESSAGE_COUNT=32
CONFIG_BINDING_TABLE_SIZE=32
CONFIG_ADDRESS_TABLE_SIZE=32
CONFIG_MULTICAST_TABLE_SIZE=8
CONFIG_ROUTE_TABLE_SIZE=16
[...]
CONFIG_NEW_BROADCAST_ENTRY_THRESHOLD=29
CONFIG_TRANSIENT_KEY_TIMEOUT_S=300
CONFIG_BROADCAST_MIN_ACKS_NEEDED=255
CONFIG_TC_REJOINS_USING_WELL_KNOWN_KEY_TIMEOUT_S=300
CONFIG_CTUNE_VALUE=133
CONFIG_ASSUME_TC_CONCENTRATOR_TYPE=1

Are these the kind of configs you mean? If so, we can likely just extract them from the .gbl without even needing to flash.

All of that + anything else you have changed from defaults in the firmware. Things like receive buffer size, or anything else that you may have changed.

Thanks!!

[lure23]

So... if that's useful, you can provide me the firmware URLs you are interested in and I'll make the tables. Reach me at the Zigbee2mqtt Discord as "asko".