Uses of Class
org.openhab.core.thing.Channel
Packages that use Channel
Package
Description
-
Uses of Channel in org.openhab.core.thing
Methods in org.openhab.core.thing that return ChannelModifier and TypeMethodDescription@Nullable Channel
Thing.getChannel
(String channelId) Gets the channel for the given id or null if no channel with the id exists.@Nullable Channel
Thing.getChannel
(ChannelUID channelUID) Gets the channel for the given UID or null if no channel with the UID exists.@Nullable Channel
ThingRegistry.getChannel
(ChannelUID channelUID) Returns a channel for the given channel UID or null if no channel was foundMethods in org.openhab.core.thing that return types with arguments of type ChannelModifier and TypeMethodDescriptionThing.getChannels()
Gets the channels.Thing.getChannelsOfGroup
(String channelGroupId) Gets the channels of the given channel group or an empty list if no channel group with the id exists or the channel group does not have channels. -
Uses of Channel in org.openhab.core.thing.binding
Methods in org.openhab.core.thing.binding with parameters of type ChannelModifier and TypeMethodDescription@Nullable CommandDescription
BaseDynamicCommandDescriptionProvider.getCommandDescription
(Channel channel, @Nullable CommandDescription originalCommandDescription, @Nullable Locale locale) @Nullable StateDescription
BaseDynamicStateDescriptionProvider.getStateDescription
(Channel channel, @Nullable StateDescription original, @Nullable Locale locale) protected List
<CommandOption> BaseDynamicCommandDescriptionProvider.localizedCommandOptions
(List<CommandOption> options, Channel channel, @Nullable Locale locale) Localizes aList
ofCommandOption
s that should be used for the channel.protected List
<StateOption> BaseDynamicStateDescriptionProvider.localizedStateOptions
(List<StateOption> options, Channel channel, @Nullable Locale locale) Localizes aList
ofStateOption
s that should be used for the channel.protected @Nullable String
BaseDynamicStateDescriptionProvider.localizeStatePattern
(String pattern, Channel channel, @Nullable Locale locale) Localizes a pattern that should be used for the channel.void
ThingHandlerCallback.validateConfigurationParameters
(Channel channel, Map<String, Object> configurationParameters) Validates the given configuration parameters against the configuration description. -
Uses of Channel in org.openhab.core.thing.binding.builder
Methods in org.openhab.core.thing.binding.builder that return ChannelMethods in org.openhab.core.thing.binding.builder with parameters of type ChannelModifier and TypeMethodDescriptionstatic ChannelBuilder
Creates aChannelBuilder
from the givenChannel
.BridgeBuilder.withChannel
(Channel channel) ThingBuilder.withChannel
(Channel channel) Adds the given channel to the thingBridgeBuilder.withChannels
(Channel... channels) ThingBuilder.withChannels
(Channel... channels) Replaces all channels of this thing with the given channelsBridgeBuilder.withoutChannels
(Channel... channels) ThingBuilder.withoutChannels
(Channel... channels) Removes the given channels from the thingMethod parameters in org.openhab.core.thing.binding.builder with type arguments of type ChannelModifier and TypeMethodDescriptionBridgeBuilder.withChannels
(List<Channel> channels) ThingBuilder.withChannels
(List<Channel> channels) Replaces all channels of this thing with the given channelsBridgeBuilder.withoutChannels
(List<Channel> channels) ThingBuilder.withoutChannels
(List<Channel> channels) Removes the given channels from the thing -
Uses of Channel in org.openhab.core.thing.dto
Methods in org.openhab.core.thing.dto that return ChannelModifier and TypeMethodDescriptionstatic Channel
ChannelDTOMapper.map
(ChannelDTO channelDTO) Maps channel DTO into channel object.Methods in org.openhab.core.thing.dto with parameters of type Channel -
Uses of Channel in org.openhab.core.thing.profiles
Methods in org.openhab.core.thing.profiles with parameters of type ChannelModifier and TypeMethodDescription@Nullable ProfileTypeUID
ProfileAdvisor.getSuggestedProfileTypeUID
(Channel channel, @Nullable String itemType) Suggest a custom profile for the given channel (and potentially also the itemType). -
Uses of Channel in org.openhab.core.thing.type
Methods in org.openhab.core.thing.type with parameters of type ChannelModifier and TypeMethodDescription@Nullable ChannelType
ThingTypeRegistry.getChannelType
(Channel channel) Returns the channel type for a given channel.@Nullable ChannelType
ThingTypeRegistry.getChannelType
(Channel channel, @Nullable Locale locale) Returns the channel type for a given channel and locale.@Nullable CommandDescription
DynamicCommandDescriptionProvider.getCommandDescription
(Channel channel, @Nullable CommandDescription originalCommandDescription, @Nullable Locale locale) For a givenChannel
, return aCommandDescription
that should be used for the channel, instead of the one defined statically in theChannelType
.@Nullable StateDescription
DynamicStateDescriptionProvider.getStateDescription
(Channel channel, @Nullable StateDescription originalStateDescription, @Nullable Locale locale) For a givenChannel
, return aStateDescription
that should be used for the channel, instead of the one defined statically in theChannelType
. -
Uses of Channel in org.openhab.core.thing.util
Methods in org.openhab.core.thing.util with parameters of type ChannelModifier and TypeMethodDescriptionstatic void
ThingHelper.ensureUniqueChannels
(Collection<Channel> channels, Channel channel) Ensures that there are no duplicate channels in the collection plus the additional one (i.e. not using the same ChannelUID)static void
ThingHelper.ensureUniqueChannels
(Channel[] channels) Ensures that there are no duplicate channels in the array (i.e. not using the same ChannelUID)Method parameters in org.openhab.core.thing.util with type arguments of type ChannelModifier and TypeMethodDescriptionstatic void
ThingHelper.addChannelsToThing
(Thing thing, Collection<Channel> channels) static void
ThingHelper.ensureUniqueChannels
(Collection<Channel> channels) Ensures that there are no duplicate channels in the collection (i.e. not using the same ChannelUID)static void
ThingHelper.ensureUniqueChannels
(Collection<Channel> channels, Channel channel) Ensures that there are no duplicate channels in the collection plus the additional one (i.e. not using the same ChannelUID)