[C201] Firmware update instructions for ZHA

[C201] Firmware update instructions for ZHA



Warning
Please note these instructions are currently for ZHA only.
If your date code is 20241020, 20240813 or 20230824 and you're using ZHA you do not need to do this update.
You should not attempt this update unless your batch # and date code aren't in the table below.
Alert
The most up to date firmwares have Date Codes: 20230828, 20240813 or 20241020.
The most up to date sw build id is 1.04 for 20230828, 1.20 for 20240813 and 1.30 for 20241020.

Compatible devices

To check whether your device is compatible with the firmware update, you will need to check the firmware date code of your switch, and also the “#” number on the back of the switch.

If your "#" number and firmware date code is in the table then your dimmer is unfortunately not compatible.


# Number
Firmware Date Code
Compatibility
1-6
All
Not compatible
7
20230401
Not compatible
8
20230401
Not compatible

Instructions

  1. Check the # number on the back of the switch.
  2. Check firmware date of your Candeo device:
    1. Device Info
    2. 3 dot menu
    3. Manage Zigbee Device
    4. Clusters should be left as "Basic"
    5. Attributes section:
      1. Attributes of the selected cluster, choose date_code
    6. READ ATTRIBUTE
  3. If the combination of the date code of your device and # number is not in the above table, please proceed with this firmware upgrade. Otherwise do not proceed.
  4. To proceed create a folder in your “config” folder, for the OTA firmware file. In this example we will call the folder "zhaota".
  5. Add the following lines to your configuration.yaml file, or edit the zha ota section:

    zha:
      custom_quirks_path: /config/zha_quirks/
     
      zigpy_config:
        ota:
          extra_providers:
            - type: advanced
              warning: I understand I can *destroy* my devices by enabling OTA updates from
                files. Some OTA updates can be mistakenly applied to the wrong
                device, breaking it. I am consciously using this at my own risk.
              path: /config/zhaota
     
    logger:
      default: info
      logs:
        homeassistant.components.zha: debug
        zigpy: debug

  6. Restart HA
  7. Copy the attached firmware OTA file into your otau directory (/config/zhaota)
  8. Power off the dimmer at the mains for 30 minutes
  9. After turning it on again ZHA should recognise the firmware update. You should see a notification number next to "Settings"
  10. Click "Settings"
  11. Click the notification at the top of the page
  12. Click “Update Firmware”.
  13. After the progress bar hits 100%, close the dialogue box.
  14. Remove the dimmer from Home Assistant, perform a factory reset and pair it again.
  15. Check the firmware has succeeded:
    1. Go to the dimmers device page
    2. Under device info, click the 3 dots.
    3. Click “Manage Zigbee device”
    4. Clusters should be left as "Basic"
    5. Attributes section:
      1. Attributes of the selected cluster, choose sw_build_id
    6. Read Attribute.
    7. The value should be 1.30
Warning
IMPORTANT
We recommend you delete or at least comment out the OTA code added to your configuration.yaml file. Commenting out can be done by putting a # in front of the code lines. If you are using our ZHA quirks you must leave the ZHA quirks code in.

New features

This firmware  has the same functionality as the firmware with date code 20230824 and 20240813.
If you are updating from 20220531, 20230401, 20230318, 20230401 you will also get the additional features below:

On Level:
  • Compatible with ZHA only.
  • Allows you to set a predetermined level at which the lights come on, when using smart controls.
  • Not applicable for physical interaction. i.e. On Level setting is ignored if you use the knob on the switch.
  • To continue to use the last setting (the brightness level at which the lights were turned off), set to 255.

Start Up Behaviour (or Power On Behaviour):

  • Compatible with ZHA and zigbee2mqtt.
  • Allows you to set the behaviour in the event of a power restore e.g. After a power cut.
  • Available settings: On, Off, Previous Value.

Start Up Current Level:

  • Allows you to set the level at which the lights come on in the event of a power restore – if using “On” in Start Up Behaviour.
  • Set to 255 for Previous Value.