openhab-scripting 2.20.2 → 2.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e99181d5d68e3b8deab1440bfc457890ea512a1f25a4da4dc048555f3e296f2a
-  data.tar.gz: 2b07f929d309bda53b78270b9d7274b2373132de08a075af634ca9237a79cea7
+  metadata.gz: 3b38e635249a2d0e8633e75504eb3e42f79399d1e66b90f5242f3dc8062c711b
+  data.tar.gz: dcb573a627b8f93d5a4f6e1bbb8e9b8033f4765b33e49ab88d07414e055b5e7f
 SHA512:
-  metadata.gz: 375b6c769ee121a9dfb88d6a93338de1bd1040b1cb885f8668cdf07c0f0c0dce6d2a34cd744ebe3837a06739477f296bea0e907599b3c5446ebd400745a7a92b
-  data.tar.gz: 64396208c64ddb457a873b7829ee024d01f598c32348c9717229af106e754a545aad10dde6a85dd27045a0ac73844251b4f0bc0f56f8c72ae2b88a6a0c589878
+  metadata.gz: c6b8e1f865bf8912e0575495c0539e96acd5f7c8dc77582ab355bee6e5def4e45701cf159d77b12fe7975cb8493fafbcc0260706f2bd500fddeecf4a66683e5e
+  data.tar.gz: fb3c37bf6fdd9f9f95feb26e39e44cd336b7da07a4831e1d3b8079bcbac0f57c005c7324e683dbcb5baa67c60124e947e965edb88b3f8a43a51f03e29fa383a9

data/lib/openhab/dsl/monkey_patch/events/events.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'openhab/dsl/monkey_patch/events/item_state'
 require 'openhab/dsl/monkey_patch/events/item_state_changed'
 require 'openhab/dsl/monkey_patch/events/thing_status_info'
 require 'openhab/dsl/monkey_patch/events/item_command'

data/lib/openhab/dsl/monkey_patch/events/item_state.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'java'
+
+module OpenHAB
+  module DSL
+    module MonkeyPatch
+      #
+      # Patches OpenHAB events
+      #
+      module Events
+        java_import Java::OrgOpenhabCoreItemsEvents::ItemStateEvent
+
+        #
+        # MonkeyPatch with ruby style accessors
+        #
+        class ItemStateEvent
+          alias state item_state
+        end
+      end
+    end
+  end
+end

data/lib/openhab/dsl/monkey_patch/items/metadata.rb

@@ -29,7 +29,7 @@ module OpenHAB
             def_delegator :@metadata, :value
 
             def initialize(metadata: nil, key: nil, value: nil, config: nil)
-              @metadata = metadata || Metadata.new(key || MetadataKey.new('', ''), value, config)
+              @metadata = metadata || Metadata.new(key || MetadataKey.new('', ''), value&.to_s, config)
               super(@metadata&.configuration)
             end
 
@@ -60,9 +60,7 @@ module OpenHAB
             # @return [Java::Org::openhab::core::items::Metadata] the old metadata
             #
             def value=(value)
-              raise ArgumentError, 'Value must be a string' unless value.is_a? String
-
-              metadata = Metadata.new(@metadata&.uID, value, @metadata&.configuration)
+              metadata = Metadata.new(@metadata&.uID, value&.to_s, @metadata&.configuration)
               NamespaceAccessor.registry.update(metadata) if @metadata&.uID
             end
 
@@ -125,7 +123,7 @@ module OpenHAB
               meta_value, configuration = update_from_value(value)
 
               key = MetadataKey.new(namespace, @item_name)
-              metadata = Metadata.new(key, meta_value, configuration)
+              metadata = Metadata.new(key, meta_value&.to_s, configuration)
               # registry.get can be omitted, but registry.update will log a warning for nonexistent metadata
               if NamespaceAccessor.registry.get(key)
                 NamespaceAccessor.registry.update(metadata)

data/lib/openhab/dsl/monkey_patch/items/persistence.rb

@@ -49,7 +49,12 @@ module OpenHAB
               if timestamp.is_a? Java::JavaTimeTemporal::TemporalAmount
                 timestamp = Java::JavaTime::ZonedDateTime.now.minus(timestamp)
               end
-              PersistenceExtensions.public_send(method, self, timestamp, service&.to_s)
+              result = PersistenceExtensions.public_send(method, self, timestamp, service&.to_s)
+              if result.is_a?(Java::OrgOpenhabCoreLibraryTypes::DecimalType) && respond_to?(:unit) && unit
+                Quantity.new(Java::OrgOpenhabCoreLibraryTypes::QuantityType.new(result.to_big_decimal, unit))
+              else
+                result
+              end
             end
           end
 

data/lib/openhab/dsl/monkey_patch/ruby/string.rb

@@ -21,7 +21,7 @@ module OpenHAB
           #
           def ==(other)
             case other
-            when OpenHAB::DSL::Types::Quantity, QuantityType
+            when OpenHAB::DSL::Types::Quantity, QuantityType, Java::OrgOpenhabCoreLibraryTypes::StringType
               other == self
             else
               super

data/lib/openhab/dsl/monkey_patch/types/decimal_type.rb

@@ -63,6 +63,27 @@ module OpenHAB
             logger.trace("#{self.class} #{self} == #{other} (#{other.class})")
             (self <=> other).zero?
           end
+
+          #
+          # Convert DecimalType to a Quantity
+          #
+          # @param [Object] other String or Unit representing an OpenHAB Unit
+          #
+          # @return [OpenHAB::Core::DSL::Types::Quantity] NumberItem converted to supplied Unit
+          #
+          def |(other)
+            other = SimpleUnitFormat.instance.unitFor(other) if other.is_a? String
+            Quantity.new(QuantityType.new(to_big_decimal, other))
+          end
+
+          #
+          # Provide details about DecimalType object
+          #
+          # @return [String] Representing details about the DecimalType object
+          #
+          def inspect
+            to_string
+          end
         end
       end
     end

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

