openhab-scripting 4.15.0 → 4.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa5e8f47863d4b84f260403bcfc62b027fe118a9db4475044c8d25e202a84837
-  data.tar.gz: 7e5b9b690dd7c734c2d4bebda07ed5280d0ff718be1c760ce5f2bfb7846a2c43
+  metadata.gz: 775d56e757a494c9b854b963f2c15393c2521597cd83e5d36452a41033508339
+  data.tar.gz: 9dfd101285ad28b310156016e524a370352b192147f3fbf87d130135b5a48b9d
 SHA512:
-  metadata.gz: 0a9e776aa7e5c784a62c803d6cbb99218ff592ffa60217b0f6604929aea5f3df4ce05a74647780592f87a673fed8cf120087d9bcb519446c3e1beb1072ce947a
-  data.tar.gz: b4d4d3dd48427e67be2dd19e1c91757b0ed8e44ab9550af1804aa2f60ec6beef507ffa316e120867371df83efc5f887092d9023107533e0961c24290a752736d
+  metadata.gz: 773d6bc398e5b24a9aecfb265c6025c75c4863ddf80932e875e9cb60eea4e6fdbf8036803d17c25dfd429127fc5164f1264b4bc48f7fce2cee1cd3fde837372a
+  data.tar.gz: 2e19d2dd05b40da151bd85a253e022209c93819acd20872bd1a30f02d9ad96cdb931c81499f7c222c2c487f962cb56f9db851dee6e3c038a671bac4d44f5481d

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

@@ -131,6 +131,25 @@ module OpenHAB
           group_names.map { |name| Groups.groups[name] }
         end
 
+        # Return the item's thing if this item is linked with a thing. If an item is linked to more than one thing,
+        # this method only returns the first thing.
+        #
+        # @return [Thing] The thing associated with this item or nil
+        def thing
+          all_linked_things.first
+        end
+        alias linked_thing thing
+
+        # Returns all of the item's linked things.
+        #
+        # @return [Array] An array of things or an empty array
+        def things
+          registry = OpenHAB::Core::OSGI.service('org.openhab.core.thing.link.ItemChannelLinkRegistry')
+          channels = registry.get_bound_channels(name).to_a
+          channels.map(&:thing_uid).uniq.map { |tuid| Object.things[tuid] }
+        end
+        alias all_linked_things things
+
         #
         # Check equality without type conversion
         #

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

@@ -20,6 +20,14 @@ module OpenHAB
           on?
         end
 
+        # Convert boolean commands to ON/OFF
+        # @!visibility private
+        def format_type(command)
+          return Types::OnOffType.from(command) if [true, false].include?(command)
+
+          super
+        end
+
         #
         # Send a command to invert the state of the switch
         #

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

@@ -38,7 +38,6 @@ module OpenHAB
         config.guard = Guard::Guard.new(only_if: config.only_if, not_if: config.not_if)
         logger.trace { config.inspect }
         process_rule_config(config)
-        config
       rescue StandardError => e
         re_raise_with_backtrace(e)
       end
@@ -89,6 +88,7 @@ module OpenHAB
         Rules.script_rules << rule
         add_rule(rule)
         rule.execute(nil, { 'event' => Struct.new(:attachment).new(config.start_attachment) }) if config.on_start?
+        rule
       end
 
       #

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
@@ -83,11 +104,11 @@ module OpenHAB
         include LazyArray
         include Singleton
 
-        # Gets a specific thing by name in the format binding_id:type_id:thing_id
-        # @return Thing specified by name or nil if name does not exist in thing registry
+        # Gets a specific thing by name in the format binding_id:type_id:thing_id or via the ThingUID
+        # @return Thing specified by name/UID or nil if name/UID does not exist in thing registry
         def [](uid)
-          thing_uid = org.openhab.core.thing.ThingUID.new(*uid.split(':'))
-          thing = $things.get(thing_uid) # rubocop: disable Style/GlobalVars
+          uid = generate_thing_uid(uid) unless uid.is_a?(org.openhab.core.thing.ThingUID)
+          thing = $things.get(uid) # rubocop: disable Style/GlobalVars
           return unless thing
 
           logger.trace("Retrieved Thing(#{thing}) from registry for uid: #{uid}")
@@ -100,6 +121,15 @@ module OpenHAB
         def to_a
           $things.getAll.map { |thing| Thing.new(thing) } # rubocop: disable Style/GlobalVars
         end
+
+        private
+
+        # Returns a ThingUID given a string like object
+        #
+        # @return ThingUID generated by given name
+        def generate_thing_uid(uid)
+          org.openhab.core.thing.ThingUID.new(*uid.split(':'))
+        end
       end
 
       #

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.15.0
+  version: 4.18.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-24 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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