openhab-scripting 5.6.1 → 5.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d58174285c7861dfffd3bdb108f6d9c01af149a4f53aab9b9dd331be7f0f022
-  data.tar.gz: 6bdb6e115927aea3396ca05be97ecb1ee9d8afc9bc493689c32f7fcd19a7e71a
+  metadata.gz: 951ad54507dbf4b297d59534c124c21bbf6f6b7a02e4c3fa967a5290aac9968e
+  data.tar.gz: d4b33c4b8cdf237c6bdc1c2b99b87459f913f2d787423f261677d469d9629df3
 SHA512:
-  metadata.gz: 454fb750a412b8e153ce7df0320738b1f9729e1313d6d8e9aaaaa7c720c8c0cda7f704a35d78952705e7f21718551daae2c01e0dcf0b7e26c1fbfa2481d5ab6b
-  data.tar.gz: 0a1e62ecb2bcce48a207bed5899bd0e7913492836a5c953a4b22756fa149b353ee8db229e3b5b71f48d503db1d7bfaa4f8baa94abe92469047b386ab3d438da6
+  metadata.gz: f26471513aca95dcb0266ffca7176ee57980cbea404c8290c095642c4851954e4d870232507cbea34c6b6c4a940da84d6681944ee039199c3fcc766bdd64a598
+  data.tar.gz: 0c6e9e9cf72ee4a1935c399c235256144b0c6fbbb7bc0eb3f07a81405f3e52cc0193a1856ec910212f963c37208cb29191bbe90d143bf822bfc2c987828de47d

data/lib/openhab/core/actions/http.rb

@@ -3,6 +3,17 @@
 module OpenHAB
   module Core
     module Actions
+      #
+      # The HTTP actions allow you to send HTTP requests and receive the response.
+      #
+      # @example
+      #   # Send a GET request
+      #   headers = {
+      #     "User-Agent": "JRuby/1.2.3", # enclose in quotes if the key contains dashes
+      #     Accept: "application/json",
+      #   }
+      #   response = HTTP.send_http_get_request("http://example.com/list", headers: headers)
+      #
       # @see https://www.openhab.org/docs/configuration/actions.html#http-actions HTTP Actions
       class HTTP
         class << self
@@ -10,7 +21,8 @@ module OpenHAB
           # Sends an HTTP GET request and returns the result as a String.
           #
           # @param [String] url
-          # @param [Hash<String, String>] headers
+          # @param [Hash<String, String>, Hash<Symbol, String>] headers
+          #   A hash of headers to send with the request. Symbolic keys will be converted to strings.
           # @param [Duration, int, nil] timeout Timeout (in milliseconds, if given as an Integer)
           # @return [String] the response body
           # @return [nil] if an error occurred
@@ -19,7 +31,7 @@ module OpenHAB
             timeout ||= 5_000
             timeout = timeout.to_millis if timeout.is_a?(Duration)
 
-            sendHttpGetRequest(url, headers, timeout)
+            sendHttpGetRequest(url, headers.transform_keys(&:to_s), timeout)
           end
 
           #
@@ -28,7 +40,8 @@ module OpenHAB
           # @param [String] url
           # @param [String] content_type
           # @param [String] content
-          # @param [Hash<String, String>] headers
+          # @param [Hash<String, String>, Hash<Symbol, String>] headers
+          #   A hash of headers to send with the request. Symbolic keys will be converted to strings.
           # @param [Duration, int, nil] timeout Timeout (in milliseconds, if given as an Integer)
           # @return [String] the response body
           # @return [nil] if an error occurred
@@ -37,7 +50,7 @@ module OpenHAB
             timeout ||= 1_000
             timeout = timeout.to_millis if timeout.is_a?(Duration)
 
-            sendHttpPutRequest(url, content_type, content, headers, timeout)
+            sendHttpPutRequest(url, content_type, content, headers.transform_keys(&:to_s), timeout)
           end
 
           #
@@ -46,7 +59,8 @@ module OpenHAB
           # @param [String] url
           # @param [String] content_type
           # @param [String] content
