Class: OpenHAB::DSL::Items::ItemBuilder
- Inherits:
-
Object
- Object
- OpenHAB::DSL::Items::ItemBuilder
- Includes:
- Core::EntityLookup
- Defined in:
- lib/openhab/dsl/items/builder.rb
Overview
The ItemBuilder DSL allows you to customize an Item
Direct Known Subclasses
Instance Attribute Summary collapse
-
#autoupdate ⇒ true, ...
Autoupdate setting.
-
#channels ⇒ String, ...
Channel to link the item to.
-
#dimension ⇒ String?
Unit dimension (for number items only).
-
#format ⇒ String?
The formatting pattern for the item’s state.
-
#groups ⇒ Array<String, GroupItem>
readonly
Groups to which this item should be added.
-
#icon ⇒ Symbol, ...
The icon to be associated with the item.
-
#label ⇒ String?
Item label.
- #metadata ⇒ Core::Items::Metadata::NamespaceHash readonly
-
#name ⇒ String
Item name.
-
#state ⇒ Core::Types::State
Initial state.
-
#tags ⇒ Array<String, Semantics::Tag>
readonly
Tags to apply to this item.
-
#type ⇒ Symbol
readonly
The type of this item.
-
#unit ⇒ String?
Unit (for number items only).
Instance Method Summary collapse
-
#alexa(value, config = nil) ⇒ void
Shortcut for adding Alexa metadata.
-
#channel(channel, config = {}) ⇒ void
Add a channel link to this item.
-
#expire(duration, command: nil, state: nil, ignore_state_updates: nil, ignore_commands: nil) ⇒ void
Configure item expiration.
-
#ga(value, config = nil) ⇒ void
Shortcut for adding Google Assistant metadata.
-
#group(*groups) ⇒ void
Add this item to a group.
-
#homekit(value, config = nil) ⇒ void
Shortcut for adding Homekit metadata.
-
#initialize(type, name = nil, label = nil, provider:, dimension: nil, unit: nil, format: nil, icon: nil, group: nil, groups: nil, tag: nil, tags: nil, autoupdate: nil, thing: nil, channel: nil, expire: nil, alexa: nil, ga: nil, homekit: nil, metadata: nil, state: nil) ⇒ ItemBuilder
constructor
A new instance of ItemBuilder.
- #inspect ⇒ String
-
#tag(*tags) ⇒ void
Tag item.
-
#to_s ⇒ String
The item’s label if one is defined, otherwise its name.
Methods included from Core::EntityLookup
Constructor Details
#initialize(type, name = nil, label = nil, provider:, dimension: nil, unit: nil, format: nil, icon: nil, group: nil, groups: nil, tag: nil, tags: nil, autoupdate: nil, thing: nil, channel: nil, expire: nil, alexa: nil, ga: nil, homekit: nil, metadata: nil, state: nil) ⇒ ItemBuilder
Returns a new instance of ItemBuilder.
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 |
# File 'lib/openhab/dsl/items/builder.rb', line 315 def initialize(type, name = nil, label = nil, provider:, dimension: nil, unit: nil, format: nil, icon: nil, group: nil, groups: nil, tag: nil, tags: nil, autoupdate: nil, thing: nil, channel: nil, expire: nil, alexa: nil, ga: nil, # rubocop:disable Naming/MethodParameterName homekit: nil, metadata: nil, state: nil) raise ArgumentError, "`name` cannot be nil" if name.nil? if dimension raise ArgumentError, "`dimension` can only be specified with NumberItem" unless type == :number begin org.openhab.core.types.util.UnitUtils.parse_dimension(dimension.to_s) rescue java.lang.IllegalArgumentException raise ArgumentError, "Invalid dimension '#{dimension}'" end end name = name.name if name.respond_to?(:name) if provider.is_a?(GroupItemBuilder) name = "#{provider.name_base}#{name}" label = "#{provider.label_base}#{label}".strip if label end @provider = provider @type = type @name = name.to_s @label = label @dimension = dimension @format = format self.unit = unit @icon = icon @groups = [] @tags = [] @metadata = Core::Items::Metadata::NamespaceHash.new @metadata.merge!() if @autoupdate = autoupdate @channels = [] @thing = thing @expire = nil if expire expire = Array(expire) expire_config = expire.pop if expire.last.is_a?(Hash) expire_config ||= {} self.expire(*expire, **expire_config) end self.alexa(alexa) if alexa self.ga(ga) if ga self.homekit(homekit) if homekit self.state = state self.group(*group) self.group(*groups) self.tag(*tag) self.tag(*) self.channel(*channel) if channel end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class OpenHAB::Core::EntityLookup
Instance Attribute Details
#autoupdate ⇒ true, ...
Autoupdate setting
234 235 236 |
# File 'lib/openhab/dsl/items/builder.rb', line 234 def autoupdate @autoupdate end |
#channels ⇒ String, ...
Channel to link the item to
237 238 239 |
# File 'lib/openhab/dsl/items/builder.rb', line 237 def channels @channels end |
#dimension ⇒ String?
Unit dimension (for number items only)
If #unit is provided, and #dimension is not, it will be inferred.
209 210 211 |
# File 'lib/openhab/dsl/items/builder.rb', line 209 def dimension @dimension end |
#format ⇒ String?
222 223 224 |
# File 'lib/openhab/dsl/items/builder.rb', line 222 def format @format end |
#groups ⇒ Array<String, GroupItem> (readonly)
Groups to which this item should be added
228 229 230 |
# File 'lib/openhab/dsl/items/builder.rb', line 228 def groups @groups end |
#icon ⇒ Symbol, ...
The icon to be associated with the item
225 226 227 |
# File 'lib/openhab/dsl/items/builder.rb', line 225 def icon @icon end |
#label ⇒ String?
Item label
203 204 205 |
# File 'lib/openhab/dsl/items/builder.rb', line 203 def label @label end |
#metadata ⇒ Core::Items::Metadata::NamespaceHash (readonly)
239 240 241 |
# File 'lib/openhab/dsl/items/builder.rb', line 239 def @metadata end |
#name ⇒ String
Item name
200 201 202 |
# File 'lib/openhab/dsl/items/builder.rb', line 200 def name @name end |
#state ⇒ Core::Types::State
Initial state
If #state is set to a QuantityType, and #unit is not set, it will be inferred.
245 246 247 |
# File 'lib/openhab/dsl/items/builder.rb', line 245 def state @state end |
#tags ⇒ Array<String, Semantics::Tag> (readonly)
Tags to apply to this item
231 232 233 |
# File 'lib/openhab/dsl/items/builder.rb', line 231 def @tags end |
#type ⇒ Symbol (readonly)
The type of this item
197 198 199 |
# File 'lib/openhab/dsl/items/builder.rb', line 197 def type @type end |
Instance Method Details
#alexa(value, config = nil) ⇒ void
This method returns an undefined value.
Shortcut for adding Alexa metadata
|
# File 'lib/openhab/dsl/items/builder.rb', line 424
|
#channel(channel, config = {}) ⇒ void
This method returns an undefined value.
Add a channel link to this item.
484 485 486 487 488 |
# File 'lib/openhab/dsl/items/builder.rb', line 484 def channel(channel, config = {}) channel = channel.to_s channel = "#{@thing}:#{channel}" if @thing && !channel.include?(":") @channels << [channel, config] end |
#expire(duration, command: nil, state: nil, ignore_state_updates: nil, ignore_commands: nil) ⇒ void
This method returns an undefined value.
Configure item expiration
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 |
# File 'lib/openhab/dsl/items/builder.rb', line 520 def expire(*args, command: nil, state: nil, ignore_state_updates: nil, ignore_commands: nil) unless (0..2).cover?(args.length) raise ArgumentError, "wrong number of arguments (given #{args.length}, expected 0..2)" end return @expire if args.empty? state = args.last if args.length == 2 raise ArgumentError, "cannot provide both command and state" if command && state duration = args.first return @expire = nil if duration.nil? duration = duration.to_s[2..].downcase if duration.is_a?(Duration) state = "'#{state}'" if state.respond_to?(:to_str) && type == :string value = duration value += ",state=#{state}" if state value += ",command=#{command}" if command config = { ignoreStateUpdates: ignore_state_updates, ignoreCommands: ignore_commands } config.compact! @expire = [value, config] end |
#ga(value, config = nil) ⇒ void
This method returns an undefined value.
Shortcut for adding Google Assistant metadata
|
# File 'lib/openhab/dsl/items/builder.rb', line 435
|
#group(*groups) ⇒ void
This method returns an undefined value.
Add this item to a group
414 415 416 417 418 419 420 421 422 |
# File 'lib/openhab/dsl/items/builder.rb', line 414 def group(*groups) unless groups.all? do |group| group.is_a?(String) || group.is_a?(Core::Items::GroupItem) || group.is_a?(GroupItemBuilder) end raise ArgumentError, "`group` must be a `GroupItem`, `GroupItemBuilder`, or a `String`" end @groups.concat(groups) end |
#homekit(value, config = nil) ⇒ void
This method returns an undefined value.
Shortcut for adding Homekit metadata
457 458 459 460 461 462 |
# File 'lib/openhab/dsl/items/builder.rb', line 457 %i[alexa ga homekit].each do |shortcut| define_method(shortcut) do |value = nil, config = nil| value, config = value if value.is_a?(Array) [shortcut] = [value, config] end end |
#inspect ⇒ String
598 599 600 601 602 603 604 605 |
# File 'lib/openhab/dsl/items/builder.rb', line 598 def inspect s = "#<OpenHAB::Core::Items::#{inspect_type}ItemBuilder#{type_details} #{name} #{label.inspect}" s += " category=#{icon.inspect}" if icon s += " tags=#{.inspect}" unless .empty? s += " groups=#{groups.map { |g| g.respond_to?(:name) ? g.name : g }.inspect}" unless groups.empty? s += " metadata=#{.to_h.inspect}" unless .empty? "#{s}>" end |
#tag(*tags) ⇒ void
This method returns an undefined value.
Tag item
404 405 406 |
# File 'lib/openhab/dsl/items/builder.rb', line 404 def tag(*) @tags += self.class.(*) end |
#to_s ⇒ String
The item’s label if one is defined, otherwise its name.
394 395 396 |
# File 'lib/openhab/dsl/items/builder.rb', line 394 def to_s label || name end |