openhab-scripting 5.27.2 → 5.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55919e4e10099bb160e0f64578c398caef457c330e88df280a20ed20ffec6310
-  data.tar.gz: 2052d4bcd4dc3bcd7b2be5c4bb7b995fcaebc7101b93e24fd2db0e849b80ff36
+  metadata.gz: c99d5ea37c52514af7dfa8b5316c8b8d196f46dac4fb4ce557ac01963de8bb51
+  data.tar.gz: d2ee0a5934babcd911d2584ba7e20f73164e568108657121870422fa247d6c6f
 SHA512:
-  metadata.gz: 1c39a9d29033bf7844d1f5666f57be9ae99ae595a8d5f85e4464b6077c0171e4f4e9e19d933f17a0e190c2081dae57dc29136bb4c3e295f2d83e8e1d88374ce1
-  data.tar.gz: 5a828c34365b2d8fcef74c46fe19e94fc30dbb0c4fd17fcef7bc717a95ccb2e0b51cfadf701447d9a97c58057baebe77d8186811886479112096b46e16749a28
+  metadata.gz: c353e9b41fb5e11e95eaf2fe8d048caf7b3aa6873c7a6017a0d099f4738a67c8b2ae1015d2a2c2248a2089ebb42d7fafecafcc5613998d39739fcf44dd77ee92
+  data.tar.gz: a54105ab52153231d2ee7871f74ae5d1743c23c18fa582a09114e15c754a0ccd86bd9772298352f7c9d4f191aa8f47b3807ca20919473f1795da4e0e3d643f2e

data/lib/openhab/core/entity_lookup.rb

@@ -13,9 +13,6 @@ module OpenHAB
     #   it must be replaced with an underscore `_`. So to access `astro:sun:home`, use `astro_sun_home`
     #   as an alternative to `things["astro:sun:home"]`
     #
-    # @see OpenHAB::DSL.items items[]
-    # @see OpenHAB::DSL.things things[]
-    #
     # @example Accessing Items and Groups
     #   gAll_Lights       # Access the gAll_Lights group. It is the same as items["gAll_Lights"]
     #   Kitchen_Light.on  # The openHAB object for the Kitchen_Light item and send an ON command
@@ -66,6 +63,61 @@ module OpenHAB
         end
       end
 
+      #
+      # Fetches all items from the item registry
+      #
+      # @return [Core::Items::Registry]
+      #
+      # The examples all assume the following items exist.
+      #
+      # ```xtend
+      # Dimmer DimmerTest "Test Dimmer"
+      # Switch SwitchTest "Test Switch"
+      # ```
+      #
+      # @example
+      #   logger.info("Item Count: #{items.count}")  # Item Count: 2
+      #   logger.info("Items: #{items.map(&:label).sort.join(', ')}")  # Items: Test Dimmer, Test Switch'
+      #   logger.info("DimmerTest exists? #{items.key?('DimmerTest')}") # DimmerTest exists? true
+      #   logger.info("StringTest exists? #{items.key?('StringTest')}") # StringTest exists? false
+      #
+      # @example
+      #   rule 'Use dynamic item lookup to increase related dimmer brightness when switch is turned on' do
+      #     changed SwitchTest, to: ON
+      #     triggered { |item| items[item.name.gsub('Switch','Dimmer')].brighten(10) }
+      #   end
+      #
+      # @example
+      #   rule 'search for a suitable item' do
+      #     on_load
+      #     triggered do
+      #       # Send ON to DimmerTest if it exists, otherwise send it to SwitchTest
+      #       (items['DimmerTest'] || items['SwitchTest'])&.on
+      #     end
+      #   end
+      #
+      def items
+        Core::Items::Registry.instance
+      end
+
+      #
+      # Get all things known to openHAB
+      #
+      # @return [Core::Things::Registry] all Thing objects known to openHAB
+      #
+      # @example
+      #   things.each { |thing| logger.info("Thing: #{thing.uid}")}
+      #   logger.info("Thing: #{things['astro:sun:home'].uid}")
+      #   homie_things = things.select { |t| t.thing_type_uid == "mqtt:homie300" }
+      #   zwave_things = things.select { |t| t.binding_id == "zwave" }
+      #   homeseer_dimmers = zwave_things.select { |t| t.thing_type_uid.id == "homeseer_hswd200_00_000" }
+      #   things['zwave:device:512:node90'].uid.bridge_ids # => ["512"]
+      #   things['mqtt:topic:4'].uid.bridge_ids # => []
+      #
+      def things
+        Core::Things::Registry.instance
+      end
+
       #
       # Automatically looks up openHAB items and things in appropriate registries
       #

data/lib/openhab/dsl/sitemaps/builder.rb

