openhab-scripting 4.28.1 → 4.30.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 824e2af85aba6737c05884f3f6ca06adc1873a388b8091062781b274290c6476
-  data.tar.gz: 159ed6ce10d55640c37b61429a937f4dafaecf529479b3423552bff9d929d30d
+  metadata.gz: 10d0c23c8f73defd79189dd05ec00cd3ce3aa301b87f6c7c8dbcfef3a73071d1
+  data.tar.gz: 45699ef1e370be135a4237eae154739f3375a95a9e5921ab97d1a51eb0ae87d4
 SHA512:
-  metadata.gz: 3f6f18504814c73aad6e9c5d5a7548ae17165dff3d4f85a618103f79574389d201c82a528ec09b27b37e975b05b47bb0cd78e958ba0a4bb3b094314f842b9c0e
-  data.tar.gz: d0baf3b51e76656b68e24faa3ceb8d0e76e6afea89b2ba6f81c152ce0f2ddb560fe1942af225f8f1b7ace9c5d3e9c1605c83a1654bddecdceb16f57d47c93b6e
+  metadata.gz: 1e711ed86c556564fb8265781893567ce842b4a920979825a9fda79a329855535745e30f9f95c2c2015e6b4caf38e303b616c665634bb55e144662f67f5a12a4
+  data.tar.gz: 7aa7ccb682c525857d0a9f39296c902f3b0396d7b19de5d76f5d06783daeb316be3f039f0c898301af69545849410a73be8b7261340154568062d71b6f30681b

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

@@ -32,6 +32,13 @@ module OpenHAB
             group.get_members.to_a
           end
 
+          # Name of the group
+          #
+          # @return [String]
+          def name
+            group.name
+          end
+
           # Send a command to each member of the group
           #
           # @return [GroupMembers] +self+

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

@@ -35,7 +35,7 @@ module OpenHAB
         # Explicit conversion to array
         # @return [Array]
         def to_a
-          $ir.items.grep_v(org.openhab.core.items.GroupItem) # rubocop:disable Style/GlobalVars
+          $ir.items.to_a # rubocop:disable Style/GlobalVars
         end
       end
 

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

@@ -45,7 +45,7 @@ module OpenHAB
           between = config.between&.yield_self { between(config.between) }
           @between = between || OpenHAB::DSL::Between::ALL_DAY
           # Convert between to correct range or nil if not set
-          @trigger_delays = config.trigger_delays
+          @trigger_conditions = config.trigger_conditions
           @attachments = config.attachments
         end
         # rubocop:enable Metrics/MethodLength
@@ -57,18 +57,12 @@ module OpenHAB
         # @param [Map] inputs map provided by OpenHAB rules engine containing event and other information
         #
         #
-        def execute(mod = nil, inputs = nil) # rubocop:disable Metrics/MethodLength
+        def execute(mod = nil, inputs = nil)
           thread_local(RULE_NAME: name) do
             logger.trace { "Execute called with mod (#{mod&.to_string}) and inputs (#{inputs&.pretty_inspect})" }
             logger.trace { "Event details #{inputs['event'].pretty_inspect}" } if inputs&.key?('event')
-            if trigger_delay inputs
-              trigger_delay = trigger_delay(inputs)
-              process_trigger_delay(trigger_delay, mod, inputs)
-            else
-              # If guards are satisfied execute the run type blocks
-              # If they are not satisfied, execute the Othewise blocks
-              queue = create_queue(inputs)
-              process_queue(queue, mod, inputs)
+            trigger_conditions(inputs).process(mod: mod, inputs: inputs) do
+              process_queue(create_queue(inputs), mod, inputs)
             end
           end
         end
@@ -124,18 +118,18 @@ module OpenHAB
         end
 
         #
-        # Returns trigger delay from inputs if it exists
+        # Returns trigger conditions from inputs if it exists
         #
         # @param [Map] inputs map from OpenHAB containing UID
         #
-        # @return [Array] Array of trigger delays that match rule UID
+        # @return [Array] Array of trigger conditions that match rule UID
         #
-        def trigger_delay(inputs)
+        def trigger_conditions(inputs)
           # Parse this to get the trigger UID:
           # ["72698819-83cb-498a-8e61-5aab8b812623.event", "oldState", "module", \
           #  "72698819-83cb-498a-8e61-5aab8b812623.oldState", "event", "newState",\
           #  "72698819-83cb-498a-8e61-5aab8b812623.newState"]
-          @trigger_delays[trigger_id(inputs)]
+          @trigger_conditions[trigger_id(inputs)]
         end
 
         # If an attachment exists for the trigger for this event add it to the event object
@@ -151,138 +145,6 @@ module OpenHAB
           event
         end
 