-          # @param [Hash<String, String>] headers
+          # @param [Hash<String, String>, Hash<Symbol, String>] headers
+          #   A hash of headers to send with the request. Symbolic keys will be converted to strings.
           # @param [Duration, int, nil] timeout Timeout (in milliseconds, if given as an Integer)
           # @return [String] the response body
           # @return [nil] if an error occurred
@@ -55,14 +69,16 @@ module OpenHAB
             timeout ||= 1_000
             timeout = timeout.to_millis if timeout.is_a?(Duration)
 
-            sendHttpPostRequest(url, content_type, content, headers, timeout)
+            sendHttpPostRequest(url, content_type, content, headers.transform_keys(&:to_s), timeout)
           end
 
           #
           # Sends an HTTP DELETE request and returns the result as a String.
           #
           # @param [String] url
-          # @param [Hash<String, String>] headers
+          # @param [Hash<String, String>, Hash<Symbol, String>] headers
+          #   A hash of headers to send with the request. Keys are strings or symbols, values are strings.
+          #   Underscores in symbolic keys are replaced with dashes.
           # @param [Duration, int, nil] timeout Timeout (in milliseconds, if given as an Integer)
           # @return [String] the response body
           # @return [nil] if an error occurred
@@ -71,7 +87,7 @@ module OpenHAB
             timeout ||= 1_000
             timeout = timeout.to_millis if timeout.is_a?(Duration)
 
-            sendHttpDeleteRequest(url, headers, timeout)
+            sendHttpDeleteRequest(url, headers.transform_keys(&:to_s), timeout)
           end
         end
       end

data/lib/openhab/core/items/registry.rb

@@ -48,7 +48,7 @@ module OpenHAB
         # @yield Block executed in the context of a {DSL::Items::Builder}
         # @return [Object] The return value of the block.
         #
-        # (see Items::Builder)
+        # @see DSL::Items::Builder
         #
         def build(preferred_provider = nil, &block)
           DSL::Items::BaseBuilderDSL.new(preferred_provider).instance_eval_with_dummy_items(&block)

data/lib/openhab/core/items/semantics.rb

@@ -262,7 +262,7 @@ module OpenHAB
         # @deprecated OH3.4 cannot add a tag
         # this not in the class << self block above because YARD doesn't figure out
         # it's a class method with the conditional
-        if Provider.registry || org.openhab.core.semantics.SemanticTags.respond_to?(:add)
+        if Provider.registry
           class << self
             #
             # Adds custom semantic tags.
@@ -311,25 +311,16 @@ module OpenHAB
               synonyms = Array.wrap(synonyms).map { |s| s.to_s.strip }
 
               tags.map do |name, parent|
-                # @deprecated OH4.0.0.M4 missing registry
-                if Provider.registry
-                  parent = lookup(parent) unless parent.is_a?(SemanticTag)
-                  next if lookup(name)
-                  next unless parent
-
-                  new_tag = org.openhab.core.semantics.SemanticTagImpl.new("#{parent.uid}_#{name}",
-                                                                           label,
-                                                                           description,
-                                                                           synonyms)
-                  Provider.instance.add(new_tag)
-                  lookup(name)
-                else
-                  parent_is_tag = parent.respond_to?(:java_class) && parent.java_class < Tag.java_class
-                  parent = parent_is_tag ? parent.java_class : parent.to_s
-                  org.openhab.core.semantics.SemanticTags
-                     .add(name.to_s, parent, label, synonyms.join(","), description)
-                    &.then { lookup(name) }
-                end
+                parent = lookup(parent) unless parent.is_a?(SemanticTag)
+                next if lookup(name)
+                next unless parent
+
+                new_tag = org.openhab.core.semantics.SemanticTagImpl.new("#{parent.uid}_#{name}",
+                                                                         label,
+                                                                         description,
+                                                                         synonyms)
+                Provider.instance.add(new_tag)
+                lookup(name)
               end.compact
             end
           end

data/lib/openhab/core/provider.rb

@@ -44,6 +44,7 @@ module OpenHAB
 
       # Known supported provider types
       # @return [Array<Symbol>]
+      # @!visibility private
       KNOWN_TYPES = %i[items metadata things links].freeze
 
       class << self
