Package org.openhab.core.thing.firmware

Interface FirmwareProvider

@NonNullByDefault public interface FirmwareProvider
The FirmwareProvider is registered as an OSGi service and is responsible for providing firmwares. If a locale is given to one of its operations then the following firmware attributes are to be localized:
Author:
Thomas Höfer - Initial contribution, Dimitar Ivanov - Firmwares are provided for thing

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable Firmware
    getFirmware(Thing thing, String version)
    Returns the firmware for the given thing and provided firmware version.
    @Nullable Firmware
    getFirmware(Thing thing, String version, @Nullable Locale locale)
    Returns the firmware for the given thing and version for the given locale.
    @Nullable Set<Firmware>
    getFirmwares(Thing thing)
    Returns the set of available firmwares for the given thing.
    @Nullable Set<Firmware>
    getFirmwares(Thing thing, @Nullable Locale locale)
    Returns the set of available firmwares for the given thing and the given locale.

  • Method Details

    • getFirmware

      @Nullable Firmware getFirmware(Thing thing, String version)
      Returns the firmware for the given thing and provided firmware version.
      Parameters:
      thing - the thing for which the firmware will be provided with the specified version
      version - the version of the firmware to be provided for the specified thing
      Returns:
      the corresponding firmware or null if no firmware was found

    • getFirmware

      @Nullable Firmware getFirmware(Thing thing, String version, @Nullable Locale locale)
      Returns the firmware for the given thing and version for the given locale.
      Parameters:
      thing - the thing for which the firmwares are to be provided (not null)
      version - the version of the firmware to be provided
      locale - the locale to be used (if null then the default locale is to be used)
      Returns:
      the corresponding firmware for the given locale or null if no firmware was found

    • getFirmwares

      @Nullable Set<Firmware> getFirmwares(Thing thing)
      Returns the set of available firmwares for the given thing.
      Parameters:
      thing - the thing for which the firmwares are to be provided (not null)
      Returns:
      the set of available firmwares for the given thing (can be null)

    • getFirmwares

      @Nullable Set<Firmware> getFirmwares(Thing thing, @Nullable Locale locale)
      Returns the set of available firmwares for the given thing and the given locale.
      Parameters:
      thing - the thing for which the firmwares are to be provided (not null)
      locale - the locale to be used (if null then the default locale is to be used)
      Returns:
      the set of available firmwares for the given thing (can be null)