@@ -100,8 +100,7 @@ module OpenHAB
         # @return [Boolean] True if the rule should execute, false if trigger guard prevents execution
         #
         def check_trigger_guards(trigger_delay, inputs)
-          old_state = inputs['oldState']
-          new_state = inputs['newState']
+          new_state, old_state = retrieve_states(inputs)
           if check_from(trigger_delay, old_state)
             return true if check_to(trigger_delay, new_state)
 
@@ -113,6 +112,32 @@ module OpenHAB
           end
         end
 
+        #
+        # Rerieve the newState and oldState, alternatively newStatus and oldStatus
+        # from the input map
+        #
+        # @param [Map] inputs OpenHAB map object describing rule trigger
+        #
+        # @return [Array] An array of the values for [newState, oldState] or [newStatus, oldStatus]
+        #
+        def retrieve_states(inputs)
+          old_state = inputs['oldState'] || thing_status_to_sym(inputs['oldStatus'])
+          new_state = inputs['newState'] || thing_status_to_sym(inputs['newStatus'])
+
+          [new_state, old_state]
+        end
+
+        #
+        # Converts a ThingStatus object to a ruby Symbol
+        #
+        # @param [Java::OrgOpenhabCoreThing::ThingStatus] status A ThingStatus instance
+        #
+        # @return [Symbol] A corresponding symbol, in lower case
+        #
+        def thing_status_to_sym(status)
+          status&.to_s&.downcase&.to_sym
+        end
+
         #
         # Check the from state against the trigger delay
         #
@@ -122,7 +147,7 @@ module OpenHAB
         # @return [Boolean] true if no from state is defined or defined state equals supplied state
         #
         def check_from(trigger_delay, state)
-          trigger_delay.from.nil? || trigger_delay.from == state
+          trigger_delay.from.nil? || state == trigger_delay.from
         end
 
         #
@@ -134,7 +159,7 @@ module OpenHAB
         # @return [Boolean] true if no to state is defined or defined state equals supplied state
         #
         def check_to(trigger_delay, state)
-          trigger_delay.to.nil? || trigger_delay.to == state
+          trigger_delay.to.nil? || state == trigger_delay.to
         end
 
         #
@@ -174,7 +199,7 @@ module OpenHAB
             queue = create_queue(inputs)
             process_queue(queue, mod, inputs)
           end
-          trigger_delay.tracking_to = inputs['newState']
+          trigger_delay.tracking_to, = retrieve_states(inputs)
         end
 
         #
@@ -186,7 +211,7 @@ module OpenHAB
         #
         #
         def process_active_timer(inputs, mod, trigger_delay)
-          state = inputs['newState']
+          state, = retrieve_states(inputs)
           if state == trigger_delay.tracking_to
             logger.trace("Item changed to #{state} for #{trigger_delay}, rescheduling timer.")
             trigger_delay.timer.reschedule(ZonedDateTime.now.plus(trigger_delay.duration))

data/lib/openhab/dsl/rules/triggers/changed.rb

@@ -58,16 +58,8 @@ module OpenHAB
         # @return [Array] Array of current TriggerDelay objects
         #
         def changed_wait(item, duration:, to: nil, from: nil)
-          # If GroupItems specified, use the group state trigger instead
-          if item.is_a? GroupItems
-            config = { 'groupName' => item.group.name }
-            trigger = Trigger::GROUP_STATE_CHANGE
-          else
-            config = { 'itemName' => item.name }
-            trigger = Trigger::ITEM_STATE_CHANGE
-          end
-          logger.trace("Creating Changed Wait Change Trigger for #{config}")
-          trigger = append_trigger(trigger, config)
+          trigger = create_changed_trigger(item, nil, nil)
+          logger.trace("Creating Changed Wait Change Trigger for #{item}")
           @trigger_delays[trigger.id] = TriggerDelay.new(to: to, from: from, duration: duration)
         end
 

data/lib/openhab/dsl/types/quantity.rb

@@ -22,6 +22,7 @@ module OpenHAB
         def_delegator :@quantity, :to_s
 
         java_import org.openhab.core.library.types.QuantityType
+        java_import org.openhab.core.library.types.DecimalType
         java_import 'tec.uom.se.format.SimpleUnitFormat'
         java_import 'tec.uom.se.AbstractUnit'
 
@@ -92,6 +93,7 @@ module OpenHAB
           case other
           when Quantity then [other.quantity, quantity]
           when QuantityType then [other, quantity]
+          when DecimalType then [Quantity.new(other.to_big_decimal.to_d), quantity]
           when NumberItem then [other.to_qt.quantity, quantity]
           when Numeric, String then [Quantity.new(other), self]
           end

data/lib/openhab/version.rb

@@ -5,5 +5,5 @@
 #
 module OpenHAB
   # @return [String] Version of OpenHAB helper libraries
-  VERSION = '2.20.2'
+  VERSION = '2.23.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.20.2
+  version: 2.23.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -49,6 +49,7 @@ files:
 - lib/openhab/dsl/monkey_patch/actions/script_thing_actions.rb
 - lib/openhab/dsl/monkey_patch/events/events.rb
 - lib/openhab/dsl/monkey_patch/events/item_command.rb
+- lib/openhab/dsl/monkey_patch/events/item_state.rb
 - lib/openhab/dsl/monkey_patch/events/item_state_changed.rb
 - lib/openhab/dsl/monkey_patch/events/thing_status_info.rb
 - lib/openhab/dsl/monkey_patch/items/contact_item.rb