openhab-scripting 2.20.1 → 2.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8d7de90fee54798d88e51a4ea9f7ac6437852d7c4eb5da2b847700f0dedd5de
-  data.tar.gz: 9a91e9a2ee0d977f4e2a0dd9b0ba50b1db89c71554596bfd8ca86bd9ec168d68
+  metadata.gz: 854569a4ecda01dc3fb8dc2e12f66147248a2aafffdbbdbabe5d0e750b6849cc
+  data.tar.gz: 1bf8451a6c8d1dd556472ffa0ceb210e34b9db1b0af6a652bdb336182abb7f20
 SHA512:
-  metadata.gz: 1d956f08c8884347de414eb9de04a69184c9d95a39c35bd0ff8685ceefb28efe64945a944a87efd11da16f5dceda77be453693b84cc816a7541e3e923b218479
-  data.tar.gz: ab3fd69c22c115a03848b112922f9b489d69c35a1bac3040ef40c9a73ffa8540e73318011768647fe0793a197973239e028949126a83ed233340efbeb667f490
+  metadata.gz: 4cb862c98031f4d62d1366dbfaf4a9370103687ad06ab930db77dba32af5623337652d9264f09f28622c12b14314902d1a5ea3b58fffec4cfa2fdd086c3bab31
+  data.tar.gz: 2044c8d3cee633c59b9368889c7995b4533b29add5d36e97dc3b8400706229c0afd133121b816fd8b4f53886b86e82b281f9dbe659e104c859bec212f6f5e1d8

data/lib/openhab/dsl/items/item_command.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'java'
+
+module OpenHAB
+  module DSL
+    module Items
+      #
+      # Holds methods to automatically generate commands and
+      # accessors for items
+      module ItemCommand
+        #
+        # For every value in the supplied enumeration create a corresponding method mapped to the lowercase
+        # string representation of the enum value For example, an enum with values of STOP and START
+        # would create methods stop() and start() that send the corresponding STOP and START commands to the item
+        #
+        # @param [Java::JavaLang::Enum] command_enum Enumeration to create commands for
+        #
+        #
+        def item_command(command_enum)
+          # rubocop:disable Style/HashEachMethods
+          # Disable rule because Java enum does not support each_value
+          command_enum.values.each do |command|
+            command_method = command.to_s.downcase
+            define_method(command_method) do
+              self.command(command)
+            end
+          end
+          # rubocop:enable Style/HashEachMethods
+        end
+
+        #
+        # For every value in the supplied enumeration create a corresponding method mapped to the lowercase
+        # string representation appended with a question mark '?' of the enum value For example,
+        # an enum with values of UP and DOWN would create methods up? and down? that check
+        # if the current state matches the value of the enum
+        #
+        # @param [Java::JavaLang::Enum] command_enum Enumeration to create methods for each value
+        #   to check if current state matches that enum
+        # @yield [state] Optional block that can be used to transform state prior to comparison
+        #
+        #
+        def item_state(command_enum)
+          # rubocop:disable Style/HashEachMethods
+          # Disable rule because Java enum does not support each_value
+          command_enum.values.each do |command|
+            status_method = "#{command.to_s.downcase}?"
+            define_method(status_method) do
+              state? && state.as(command_enum) == command
+            end
+          end
+          # rubocop:enable Style/HashEachMethods
+        end
+      end
+    end
+  end
+end

data/lib/openhab/dsl/items/rollershutter_item.rb

@@ -2,6 +2,7 @@
 
 require 'forwardable'
 require 'java'
+require 'openhab/dsl/items/item_command'
 
 module OpenHAB
   module DSL
@@ -11,6 +12,7 @@ module OpenHAB
       #
       class RollershutterItem < Numeric
         extend Forwardable
+        extend OpenHAB::DSL::Items::ItemCommand
         include Comparable
 
         def_delegator :@rollershutter_item, :to_s
@@ -19,6 +21,10 @@ module OpenHAB
         java_import Java::OrgOpenhabCoreLibraryTypes::UpDownType
         java_import Java::OrgOpenhabCoreLibraryTypes::StopMoveType
 
+        item_command Java::OrgOpenhabCoreLibraryTypes::StopMoveType
+        item_command Java::OrgOpenhabCoreLibraryTypes::UpDownType
+        item_state   Java::OrgOpenhabCoreLibraryTypes::UpDownType
+
         #
         # Creates a new RollershutterItem
         #