@@ -127,7 +127,12 @@ module OpenHAB
         #   One or more value color rules (see {#value_color})
         # @param icon_color [String, Hash<String, String>, Hash<Array<String>, String>, nil]
         #   One or more icon color rules (see {#icon_color})
-        # @param visibility [String, Array<String>, Array<Array<String>>, nil]
+        # @param visibility [String,
+        #                    Core::Types::State,
+        #                    Array<String>,
+        #                    Array<Core::Types::State>,
+        #                    Array<Array<String>>,
+        #                    nil]
         #   One or more visibility rules (see {#visibility})
         # @!visibility private
         def initialize(type,
@@ -286,8 +291,12 @@ module OpenHAB
           supports_and_conditions = SitemapBuilder.factory.respond_to?(:create_condition)
 
           Array.wrap(conditions).each do |c|
+            c = c.to_s if c.is_a?(Core::Types::State)
+            unless c.is_a?(String) || c.is_a?(Symbol)
+              raise ArgumentError, "#{c.inspect} is not a valid condition data type for #{inspect}"
+            end
             unless (match = CONDITION_PATTERN.match(c))
-              raise ArgumentError, "Syntax error in condition #{c.inspect}"
+              raise ArgumentError, "Syntax error in condition #{c.inspect} for #{inspect}"
             end
 
             condition = supports_and_conditions ? SitemapBuilder.factory.create_condition : container

data/lib/openhab/dsl/version.rb

@@ -4,6 +4,6 @@ module OpenHAB
   module DSL
     # Version of openHAB helper libraries
     # @return [String]
-    VERSION = "5.27.2"
+    VERSION = "5.28.0"
   end
 end

data/lib/openhab/dsl.rb

@@ -51,6 +51,8 @@ module OpenHAB
 
     @debouncers = java.util.concurrent.ConcurrentHashMap.new
 
+    module_function :items, :things
+
     module_function
 
     # @!group Rule Creation
@@ -229,6 +231,13 @@ module OpenHAB
 
     # @!group Object Access
 
+    # @!parse
+    #   # (see Core::EntityLookup#items)
+    #   def items; end
+    #
+    #   # (see Core::EntityLookup#things)
+    #   def things; end
+
     #
     # (see Core::ValueCache)
     #
@@ -249,66 +258,11 @@ module OpenHAB
       Core::Rules::Registry.instance
     end
 
-    #
-    # Fetches all items from the item registry
-    #
-    # @return [Core::Items::Registry]
-    #
-    # The examples all assume the following items exist.
-    #
-    # ```xtend
-    # Dimmer DimmerTest "Test Dimmer"
-    # Switch SwitchTest "Test Switch"
-    # ```
-    #
-    # @example
-    #   logger.info("Item Count: #{items.count}")  # Item Count: 2
-    #   logger.info("Items: #{items.map(&:label).sort.join(', ')}")  # Items: Test Dimmer, Test Switch'
-    #   logger.info("DimmerTest exists? #{items.key?('DimmerTest')}") # DimmerTest exists? true
-    #   logger.info("StringTest exists? #{items.key?('StringTest')}") # StringTest exists? false
-    #
-    # @example
-    #   rule 'Use dynamic item lookup to increase related dimmer brightness when switch is turned on' do
-    #     changed SwitchTest, to: ON
-    #     triggered { |item| items[item.name.gsub('Switch','Dimmer')].brighten(10) }
-    #   end
-    #
-    # @example
-    #   rule 'search for a suitable item' do
-    #     on_load
-    #     triggered do
-    #       # Send ON to DimmerTest if it exists, otherwise send it to SwitchTest
-    #       (items['DimmerTest'] || items['SwitchTest'])&.on
-    #     end
-    #   end
-    #
-    def items
-      Core::Items::Registry.instance
-    end
-
     # @return [Core::Sitemaps::Provider]
     def sitemaps
       Core::Sitemaps::Provider.instance
     end
 
-    #
-    # Get all things known to openHAB
-    #
-    # @return [Core::Things::Registry] all Thing objects known to openHAB
-    #
-    # @example
-    #   things.each { |thing| logger.info("Thing: #{thing.uid}")}
-    #   logger.info("Thing: #{things['astro:sun:home'].uid}")
-    #   homie_things = things.select { |t| t.thing_type_uid == "mqtt:homie300" }
-    #   zwave_things = things.select { |t| t.binding_id == "zwave" }
-    #   homeseer_dimmers = zwave_things.select { |t| t.thing_type_uid.id == "homeseer_hswd200_00_000" }
-    #   things['zwave:device:512:node90'].uid.bridge_ids # => ["512"]
-    #   things['mqtt:topic:4'].uid.bridge_ids # => []
-    #
-    def things
-      Core::Things::Registry.instance
-    end
-
     #
     # Provides access to timers created by {after after}
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.27.2
+  version: 5.28.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-11 00:00:00.000000000 Z
+date: 2024-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler