Class MagicChattyThingHandler
- 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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidchannelLinked(ChannelUID channelUID) Notifies the handler that a channel was linked.voidchannelUnlinked(ChannelUID channelUID) Notifies the handler that a channel was unlinked.voiddispose()Disposes the thing handler, e.g. deallocate resources.voidhandleCommand(ChannelUID channelUID, Command command) Handles a command for a given channel.voidInitializes the thing handler, e.g. update thing status, allocate resources, transfer configuration.protected voidupdateState(ChannelUID channelUID, State state) Updates the state of the thing.Methods inherited from class org.openhab.core.thing.binding.BaseThingHandler
bridgeStatusChanged, changeThingType, 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, updateStatus, updateStatus, updateStatus, updateThing, validateConfigurationParametersMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.openhab.core.thing.binding.ThingHandler
getServices
-
Constructor Details
-
MagicChattyThingHandler
-
-
Method Details
-
initialize
public void initialize()Description copied from interface:ThingHandlerInitializes the thing handler, e.g. update thing status, allocate resources, transfer configuration.This method is only called, if the
Thingcontains all required configuration parameters.Only
Things with statusThingStatus.UNKNOWN,ThingStatus.ONLINEorThingStatus.OFFLINEare 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.OFFLINEwith 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:ThingHandlerDisposes the thing handler, e.g. deallocate resources.The framework expects this method to be non-blocking and return quickly.
- Specified by:
disposein interfaceThingHandler- Overrides:
disposein classBaseThingHandler
-
channelLinked
Description copied from interface:ThingHandlerNotifies the handler that a channel was linked.This method is only called, if the thing has been initialized (status ONLINE/OFFLINE/UNKNOWN).
- Specified by:
channelLinkedin interfaceThingHandler- Overrides:
channelLinkedin classBaseThingHandler- Parameters:
channelUID- UID of the linked channel
-
channelUnlinked
Description copied from interface:ThingHandlerNotifies the handler that a channel was unlinked.This method is only called, if the thing has been initialized (status ONLINE/OFFLINE/UNKNOWN).
- Specified by:
channelUnlinkedin interfaceThingHandler- Overrides:
channelUnlinkedin classBaseThingHandler- Parameters:
channelUID- UID of the unlinked channel
-
handleCommand
Description copied from interface:ThingHandlerHandles a command for a given channel.This method is only called, if the thing has been initialized (status ONLINE/OFFLINE/UNKNOWN).
- Parameters:
channelUID- theChannelUIDof the channel to which the command was sentcommand- theCommand
-
updateState
Description copied from class:BaseThingHandlerUpdates the state of the thing.- Overrides:
updateStatein classBaseThingHandler- Parameters:
channelUID- unique id of the channel, which was updatedstate- new state
-