Module: OpenHAB::Core::Things::Thing
- Defined in:
- lib/openhab/core/things/thing.rb
Overview
Defined Under Namespace
Classes: ChannelsArray
Instance Attribute Summary collapse
- #bridge ⇒ Thing? readonly
-
#bridge_uid ⇒ ThingUID?
readonly
Return the Bridge UID when available.
- #channels ⇒ ChannelsArray readonly
-
#configuration ⇒ OpenHAB::Core::Configuration
readonly
Return the thing’s configuration.
-
#label ⇒ String
Return the thing label.
-
#location ⇒ String
Return the thing location.
-
#properties ⇒ Hash
readonly
Return the properties when available.
-
#status ⇒ org.openhab.core.thing.ThingStatus
readonly
Return the thing status.
- #thing_type ⇒ ThingType readonly
- #thing_type_uid ⇒ ThingTypeUID readonly
-
#uid ⇒ ThingUID
readonly
Return the UID.
Instance Method Summary collapse
-
#actions(scope = nil) ⇒ Object?
Fetches the actions available for this thing.
-
#bridge? ⇒ true, false
True if this Thing is a bridge.
-
#config_eql?(other) ⇒ true, false
Compares all attributes of the thing with another thing.
-
#disable ⇒ void
Disable the Thing.
-
#enable(enabled: true) ⇒ void
Enable the Thing.
-
#initialized? ⇒ true, false
Check if thing status == INITIALIZED.
- #inspect ⇒ String
-
#method_missing(method, *args, &block) ⇒ Object
Delegate missing methods to the thing’s default actions scope.
-
#offline? ⇒ true, false
Check if thing status == OFFLINE.
-
#online? ⇒ true, false
Check if thing status == ONLINE.
- #provider ⇒ org.openhab.core.common.registry.Provider?
-
#removed? ⇒ true, false
Check if thing status == REMOVED.
-
#removing? ⇒ true, false
Check if thing status == REMOVING.
-
#to_s ⇒ String
Return Thing’s uid as a string.
-
#uninitialized? ⇒ true, false
Check if thing status == UNINITIALIZED.
-
#unknown? ⇒ true, false
Check if thing status == UNKNOWN.
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(method, *args, &block) ⇒ Object
Delegate missing methods to the thing’s default actions scope.
251 252 253 254 255 |
# File 'lib/openhab/core/things/thing.rb', line 251 def method_missing(method, *args, &block) return actions.public_send(method, *args, &block) if actions.respond_to?(method) super end |
Instance Attribute Details
#bridge ⇒ Thing? (readonly)
178 179 180 |
# File 'lib/openhab/core/things/thing.rb', line 178 def bridge bridge_uid && EntityLookup.lookup_thing(bridge_uid) end |
#bridge_uid ⇒ ThingUID? (readonly)
Return the Bridge UID when available.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/openhab/core/things/thing.rb', line 74 module Thing # Array wrapper class to allow searching a list of channels # by channel id class ChannelsArray < Array def initialize(thing, array) super(array) @thing = thing end # Allows indexing by both integer as an array or channel id acting like a hash. # @param [Integer, String, ChannelUID] index # Numeric index, string channel id, or a {ChannelUID} to search for. # @return [Channel, nil] def [](index) return @thing.get_channel(index) if index.is_a?(ChannelUID) return @thing.get_channel(index.to_str) if index.respond_to?(:to_str) super end end class << self # @!visibility private # # Override to support Proxy # def ===(other) other.is_a?(self) end end # # @!method uninitialized? # Check if thing status == UNINITIALIZED # @return [true,false] # # # @!method initialized? # Check if thing status == INITIALIZED # @return [true,false] # # # @!method unknown? # Check if thing status == UNKNOWN # @return [true,false] # # # @!method online? # Check if thing status == ONLINE # @return [true,false] # # # @!method offline? # Check if thing status == OFFLINE # @return [true,false] # # # @!method removing? # Check if thing status == REMOVING # @return [true,false] # # # @!method removed? # Check if thing status == REMOVED # @return [true,false] # ThingStatus.constants.each do |thingstatus| define_method(:"#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) } end # # Enable the Thing # # @param [true, false] enabled # @return [void] # def enable(enabled: true) Things.manager.set_enabled(uid, enabled) end # # Disable the Thing # # @return [void] # def disable enable(enabled: false) end # @!attribute [r] thing_type # @return [ThingType] def thing_type ThingType.registry.get_thing_type(thing_type_uid) end # @!attribute [r] bridge # @return [Thing, nil] def bridge bridge_uid && EntityLookup.lookup_thing(bridge_uid) end # @return [true,false] true if this Thing is a bridge def bridge? is_a?(org.openhab.core.thing.Bridge) end # @return [String] def inspect r = "#<OpenHAB::Core::Things::Thing #{uid}" r += " #{label.inspect}" if label r += " (#{location.inspect})" if location r += " #{status}" unless status_info.status_detail == org.openhab.core.thing.ThingStatusDetail::NONE r += " (#{status_info.status_detail})" end r += " configuration=#{configuration.properties.to_h}" unless configuration.properties.empty? r += " properties=#{properties.to_h}" unless properties.empty? "#{r}>" end # # Return Thing's uid as a string # # @return [String] # def to_s uid.to_s end # @return [org.openhab.core.common.registry.Provider, nil] def provider Provider.registry.provider_for(uid) end # # Fetches the actions available for this thing. # # Default scope actions are available directly on the thing object, via # {#method_missing}. # # @param [String, nil] scope The action scope. Default's to the thing's binding. # @return [Object, nil] # # @example # things["max:thermostat:mybridge:thermostat"].actions("max-devices").delete_from_cube # # @example (see #method_missing) # def actions(scope = nil) $actions.get(scope || uid.binding_id, uid.to_s) end # # Compares all attributes of the thing with another thing. # # @param other [Thing] The thing to compare with # @return [true,false] true if all attributes are equal, false otherwise # def config_eql?(other) # @deprecated OH3.4 - in OH4, channels can be included in the array and do not need to be compared separately channels.to_a == other.channels.to_a && %i[uid label bridge_uid location configuration].all? { |method| send(method) == other.send(method) } end # # Delegate missing methods to the thing's default actions scope. # # @example # things['mail:smtp:local'].send_email('[email protected]', 'subject', 'message') # def method_missing(method, *args, &block) return actions.public_send(method, *args, &block) if actions.respond_to?(method) super end # @!visibility private def respond_to_missing?(method_name, _include_private = false) logger.trace { "Checking if Thing #{uid} supports #{method_name} action" } return true if actions.respond_to?(method_name) super end end |
#channels ⇒ ChannelsArray (readonly)
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/openhab/core/things/thing.rb', line 74 module Thing # Array wrapper class to allow searching a list of channels # by channel id class ChannelsArray < Array def initialize(thing, array) super(array) @thing = thing end # Allows indexing by both integer as an array or channel id acting like a hash. # @param [Integer, String, ChannelUID] index # Numeric index, string channel id, or a {ChannelUID} to search for. # @return [Channel, nil] def [](index) return @thing.get_channel(index) if index.is_a?(ChannelUID) return @thing.get_channel(index.to_str) if index.respond_to?(:to_str) super end end class << self # @!visibility private # # Override to support Proxy # def ===(other) other.is_a?(self) end end # # @!method uninitialized? # Check if thing status == UNINITIALIZED # @return [true,false] # # # @!method initialized? # Check if thing status == INITIALIZED # @return [true,false] # # # @!method unknown? # Check if thing status == UNKNOWN # @return [true,false] # # # @!method online? # Check if thing status == ONLINE # @return [true,false] # # # @!method offline? # Check if thing status == OFFLINE # @return [true,false] # # # @!method removing? # Check if thing status == REMOVING # @return [true,false] # # # @!method removed? # Check if thing status == REMOVED # @return [true,false] # ThingStatus.constants.each do |thingstatus| define_method(:"#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) } end # # Enable the Thing # # @param [true, false] enabled # @return [void] # def enable(enabled: true) Things.manager.set_enabled(uid, enabled) end # # Disable the Thing # # @return [void] # def disable enable(enabled: false) end # @!attribute [r] thing_type # @return [ThingType] def thing_type ThingType.registry.get_thing_type(thing_type_uid) end # @!attribute [r] bridge # @return [Thing, nil] def bridge bridge_uid && EntityLookup.lookup_thing(bridge_uid) end # @return [true,false] true if this Thing is a bridge def bridge? is_a?(org.openhab.core.thing.Bridge) end # @return [String] def inspect r = "#<OpenHAB::Core::Things::Thing #{uid}" r += " #{label.inspect}" if label r += " (#{location.inspect})" if location r += " #{status}" unless status_info.status_detail == org.openhab.core.thing.ThingStatusDetail::NONE r += " (#{status_info.status_detail})" end r += " configuration=#{configuration.properties.to_h}" unless configuration.properties.empty? r += " properties=#{properties.to_h}" unless properties.empty? "#{r}>" end # # Return Thing's uid as a string # # @return [String] # def to_s uid.to_s end # @return [org.openhab.core.common.registry.Provider, nil] def provider Provider.registry.provider_for(uid) end # # Fetches the actions available for this thing. # # Default scope actions are available directly on the thing object, via # {#method_missing}. # # @param [String, nil] scope The action scope. Default's to the thing's binding. # @return [Object, nil] # # @example # things["max:thermostat:mybridge:thermostat"].actions("max-devices").delete_from_cube # # @example (see #method_missing) # def actions(scope = nil) $actions.get(scope || uid.binding_id, uid.to_s) end # # Compares all attributes of the thing with another thing. # # @param other [Thing] The thing to compare with # @return [true,false] true if all attributes are equal, false otherwise # def config_eql?(other) # @deprecated OH3.4 - in OH4, channels can be included in the array and do not need to be compared separately channels.to_a == other.channels.to_a && %i[uid label bridge_uid location configuration].all? { |method| send(method) == other.send(method) } end # # Delegate missing methods to the thing's default actions scope. # # @example # things['mail:smtp:local'].send_email('[email protected]', 'subject', 'message') # def method_missing(method, *args, &block) return actions.public_send(method, *args, &block) if actions.respond_to?(method) super end # @!visibility private def respond_to_missing?(method_name, _include_private = false) logger.trace { "Checking if Thing #{uid} supports #{method_name} action" } return true if actions.respond_to?(method_name) super end end |
#configuration ⇒ OpenHAB::Core::Configuration (readonly)
Return the thing’s configuration.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/openhab/core/things/thing.rb', line 74 module Thing # Array wrapper class to allow searching a list of channels # by channel id class ChannelsArray < Array def initialize(thing, array) super(array) @thing = thing end # Allows indexing by both integer as an array or channel id acting like a hash. # @param [Integer, String, ChannelUID] index # Numeric index, string channel id, or a {ChannelUID} to search for. # @return [Channel, nil] def [](index) return @thing.get_channel(index) if index.is_a?(ChannelUID) return @thing.get_channel(index.to_str) if index.respond_to?(:to_str) super end end class << self # @!visibility private # # Override to support Proxy # def ===(other) other.is_a?(self) end end # # @!method uninitialized? # Check if thing status == UNINITIALIZED # @return [true,false] # # # @!method initialized? # Check if thing status == INITIALIZED # @return [true,false] # # # @!method unknown? # Check if thing status == UNKNOWN # @return [true,false] # # # @!method online? # Check if thing status == ONLINE # @return [true,false] # # # @!method offline? # Check if thing status == OFFLINE # @return [true,false] # # # @!method removing? # Check if thing status == REMOVING # @return [true,false] # # # @!method removed? # Check if thing status == REMOVED # @return [true,false] # ThingStatus.constants.each do |thingstatus| define_method(:"#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) } end # # Enable the Thing # # @param [true, false] enabled # @return [void] # def enable(enabled: true) Things.manager.set_enabled(uid, enabled) end # # Disable the Thing # # @return [void] # def disable enable(enabled: false) end # @!attribute [r] thing_type # @return [ThingType] def thing_type ThingType.registry.get_thing_type(thing_type_uid) end # @!attribute [r] bridge # @return [Thing, nil] def bridge bridge_uid && EntityLookup.lookup_thing(bridge_uid) end # @return [true,false] true if this Thing is a bridge def bridge? is_a?(org.openhab.core.thing.Bridge) end # @return [String] def inspect r = "#<OpenHAB::Core::Things::Thing #{uid}" r += " #{label.inspect}" if label r += " (#{location.inspect})" if location r += " #{status}" unless status_info.status_detail == org.openhab.core.thing.ThingStatusDetail::NONE r += " (#{status_info.status_detail})" end r += " configuration=#{configuration.properties.to_h}" unless configuration.properties.empty? r += " properties=#{properties.to_h}" unless properties.empty? "#{r}>" end # # Return Thing's uid as a string # # @return [String] # def to_s uid.to_s end # @return [org.openhab.core.common.registry.Provider, nil] def provider Provider.registry.provider_for(uid) end # # Fetches the actions available for this thing. # # Default scope actions are available directly on the thing object, via # {#method_missing}. # # @param [String, nil] scope The action scope. Default's to the thing's binding. # @return [Object, nil] # # @example # things["max:thermostat:mybridge:thermostat"].actions("max-devices").delete_from_cube # # @example (see #method_missing) # def actions(scope = nil) $actions.get(scope || uid.binding_id, uid.to_s) end # # Compares all attributes of the thing with another thing. # # @param other [Thing] The thing to compare with # @return [true,false] true if all attributes are equal, false otherwise # def config_eql?(other) # @deprecated OH3.4 - in OH4, channels can be included in the array and do not need to be compared separately channels.to_a == other.channels.to_a && %i[uid label bridge_uid location configuration].all? { |method| send(method) == other.send(method) } end # # Delegate missing methods to the thing's default actions scope. # # @example # things['mail:smtp:local'].send_email('[email protected]', 'subject', 'message') # def method_missing(method, *args, &block) return actions.public_send(method, *args, &block) if actions.respond_to?(method) super end # @!visibility private def respond_to_missing?(method_name, _include_private = false) logger.trace { "Checking if Thing #{uid} supports #{method_name} action" } return true if actions.respond_to?(method_name) super end end |
#label ⇒ String
Return the thing label
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/openhab/core/things/thing.rb', line 74 module Thing # Array wrapper class to allow searching a list of channels # by channel id class ChannelsArray < Array def initialize(thing, array) super(array) @thing = thing end # Allows indexing by both integer as an array or channel id acting like a hash. # @param [Integer, String, ChannelUID] index # Numeric index, string channel id, or a {ChannelUID} to search for. # @return [Channel, nil] def [](index) return @thing.get_channel(index) if index.is_a?(ChannelUID) return @thing.get_channel(index.to_str) if index.respond_to?(:to_str) super end end class << self # @!visibility private # # Override to support Proxy # def ===(other) other.is_a?(self) end end # # @!method uninitialized? # Check if thing status == UNINITIALIZED # @return [true,false] # # # @!method initialized? # Check if thing status == INITIALIZED # @return [true,false] # # # @!method unknown? # Check if thing status == UNKNOWN # @return [true,false] # # # @!method online? # Check if thing status == ONLINE # @return [true,false] # # # @!method offline? # Check if thing status == OFFLINE # @return [true,false] # # # @!method removing? # Check if thing status == REMOVING # @return [true,false] # # # @!method removed? # Check if thing status == REMOVED # @return [true,false] # ThingStatus.constants.each do |thingstatus| define_method(:"#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) } end # # Enable the Thing # # @param [true, false] enabled # @return [void] # def enable(enabled: true) Things.manager.set_enabled(uid, enabled) end # # Disable the Thing # # @return [void] # def disable enable(enabled: false) end # @!attribute [r] thing_type # @return [ThingType] def thing_type ThingType.registry.get_thing_type(thing_type_uid) end # @!attribute [r] bridge # @return [Thing, nil] def bridge bridge_uid && EntityLookup.lookup_thing(bridge_uid) end # @return [true,false] true if this Thing is a bridge def bridge? is_a?(org.openhab.core.thing.Bridge) end # @return [String] def inspect r = "#<OpenHAB::Core::Things::Thing #{uid}" r += " #{label.inspect}" if label r += " (#{location.inspect})" if location r += " #{status}" unless status_info.status_detail == org.openhab.core.thing.ThingStatusDetail::NONE r += " (#{status_info.status_detail})" end r += " configuration=#{configuration.properties.to_h}" unless configuration.properties.empty? r += " properties=#{properties.to_h}" unless properties.empty? "#{r}>" end # # Return Thing's uid as a string # # @return [String] # def to_s uid.to_s end # @return [org.openhab.core.common.registry.Provider, nil] def provider Provider.registry.provider_for(uid) end # # Fetches the actions available for this thing. # # Default scope actions are available directly on the thing object, via # {#method_missing}. # # @param [String, nil] scope The action scope. Default's to the thing's binding. # @return [Object, nil] # # @example # things["max:thermostat:mybridge:thermostat"].actions("max-devices").delete_from_cube # # @example (see #method_missing) # def actions(scope = nil) $actions.get(scope || uid.binding_id, uid.to_s) end # # Compares all attributes of the thing with another thing. # # @param other [Thing] The thing to compare with # @return [true,false] true if all attributes are equal, false otherwise # def config_eql?(other) # @deprecated OH3.4 - in OH4, channels can be included in the array and do not need to be compared separately channels.to_a == other.channels.to_a && %i[uid label bridge_uid location configuration].all? { |method| send(method) == other.send(method) } end # # Delegate missing methods to the thing's default actions scope. # # @example # things['mail:smtp:local'].send_email('[email protected]', 'subject', 'message') # def method_missing(method, *args, &block) return actions.public_send(method, *args, &block) if actions.respond_to?(method) super end # @!visibility private def respond_to_missing?(method_name, _include_private = false) logger.trace { "Checking if Thing #{uid} supports #{method_name} action" } return true if actions.respond_to?(method_name) super end end |
#location ⇒ String
Return the thing location
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/openhab/core/things/thing.rb', line 74 module Thing # Array wrapper class to allow searching a list of channels # by channel id class ChannelsArray < Array def initialize(thing, array) super(array) @thing = thing end # Allows indexing by both integer as an array or channel id acting like a hash. # @param [Integer, String, ChannelUID] index # Numeric index, string channel id, or a {ChannelUID} to search for. # @return [Channel, nil] def [](index) return @thing.get_channel(index) if index.is_a?(ChannelUID) return @thing.get_channel(index.to_str) if index.respond_to?(:to_str) super end end class << self # @!visibility private # # Override to support Proxy # def ===(other) other.is_a?(self) end end # # @!method uninitialized? # Check if thing status == UNINITIALIZED # @return [true,false] # # # @!method initialized? # Check if thing status == INITIALIZED # @return [true,false] # # # @!method unknown? # Check if thing status == UNKNOWN # @return [true,false] # # # @!method online? # Check if thing status == ONLINE # @return [true,false] # # # @!method offline? # Check if thing status == OFFLINE # @return [true,false] # # # @!method removing? # Check if thing status == REMOVING # @return [true,false] # # # @!method removed? # Check if thing status == REMOVED # @return [true,false] # ThingStatus.constants.each do |thingstatus| define_method(:"#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) } end # # Enable the Thing # # @param [true, false] enabled # @return [void] # def enable(enabled: true) Things.manager.set_enabled(uid, enabled) end # # Disable the Thing # # @return [void] # def disable enable(enabled: false) end # @!attribute [r] thing_type # @return [ThingType] def thing_type ThingType.registry.get_thing_type(thing_type_uid) end # @!attribute [r] bridge # @return [Thing, nil] def bridge bridge_uid && EntityLookup.lookup_thing(bridge_uid) end # @return [true,false] true if this Thing is a bridge def bridge? is_a?(org.openhab.core.thing.Bridge) end # @return [String] def inspect r = "#<OpenHAB::Core::Things::Thing #{uid}" r += " #{label.inspect}" if label r += " (#{location.inspect})" if location r += " #{status}" unless status_info.status_detail == org.openhab.core.thing.ThingStatusDetail::NONE r += " (#{status_info.status_detail})" end r += " configuration=#{configuration.properties.to_h}" unless configuration.properties.empty? r += " properties=#{properties.to_h}" unless properties.empty? "#{r}>" end # # Return Thing's uid as a string # # @return [String] # def to_s uid.to_s end # @return [org.openhab.core.common.registry.Provider, nil] def provider Provider.registry.provider_for(uid) end # # Fetches the actions available for this thing. # # Default scope actions are available directly on the thing object, via # {#method_missing}. # # @param [String, nil] scope The action scope. Default's to the thing's binding. # @return [Object, nil] # # @example # things["max:thermostat:mybridge:thermostat"].actions("max-devices").delete_from_cube # # @example (see #method_missing) # def actions(scope = nil) $actions.get(scope || uid.binding_id, uid.to_s) end # # Compares all attributes of the thing with another thing. # # @param other [Thing] The thing to compare with # @return [true,false] true if all attributes are equal, false otherwise # def config_eql?(other) # @deprecated OH3.4 - in OH4, channels can be included in the array and do not need to be compared separately channels.to_a == other.channels.to_a && %i[uid label bridge_uid location configuration].all? { |method| send(method) == other.send(method) } end # # Delegate missing methods to the thing's default actions scope. # # @example # things['mail:smtp:local'].send_email('[email protected]', 'subject', 'message') # def method_missing(method, *args, &block) return actions.public_send(method, *args, &block) if actions.respond_to?(method) super end # @!visibility private def respond_to_missing?(method_name, _include_private = false) logger.trace { "Checking if Thing #{uid} supports #{method_name} action" } return true if actions.respond_to?(method_name) super end end |
#properties ⇒ Hash (readonly)
Return the properties when available.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/openhab/core/things/thing.rb', line 74 module Thing # Array wrapper class to allow searching a list of channels # by channel id class ChannelsArray < Array def initialize(thing, array) super(array) @thing = thing end # Allows indexing by both integer as an array or channel id acting like a hash. # @param [Integer, String, ChannelUID] index # Numeric index, string channel id, or a {ChannelUID} to search for. # @return [Channel, nil] def [](index) return @thing.get_channel(index) if index.is_a?(ChannelUID) return @thing.get_channel(index.to_str) if index.respond_to?(:to_str) super end end class << self # @!visibility private # # Override to support Proxy # def ===(other) other.is_a?(self) end end # # @!method uninitialized? # Check if thing status == UNINITIALIZED # @return [true,false] # # # @!method initialized? # Check if thing status == INITIALIZED # @return [true,false] # # # @!method unknown? # Check if thing status == UNKNOWN # @return [true,false] # # # @!method online? # Check if thing status == ONLINE # @return [true,false] # # # @!method offline? # Check if thing status == OFFLINE # @return [true,false] # # # @!method removing? # Check if thing status == REMOVING # @return [true,false] # # # @!method removed? # Check if thing status == REMOVED # @return [true,false] # ThingStatus.constants.each do |thingstatus| define_method(:"#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) } end # # Enable the Thing # # @param [true, false] enabled # @return [void] # def enable(enabled: true) Things.manager.set_enabled(uid, enabled) end # # Disable the Thing # # @return [void] # def disable enable(enabled: false) end # @!attribute [r] thing_type # @return [ThingType] def thing_type ThingType.registry.get_thing_type(thing_type_uid) end # @!attribute [r] bridge # @return [Thing, nil] def bridge bridge_uid && EntityLookup.lookup_thing(bridge_uid) end # @return [true,false] true if this Thing is a bridge def bridge? is_a?(org.openhab.core.thing.Bridge) end # @return [String] def inspect r = "#<OpenHAB::Core::Things::Thing #{uid}" r += " #{label.inspect}" if label r += " (#{location.inspect})" if location r += " #{status}" unless status_info.status_detail == org.openhab.core.thing.ThingStatusDetail::NONE r += " (#{status_info.status_detail})" end r += " configuration=#{configuration.properties.to_h}" unless configuration.properties.empty? r += " properties=#{properties.to_h}" unless properties.empty? "#{r}>" end # # Return Thing's uid as a string # # @return [String] # def to_s uid.to_s end # @return [org.openhab.core.common.registry.Provider, nil] def provider Provider.registry.provider_for(uid) end # # Fetches the actions available for this thing. # # Default scope actions are available directly on the thing object, via # {#method_missing}. # # @param [String, nil] scope The action scope. Default's to the thing's binding. # @return [Object, nil] # # @example # things["max:thermostat:mybridge:thermostat"].actions("max-devices").delete_from_cube # # @example (see #method_missing) # def actions(scope = nil) $actions.get(scope || uid.binding_id, uid.to_s) end # # Compares all attributes of the thing with another thing. # # @param other [Thing] The thing to compare with # @return [true,false] true if all attributes are equal, false otherwise # def config_eql?(other) # @deprecated OH3.4 - in OH4, channels can be included in the array and do not need to be compared separately channels.to_a == other.channels.to_a && %i[uid label bridge_uid location configuration].all? { |method| send(method) == other.send(method) } end # # Delegate missing methods to the thing's default actions scope. # # @example # things['mail:smtp:local'].send_email('[email protected]', 'subject', 'message') # def method_missing(method, *args, &block) return actions.public_send(method, *args, &block) if actions.respond_to?(method) super end # @!visibility private def respond_to_missing?(method_name, _include_private = false) logger.trace { "Checking if Thing #{uid} supports #{method_name} action" } return true if actions.respond_to?(method_name) super end end |
#status ⇒ org.openhab.core.thing.ThingStatus (readonly)
Return the thing status
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/openhab/core/things/thing.rb', line 74 module Thing # Array wrapper class to allow searching a list of channels # by channel id class ChannelsArray < Array def initialize(thing, array) super(array) @thing = thing end # Allows indexing by both integer as an array or channel id acting like a hash. # @param [Integer, String, ChannelUID] index # Numeric index, string channel id, or a {ChannelUID} to search for. # @return [Channel, nil] def [](index) return @thing.get_channel(index) if index.is_a?(ChannelUID) return @thing.get_channel(index.to_str) if index.respond_to?(:to_str) super end end class << self # @!visibility private # # Override to support Proxy # def ===(other) other.is_a?(self) end end # # @!method uninitialized? # Check if thing status == UNINITIALIZED # @return [true,false] # # # @!method initialized? # Check if thing status == INITIALIZED # @return [true,false] # # # @!method unknown? # Check if thing status == UNKNOWN # @return [true,false] # # # @!method online? # Check if thing status == ONLINE # @return [true,false] # # # @!method offline? # Check if thing status == OFFLINE # @return [true,false] # # # @!method removing? # Check if thing status == REMOVING # @return [true,false] # # # @!method removed? # Check if thing status == REMOVED # @return [true,false] # ThingStatus.constants.each do |thingstatus| define_method(:"#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) } end # # Enable the Thing # # @param [true, false] enabled # @return [void] # def enable(enabled: true) Things.manager.set_enabled(uid, enabled) end # # Disable the Thing # # @return [void] # def disable enable(enabled: false) end # @!attribute [r] thing_type # @return [ThingType] def thing_type ThingType.registry.get_thing_type(thing_type_uid) end # @!attribute [r] bridge # @return [Thing, nil] def bridge bridge_uid && EntityLookup.lookup_thing(bridge_uid) end # @return [true,false] true if this Thing is a bridge def bridge? is_a?(org.openhab.core.thing.Bridge) end # @return [String] def inspect r = "#<OpenHAB::Core::Things::Thing #{uid}" r += " #{label.inspect}" if label r += " (#{location.inspect})" if location r += " #{status}" unless status_info.status_detail == org.openhab.core.thing.ThingStatusDetail::NONE r += " (#{status_info.status_detail})" end r += " configuration=#{configuration.properties.to_h}" unless configuration.properties.empty? r += " properties=#{properties.to_h}" unless properties.empty? "#{r}>" end # # Return Thing's uid as a string # # @return [String] # def to_s uid.to_s end # @return [org.openhab.core.common.registry.Provider, nil] def provider Provider.registry.provider_for(uid) end # # Fetches the actions available for this thing. # # Default scope actions are available directly on the thing object, via # {#method_missing}. # # @param [String, nil] scope The action scope. Default's to the thing's binding. # @return [Object, nil] # # @example # things["max:thermostat:mybridge:thermostat"].actions("max-devices").delete_from_cube # # @example (see #method_missing) # def actions(scope = nil) $actions.get(scope || uid.binding_id, uid.to_s) end # # Compares all attributes of the thing with another thing. # # @param other [Thing] The thing to compare with # @return [true,false] true if all attributes are equal, false otherwise # def config_eql?(other) # @deprecated OH3.4 - in OH4, channels can be included in the array and do not need to be compared separately channels.to_a == other.channels.to_a && %i[uid label bridge_uid location configuration].all? { |method| send(method) == other.send(method) } end # # Delegate missing methods to the thing's default actions scope. # # @example # things['mail:smtp:local'].send_email('[email protected]', 'subject', 'message') # def method_missing(method, *args, &block) return actions.public_send(method, *args, &block) if actions.respond_to?(method) super end # @!visibility private def respond_to_missing?(method_name, _include_private = false) logger.trace { "Checking if Thing #{uid} supports #{method_name} action" } return true if actions.respond_to?(method_name) super end end |
#thing_type ⇒ ThingType (readonly)
172 173 174 |
# File 'lib/openhab/core/things/thing.rb', line 172 def thing_type ThingType.registry.get_thing_type(thing_type_uid) end |
#thing_type_uid ⇒ ThingTypeUID (readonly)
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/openhab/core/things/thing.rb', line 74 module Thing # Array wrapper class to allow searching a list of channels # by channel id class ChannelsArray < Array def initialize(thing, array) super(array) @thing = thing end # Allows indexing by both integer as an array or channel id acting like a hash. # @param [Integer, String, ChannelUID] index # Numeric index, string channel id, or a {ChannelUID} to search for. # @return [Channel, nil] def [](index) return @thing.get_channel(index) if index.is_a?(ChannelUID) return @thing.get_channel(index.to_str) if index.respond_to?(:to_str) super end end class << self # @!visibility private # # Override to support Proxy # def ===(other) other.is_a?(self) end end # # @!method uninitialized? # Check if thing status == UNINITIALIZED # @return [true,false] # # # @!method initialized? # Check if thing status == INITIALIZED # @return [true,false] # # # @!method unknown? # Check if thing status == UNKNOWN # @return [true,false] # # # @!method online? # Check if thing status == ONLINE # @return [true,false] # # # @!method offline? # Check if thing status == OFFLINE # @return [true,false] # # # @!method removing? # Check if thing status == REMOVING # @return [true,false] # # # @!method removed? # Check if thing status == REMOVED # @return [true,false] # ThingStatus.constants.each do |thingstatus| define_method(:"#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) } end # # Enable the Thing # # @param [true, false] enabled # @return [void] # def enable(enabled: true) Things.manager.set_enabled(uid, enabled) end # # Disable the Thing # # @return [void] # def disable enable(enabled: false) end # @!attribute [r] thing_type # @return [ThingType] def thing_type ThingType.registry.get_thing_type(thing_type_uid) end # @!attribute [r] bridge # @return [Thing, nil] def bridge bridge_uid && EntityLookup.lookup_thing(bridge_uid) end # @return [true,false] true if this Thing is a bridge def bridge? is_a?(org.openhab.core.thing.Bridge) end # @return [String] def inspect r = "#<OpenHAB::Core::Things::Thing #{uid}" r += " #{label.inspect}" if label r += " (#{location.inspect})" if location r += " #{status}" unless status_info.status_detail == org.openhab.core.thing.ThingStatusDetail::NONE r += " (#{status_info.status_detail})" end r += " configuration=#{configuration.properties.to_h}" unless configuration.properties.empty? r += " properties=#{properties.to_h}" unless properties.empty? "#{r}>" end # # Return Thing's uid as a string # # @return [String] # def to_s uid.to_s end # @return [org.openhab.core.common.registry.Provider, nil] def provider Provider.registry.provider_for(uid) end # # Fetches the actions available for this thing. # # Default scope actions are available directly on the thing object, via # {#method_missing}. # # @param [String, nil] scope The action scope. Default's to the thing's binding. # @return [Object, nil] # # @example # things["max:thermostat:mybridge:thermostat"].actions("max-devices").delete_from_cube # # @example (see #method_missing) # def actions(scope = nil) $actions.get(scope || uid.binding_id, uid.to_s) end # # Compares all attributes of the thing with another thing. # # @param other [Thing] The thing to compare with # @return [true,false] true if all attributes are equal, false otherwise # def config_eql?(other) # @deprecated OH3.4 - in OH4, channels can be included in the array and do not need to be compared separately channels.to_a == other.channels.to_a && %i[uid label bridge_uid location configuration].all? { |method| send(method) == other.send(method) } end # # Delegate missing methods to the thing's default actions scope. # # @example # things['mail:smtp:local'].send_email('[email protected]', 'subject', 'message') # def method_missing(method, *args, &block) return actions.public_send(method, *args, &block) if actions.respond_to?(method) super end # @!visibility private def respond_to_missing?(method_name, _include_private = false) logger.trace { "Checking if Thing #{uid} supports #{method_name} action" } return true if actions.respond_to?(method_name) super end end |
#uid ⇒ ThingUID (readonly)
Return the UID.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/openhab/core/things/thing.rb', line 74 module Thing # Array wrapper class to allow searching a list of channels # by channel id class ChannelsArray < Array def initialize(thing, array) super(array) @thing = thing end # Allows indexing by both integer as an array or channel id acting like a hash. # @param [Integer, String, ChannelUID] index # Numeric index, string channel id, or a {ChannelUID} to search for. # @return [Channel, nil] def [](index) return @thing.get_channel(index) if index.is_a?(ChannelUID) return @thing.get_channel(index.to_str) if index.respond_to?(:to_str) super end end class << self # @!visibility private # # Override to support Proxy # def ===(other) other.is_a?(self) end end # # @!method uninitialized? # Check if thing status == UNINITIALIZED # @return [true,false] # # # @!method initialized? # Check if thing status == INITIALIZED # @return [true,false] # # # @!method unknown? # Check if thing status == UNKNOWN # @return [true,false] # # # @!method online? # Check if thing status == ONLINE # @return [true,false] # # # @!method offline? # Check if thing status == OFFLINE # @return [true,false] # # # @!method removing? # Check if thing status == REMOVING # @return [true,false] # # # @!method removed? # Check if thing status == REMOVED # @return [true,false] # ThingStatus.constants.each do |thingstatus| define_method(:"#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) } end # # Enable the Thing # # @param [true, false] enabled # @return [void] # def enable(enabled: true) Things.manager.set_enabled(uid, enabled) end # # Disable the Thing # # @return [void] # def disable enable(enabled: false) end # @!attribute [r] thing_type # @return [ThingType] def thing_type ThingType.registry.get_thing_type(thing_type_uid) end # @!attribute [r] bridge # @return [Thing, nil] def bridge bridge_uid && EntityLookup.lookup_thing(bridge_uid) end # @return [true,false] true if this Thing is a bridge def bridge? is_a?(org.openhab.core.thing.Bridge) end # @return [String] def inspect r = "#<OpenHAB::Core::Things::Thing #{uid}" r += " #{label.inspect}" if label r += " (#{location.inspect})" if location r += " #{status}" unless status_info.status_detail == org.openhab.core.thing.ThingStatusDetail::NONE r += " (#{status_info.status_detail})" end r += " configuration=#{configuration.properties.to_h}" unless configuration.properties.empty? r += " properties=#{properties.to_h}" unless properties.empty? "#{r}>" end # # Return Thing's uid as a string # # @return [String] # def to_s uid.to_s end # @return [org.openhab.core.common.registry.Provider, nil] def provider Provider.registry.provider_for(uid) end # # Fetches the actions available for this thing. # # Default scope actions are available directly on the thing object, via # {#method_missing}. # # @param [String, nil] scope The action scope. Default's to the thing's binding. # @return [Object, nil] # # @example # things["max:thermostat:mybridge:thermostat"].actions("max-devices").delete_from_cube # # @example (see #method_missing) # def actions(scope = nil) $actions.get(scope || uid.binding_id, uid.to_s) end # # Compares all attributes of the thing with another thing. # # @param other [Thing] The thing to compare with # @return [true,false] true if all attributes are equal, false otherwise # def config_eql?(other) # @deprecated OH3.4 - in OH4, channels can be included in the array and do not need to be compared separately channels.to_a == other.channels.to_a && %i[uid label bridge_uid location configuration].all? { |method| send(method) == other.send(method) } end # # Delegate missing methods to the thing's default actions scope. # # @example # things['mail:smtp:local'].send_email('[email protected]', 'subject', 'message') # def method_missing(method, *args, &block) return actions.public_send(method, *args, &block) if actions.respond_to?(method) super end # @!visibility private def respond_to_missing?(method_name, _include_private = false) logger.trace { "Checking if Thing #{uid} supports #{method_name} action" } return true if actions.respond_to?(method_name) super end end |
Instance Method Details
#actions(scope = nil) ⇒ Object?
Fetches the actions available for this thing.
Default scope actions are available directly on the thing object, via #method_missing.
229 230 231 |
# File 'lib/openhab/core/things/thing.rb', line 229 def actions(scope = nil) $actions.get(scope || uid.binding_id, uid.to_s) end |
#bridge? ⇒ true, false
Returns true if this Thing is a bridge.
183 184 185 |
# File 'lib/openhab/core/things/thing.rb', line 183 def bridge? is_a?(org.openhab.core.thing.Bridge) end |
#config_eql?(other) ⇒ true, false
Compares all attributes of the thing with another thing.
239 240 241 242 243 |
# File 'lib/openhab/core/things/thing.rb', line 239 def config_eql?(other) # @deprecated OH3.4 - in OH4, channels can be included in the array and do not need to be compared separately channels.to_a == other.channels.to_a && %i[uid label bridge_uid location configuration].all? { |method| send(method) == other.send(method) } end |
#disable ⇒ void
This method returns an undefined value.
Disable the Thing
166 167 168 |
# File 'lib/openhab/core/things/thing.rb', line 166 def disable enable(enabled: false) end |
#enable(enabled: true) ⇒ void
This method returns an undefined value.
Enable the Thing
157 158 159 |
# File 'lib/openhab/core/things/thing.rb', line 157 def enable(enabled: true) Things.manager.set_enabled(uid, enabled) end |
#initialized? ⇒ true, false
Check if thing status == INITIALIZED
|
# File 'lib/openhab/core/things/thing.rb', line 111
|
#inspect ⇒ String
188 189 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/openhab/core/things/thing.rb', line 188 def inspect r = "#<OpenHAB::Core::Things::Thing #{uid}" r += " #{label.inspect}" if label r += " (#{location.inspect})" if location r += " #{status}" unless status_info.status_detail == org.openhab.core.thing.ThingStatusDetail::NONE r += " (#{status_info.status_detail})" end r += " configuration=#{configuration.properties.to_h}" unless configuration.properties.empty? r += " properties=#{properties.to_h}" unless properties.empty? "#{r}>" end |
#offline? ⇒ true, false
Check if thing status == OFFLINE
|
# File 'lib/openhab/core/things/thing.rb', line 129
|
#online? ⇒ true, false
Check if thing status == ONLINE
|
# File 'lib/openhab/core/things/thing.rb', line 123
|
#provider ⇒ org.openhab.core.common.registry.Provider?
211 212 213 |
# File 'lib/openhab/core/things/thing.rb', line 211 def provider Provider.registry.provider_for(uid) end |
#removed? ⇒ true, false
Check if thing status == REMOVED
147 148 149 |
# File 'lib/openhab/core/things/thing.rb', line 147 ThingStatus.constants.each do |thingstatus| define_method(:"#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) } end |
#removing? ⇒ true, false
Check if thing status == REMOVING
|
# File 'lib/openhab/core/things/thing.rb', line 135
|
#to_s ⇒ String
Return Thing’s uid as a string
206 207 208 |
# File 'lib/openhab/core/things/thing.rb', line 206 def to_s uid.to_s end |
#uninitialized? ⇒ true, false
Check if thing status == UNINITIALIZED
|
# File 'lib/openhab/core/things/thing.rb', line 105
|
#unknown? ⇒ true, false
Check if thing status == UNKNOWN
|
# File 'lib/openhab/core/things/thing.rb', line 117
|