Firmware OTA wrongly interprets Query Next Image Command file version parameter

[pgaufillet]

While troubleshooting the Zigbee Firmware OTA process, I have discovered that the field File Version of Query Next Image Command is probably wrongly interpreted in ZigBeeThingHandler:

    @Override
    public ZigBeeOtaFile otaIncomingRequest(QueryNextImageCommand command) {
        // We simply store the requested firmware version information so that it's
        // available for the firmware provider
        lastFirmwareVersion = new ZigBeeFirmwareVersion(command.getManufacturerCode(), command.getImageType(),
                command.getFileVersion());

As stated in the ZigBee Cluster Library Specification (document 075123), section 11.13.4.2.4, The file version included in the payload represents the device’s current running image version, and not the requested version. Due to it, the logic in ZigBeeFirmwareProvider.getFirmware() and ZigBeeFirmwareProvider.getFirmwares() is probably broken: the selection should include files which version is greater than the current version (hence called improperly requestedVersion).

[cdjackson]

I don't think the code you reference above is relevant. All this is doing is recording the request that was made by the device. I agree that the version probably isn't necessary to be stored here, but it is...

I think the relevant code is below - this is in the GithubLibraryReader class. This is called to get a list of firmwares for the device, and you can see it only checks the manufacturer code and the file type - not the firmware version. This code will return a list of all firmware available for the device (based on manufacturer and file type).

   public Set<DirectoryFileEntry> getDirectorEntries(ZigBeeFirmwareVersion requestedVersion) {
        final Set<DirectoryFileEntry> firmwareSet = new HashSet<>();
        synchronized (directory) {
            for (DirectoryFileEntry firmware : directory) {
                if (firmware.getManufacturerCode().equals(requestedVersion.getManufacturerCode())
                        && firmware.getImageType().equals(requestedVersion.getFileType())) {
                    firmwareSet.add(firmware);
                }
            }
        }

        for (DirectoryFileEntry firmware : firmwareSet) {
            if (firmware.getMd5() != null) {
                downloadFile(firmware);
            }
        }
        return firmwareSet;
    }

I will say that this is the current code in my updated branch I referenced elsewhere so your point might be correct for the current provider - I've not checked.