@@ -223,7 +224,6 @@ module OpenHAB
       def initialize(unload_priority: nil)
         super()
         @elements = java.util.concurrent.ConcurrentHashMap.new
-        # @deprecated OH3.4 safe navigation only required for missing Semantics registry
         self.class.registry&.add_provider(self)
         ScriptHandling.script_unloaded(priority: unload_priority) { unregister }
       end

data/lib/openhab/core/sitemaps/provider.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module OpenHAB
+  module Core
+    #
+    # Contains sitemap related classes.
+    #
+    module Sitemaps
+      #
+      # Provides sitemaps created in Ruby to openHAB
+      #
+      class Provider < Core::Provider
+        PREFIX = "jruby_"
+        SUFFIX = ".sitemap"
+        private_constant :PREFIX, :SUFFIX
+
+        class << self
+          # @!visibility private
+          def registry
+            nil
+          end
+        end
+
+        include org.openhab.core.model.sitemap.SitemapProvider
+
+        # @!visibility private
+        alias_method :getSitemap, :get
+
+        # rubocop:disable Naming/MethodName
+
+        # @!visibility private
+        def getSitemapNames
+          @elements.key_set
+        end
+
+        # @!visibility private
+        def addModelChangeListener(listener)
+          @listeners.add(listener)
+        end
+
+        # @!visibility private
+        def removeModelChangeListener(listener)
+          @listeners.remove(listener)
+        end
+
+        # rubocop:enable Naming/MethodName
+
+        # @!visibility private
+        def unregister
+          @registration.unregister
+        end
+
+        # rubocop:disable Layout/LineLength
+
+        #
+        # Enter the Sitemap Builder DSL.
+        #
+        # @yield Block executed in the context of a {DSL::Sitemaps::Builder}
+        # @return [void]
+        #
+        # @see DSL::Sitemaps::Builder
+        #
+        # @example
+        #   sitemaps.build do
+        #     sitemap "default", "My Residence" do
+        #       frame label: "Control" do
+        #         text label: "Climate", icon: "if:mdi:home-thermometer-outline" do
+        #           frame label: "Main Floor" do
+        #             text item: MainFloor_AmbTemp
+        #             switch item: MainFloorThermostat_TargetMode, label: "Mode", mappings: %w[off auto cool heat]
+        #             setpoint item: MainFloorThermostat_SetPoint, label: "Set Point", visibility: "MainFloorThermostat_TargetMode!=off"
+        #           end
+        #           frame label: "Basement" do
+        #             text item: Basement_AmbTemp
+        #             switch item: BasementThermostat_TargetMode, label: "Mode", mappings: { OFF: "off", COOL: "cool", HEAT: "heat" }
+        #             setpoint item: BasementThermostat_SetPoint, label: "Set Point", visibility: "BasementThermostat_TargetMode!=off"
+        #           end
+        #         end
+        #       end
+        #     end
+        #   end
+        #
+        def build(&block)
+          DSL::Sitemaps::Builder.new(self).instance_eval(&block)
+        end
+        # rubocop:enable Layout/LineLength
+
+        # For use in specs
+        # @!visibility private
+        def clear
+          elements = @elements
+          @elements = java.util.concurrent.ConcurrentHashMap.new
+          elements.each_value do |v|
+            notify_listeners_about_removed_element(v)
+          end
+        end
+
+        #
+        # Remove a sitemap.
+        #
+        # @param [String] sitemap_name
+        # @return [Boolean] If a sitemap was removed
+        def remove(sitemap_name)
+          super("#{PREFIX}#{sitemap_name}#{SUFFIX}")
+        end
+
+        private
+
+        def initialize
+          super
+          @listeners = java.util.concurrent.CopyOnWriteArraySet.new
+
+          @registration = OSGi.register_service(self, org.openhab.core.model.sitemap.SitemapProvider)
+        end
+
+        def notify_listeners_about_added_element(element)
+          @listeners.each { |l| l.model_changed(element.name, org.openhab.core.model.core.EventType::ADDED) }
+        end
+
+        def notify_listeners_about_removed_element(element)
+          @listeners.each { |l| l.model_changed(element.name, org.openhab.core.model.core.EventType::REMOVED) }
+        end
+
+        def notify_listeners_about_updated_element(element)
+          @listeners.each { |l| l.model_changed(element.name, org.openhab.core.model.core.EventType::MODIFIED) }
+        end
+      end
+    end
+  end
+end