-        #
-        # Check if trigger guards prevent rule execution
-        #
-        # @param [Delay] trigger_delay rules delaying trigger because of
-        # @param [Map] inputs OpenHAB map object describing rule trigger
-        #
-        # @return [Boolean] True if the rule should execute, false if trigger guard prevents execution
-        #
-        def check_trigger_guards(trigger_delay, inputs)
-          new_state, old_state = retrieve_states(inputs)
-          if check_from(trigger_delay, old_state)
-            return true if check_to(trigger_delay, new_state)
-
-            logger.trace("Skipped execution of rule '#{name}' because to state #{new_state}"\
-                         " does not equal specified state(#{trigger_delay.to})")
-          else
-            logger.trace("Skipped execution of rule '#{name}' because old state #{old_state}"\
-                         " does not equal specified state(#{trigger_delay.from})")
-          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
-        #
-        # @param [TriggerDelay] trigger_delay Information about the trigger delay
-        # @param [Item State] state from state to check
-        #
-        # @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? || state == trigger_delay.from
-        end
-
-        #
-        # Check the to state against the trigger delay
-        #
-        # @param [TriggerDelay] trigger_delay Information about the trigger delay
-        # @param [Item State] state to-state to check
-        #
-        # @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? || state == trigger_delay.to
-        end
-
-        #
-        # Process any matching trigger delays
-        #
-        # @param [Map] mod OpenHAB map object describing rule trigger
-        # @param [Map] inputs OpenHAB map object describing rule trigger
-        #
-        #
-        def process_trigger_delay(trigger_delay, mod, inputs)
-          if trigger_delay.timer_active?
-            process_active_timer(inputs, mod, trigger_delay)
-          elsif check_trigger_guards(trigger_delay, inputs)
-            logger.trace("Trigger Guards Matched for #{trigger_delay}, delaying rule execution")
-            # Add timer and attach timer to delay object, and also state being tracked to so timer can be cancelled if
-            #   state changes
-            # Also another timer should not be created if changed to same value again but instead rescheduled
-            create_trigger_delay_timer(inputs, mod, trigger_delay)
-          else
-            logger.trace("Trigger Guards did not match for #{trigger_delay}, ignoring trigger.")
-          end
-        end
-
-        #
-        # Creatas a timer for trigger delays
-        #
-        # @param [Hash] inputs rule trigger inputs
-        # @param [Hash] mod rule trigger mods
-        # @param [TriggerDelay] trigger_delay specifications
-        #
-        #
-        def create_trigger_delay_timer(inputs, mod, trigger_delay)
-          logger.trace("Creating timer for rule #{name} and trigger delay #{trigger_delay}")
-          trigger_delay.timer = after(trigger_delay.duration) do
-            logger.trace("Delay Complete for #{trigger_delay}, executing rule")
-            trigger_delay.timer = nil
-            queue = create_queue(inputs)
-            process_queue(queue, mod, inputs)
-          end
-          trigger_delay.tracking_to, = retrieve_states(inputs)
-        end
-
-        #
-        # Process an active trigger timer
-        #
-        # @param [Hash] inputs rule trigger inputs
-        # @param [Hash] mod rule trigger mods
-        # @param [TriggerDelay] trigger_delay specifications
-        #
-        #
-        def process_active_timer(inputs, mod, trigger_delay)
-          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))
-          else
-            logger.trace("Item changed to #{state} for #{trigger_delay}, canceling timer.")
-            trigger_delay.timer.cancel
-            # Reprocess trigger delay after canceling to track new state (if guards matched, etc)
-            process_trigger_delay(trigger_delay, mod, inputs)
-          end
-        end
-
         #
         # Check if any guards prevent execution
         #

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

@@ -5,7 +5,6 @@ require 'openhab/core/services'
 require 'openhab/log/logger'
 require_relative 'rule_config'
 require_relative 'automation_rule'
-require_relative 'cron_trigger_rule'
 require_relative 'guard'
 
 module OpenHAB
@@ -70,44 +69,14 @@ module OpenHAB
       def process_rule_config(config)
         return unless create_rule?(config)
 
-        cron_attach_triggers, other_triggers = partition_triggers(config)
-        logger.trace("Cron triggers: #{cron_attach_triggers} -  Other triggers: #{other_triggers}")
-        config.triggers = other_triggers
-
         rule = AutomationRule.new(config: config)
         Rules.script_rules << rule
         add_rule(rule)
 
-        process_cron_attach(cron_attach_triggers, config, rule)
-
         rule.execute(nil, { 'event' => Struct.new(:attachment).new(config.start_attachment) }) if config.on_start?
         rule
       end
 
-      #
-      # Add cron triggers with attachments to rules
-      # @param [Array] cron_attach_triggers cron type triggers with attachments
-      #
-      def process_cron_attach(cron_attach_triggers, config, rule)
-        cron_attach_triggers&.map { |trigger| CronTriggerRule.new(rule_config: config, rule: rule, trigger: trigger) }
-                            &.each { |trigger| add_rule(trigger) }
-      end
-
-      #
-      # Partitions triggers in a config, removing cron triggers with a corresponding attachment
-      # so they can be used with CronTriggerRules to support attachments
-      # @return [Array] Two element array the first element is cron triggers with attachments,
-      #   second element is other triggers
-      #
-      def partition_triggers(config)
-        config
-          .triggers
-          .partition do |trigger|
-          trigger.typeUID == OpenHAB::DSL::Rules::Triggers::Trigger::CRON &&
-            config.attachments.key?(trigger.id)
-        end
-      end
-
       #
       # Should a rule be created based on rule configuration
       #

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

@@ -10,6 +10,7 @@ require_relative 'triggers/command'
 require_relative 'triggers/updated'
 require_relative 'triggers/generic'
 require_relative 'triggers/watch'
+require_relative 'triggers/conditions/proc'
 require_relative 'guard'
 require 'openhab/core/entity_lookup'
 require 'openhab/dsl/between'