@@ -32,24 +38,6 @@ module OpenHAB
           super()
         end
 
-        #
-        # Check if the rollershutter is up
-        #
-        # @return [Boolean] true if the rollershutter is up, false otherwise
-        #
-        def up?
-          state.as(UpDownType) == UpDownType::UP
-        end
-
-        #
-        # Check if the rollershutter is down
-        #
-        # @return [Boolean] true if the rollershutter is down, false otherwise
-        #
-        def down?
-          state.as(UpDownType) == UpDownType::DOWN
-        end
-
         #
         # Returns the rollershutter's position
         #
@@ -104,34 +92,6 @@ module OpenHAB
           state.as(UpDownType).equals(other)
         end
 
-        #
-        # Sends an UP command to the Item
-        #
-        def up
-          command UpDownType::UP
-        end
-
-        #
-        # Sends a DOWN command to the Item
-        #
-        def down
-          command UpDownType::DOWN
-        end
-
-        #
-        # Sends a STOP command to the Item
-        #
-        def stop
-          command StopMoveType::STOP
-        end
-
-        #
-        # Sends a MOVE command to the Item
-        #
-        def move
-          command StopMoveType::MOVE
-        end
-
         #
         # Define math operations
         #

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'java'
+require 'openhab/dsl/items/item_command'
 
 module OpenHAB
   module DSL
@@ -20,24 +21,11 @@ module OpenHAB
         # Monkey patch Contact Item with Ruby methods
         #
         class ContactItem
-          java_import org.openhab.core.library.types.OpenClosedType
-          #
-          # Check if the contact is open
-          #
-          # @return [Boolean] True if contact has state and is open, false otherwise
-          #
-          def open?
-            state? && state == OpenClosedType::OPEN
-          end
+          extend OpenHAB::DSL::Items::ItemCommand
 
-          #
-          # Check if the contact is closed
-          #
-          # @return [Boolean] True if contact has state and is closed, false otherwise
-          #
-          def closed?
-            state? && state == OpenClosedType::CLOSED
-          end
+          java_import Java::OrgOpenhabCoreLibraryTypes::OpenClosedType
+
+          item_state Java::OrgOpenhabCoreLibraryTypes::OpenClosedType
 
           #
           # Compares contacts to OpenClosedTypes

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/items/switch_item.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'java'
+require 'openhab/dsl/items/item_command'
+
 module OpenHAB
   module DSL
     module MonkeyPatch
@@ -16,43 +19,15 @@ module OpenHAB
         # Monkeypatching SwitchItem to add Ruby Support methods
         #
         class SwitchItem
-          java_import Java::OrgOpenhabCoreLibraryTypes::OnOffType
-          #
-          # Send the OFF command to the switch
-          #
-          #
-          def off
-            command(OnOffType::OFF)
-          end
+          extend OpenHAB::DSL::Items::ItemCommand
 
-          #
-          # Send the OFF command to the switch
-          #
-          #
-          def on
-            command(OnOffType::ON)
-          end
+          java_import Java::OrgOpenhabCoreLibraryTypes::OnOffType
 
-          #
-          # Check if a switch is on
-          #
-          # @return [Boolean] True if the switch is on, false otherwise
-          #
-          def on?
-            state? && state == OnOffType::ON
-          end
+          item_command Java::OrgOpenhabCoreLibraryTypes::OnOffType
+          item_state Java::OrgOpenhabCoreLibraryTypes::OnOffType
 
           alias truthy? on?
 
-          #
-          # Check if a switch is off
-          #
-          # @return [Boolean] True if the switch is off, false otherwise
-          #
-          def off?
-            state? && state == OnOffType::OFF
-          end
-
           #
           # Send a command to invert the state of the switch
           #

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.1'
+  VERSION = '2.22.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.20.1
+  version: 2.22.1
 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
@@ -40,6 +40,7 @@ files:
 - lib/openhab/dsl/gems.rb
 - lib/openhab/dsl/group.rb
 - lib/openhab/dsl/items/datetime_item.rb
+- lib/openhab/dsl/items/item_command.rb
 - lib/openhab/dsl/items/items.rb
 - lib/openhab/dsl/items/number_item.rb
 - lib/openhab/dsl/items/rollershutter_item.rb