Class MagicActionModuleThingHandler
- All Implemented Interfaces:
ThingHandler
- Author:
- Stefan Triller - Initial contribution
-
Field Summary
Fields inherited from class org.openhab.core.thing.binding.BaseThingHandler
scheduler, thing
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
communicateActionToDevice
(String doSomething) Collection<Class<? extends ThingHandlerService>>
This method provides a list of classes which should be registered as services by the frameworkvoid
handleCommand
(ChannelUID channelUID, Command command) Handles a command for a given channel.void
Initializes the thing handler, e.g.Methods inherited from class org.openhab.core.thing.binding.BaseThingHandler
bridgeStatusChanged, changeThingType, channelLinked, channelUnlinked, dispose, editConfiguration, editProperties, editThing, getBridge, getCallback, getConfig, getConfigAs, getConfigDescription, getConfigDescription, getThing, handleConfigurationUpdate, handleRemoval, isInitialized, isLinked, isLinked, isModifyingCurrentConfig, postCommand, postCommand, sendTimeSeries, sendTimeSeries, setCallback, thingUpdated, triggerChannel, triggerChannel, triggerChannel, triggerChannel, updateConfiguration, updateProperties, updateProperty, updateState, updateState, updateStatus, updateStatus, updateStatus, updateThing, validateConfigurationParameters
-
Constructor Details
-
MagicActionModuleThingHandler
-
-
Method Details
-
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
Thing
s with statusThingStatus.UNKNOWN
,ThingStatus.ONLINE
orThingStatus.OFFLINE
are considered as initialized by the framework. To achieve that, the status must be reported viaThingHandlerCallback.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. -
handleCommand
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
- theChannelUID
of the channel to which the command was sentcommand
- theCommand
-
communicateActionToDevice
-
getServices
Description copied from interface:ThingHandler
This method provides a list of classes which should be registered as services by the framework- Returns:
- - list of classes that will be registered as OSGi services
-