@@ -37,7 +38,7 @@ module OpenHAB
         attr_accessor :triggers
 
         # @return [Array] Of trigger delays
-        attr_reader :trigger_delays
+        attr_reader :trigger_conditions
 
         # @return [Hash] Hash of trigger UIDs to attachments
         attr_reader :attachments
@@ -86,7 +87,7 @@ module OpenHAB
         #
         def initialize(rule_name, caller_binding)
           @triggers = []
-          @trigger_delays = {}
+          @trigger_conditions = Hash.new(OpenHAB::DSL::Rules::Triggers::Conditions::Proc::ANY)
           @attachments = {}
           @caller = caller_binding.eval 'self'
           name(rule_name)
@@ -145,7 +146,7 @@ module OpenHAB
             "Triggers: (#{triggers}) " \
             "Run blocks: (#{run}) " \
             "on_start: (#{on_start?}) " \
-            "Trigger Waits: #{trigger_delays} " \
+            "Trigger Conditions: #{trigger_conditions} " \
             "Trigger UIDs: #{triggers.map(&:id).join(', ')}" \
             "Attachments: #{attachments} "
         end

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

@@ -1,25 +1,19 @@
 # frozen_string_literal: true
 
 require 'openhab/log/logger'
+require_relative 'conditions/duration'
+require_relative 'conditions/proc'
 
 module OpenHAB
   module DSL
     module Rules
       #
-      # Module holds rule triggers
+      # Module for changed triggers
       #
+
       module Triggers
         include OpenHAB::Log
 
-        #
-        # Struct capturing data necessary for a conditional trigger
-        #
-        TriggerDelay = Struct.new(:to, :from, :duration, :timer, :tracking_to, keyword_init: true) do
-          def timer_active?
-            timer&.is_active
-          end
-        end
-
         #
         # Creates a trigger item, group and thing changed
         #
@@ -38,7 +32,7 @@ module OpenHAB
             wait_duration = binding.local_variable_get(:for)
 
             each_state(from, to) do |from_state, to_state|
-              changed_or_wait(item, from_state, to_state, wait_duration, attach)
+              changed_trigger(item, from_state, to_state, wait_duration, attach)
             end
           end.flatten
         end
@@ -65,7 +59,7 @@ module OpenHAB
         end
 
         #
-        # Create regular or delayed trigger based on duration
+        # Create the trigger
         #
         # @param [Object] item item to create trigger for
         # @param [Item State] from state to restrict trigger to
@@ -75,9 +69,13 @@ module OpenHAB
         #
         # @return [Trigger] OpenHAB triggers
         #
-        def changed_or_wait(item, from, to, duration, attach)
+        def changed_trigger(item, from, to, duration, attach)
           if duration
             changed_wait(item, from: from, to: to, duration: duration, attach: attach)
+          elsif [to, from].grep(Range).any?
+            create_changed_range_trigger(item, from: from, to: to, attach: attach)
+          elsif [to, from].grep(Proc).any?
+            create_changed_proc_trigger(item, from: from, to: to, attach: attach)
           else
             create_changed_trigger(item, from, to, attach)
           end
@@ -90,13 +88,48 @@ module OpenHAB
         # @param [OpenHAB::Core::Duration] duration to delay trigger for until condition is met
         # @param [Item State] to OpenHAB Item State item or group needs to change to
         # @param [Item State] from OpenHAB Item State item or group needs to be coming from
+        # @param [Object] attach to trigger
         #
         # @return [Trigger] OpenHAB trigger
         #
         def changed_wait(item, duration:, to: nil, from: nil, attach: nil)
-          trigger = create_changed_trigger(item, nil, nil, attach)
-          logger.trace("Creating Changed Wait Change Trigger for #{item}")
-          @trigger_delays[trigger.id] = TriggerDelay.new(to: to, from: from, duration: duration)
+          item_name = item.respond_to?(:name) ? item.name : item.to_s
+          logger.trace("Creating Changed Wait Change Trigger for Item(#{item_name}) Duration(#{duration}) "\
+                       "To(#{to}) From(#{from}) Attach(#{attach})")
+          create_changed_trigger(item, nil, nil, attach).tap do |trigger|
+            @trigger_conditions[trigger.id] = Conditions::Duration.new(to: to, from: from, duration: duration)
+          end
+        end
+
+        #
+        # Creates a trigger with a range condition on either 'from' or 'to' field
+        # @param [Object] item to create changed trigger on
+        # @param [Object] from state to restrict trigger to
+        # @param [Object] to state restrict trigger to
+        # @param [Object] attach to trigger
+        # @return [Trigger] OpenHAB trigger
+        #
+        def create_changed_range_trigger(item, from:, to:, attach:)
+          from, to = Conditions::Proc.range_procs(from, to)
+          create_changed_proc_trigger(item, from: from, to: to, attach: attach)
+        end
+
+        #
+        # Creates a trigger with a proc condition on either 'from' or 'to' field
+        # @param [Object] item to create changed trigger on
+        # @param [Object] from state to restrict trigger to
+        # @param [Object] to state restrict trigger to
+        # @param [Object] attach to trigger
+        # @return [Trigger] OpenHAB trigger
+        #
+        def create_changed_proc_trigger(item, from:, to:, attach:)
+          # swap from/to w/ nil if from/to is a proc
+          # rubocop:disable Style/ParallelAssignment
+          from_proc, from = from, nil if from.is_a? Proc
+          to_proc, to = to, nil if to.is_a? Proc
+          # rubocop:enable Style/ParallelAssignment
+          trigger = create_changed_trigger(item, from, to, attach)
+          @trigger_conditions[trigger.id] = Conditions::Proc.new(to: to_proc, from: from_proc)
           trigger
         end
 
