openHAB

Class: OpenHAB::DSL::Things::ThingBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/openhab/dsl/things/builder.rb

Overview

The ThingBuilder DSL allows you to customize a thing

Direct Known Subclasses

BridgeBuilder

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(uid, label = nil, binding: nil, type: nil, bridge: nil, location: nil, config: {}, enabled: nil) ⇒ ThingBuilder

Constructor for ThingBuilder

Parameters:

  • uid (String) —

    The ThingUID for the created Thing. This can consist one or more segments separated by a colon. When the uid contains:

    • One segment: When the uid contains one segment, binding or bridge id must be provided.
    • Two segments: typeid:thingid The binding or bridge id must be provided.
    • Three or more segments: bindingid:typeid:[bridgeid...]:thingid. The type and bridge can be omitted
  • label (String) (defaults to: nil) —

    The Thing's label.

  • binding (String) (defaults to: nil) —

    The binding id. When this argument is not provided, the binding id must be deducible from the uid, type, or bridge.

  • type (String) (defaults to: nil) —

    The type id. When this argument is not provided, it will be deducible from the uid if it contains two or more segments. To create a Thing with a blank type id, use one segment for uid and provide the binding id.

  • bridge (String, BridgeBuilder) (defaults to: nil) —

    The bridge uid, if the Thing should belong to a bridge.

  • location (String, Item) (defaults to: nil) —

    The location of this Thing. When given an Item, use the item's label as the location.

  • config (Hash) (defaults to: {}) —

    The Thing's configuration, as required by the binding. The key can be strings or symbols.

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

    Whether the Thing should be enabled or disabled.



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
 
# File 'lib/openhab/dsl/things/builder.rb', line 141

def initialize(uid, label = nil, binding: nil, type: nil, bridge: nil, location: nil, config: {}, enabled: nil)
  @channels = []
  uid = uid.to_s
  uid_segments = uid.split(org.openhab.core.common.AbstractUID::SEPARATOR)
  @bridge_uid = nil
  bridge = bridge.uid if bridge.is_a?(org.openhab.core.thing.Bridge) || bridge.is_a?(BridgeBuilder)
  bridge = bridge&.to_s
  bridge_segments = bridge&.split(org.openhab.core.common.AbstractUID::SEPARATOR) || []
  type = type&.to_s

  # infer missing components
  type ||= uid_segments[0] if uid_segments.length == 2
  type ||= uid_segments[1] if uid_segments.length > 2
  binding ||= uid_segments[0] if uid_segments.length > 2
  binding ||= bridge_segments[0] if bridge_segments && bridge_segments.length > 2

  if bridge
    bridge_segments.unshift(binding) if bridge_segments.length < 3
    @bridge_uid = org.openhab.core.thing.ThingUID.new(*bridge_segments)
  end

  thinguid = if uid_segments.length > 2
               [binding, type, uid_segments.last].compact
             else
               [binding, type, @bridge_uid&.id, uid_segments.last].compact
             end

  @uid = org.openhab.core.thing.ThingUID.new(*thinguid)
  @thing_type_uid = org.openhab.core.thing.ThingTypeUID.new(*@uid.all_segments[0..1])
  @label = label
  @location = location
  @location = location.label if location.is_a?(Item)
  @config = config.transform_keys(&:to_s)
  @enabled = enabled
end

Instance Attribute Details

#bridge_uid ⇒ Core::Things::ThingUID? (readonly)

The bridge of this thing

Returns:



87
88
89
 
# File 'lib/openhab/dsl/things/builder.rb', line 87

def bridge_uid
  @bridge_uid
end

#channels ⇒ Array<ChannelBuilder> (readonly)

Explicitly configured channels on this thing

Returns:



96
97
98
 
# File 'lib/openhab/dsl/things/builder.rb', line 96

def channels
  @channels
end

#config ⇒ Hash? (readonly)

The config for this thing

Returns:

  • (Hash, nil) 


90
91
92
 
# File 'lib/openhab/dsl/things/builder.rb', line 90

def config
  @config
end

#enabled ⇒ true, ... (readonly)

If the thing should be enabled after it is created

Returns:

  • (true, false, nil) 


93
94
95
 
# File 'lib/openhab/dsl/things/builder.rb', line 93

def enabled
  @enabled
end

#label ⇒ String?

The label for this thing

Returns:

  • (String, nil) 


75
76
77
 
# File 'lib/openhab/dsl/things/builder.rb', line 75

def label
  @label
end

#location ⇒ String?

The location for this thing

Returns:

  • (String, nil) 


78
79
80
 
# File 'lib/openhab/dsl/things/builder.rb', line 78

def location
  @location
end

#thing_type_uid ⇒ ThingTypeUID (readonly)

The type of this thing

Returns:

  • (ThingTypeUID) 


84
85
86
 
# File 'lib/openhab/dsl/things/builder.rb', line 84

def thing_type_uid
  @thing_type_uid
end

#uid ⇒ Core::Things::ThingUID (readonly)

The id for this thing

Returns:



81
82
83
 
# File 'lib/openhab/dsl/things/builder.rb', line 81

def uid
  @uid
end

Instance Method Details

#channel(*args, **kwargs, &block) ⇒ Object

Add an explicitly configured channel to this item

See Also:



179
180
181
182
183
 
# File 'lib/openhab/dsl/things/builder.rb', line 179

def channel(*args, **kwargs, &block)
  channel = ChannelBuilder.new(*args, thing: self, **kwargs)
  channel.instance_eval(&block) if block
  @channels << channel.build
end