data/lib/openhab/core/timer.rb

@@ -49,7 +49,8 @@ module OpenHAB
         @id = id
         @thread_locals = thread_locals
         @block = block
-        @timer = ScriptExecution.create_timer(1.minute.from_now) { execute }
+        timer_identifier = block.source_location.join(":")
+        @timer = ScriptExecution.create_timer(timer_identifier, 1.minute.from_now) { execute }
         reschedule!(@time)
       end
 

data/lib/openhab/core/types/quantity_type.rb

@@ -174,25 +174,30 @@ module OpenHAB
           add: :+,
           subtract: :-
         }.each do |java_op, ruby_op|
-          convert = "self.class.new(other, DSL.unit(dimension) || unit)"
+          convert = "self.class.new(other, thread_unit)"
 
           class_eval( # rubocop:disable Style/DocumentDynamicEvalDefinition https://github.com/rubocop/rubocop/issues/10179
             # def +(other)
             #   logger.trace("#{self} + #{other} (#{other.class})")
             #   if other.is_a?(QuantityType)
             #     add_quantity(other)
-            #   elsif other.is_a?(DecimalType)
-            #     other = other.to_big_decimal
-            #     add_quantity(self.class.new(other, DSL.unit(dimension) || unit))
-            #   elsif other.is_a?(java.math.BigDecimal)
-            #     add_quantity(self.class.new(other, DSL.unit(dimension) || unit))
-            #   elsif other.respond_to?(:to_d)
-            #     other = other.to_d.to_java
-            #     add_quantity(self.class.new(other, DSL.unit(dimension) || unit))
-            #   elsif other.respond_to?(:coerce) && (lhs, rhs = other.coerce(to_d))
-            #     lhs + rhs
+            #   elsif (thread_unit = DSL.unit(dimension))
+            #     if other.is_a?(DecimalType)
+            #       other = other.to_big_decimal
+            #       add_quantity(self.class.new(other, thread_unit))
+            #     elsif other.is_a?(java.math.BigDecimal)
+            #       add_quantity(self.class.new(other, thread_unit))
+            #     elsif other.respond_to?(:to_d)
+            #       other = other.to_d.to_java
+            #       add_quantity(self.class.new(other, thread_unit))
+            #     elsif other.respond_to?(:coerce) && (lhs, rhs = other.coerce(to_d))
+            #       lhs + rhs
+            #     else
+            #       raise TypeError, "#{other.class} can't be coerced into #{self.class}"
+            #     end
             #   else
-            #     raise TypeError, "#{other.class} can't be coerced into #{self.class}"
+            #     raise TypeError,
+            #       "#{self.class} can only be added with another #{self.class} outside a unit block"
             #   end
             # end
             <<~RUBY, __FILE__, __LINE__ + 1
@@ -200,18 +205,23 @@ module OpenHAB
                 logger.trace("\#{self} #{ruby_op} \#{other} (\#{other.class})")
                 if other.is_a?(QuantityType)
                   #{java_op}_quantity(other)
-                elsif other.is_a?(DecimalType)
-                  other = other.to_big_decimal
-                  #{java_op}_quantity(#{convert})
-                elsif other.is_a?(java.math.BigDecimal)
-                  #{java_op}_quantity(#{convert})
-                elsif other.respond_to?(:to_d)
-                  other = other.to_d.to_java
-                  #{java_op}_quantity(#{convert})
-                elsif other.respond_to?(:coerce) && (lhs, rhs = other.coerce(to_d))
-                  lhs #{ruby_op} rhs
+                elsif (thread_unit = DSL.unit(dimension))
+                  if other.is_a?(DecimalType)
+                    other = other.to_big_decimal
+                    #{java_op}_quantity(#{convert})
+                  elsif other.is_a?(java.math.BigDecimal)
+                    #{java_op}_quantity(#{convert})
+                  elsif other.respond_to?(:to_d)
+                    other = other.to_d.to_java
+                    #{java_op}_quantity(#{convert})
+                  elsif other.respond_to?(:coerce) && (lhs, rhs = other.coerce(to_d))
+                    lhs #{ruby_op} rhs
+                  else
+                    raise TypeError, "\#{other.class} can't be coerced into \#{self.class}"
+                  end
                 else
-                  raise TypeError, "\#{other.class} can't be coerced into \#{self.class}"
+                  raise TypeError,
+                    "\#{self.class} can only be #{java_op}ed with another \#{self.class} outside a unit block"
                 end
               end
             RUBY
@@ -243,13 +253,13 @@ module OpenHAB
               def #{ruby_op}(other)
                 logger.trace("\#{self} #{ruby_op} \#{other} (\#{other.class})")
                 if other.is_a?(QuantityType)
-                  #{java_op}_quantity(other)
+                  #{java_op}_quantity(other).unitize
                 elsif other.is_a?(DecimalType)
-                  #{java_op}(other.to_big_decimal)
+                  #{java_op}(other.to_big_decimal).unitize
                 elsif other.is_a?(java.math.BigDecimal)
-                  #{java_op}(other)
+                  #{java_op}(other).unitize
                 elsif other.respond_to?(:to_d)
-                  #{java_op}(other.to_d.to_java)
+                  #{java_op}(other.to_d.to_java).unitize
                 elsif other.respond_to?(:coerce) && (lhs, rhs = other.coerce(to_d))
                   lhs #{ruby_op} rhs
                 else
@@ -262,7 +272,7 @@ module OpenHAB
 
         # if it's a dimensionless quantity, change the unit to match other_unit
         # @!visibility private
-        def unitize(other_unit = unit)
+        def unitize(other_unit = unit, relative: false)
           # prefer converting to the thread-specified unit if there is one
           other_unit = DSL.unit(dimension) || other_unit
           logger.trace("Converting #{self} to #{other_unit}")
@@ -273,7 +283,7 @@ module OpenHAB
           when other_unit
             self
           else
-            to_unit(other_unit)
+            relative ? to_unit_relative(other_unit) : to_unit(other_unit)
           end
         end
 
@@ -288,16 +298,16 @@ module OpenHAB
 
         private
 
-        # do addition directly against a QuantityType while ensuring we unitize
-        # both sides
+        # do addition directly against a QuantityType while ensuring we unitize both sides
         def add_quantity(other)
-          unitize(other.unit).add(other.unitize(unit))
+          self_unit = (unit == Units::ONE && DSL.unit(other.dimension)) || unit
+          unitize(self_unit).add(other.unitize(relative: true))
         end
 
-        # do subtraction directly against a QuantityType while ensuring we
-        # unitize both sides
+        # do subtraction directly against a QuantityType while ensuring we unitize both sides
         def subtract_quantity(other)
-          unitize(other.unit).subtract(other.unitize(unit))
+          self_unit = (unit == Units::ONE && DSL.unit(other.dimension)) || unit
+          unitize(self_unit).subtract(other.unitize(relative: true))
         end
 
         # do multiplication directly against a QuantityType while ensuring

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

@@ -1592,12 +1592,15 @@ module OpenHAB
         end
 
         #
-        # Creates a trigger based on the time stored in a {DateTimeItem}
+        # Creates a trigger based on the date and time stored in a {DateTimeItem}
         #
-        # The trigger will dynamically update any time the state of the item
-        # changes. If the item is {NULL} or {UNDEF}, the trigger will not run.
+        # The trigger will dynamically update whenever the state of the item changes.
+        # If the item is {NULL} or {UNDEF}, the trigger will not run.
         #
-        # @param [Item, String, Symbol] item The item (or it's name)
+        # To trigger just on the time portion of the item, use {every} instead, e.g.
+        # `every :day, at: MyDateTimeItem`.
+        #
+        # @param [Item, String, Symbol] item The item (or its name)
         # @return [void]
         #
         # @example