@@ -104,8 +137,8 @@ module OpenHAB
         # Create a changed trigger
         #
         # @param [Object] item to create changed trigger on
-        # @param [String] from state to restrict trigger to
-        # @param [String] to state restrict trigger to
+        # @param [Object] from state to restrict trigger to
+        # @param [Object] to state restrict trigger to
         #
         #
         def create_changed_trigger(item, from, to, attach)

data/lib/openhab/dsl/rules/triggers/conditions/duration.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require 'openhab/log/logger'
+
+module OpenHAB
+  module DSL
+    module Rules
+      module Triggers
+        #
+        # Module for conditions for triggers
+        #
+        module Conditions
+          include OpenHAB::Log
+          #
+          # this is a no-op condition which simply executes the provided block
+          #
+
+          #
+          # Struct capturing data necessary for a conditional trigger
+          #
+          # TriggerDelay = Struct.new(:to, :from, :duration, :timer, :tracking_to, keyword_init: true) do
+          #  def timer_active?
+          #    timer&.is_active
+          #  end
+          # end
+          class Duration
+            #
+            # Create a new duration condition
+            # @param [Object] to optional condition on to state
+            # @param [Object] from optional condition on from state
+            # @param [Duration] Duration to state must stay at specific value before triggering
+            #
+            def initialize(to:, from:, duration:)
+              to = Conditions::Proc.from_value(to)
+              from = Conditions::Proc.from_value(from)
+              @conditions = Conditions::Proc.new(to: to, from: from)
+              @duration = duration
+              logger.trace "Created Duration Condition To(#{to}) From(#{from}) "\
+                           "Conditions(#{@conditions}) Duration(#{@duration})"
+            end
+
+            # Process rule
+            # @param [Hash] inputs inputs from trigger
+            #
+            def process(mod:, inputs:, &block)
+              process_trigger_delay(mod, inputs, &block)
+            end
+
+            private
+
+            #
+            # Checks if there is an active timer
+            # @return [true, false] true if the timer exists and is active, false otherwise
+            def timer_active?
+              @timer&.is_active
+            end
+
+            #
+            # Check if trigger guards prevent rule execution
+            #
+            # @param [Map] inputs OpenHAB map object describing rule trigger
+            #
+            # @return [Boolean] True if the rule should execute, false if trigger guard prevents execution
+            #
+            def check_trigger_guards(inputs)
+              new_state, old_state = retrieve_states(inputs)
+              @conditions.check_from(state: old_state) && @conditions.check_to(state: new_state)
+            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)
+              new_state = inputs['newState'] || thing_status_to_sym(inputs['newStatus'])
+              old_state = inputs['oldState'] || thing_status_to_sym(inputs['oldStatus'])
+
+              [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
+
+            #
+            # Process any matching trigger delays
+            #
+            # @param [Map] mod OpenHAB map object describing rule trigger
+            # @param [Map] inputs OpenHAB map object describing rule trigger
+            #
+            #
+            def process_trigger_delay(mod, inputs, &block)
+              if timer_active?
+                process_active_timer(inputs, mod, &block)
+              elsif check_trigger_guards(inputs)
+                logger.trace("Trigger Guards Matched for #{self}, delaying rule execution")
+                # Add timer and attach timer to delay object, and also state being tracked to so
+                # timer can be cancelled if state changes
+                # Also another timer should not be created if changed to same value again but instead rescheduled
+                create_trigger_delay_timer(inputs, mod, &block)
+              else
+                logger.trace("Trigger Guards did not match for #{self}, ignoring trigger.")
+              end
+            end
+
+            #
+            # Creates a timer for trigger delays
+            #
+            # @param [Hash] inputs rule trigger inputs
+            # @param [Hash] mod rule trigger mods
+            #
+            #
+            def create_trigger_delay_timer(inputs, _mod)
+              logger.trace("Creating timer for trigger delay #{self}")
+              @timer = after(@duration) do
+                logger.trace("Delay Complete for #{self}, executing rule")
+                @timer = nil
+                yield
+              end
+              @tracking_to, = retrieve_states(inputs)
+            end
+
+            #
+            # Process an active trigger timer
+            #
+            # @param [Hash] inputs rule trigger inputs
+            # @param [Hash] mod rule trigger mods
+            #
+            #
+            def process_active_timer(inputs, mod, &block)
+              state, = retrieve_states(inputs)
+              if state == @tracking_to
+                logger.trace("Item changed to #{state} for #{self}, rescheduling timer.")
+                @timer.reschedule(ZonedDateTime.now.plus(@duration))
+              else
+                logger.trace("Item changed to #{state} for #{self}, canceling timer.")
+                @timer.cancel
+                # Reprocess trigger delay after canceling to track new state (if guards matched, etc)
+                process_trigger_delay(mod, inputs, &block)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openhab/dsl/rules/triggers/conditions/proc.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require 'openhab/log/logger'
+
+module OpenHAB
+  module DSL
+    module Rules
+      module Triggers
+        #
+        # Module for conditions for triggers
+        #
+        module Conditions
+          include OpenHAB::Log
+
+          #
+          # This creates trigger conditions that work on procs
+          # @param [Proc] from Proc
+          # @param [Proc] to Proc
+          #
+          class Proc
+            include OpenHAB::Log
+
+            # Proc that doesn't check any fields
+            ANY = Proc.new.freeze
+
+            #
+            # Converts supplied ranges to procs that check range
+            # @param [Array] ranges objects to convert to range proc if they are ranges
+            # @return [Array] of procs or supplied arguments if argument was not of type Range
+            #
+            def self.range_procs(*ranges)
+              ranges.map { |range| range.is_a?(Range) ? range_proc(range) : range }
+            end
+
+            #
+            # Create a range proc for the supplied range object
+            # @param [Range] range to build proc for
+            #
+            def self.range_proc(range)
+              logger.trace("Creating range proc for #{range}")
+              lambda do |state|
+                logger.trace("Range proc checking if #{state} is in  #{range}")
+                range.include? state
+              end
+            end
+
+            #
+            # Create a range proc for the supplied range object
+            # @param [Range] range to build proc for
+            #
+            def self.equality_proc(value)
+              logger.trace("Creating equality proc for #{value}")
+              lambda do |state|
+                logger.trace("Equality proc comparing #{value} against #{state}")
+                value == state
+              end
+            end
+
+            #
+            # Constructs a proc for the specific value type
+            #  if the value is a proc return the proc
+            #  if the value is a range create a range proc
+            #  if the value is nil, return nil
+            #  otherwise create an equality proc
+            # @param [Object] value to construct proc from
+            def self.from_value(value)
+              logger.trace("Creating proc for Value(#{value})")
+              return value if value.nil?
+              return value if value.is_a? ::Proc
+              return range_proc(value) if value.is_a? Range
+
+              equality_proc(value)
+            end
+
+            #
+            # Create a new Proc Condition that executes only if procs return true
+            # @param [Proc] from Proc to check against from value
+            # @param [Proc] to Proc to check against to value
+            #
+            def initialize(from: nil, to: nil)
+              @from = from
+              @to = to
+            end
+
+            #
+            # Process rule
+            # @param [Hash] inputs inputs from trigger
+            #
+            def process(mod:, inputs:) # rubocop:disable Lint/UnusedMethodArgument - mod is unused here but required
+              logger.trace("Checking #{inputs} against condition trigger #{self}")
+              yield if check_from(inputs: inputs) && check_to(inputs: inputs)
+            end
+
+            #
+            # Check if from condition match the proc
+            # @param [Hash] inputs from trigger must be supplied if state is not supplied
+            # @param [String] state if supplied proc will be passed state value for comparision
+            # @return [true/false] depending on if from is set and matches supplied conditions
+            #
+            def check_from(inputs: nil, state: nil)
+              state ||= input_state(inputs, 'oldState')
+              logger.trace "Checking from(#{@from}) against state(#{state})"
+              check_proc(proc: @from, state: state)
+            end
+
+            #
+            # Check if to conditions match the proc
+            # @param [Hash] inputs from trigger must be supplied if state is not supplied
+            # @param [String] state if supplied proc will be passed state value for comparision
+            # @return [true/false] depending on if from is set and matches supplied conditions
+            #
+            def check_to(inputs: nil, state: nil)
+              state ||= input_state(inputs, 'newState', 'state')
+              logger.trace "Checking to(#{@to}) against state(#{state})"
+              check_proc(proc: @to, state: state)
+            end
+
+            # Describe the Proc Condition as a string
+            # @return [String] string representation of proc condition
+            #
+            def to_s
+              "From:(#{@from}) To:(#{@to})"
+            end
+
+            private
+
+            # Check if a field matches the proc condition
+            # @param [Proc] proc to call
+            # @param [Hash] inputs containing fields
+            # @param [Array] fields array of fields to extract from inputs, first one found is passed to proc
+            # @return [true,false] true if proc is nil or proc.call returns true, false otherwise
+            def check_proc(proc:, state:)
+              return true if proc.nil? || proc.call(state)
+
+              logger.trace("Skipped execution of rule because state #{state} evalulated false for (#{proc})")
+              false
+            end
+
+            # Get the first field from supplied fields in inputs
+            # @param [Hash] inputs containing fields
+            # @param [Array] fields array of fields to extract from inputs, first one found is returned
+            def input_state(inputs, *fields)
+              fields.map { |f| inputs[f] }.compact.first
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -164,7 +164,125 @@ module OpenHAB
           end
           expression_map
         end
+
+        #
+        # Cron trigger that provides trigger ID
+        #
+        module Cron
+          include OpenHAB::Log
+
+          #
+          # Creates trigger types and trigger type factories for OpenHAB
+          #
+          def self.add_script_cron_handler
+            java_import org.openhab.core.automation.type.TriggerType
+            OpenHAB::Core.automation_manager.add_trigger_handler(
+              OpenHAB::DSL::Rules::Triggers::Cron::CRON_TRIGGER_MODULE_ID,
+              OpenHAB::DSL::Rules::Triggers::Cron::CronTriggerHandlerFactory.new
+            )
+
+            OpenHAB::Core.automation_manager.add_trigger_type(cron_trigger_type)
+            OpenHAB::Log.logger(self).trace('Added script cron trigger handler')
+          end
+
+          #
+          # Creates trigger types and trigger type factories for OpenHAB
+          #
+          private_class_method def self.cron_trigger_type
+            TriggerType.new(
+              OpenHAB::DSL::Rules::Triggers::Cron::CRON_TRIGGER_MODULE_ID,
+              nil,
+              'A specific instant occurs',
+              'Triggers when the specified instant occurs',
+              nil,
+              org.openhab.core.automation.Visibility::VISIBLE,
+              nil
+            )
+          end
+
+          # Trigger ID for Watch Triggers
+          CRON_TRIGGER_MODULE_ID = 'jsr223.jruby.CronTrigger'
+
+          # Cron Trigger Handler that provides trigger IDs
+          # Unfortunatly because the CronTriggerHandler in OpenHAB core is marked internal
+          # the entire thing must be recreated here
+          class CronTriggerHandler < org.openhab.core.automation.handler.BaseTriggerModuleHandler
+            include OpenHAB::Log
+            include org.openhab.core.scheduler.SchedulerRunnable
+            include org.openhab.core.automation.handler.TimeBasedTriggerHandler
+
+            # Provides access to protected fields
+            field_accessor :callback
+
+            # Creates a new CronTriggerHandler
+            # @param [Trigger] OpenHAB trigger associated with handler
+            #
+            def initialize(trigger)
+              @trigger = trigger
+              @scheduler = OpenHAB::Core::OSGI.service('org.openhab.core.scheduler.CronScheduler')
+              @expression = trigger.configuration.get('cronExpression')
+              super(trigger)
+            end
+
+            #
+            # Set the callback to execute when cron trigger fires
+            # @param [Object] callback to run
+            #
+            def setCallback(callback) # rubocop:disable Naming/MethodName
+              synchronized do
+                super(callback)
+                @scheduler.schedule(self, @expression)
+                logger.trace("Scheduled cron job '#{@expression}' for trigger '#{@trigger.id}'.")
+              end
+            end
+
+            #
+            # Get the temporal adjuster
+            # @return [CronAdjuster]
+            #
+            def getTemporalAdjuster # rubocop:disable Naming/MethodName
+              org.openhab.core.scheduler.CronAdjuster.new(expression)
+            end
+
+            #
+            # Execute the callback
+            #
+            def run
+              callback&.triggered(@trigger, { 'module' => @trigger.id })
+            end
+
+            #
+            # Displose of the handler
+            # cancel the cron scheduled task
+            #
+            def dispose
+              synchronized do
+                super
+                return unless @schedule
+
+                @schedule&.cancel(true)
+              end
+              logger.trace("cancelled job for trigger '#{@trigger.id}'.")
+            end
+          end
+
+          # Implements the ScriptedTriggerHandlerFactory interface to create a new Cron Trigger Handler
+          class CronTriggerHandlerFactory
+            include org.openhab.core.automation.module.script.rulesupport.shared.factories.ScriptedTriggerHandlerFactory
+
+            # Invoked by the OpenHAB core to get a trigger handler for the supllied trigger
+            # @param [Trigger] OpenHAB trigger
+            #
+            # @return [WatchTriggerHandler] trigger handler for supplied trigger
+            def get(trigger)
+              CronTriggerHandler.new(trigger)
+            end
+          end
+        end
       end
     end
   end
 end
+
+# Add the cron handler to OpenHAB
+OpenHAB::DSL::Rules::Triggers::Cron.add_script_cron_handler

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

@@ -2,6 +2,7 @@
 
 require 'securerandom'
 require 'java'
+require_relative 'cron'
 
 module OpenHAB
   module DSL
@@ -111,7 +112,7 @@ module OpenHAB
           TIME_OF_DAY = 'timer.TimeOfDayTrigger'
 
           # @return [String] A cron trigger
-          CRON = 'timer.GenericCronTrigger'
+          CRON = OpenHAB::DSL::Rules::Triggers::Cron::CRON_TRIGGER_MODULE_ID
 
           #
           # Create a trigger

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'openhab/log/logger'
+require_relative 'trigger'
 
 module OpenHAB
   module DSL
@@ -23,29 +24,71 @@ module OpenHAB
           separate_groups(items).map do |item|
             logger.trace("Creating updated trigger for item(#{item}) to(#{to})")
             [to].flatten.map do |to_state|
-              trigger, config = create_update_trigger(item, to_state)
-              append_trigger(trigger, config, attach: attach)
+              update_trigger(item: item, to: to_state, attach: attach)
             end
           end.flatten
         end
 
         private
 
+        #
+        # Create the trigger
+        #
+        # @param [Object] item item to create trigger for
+        # @param [Item State] from state to restrict trigger to
+        # @param [Item State] to state to restrict trigger to
+        # @param attach attachment
+        #
+        # @return [Trigger] OpenHAB triggers
+        #
+        def update_trigger(item:, to:, attach:)
+          case to
+          when Range then create_update_range_trigger(item: item, to: to, attach: attach)
+          when Proc then create_update_proc_trigger(item: item, to: to, attach: attach)
+          else create_update_trigger(item: item, to: to, attach: attach)
+          end
+        end
+
+        #
+        # Creates a trigger with a range condition on the 'to' field
+        # @param [Object] item to create changed trigger on
+        # @param [Object] to state restrict trigger to
+        # @param [Object] attach to trigger
+        # @return [Trigger] OpenHAB trigger
+        #
+        def create_update_range_trigger(item:, to:, attach:)
+          to, * = Conditions::Proc.range_procs(to)
+          create_update_proc_trigger(item: item, to: to, attach: attach)
+        end
+
+        #
+        # Creates a trigger with a proc condition on the 'to' field
+        # @param [Object] item to create changed trigger on
+        # @param [Object] to state restrict trigger to
+        # @param [Object] attach to trigger
+        # @return [Trigger] OpenHAB trigger
+        #
+        def create_update_proc_trigger(item:, to:, attach:)
+          create_update_trigger(item: item, to: nil, attach: attach).tap do |trigger|
+            @trigger_conditions[trigger.id] = Conditions::Proc.new(to: to)
+          end
+        end
+
         #
         # Create a trigger for updates
         #
         # @param [Object] item Type of item [Group,Thing,Item] to create update trigger for
         # @param [State] to_state state restriction on trigger
         #
-        # @return [Array<Hash,String>] first element is a String specifying trigger type
-        #  second element is a Hash configuring trigger
+        # @return [Trigger] OpenHAB triggers
         #
-        def create_update_trigger(item, to_state)
-          case item
-          when OpenHAB::DSL::Items::GroupItem::GroupMembers then group_update(item, to_state)
-          when Thing then thing_update(item, to_state)
-          else item_update(item, to_state)
-          end
+        def create_update_trigger(item:, to:, attach:)
+          trigger, config = case item
+                            when OpenHAB::DSL::Items::GroupItem::GroupMembers then group_update(item: item, to: to)
+                            when Thing then thing_update(thing: item, to: to)
+                            else item_update(item: item, to: to)
+                            end
+          append_trigger(trigger, config, attach: attach)
         end
 
         #
@@ -57,9 +100,9 @@ module OpenHAB
         # @return [Array<Hash,String>] first element is a String specifying trigger type
         #  second element is a Hash configuring trigger
         #
-        def item_update(item, to_state)
+        def item_update(item:, to:)
           config = { 'itemName' => item.name }
-          config['state'] = to_state.to_s unless to_state.nil?
+          config['state'] = to.to_s unless to.nil?
           trigger = Trigger::ITEM_STATE_UPDATE
           [trigger, config]
         end
@@ -73,9 +116,9 @@ module OpenHAB
         # @return [Array<Hash,String>] first element is a String specifying trigger type
         #  second element is a Hash configuring trigger
         #
-        def group_update(item, to_state)
+        def group_update(item:, to:)
           config = { 'groupName' => item.group.name }
-          config['state'] = to_state.to_s unless to_state.nil?
+          config['state'] = to.to_s unless to.nil?
           trigger = Trigger::GROUP_STATE_UPDATE
           [trigger, config]
         end
@@ -89,8 +132,8 @@ module OpenHAB
         # @return [Array<Hash,String>] first element is a String specifying trigger type
         #  second element is a Hash configuring trigger
         #
-        def thing_update(thing, to_state)
-          trigger_for_thing(thing, Trigger::THING_UPDATE, to_state)
+        def thing_update(thing:, to:)
+          trigger_for_thing(thing, Trigger::THING_UPDATE, to)
         end
       end
     end

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

@@ -138,11 +138,9 @@ module OpenHAB
 
             # Called by OpenHAB to set the rule engine to invoke when triggered
             # Must match java method name style
-            # rubocop:disable Naming/MethodName
-            def setCallback(callback)
+            def setCallback(callback) # rubocop:disable Naming/MethodName
               @rule_engine_callback = callback
             end
-            # rubocop:enable Naming/MethodName
 
             #
             # Dispose of handler which deactivates watcher

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

@@ -10,8 +10,8 @@ module OpenHAB
       DateTimeType = org.openhab.core.library.types.DateTimeType
       java_import java.time.ZonedDateTime # This is needed for the addon prior to ruby_class fix (OH 3.2.0)
 
-      # global alias
-      ::DateTimeType = DateTimeType
+      # global alias - required for jrubyscripting addon <= OH3.2.0
+      ::DateTimeType = DateTimeType if ::DateTimeType.is_a?(Java::JavaLang::Class)
 
       # @deprecated
       # Backwards-compatible alias

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

@@ -8,8 +8,8 @@ module OpenHAB
     module Types
       HSBType = org.openhab.core.library.types.HSBType
 
-      # global alias
-      ::HSBType = HSBType
+      # global alias - required for jrubyscripting addon <= OH3.2.0
+      ::HSBType = HSBType if ::HSBType.is_a?(Java::JavaLang::Class)
 
       # Adds methods to core OpenHAB HSBType to make it more natural in Ruby
       class HSBType < PercentType

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

@@ -7,8 +7,8 @@ module OpenHAB
     module Types
       PercentType = org.openhab.core.library.types.PercentType
 
-      # global alias
-      ::PercentType = PercentType
+      # global alias - required for jrubyscripting addon <= OH3.2.0
+      ::PercentType = PercentType if ::PercentType.is_a?(Java::JavaLang::Class)
 
       # Adds methods to core OpenHAB PercentType to make it more natural in Ruby
       class PercentType < DecimalType

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

@@ -5,9 +5,9 @@ module OpenHAB
     module Types
       PointType = org.openhab.core.library.types.PointType
 
-      # global scope
+      # global scope - required for jrubyscripting addon <= OH3.2.0
       # @!visibility private
-      ::PointType = PointType
+      ::PointType = PointType if ::PointType.is_a?(Java::JavaLang::Class)
 
       # Adds methods to core OpenHAB PointType to make it more natural in Ruby
       class PointType

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

@@ -7,8 +7,8 @@ module OpenHAB
     module Types
       QuantityType = org.openhab.core.library.types.QuantityType
 
-      # global alias
-      ::QuantityType = QuantityType
+      # global alias - required for jrubyscripting addon <= OH3.2.0
+      ::QuantityType = QuantityType if ::QuantityType.is_a?(Java::JavaLang::Class)
 
       # @deprecated
       # Backwards-compatible alias
@@ -20,8 +20,8 @@ module OpenHAB
         include NumericType
 
         # private alias
-        ONE = org.openhab.core.library.unit.Units::ONE
-        private_constant :ONE
+        ONE_UNIT = org.openhab.core.library.unit.Units::ONE
+        private_constant :ONE_UNIT
 
         #
         # Convert this quantity into a another unit
@@ -46,8 +46,8 @@ module OpenHAB
         def <=>(other) # rubocop:disable Metrics
           logger.trace("(#{self.class}) #{self} <=> #{other} (#{other.class})")
           if other.is_a?(self.class)
-            return unitize(other.unit).compare_to(other) if unit == ONE
-            return compare_to(other.unitize(unit)) if other.unit == ONE
+            return unitize(other.unit).compare_to(other) if unit == ONE_UNIT
+            return compare_to(other.unitize(unit)) if other.unit == ONE_UNIT
 
             compare_to(other)
           elsif other.is_a?(Items::NumericItem) ||
@@ -88,7 +88,7 @@ module OpenHAB
           elsif other.is_a?(Type)
             [other, as(other.class)]
           elsif other.respond_to?(:to_d)
-            [QuantityType.new(other.to_d.to_java, ONE), self]
+            [QuantityType.new(other.to_d.to_java, ONE_UNIT), self]
           elsif other.is_a?(String)
             [QuantityType.new(other), self]
           end
@@ -215,7 +215,7 @@ module OpenHAB
           logger.trace("Converting #{self} to #{other_unit}")
 
           case unit
-          when ONE
+          when ONE_UNIT
             QuantityType.new(to_big_decimal, other_unit)
           when other_unit
             self
@@ -224,10 +224,10 @@ module OpenHAB
           end
         end
 
-        # if unit is +ONE+, return a plain Java BigDecimal
+        # if unit is +ONE_UNIT+, return a plain Java BigDecimal
         # @!visibility private
         def deunitize
-          return to_big_decimal if unit == ONE
+          return to_big_decimal if unit == ONE_UNIT
 
           self
         end

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.28.1
+  version: 4.30.1
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-15 00:00:00.000000000 Z
+date: 2022-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,7 +97,6 @@ files:
 - lib/openhab/dsl/openhab.rb
 - lib/openhab/dsl/persistence.rb
 - lib/openhab/dsl/rules/automation_rule.rb
-- lib/openhab/dsl/rules/cron_trigger_rule.rb
 - lib/openhab/dsl/rules/guard.rb
 - lib/openhab/dsl/rules/item_event.rb
 - lib/openhab/dsl/rules/property.rb
@@ -107,6 +106,8 @@ files:
 - lib/openhab/dsl/rules/triggers/changed.rb
 - lib/openhab/dsl/rules/triggers/channel.rb
 - lib/openhab/dsl/rules/triggers/command.rb
+- lib/openhab/dsl/rules/triggers/conditions/duration.rb
+- lib/openhab/dsl/rules/triggers/conditions/proc.rb
 - lib/openhab/dsl/rules/triggers/cron.rb
 - lib/openhab/dsl/rules/triggers/generic.rb
 - lib/openhab/dsl/rules/triggers/trigger.rb

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

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-require 'openhab/log/logger'
-
-module OpenHAB
-  module DSL
-    #
-    # Creates and manages OpenHAB Rules
-    #
-    module Rules
-      #
-      # Specialized rule for cron triggers with attachments because OpenHAB does not provide trigger UID for cron rules
-      #
-      class CronTriggerRule < Java::OrgOpenhabCoreAutomationModuleScriptRulesupportSharedSimple::SimpleRule
-        include OpenHAB::Log
-
-        def initialize(rule_config:, rule:, trigger:)
-          super()
-          set_name("#{rule_config.name}-cron-#{trigger.id}")
-          set_triggers([trigger])
-          @rule = rule
-          @trigger = trigger
-          logger.trace("Created Cron Trigger Rule for #{@trigger}")
-        end
-
-        #
-        # Execute the rule
-        #
-        # @param [Map] mod map provided by OpenHAB rules engine
-        # @param [Map] inputs map provided by OpenHAB rules engine containing event and other information
-        #
-        #
-        def execute(mod = nil, _inputs = nil)
-          logger.trace "Trigger #{@trigger} fired for base rule #{@rule.inspect}"
-          inputs = { 'module' => @trigger.id }
-          @rule.execute(mod, inputs)
-        end
-      end
-    end
-  end
-end