Can't update Ikea Styrbar 1.0.024 to latest version

[DutchCoban]

What happened?

When using the OTA functionality Zigbee2MQTT concludes that the version 1.0.024 is newer than the firmware available online 2.4.5, so it won't update the device.

I've tried forcing the update, but that didn't work. To accomplish that I've renamed the index.json from pull request Koenkk/zigbee-OTA#340 to my_index.json and put it in \config\zigbee2mqtt in Home Assistant and entered /config/zigbee2mqtt/my_index.json in Zigbee2MQTT as the OTA index override file name.

What did you expect to happen?

I would have liked the device to update to the latests firmware.

How to reproduce it (minimal and precise)

Press "Check for new updates" on a Ikea Styrbar in the OTA-menu.

Zigbee2MQTT version

1.32.2-dev commit: 68ec507

Adapter firmware version

20220928

Adapter

CC2652RB

Debug log

info 2023-08-03 22:04:53: Checking if update available for 'Drukknop voordeur'
info 2023-08-03 22:04:53: MQTT publish: topic 'zigbee2mqtt/bridge/log', payload '{"message":"Checking if update available for 'Drukknop voordeur'","meta":{"device":"Drukknop voordeur","status":"checking_if_available"},"type":"ota_update"}'
debug 2023-08-03 22:04:53: Check if update available for '0x540f57fffe8f81f0' (Remote Control N2)
debug 2023-08-03 22:04:53: Using endpoint '1'
debug 2023-08-03 22:04:54: Received Zigbee message from 'Drukknop voordeur', type 'commandOff', cluster 'genOnOff', data '{}' from endpoint 1 with groupID 0
info 2023-08-03 22:04:54: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur', payload '{"action":"off","battery":100,"last_seen":"2023-08-03T22:04:54+02:00","linkquality":36,"update":{"installed_version":65572,"latest_version":581,"state":"idle"},"update_available":false}'
info 2023-08-03 22:04:54: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur', payload '{"action":"","battery":100,"last_seen":"2023-08-03T22:04:54+02:00","linkquality":36,"update":{"installed_version":65572,"latest_version":581,"state":"idle"},"update_available":false}'
info 2023-08-03 22:04:54: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur/action', payload 'off'
debug 2023-08-03 22:04:54: Received Zigbee message from 'Drukknop voordeur', type 'commandOff', cluster 'genOnOff', data '{}' from endpoint 1 with groupID 0
info 2023-08-03 22:04:54: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur', payload '{"action":null,"battery":100,"last_seen":"2023-08-03T22:04:54+02:00","linkquality":36,"update":{"installed_version":65572,"latest_version":581,"state":"idle"},"update_available":false}'
debug 2023-08-03 22:04:56: Received Zigbee message from 'Drukknop voordeur', type 'commandTradfriArrowSingle', cluster 'genScenes', data '{"value":256,"value2":13}' from endpoint 1 with groupID 0
info 2023-08-03 22:04:56: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur', payload '{"action":"arrow_right_click","battery":100,"last_seen":"2023-08-03T22:04:56+02:00","linkquality":36,"update":{"installed_version":65572,"latest_version":581,"state":"idle"},"update_available":false}'
info 2023-08-03 22:04:56: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur', payload '{"action":"","battery":100,"last_seen":"2023-08-03T22:04:56+02:00","linkquality":36,"update":{"installed_version":65572,"latest_version":581,"state":"idle"},"update_available":false}'
info 2023-08-03 22:04:56: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur/action', payload 'arrow_right_click'
debug 2023-08-03 22:04:56: Received Zigbee message from 'Drukknop voordeur', type 'commandTradfriArrowSingle', cluster 'genScenes', data '{"value":256,"value2":13}' from endpoint 1 with groupID 0
info 2023-08-03 22:04:56: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur', payload '{"action":null,"battery":100,"last_seen":"2023-08-03T22:04:56+02:00","linkquality":36,"update":{"installed_version":65572,"latest_version":581,"state":"idle"},"update_available":false}'
debug 2023-08-03 22:04:57: Received Zigbee message from 'Drukknop voordeur', type 'commandTradfriArrowSingle', cluster 'genScenes', data '{"value":257,"value2":13}' from endpoint 1 with groupID 0
info 2023-08-03 22:04:57: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur', payload '{"action":"arrow_left_click","battery":100,"last_seen":"2023-08-03T22:04:57+02:00","linkquality":36,"update":{"installed_version":65572,"latest_version":581,"state":"idle"},"update_available":false}'
info 2023-08-03 22:04:57: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur', payload '{"action":"","battery":100,"last_seen":"2023-08-03T22:04:57+02:00","linkquality":36,"update":{"installed_version":65572,"latest_version":581,"state":"idle"},"update_available":false}'
info 2023-08-03 22:04:57: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur/action', payload 'arrow_left_click'
debug 2023-08-03 22:04:57: Received Zigbee message from 'Drukknop voordeur', type 'commandTradfriArrowSingle', cluster 'genScenes', data '{"value":257,"value2":13}' from endpoint 1 with groupID 0
info 2023-08-03 22:04:57: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur', payload '{"action":null,"battery":100,"last_seen":"2023-08-03T22:04:57+02:00","linkquality":36,"update":{"installed_version":65572,"latest_version":581,"state":"idle"},"update_available":false}'
debug 2023-08-03 22:04:57: Received Zigbee message from 'Drukknop voordeur', type 'commandQueryNextImageRequest', cluster 'genOta', data '{"fieldControl":1,"fileVersion":65572,"imageType":4555,"manufacturerCode":4476}' from endpoint 1 with groupID 0
info 2023-08-03 22:04:57: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur', payload '{"action":null,"battery":100,"last_seen":"2023-08-03T22:04:57+02:00","linkquality":36,"update":{"installed_version":65572,"latest_version":581,"state":"idle"},"update_available":false}'
debug 2023-08-03 22:04:57: Got OTA request '{"fieldControl":1,"manufacturerCode":4476,"imageType":4555,"fileVersion":65572}'
debug 2023-08-03 22:04:58: Received Zigbee message from 'Drukknop voordeur', type 'commandOn', cluster 'genOnOff', data '{}' from endpoint 1 with groupID 0
info 2023-08-03 22:04:58: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur', payload '{"action":"on","battery":100,"last_seen":"2023-08-03T22:04:58+02:00","linkquality":32,"update":{"installed_version":65572,"latest_version":581,"state":"idle"},"update_available":false}'
info 2023-08-03 22:04:58: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur', payload '{"action":"","battery":100,"last_seen":"2023-08-03T22:04:58+02:00","linkquality":32,"update":{"installed_version":65572,"latest_version":581,"state":"idle"},"update_available":false}'
info 2023-08-03 22:04:58: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur/action', payload 'on'
debug 2023-08-03 22:04:58: Received Zigbee message from 'Drukknop voordeur', type 'commandOn', cluster 'genOnOff', data '{}' from endpoint 1 with groupID 0
info 2023-08-03 22:04:58: MQTT publish: topic 'zigbee2mqtt/Drukknop voordeur', payload '{"action":null,"battery":100,"last_seen":"2023-08-03T22:04:58+02:00","linkquality":36,"update":{"installed_version":65572,"latest_version":581,"state":"idle"},"update_available":false}'
debug 2023-08-03 22:04:58: Is new image available for '0x540f57fffe8f81f0', current '{"fieldControl":1,"manufacturerCode":4476,"imageType":4555,"fileVersion":65572}', latest meta '{"fileVersion":581,"url":"http://fw.ota.homesmart.ikea.net/global/GW1.0/01.20.065/bin/10078031-zingo_kt_styrbar_remote-2.4.5.ota.ota.signed"}'
debug 2023-08-03 22:04:58: Update available for '0x540f57fffe8f81f0': NO
warn 2023-08-03 22:04:58: Firmware on '0x540f57fffe8f81f0' is newer than latest firmware online.
info 2023-08-03 22:04:58: No update available for 'Drukknop voordeur'

[DutchCoban]

I've found someone having the same issues as me.
Someone has altered the header in the update: zigpy/zigpy#1153 (comment) (was browsing Koenkk/zigbee-herdsman-converters#5393 (comment))
I've published the file on my server, created a my_index.json with only that file:

[
    {
        "fileVersion": 33816581,
        "fileSize": 218698,
        "manufacturerCode": 4476,
        "imageType": 4555,
        "sha512": "0e94264bd853d41cc5ee7caa8336b310b60ea8503d56f05ccfb42cb9ec8b03a1aa0cdac27bb6314c3cf9abbd55c9862cc6127bea46abedb8067bea07ffb8a8b1",
        "url": "http://__myserver__/10078031-zingo_kt_styrbar_remote-2.4.5_modded_header.ota.ota.signed",
        "force": true
    }
]

I've entered /config/zigbee2mqtt/my_index.json in "OTA index override file name", I've also tried my_index.json, but it still fails to update.

[malaakso]

I've also tried (and failed) to force update Styrbar by downloading the file locally and using local index.json. It seems that zigbee2mqtt ignores local index.json for those devices which are found in online feed, like IKEA. @Koenkk can you confirm this?

[Koenkk]

It's only used when ota.zigbeeOTA is used (for this device ota.tradfri is used). You can override it with an ext converter: https://gist.github.com/Koenkk/fafd62c76aee9d331f70aa4ff4cf12fd

• save this as file next to configuration.yaml as ext_converter.js
• add it to configuration.yaml:

external_converters:
  - ext_converter.js

• start z2m, check if issue is fixed
• After update remove the ext converter again

[malaakso]

Thanks! I was able to update to 2.4.5 with the external converter.

I opened a pull request to get this information to the official docs.

[Koenkk]

Great, assuming this can be closed now.

[DutchCoban]

I've tried it in several ways and couldn't get it to work. I've created the .js-file, I've changed the config, I've restarted Z2M from within Home Assistant numerous times and I can't get the button to update. I've added my my_index.json to the config and then I got the message that 1.0.024 is newer than 2.4.5.

[malaakso]

@crispy78 this is the index.json I used for successful OTA (I downloaded the file from IKEA feed to the /app/data directory):
[ { "manufacturerCode": 4476, "imageType": 4555, "fileVersion": 581, "url": "10078031-zingo_kt_styrbar_remote-2.4.5.ota.ota.signed", "force": true } ]
Your file version seems off.

[DutchCoban]

I'm about to quit this struggle. I can't find the app/data directory, so I've placed the file in the Zigbee2MQTT config-directory. I've changed the my_index.json-file, changed the config-file and still no luck. I'm thinking of changing to ZHA temporarily, the device seems to be updating on that platform with less hassle. I might be wrong.

[tishcufksips]

I'm about to quit this struggle. I can't find the app/data directory, so I've placed the file in the Zigbee2MQTT config-directory. I've changed the my_index.json-file, changed the config-file and still no luck. I'm thinking of changing to ZHA temporarily, the device seems to be updating on that platform with less hassle. I might be wrong.

I've just managed to start the update, maybe I can help...

My problem was that I didn't know that GUI settings override the settings I've put in config files by hand.
Do you see any error when trying to update?

I've used simple-web-server from GitHub on my PC, and put 10078031-zingo_kt_styrbar_remote-2.4.5.ota.ota.signed and my_index.json files in the root directory. Then in Z2M\Settings\OTA Updates I've unchecked "IKEA TRADFRI OTA use test url" and put url to my_index.json file on web server - in my case it was http://192.168.1.100/my_index.json

Contents of my my_index.json:
[ { "manufacturerCode": 4476, "imageType": 4555, "fileVersion": 581, "url": "http://192.168.1.100/10078031-zingo_kt_styrbar_remote-2.4.5.ota.ota.signed", "force": true } ]

and last thing was ext_converter.js which I've uploaded with File Editor to the zigbee2mqtt directory. Contents were taken from the link that koenkk provided above. Then i just entered converter filename in Z2M\Settings\External Converters

[DutchCoban]

@tishcufksips thanks for your instructions, it finally got to the point that it found an update and it's currently updating.
For some reason the config wanted to use the test server so I had to change that to false and putting the my_index.json and update on my own server was a very helpfull comment.

[jkl1337]

There is no need to run a server or anything like that. zigbee2mqtt is perfectly capable of serving the file. The firmware file and my_index.json can both go in the data directory, which is the same directory that zigbee2mqtt configuration.yaml is located.
The steps that work are as follows:

1. Copy https://gist.github.com/Koenkk/fafd62c76aee9d331f70aa4ff4cf12fd to ext_converter.js (in the zigbee2mqtt data directory).
2. Download http://fw.ota.homesmart.ikea.net/global/GW1.0/01.20.065/bin/10078031-zingo_kt_styrbar_remote-2.4.5.ota.ota.signed and place the file into the zigbee2mqtt data directory.
3. Add the following to a file called my_index.json in the data directory

[ { "manufacturerCode": 4476,
"imageType": 4555, 
"fileVersion": 581,
"url": "10078031-zingo_kt_styrbar_remote-2.4.5.ota.ota.signed",
"force": true } ]

4. Add/merge the following configuration items to configuration.yaml

external_converters:
  - ext_converter.js
ota:
  zigbee_ota_override_index_location: my_index.json

5. Restart zigbee2mqtt and go through the OTA update process as normal. After completion should then remove the ext_converter.js from the configuration and restart.

[brainhig]

Hi y'all:

I'm pretty sure I've done all the steps here correctly, and have tried both using a web server and putting the necessary files on the HA instance directly, but I'm getting errors (see below) that seem to point to another problem. The buttons are working correctly, so I'm not sure these errors really mean what they say. Any help or pointers is appreciated!

Info 2023-10-04 18:30:39MQTT publish: topic 'zigbee2mqtt/bridge/log', payload '{"message":"Failed to check if update available for 'IKEAButton2' (Device didn't respond to OTA request)","meta":{"device":"IKEAButton2","status":"check_failed"},"type":"ota_update"}'
Info 2023-10-04 18:30:39MQTT publish: topic 'zigbee2mqtt/bridge/response/device/ota_update/check', payload '{"data":{"id":"IKEAButton2"},"error":"Failed to check if update available for 'IKEAButton2' (Device didn't respond to OTA request)","status":"error","transaction":"9rsko-15"}'

with DEBUG on, these errors appear:

Error 2023-10-04 19:13:07Failed to check if update available for 'IKEAButton2' (Device didn't respond to OTA request)
Debug 2023-10-04 19:13:07Error: Device didn't respond to OTA request at requestOTA (/app/node_modules/zigbee-herdsman-converters/src/lib/ota/common.ts:202:15) at Object.isUpdateAvailable (/app/node_modules/zigbee-herdsman-converters/src/lib/ota/common.ts:274:25) at OTAUpdate.onMQTTMessage (/app/lib/extension/otaUpdate.ts:203:45)

[malaakso]

Did you press button on the remote to wake it up immediately after clicking Check for updates?