openHAB

Class: OpenHAB::Core::Sitemaps::Registry

Inherits:
Object
  • Object
show all
Includes:
LazyArray
Defined in:
lib/openhab/core/sitemaps/registry.rb

Overview

Provides access to all openHAB sitemap definitions, and acts like an array.

Instance Method Summary collapse

Methods included from LazyArray

#each, #method_missing, #to_ary

Methods included from Enumerable

#all_groups, #all_members, #command, #command!, #decrease, #down, #equipments, #fast_forward, #groups, #increase, #locations, #member_of, #members, #move, #next, #not_member_of, #not_tagged, #off, #on, #pause, #play, #points, #previous, #refresh, #rewind, #stop, #tagged, #toggle, #up, #update, #update!

Dynamic Method Handling

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

Instance Method Details

#[](name) ⇒ Sitemap? Also known as: include?, key?, has_key?

Gets a specific sitemap definition.

Parameters:

  • name (String) —

    Sitemap name

Returns:



23
24
25
26
 
# File 'lib/openhab/core/sitemaps/registry.rb', line 23

def [](name)
  # @deprecated OH 5.2: Remove the registry check when dropping OH 5.1
  Provider.registry ? Provider.registry.get(name) : Provider.current.get(name)
end

#build(update: true) { ... } ⇒ void

This method returns an undefined value.

Enter the Sitemap Builder DSL.

Examples:

sitemaps.build do
  sitemap "default", label: "My Residence" do
    frame label: "Control" do
      text label: "Climate", icon: "if:mdi:home-thermometer-outline" do
        frame label: "Main Floor" do
          # colors are set with a hash, with key being condition, and value being the color
          # The :default key is used when no other condition matches
          text item: MainFloor_AmbTemp,
            label_color: "purple", # A simple string can be used when no conditions are needed
            value_color: { ">=90" => "red", "<=70" => "blue", :default => "black" }

          # If item name is not provided in the condition, it will default to the widget's Item
          # The operator will default to == if not specified
          switch item: MainFloorThermostat_TargetMode, label: "Mode",
            mappings: %w[off auto cool heat],
            value_color: { "cool" => "blue", "heat" => "red", :default => "black" }

          # an array of conditions are AND'd together
          setpoint item: MainFloorThermostat_SetPoint, label: "Set Point",
            value_color: {
              ["MainFloorThermostat_TargetMode!=off", ">80"] => "red", # red if mode!=off AND setpoint > 80
              ["MainFloorThermostat_TargetMode!=off", ">74"] => "yellow",
              ["MainFloorThermostat_TargetMode!=off", ">70"] => "green",
              "MainFloorThermostat_TargetMode!=off" => "blue",
              :default => "gray"
            }
        end
        frame label: "Basement" do
          text item: Basement_AmbTemp
          switch item: BasementThermostat_TargetMode, label: "Mode",
            mappings: { OFF: "off", COOL: "cool", HEAT: "heat" }

          # Conditions within a nested array are AND'd together (requires openHAB 4.1)
          setpoint item: BasementThermostat_SetPoint, label: "Set Point",
            visibility: [["BasementThermostat_TargetMode!=off", "Vacation_Switch==OFF"]]

          # Additional elements are OR'd
          # The following visibility conditions are evaluated as:
          # (BasementThermostat_TargetMode!=off AND Vacation_Switch==OFF) OR Verbose_Mode==ON
          setpoint item: BasementThermostat_SetPoint, label: "Set Point",
            visibility: [
              ["BasementThermostat_TargetMode!=off", "Vacation_Switch==OFF"],
              "Verbose_Mode==ON"
            ]
        end
      end
    end
  end
end
def add_tv(builder, tv)
  builder.frame label: tv.location.label do
    builder.switch item: tv.points(Semantics::Switch), label: "Power"
  end
end

sitemaps.build do |builder|
  builder.sitemap "tvs", label: "TVs" do
    items.equipments(Semantics::TV).each do |tv|
      add_tv(builder, tv)
    end
  end
end

Parameters:

  • update (true, false) (defaults to: true) —

    When true, existing sitemaps with the same name will be updated.

Yields:

See Also:



117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/openhab/core/sitemaps/registry.rb', line 117

def build(update: true, &block)
  builder_proxy = SimpleDelegator.new(nil) if block.arity == 1
  builder = DSL::Sitemaps::Builder.new(builder_proxy, update:)
  if block.arity == 1
    builder_proxy.__setobj__(builder)
    DSL::ThreadLocal.thread_local(openhab_create_dummy_items: true) do
      yield builder_proxy
    end
  else
    builder.instance_eval(&block)
  end
end

#remove(sitemap) ⇒ Sitemap

Remove a sitemap.

The sitemap must be managed by Ruby.

Parameters:

  • sitemap (String, Sitemap) —

    Sitemap or sitemap name

Returns:

  • (Sitemap) —

    The removed sitemap.

Raises:

  • (RuntimeError) —

    if the sitemap cannot be removed.



139
140
141
142
143
144
145
146
147
 
# File 'lib/openhab/core/sitemaps/registry.rb', line 139

def remove(sitemap)
  sitemap = sitemap.uid if sitemap.respond_to?(:uid)
  old_instance = Provider.current.remove(sitemap)
  old_instance ||= Provider.registry&.remove(sitemap)

  raise "Cannot remove sitemap #{sitemap}" unless old_instance

  old_instance
end

#to_a ⇒ Array<Sitemap>

Explicit conversion to array.

Returns:



37
38
39
40
 
# File 'lib/openhab/core/sitemaps/registry.rb', line 37

def to_a
  # @deprecated OH 5.2: Remove the registry check when dropping OH 5.1
  Provider.registry ? Provider.registry.all.to_a : Provider.current.all.to_a
end