Class: OpenHAB::DSL::Items::GroupItemBuilder

Inherits:

ItemBuilder

• Object
• ItemBuilder
• OpenHAB::DSL::Items::GroupItemBuilder

Includes:

Builder

Defined in:

lib/openhab/dsl/items/builder.rb

Overview

Allows customizing a group. You can also call any method from Builder, and those items will automatically be a member of this group.

Instance Attribute Summary

• #function ⇒ String^?

  The combiner function for this group.

• #label_base ⇒ String^?

  A prefix to be added to the label of any member items.

• #members ⇒ Array<ItemBuilder> readonly

  Members to be created in this group.

• #name_base ⇒ String^?

  A prefix to be added to the name of any member items.

• #thing ⇒ Core::Things::ThingUID, ...

  A thing to be used as the base for the channel of any member items.

• #unit ⇒ String^? readonly

  Unit (for number items only).

Attributes inherited from ItemBuilder

#autoupdate, #command_options, #dimension, #format, #icon, #label, #metadata, #name, #range, #read_only, #state, #state_options, #step, #type

Instance Method Summary

• #initialize(type: nil, function: nil, thing: nil) ⇒ GroupItemBuilder constructor

  A new instance of GroupItemBuilder.

Methods included from Builder

#call_item, #color_item, #contact_item, #date_time_item, #dimmer_item, #group_item, #image_item, #location_item, #number_item, #player_item, #rollershutter_item, #string_item, #switch_item

Methods included from Core::EntityLookup

#items, #method_missing, #things

Methods inherited from ItemBuilder

#alexa, #channel, #expire, #ga, #group, #homekit, #inspect, #matter, #tag, #to_s

Constructor Details

#initialize(type: nil, function: nil, thing: nil) ⇒ GroupItemBuilder

Returns a new instance of GroupItemBuilder.

Parameters:

• type (Symbol, nil) (defaults to: nil) —

  The base type for the group

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

  The combiner function for this group

• thing (Core::Things::ThingUID, Core::Things::Thing, DSL::Things::Builder::ThingBuilder, String, nil) (defaults to: nil) —

  A Thing to be used as the base for the channel for any contained items.

• dimension (Symbol, String, nil) —

  The unit dimension for a NumberItem (see ItemBuilder#dimension) Note the dimension must be properly capitalized.

• unit (Symbol, String, nil) —

  The unit for a NumberItem (see ItemBuilder#unit)

• format (String, nil) —

  The formatting pattern for the item’s state (see ItemBuilder#format)

• icon (Symbol, String, nil) —

  The icon to be associated with the item (see ItemBuilder#icon)

• group (String, GroupItem, GroupItemBuilder, Array<String, GroupItem, GroupItemBuilder>, nil) —

  Group(s) to which this item should be added (see ItemBuilder#group).

• groups (String, GroupItem, GroupItemBuilder, Array<String, GroupItem, GroupItemBuilder>, nil) —

  Fluent alias for group.

• tag (String, Symbol, Semantics::Tag, Array<String, Symbol, Semantics::Tag>, nil) —

  Tag(s) to apply to this item (see ItemBuilder#tag).

• tags (String, Symbol, Semantics::Tag, Array<String, Symbol, Semantics::Tag>, nil) —

  Fluent alias for tag.

• autoupdate (true, false, nil) —

  Autoupdate setting (see ItemBuilder#autoupdate)

• thing (String, Core::Things::Thing, Core::Things::ThingUID, DSL::Things::Builder::ThingBuilder, nil) (defaults to: nil) —

  A Thing to be used as the base for the channel.

• channel (String, Symbol, Core::Things::ChannelUID, Core::Things::Channel, nil) —

  Channel to link the item to (see ItemBuilder#channel).

• expire (String) —

  An expiration specification (see ItemBuilder#expire).

• alexa (String, Symbol, Array<(String, Hash<String, Object>)>, nil) —

  Alexa metadata (see ItemBuilder#alexa)

• ga (String, Symbol, Array<(String, Hash<String, Object>)>, nil) —

  Google Assistant metadata (see ItemBuilder#ga)

• homekit (String, Symbol, Array<(String, Hash<String, Object>)>, nil) —

  Homekit metadata (see ItemBuilder#homekit)

• matter (String, Symbol, Array<(String, Hash<String, Object>)>, nil) —

  Matter metadata (see ItemBuilder#matter)

• metadata (Hash<String, Hash>) —

  Generic metadata (see ItemBuilder#metadata)

• state (State) —

  Initial state

Raises:

• (ArgumentError)

# File 'lib/openhab/dsl/items/builder.rb', line 809

def initialize(*, type: nil, function: nil, thing: nil, **)
  raise ArgumentError, "invalid function #{function}" if function && !function.match?(FUNCTION_REGEX)

  super(type, *, **)
  @function = function
  @members = []
  @thing = thing
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class OpenHAB::Core::EntityLookup

Instance Attribute Details

#function ⇒ String^?

The combiner function for this group

Returns:

• (String, nil)

# File 'lib/openhab/dsl/items/builder.rb', line 790

def function
  @function
end

#label_base ⇒ String^?

A prefix to be added to the label of any member items

Returns:

• (String, nil)

# File 'lib/openhab/dsl/items/builder.rb', line 799

def label_base
  @label_base
end

#members ⇒ Array<ItemBuilder> (readonly)

Members to be created in this group

Returns:

• (Array<ItemBuilder>)

# File 'lib/openhab/dsl/items/builder.rb', line 802

def members
  @members
end

#name_base ⇒ String^?

A prefix to be added to the name of any member items

Returns:

• (String, nil)

# File 'lib/openhab/dsl/items/builder.rb', line 796

def name_base
  @name_base
end

#thing ⇒ Core::Things::ThingUID, ...

A thing to be used as the base for the channel of any member items

Returns:

• (Core::Things::ThingUID, Core::Things::Thing, DSL::Things::Builder::ThingBuilder, String, nil)

# File 'lib/openhab/dsl/items/builder.rb', line 793

def thing
  @thing
end

#unit ⇒ String^? (readonly)

Unit (for number items only)

Returns:

• (String, nil)

# File 'lib/openhab/dsl/items/builder.rb', line 771

def unit
  @unit
end