openHAB

Module: OpenHAB::Core::Things::Thing

Defined in:
lib/openhab/core/things/thing.rb

Overview

A Thing is a representation of a connected part (e.g. physical device or cloud service) from the real world. It contains a list of Channels, which can be bound to Items.

Examples:

thing = things["chromecast:audiogroup:dd9f8622-eee-4eaf-b33f-cdcdcdeee001121"]
logger.info("Audiogroup Status: #{thing&.status}")
logger.info("Audiogroup Online? #{thing&.online?}")
logger.info("Channel ids: #{thing.channels.map(&:uid)}")
logger.info("Items linked to volume channel: #{thing.channels['volume']&.items&.map(&:name)&.join(', ')}")
logger.info("Item linked to volume channel: #{thing.channels['volume']&.item&.name}")

Thing actions can be called directly through a Thing object

things["mqtt:broker:mosquitto"].publish_mqtt("zigbee2mqttt/bridge/config/permit_join", "true")
things["mail:smtp:local"].send_mail("me@example.com", "Subject", "Email body")

Thing can be accessed directly through entity lookup

# replace ':' with '_' in thing uid
mqtt_broker_mosquitto.online? # is mqtt:broker:mosquitto thing online?

See Also:

Defined Under Namespace

Classes: ChannelsArray

Instance Attribute Summary collapse

Instance Method Summary collapse

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.

Examples:

things['mail:smtp:local'].send_email('me@example.com', 'subject', 'message')


222
223
224
225
226
 
# File 'lib/openhab/core/things/thing.rb', line 222

def method_missing(method, *args, &block)
  return actions.public_send(method, *args, &block) if actions.respond_to?(method)

  super
end

Instance Attribute Details

#bridge_uid ⇒ org.openhab.core.thing.ThingUID (readonly)

Return the Bridge UID when available.

Returns:



63
64
65
66
67
68
69
70
71
72
73
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
 
# File 'lib/openhab/core/things/thing.rb', line 63

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.
    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

  # @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('me@example.com', '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)

Returns:



63
64
65
66
67
68
69
70
71
72
73
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
 
# File 'lib/openhab/core/things/thing.rb', line 63

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.
    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

  # @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('me@example.com', '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.

Examples:

logger.info things["smtp:mail:local"].configuration["hostname"]
logger.info things["ipcamera:dahua:frontporch"].configuration["ipAddress"]

Returns:



63
64
65
66
67
68
69
70
71
72
73
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
 
# File 'lib/openhab/core/things/thing.rb', line 63

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.
    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

  # @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('me@example.com', '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.

Examples:

logger.info things["fronius:meter:mybridge:mymeter"].properties["modelId"]

Returns:

  • (Hash) 


63
64
65
66
67
68
69
70
71
72
73
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
 
# File 'lib/openhab/core/things/thing.rb', line 63

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.
    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

  # @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('me@example.com', '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

Returns:



63
64
65
66
67
68
69
70
71
72
73
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
 
# File 'lib/openhab/core/things/thing.rb', line 63

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.
    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

  # @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('me@example.com', '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 ⇒ org.openhab.core.thing.ThingUID (readonly)

Return the UID.

Returns:



63
64
65
66
67
68
69
70
71
72
73
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
 
# File 'lib/openhab/core/things/thing.rb', line 63

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.
    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

  # @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('me@example.com', '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.

Examples:

things["max:thermostat:mybridge:thermostat"].actions("max-devices").delete_from_cube
things['mail:smtp:local'].send_email('me@example.com', 'subject', 'message')

Parameters:

  • scope (String, nil) (defaults to: nil) —

    The action scope. Default's to the thing's binding.

Returns:

  • (Object, nil) 


200
201
202
 
# File 'lib/openhab/core/things/thing.rb', line 200

def actions(scope = nil)
  $actions.get(scope || uid.binding_id, uid.to_s)
end

#config_eql?(other) ⇒ true, false

Compares all attributes of the thing with another thing.

Parameters:

  • other (Thing) —

    The thing to compare with

Returns:

  • (true, false) —

    true if all attributes are equal, false otherwise



210
211
212
213
214
 
# File 'lib/openhab/core/things/thing.rb', line 210

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



154
155
156
 
# File 'lib/openhab/core/things/thing.rb', line 154

def disable
  enable(enabled: false)
end

#enable(enabled: true) ⇒ void

This method returns an undefined value.

Enable the Thing

Parameters:

  • enabled (true, false) (defaults to: true) 


145
146
147
 
# File 'lib/openhab/core/things/thing.rb', line 145

def enable(enabled: true)
  Things.manager.set_enabled(uid, enabled)
end

#initialized? ⇒ true, false

Check if thing status == INITIALIZED

Returns:

  • (true, false) 



# File 'lib/openhab/core/things/thing.rb', line 99

#inspect ⇒ String

Returns:

  • (String) 


159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/openhab/core/things/thing.rb', line 159

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

Returns:

  • (true, false) 



# File 'lib/openhab/core/things/thing.rb', line 117

#online? ⇒ true, false

Check if thing status == ONLINE

Returns:

  • (true, false) 



# File 'lib/openhab/core/things/thing.rb', line 111

#provider ⇒ org.openhab.core.common.registry.Provider?

Returns:



182
183
184
 
# File 'lib/openhab/core/things/thing.rb', line 182

def provider
  Provider.registry.provider_for(uid)
end

#removed? ⇒ true, false

Check if thing status == REMOVED

Returns:

  • (true, false) 


135
136
137
 
# File 'lib/openhab/core/things/thing.rb', line 135

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

Returns:

  • (true, false) 



# File 'lib/openhab/core/things/thing.rb', line 123

#to_s ⇒ String

Return Thing's uid as a string

Returns:

  • (String) 


177
178
179
 
# File 'lib/openhab/core/things/thing.rb', line 177

def to_s
  uid.to_s
end

#uninitialized? ⇒ true, false

Check if thing status == UNINITIALIZED

Returns:

  • (true, false) 



# File 'lib/openhab/core/things/thing.rb', line 93

#unknown? ⇒ true, false

Check if thing status == UNKNOWN

Returns:

  • (true, false) 



# File 'lib/openhab/core/things/thing.rb', line 105