Class MagicButtonHandler

java.lang.Object
org.openhab.core.thing.binding.BaseThingHandler
org.openhab.core.magic.binding.handler.MagicButtonHandler
All Implemented Interfaces:
ThingHandler

@NonNullByDefault public class MagicButtonHandler extends BaseThingHandler
The MagicButtonHandler is capable of triggering different events. Triggers a PRESSED event every 5 seconds on the rawbutton trigger channel.
Author:
Christoph Weitkamp - Initial contribution
  • Constructor Details

    • MagicButtonHandler

      public MagicButtonHandler(Thing thing)
  • Method Details

    • handleCommand

      public void handleCommand(ChannelUID channelUID, Command command)
      Description copied from interface: ThingHandler
      Handles a command for a given channel.

      This method is only called, if the thing has been initialized (status ONLINE/OFFLINE/UNKNOWN).

      Parameters:
      channelUID - the ChannelUID of the channel to which the command was sent
      command - the Command
    • initialize

      public void initialize()
      Description copied from interface: ThingHandler
      Initializes the thing handler, e.g. update thing status, allocate resources, transfer configuration.

      This method is only called, if the Thing contains all required configuration parameters.

      Only Things with status ThingStatus.UNKNOWN, ThingStatus.ONLINE or ThingStatus.OFFLINE are considered as initialized by the framework. To achieve that, the status must be reported via ThingHandlerCallback.statusUpdated(Thing, ThingStatusInfo).

      The framework expects this method to be non-blocking and return quickly. For longer running initializations, the implementation has to take care of scheduling a separate job which must guarantee to set the thing status eventually.

      Any anticipated error situations should be handled gracefully and need to result in ThingStatus.OFFLINE with the corresponding status detail (e.g. *COMMUNICATION_ERROR* or *CONFIGURATION_ERROR* including a meaningful description) instead of throwing exceptions.

    • dispose

      public void dispose()
      Description copied from interface: ThingHandler
      Disposes the thing handler, e.g. deallocate resources.

      The framework expects this method to be non-blocking and return quickly.

      Specified by:
      dispose in interface ThingHandler
      Overrides:
      dispose in class BaseThingHandler