openhab-scripting 4.16.0 → 4.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f765fc75455c9aace6d355e897477c727dcdc7e826bb3b16824979c2cf882f56
-  data.tar.gz: cfb0262989931a22e637e1e2f625ca3f5256da37587d8400b10f68ece4b6c358
+  metadata.gz: 15ce3ee9beba70f7ec3bb9f22b7c805a3c73dfb08e8b13f8ca7eb9cf8625f367
+  data.tar.gz: 26afc00545927a29657b00ef76bcce40f3d6b831d01362d4a5e9d187c8a6c4b8
 SHA512:
-  metadata.gz: 99b0f1896dd66a599449dd96b061f38cc6ad92694bd9502bf14b5b6767330d8eebd714ea41536bb49f730a6fdb9c48e64a04b77c7cb9d54e72d61d617336c2d9
-  data.tar.gz: ff13507c8f80c3f7dbae3089d8ef322e0c0fbaccf835cdb80ea58ea4e595ac8e92b2e440cf4a2c8c2bf9c9401f9da7f98219857ed88ead80adbe853f3b2f2b76
+  metadata.gz: e8db2e2ae436fb49c7de5de26c1570de4b32f279b43b26c5e5e445460c3b496feb9bbeb0a90acab7954de8b664b22d8051f32f4bd8d97fc0ae04e916cbbb9661
+  data.tar.gz: f43eaebacfb2bae1c84c9aa5b275d6256dfd10bffae4aa8722e84d6c83adca275a057080b98acb4875c001bb15c405ade84692008b25aef1d5df20ca87b3666a

data/lib/openhab/dsl/channel.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module OpenHAB
+  module DSL
+    java_import org.openhab.core.thing.Channel
+    java_import org.openhab.core.thing.ChannelUID
+
+    # Adds methods to core OpenHAB Channel to make it more natural in Ruby
+    class Channel
+      extend Forwardable
+
+      delegate %i[thing item items] => :uid
+    end
+
+    # Adds methods to core OpenHAB ChannelUID to make it more natural in Ruby
+    class ChannelUID
+      # Return the thing this channel is associated with.
+      #
+      # @return [Thing] The thing associated with this channel or nil
+      def thing
+        things[thing_uid]
+      end
+
+      # Return the item if this channel is linked with an item. If a channel is linked to more than one item,
+      # this method only returns the first item.
+      #
+      # @return [GenericItem] The item associated with this channel or nil
+      def item
+        items.first
+      end
+
+      # Returns all of the channel's linked items.
+      #
+      # @return [Array<GenericItem>] An array of things or an empty array
+      def items
+        registry = OpenHAB::Core::OSGI.service('org.openhab.core.thing.link.ItemChannelLinkRegistry')
+        registry.get_linked_items(self).to_a
+      end
+    end
+  end
+end

data/lib/openhab/dsl/dsl.rb

@@ -12,6 +12,7 @@ require 'openhab/dsl/monkey_patch/actions/actions'
 require 'openhab/dsl/rules/rule'
 require 'openhab/dsl/rules/terse'
 require 'openhab/dsl/actions'
+require 'openhab/dsl/channel'
 require 'openhab/dsl/timers'
 require 'openhab/dsl/group'
 require 'openhab/dsl/things'

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

@@ -33,20 +33,56 @@ module OpenHAB
         def changed(*items, to: nil, from: nil, for: nil, attach: nil)
           separate_groups(items).map do |item|
             logger.trace("Creating changed trigger for entity(#{item}), to(#{to}), from(#{from})")
+
             # for is a reserved word in ruby, so use local_variable_get :for
-            if (wait_duration = binding.local_variable_get(:for))
-              changed_wait(item, to: to, from: from, duration: wait_duration, attach: attach)
-            else
-              # Place in array and flatten to support multiple to elements or single or nil
-              [to].flatten.map do |to_state|
-                [from].flatten.map { |from_state| create_changed_trigger(item, from_state, to_state, attach) }
-              end
+            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)
             end
           end.flatten
         end
 
         private
 
+        #
+        # Run block for each state combination
+        #
+        # @param [Item State, Array<Item State>] from state to restrict trigger to
+        # @param [Item State, Array<Item State>] to state to restrict trigger to
+        #
+        # @yieldparam [Item State] from_state from state
+        # @yieldparam [Item State] to_state to state
+        #
+        # @return [Array] array of block return values
+        #
+        def each_state(from, to)
+          [to].flatten.each_with_object([]) do |to_state, agg|
+            [from].flatten.each do |from_state|
+              agg.push(yield(from_state, to_state))
+            end
+          end
+        end
+
+        #
+        # Create regular or delayed trigger based on duration
+        #
+        # @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 [OpenHAB::Core::Duration, nil] duration ruration to delay trigger until to state is met
+        # @param attach attachment
+        #
+        # @return [Trigger] OpenHAB triggers
+        #
+        def changed_or_wait(item, from, to, duration, attach)
+          if duration
+            changed_wait(item, from: from, to: to, duration: duration, attach: attach)
+          else
+            create_changed_trigger(item, from, to, attach)
+          end
+        end
+
         #
         # Create a TriggerDelay for for an item or group that is changed for a specific duration
         #

data/lib/openhab/dsl/things.rb

@@ -21,6 +21,21 @@ module OpenHAB
       # Ruby Delegator for Thing
       #
       class Thing < SimpleDelegator
+        # Array wrapper class to allow searching a list of channels
+        # by channel id
+        class ChannelsArray < Array
+          # Allows indexing by both integer as an array or channel id acting like a hash.
+          # @param [Integer, String] index Numeric index or string channel id to search for.
+          def [](index)
+            if index.respond_to?(:to_str)
+              key = index.to_str
+              return find { |channel| channel.uid.id == key }
+            end
+
+            super
+          end
+        end
+
         include OpenHAB::DSL::Actions
         include OpenHAB::Log
 
@@ -45,6 +60,12 @@ module OpenHAB
           define_method("#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) }
         end
 
+        # Returns the list of channels associated with this Thing
+        # @return [Array] channels
+        def channels
+          ChannelsArray.new(super.to_a)
+        end
+
         private
 
         java_import org.openhab.core.automation.annotation.RuleAction

data/lib/openhab/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.16.0
+  version: 4.17.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -54,6 +54,7 @@ files:
 - lib/openhab/core/thread_local.rb
 - lib/openhab/dsl/actions.rb
 - lib/openhab/dsl/between.rb
+- lib/openhab/dsl/channel.rb
 - lib/openhab/dsl/dsl.rb
 - lib/openhab/dsl/gems.rb
 - lib/openhab/dsl/group.rb