openhab-scripting 5.12.0 → 5.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35d0d28ba4dd272f12cd989761c2d615836d25dbafbc2af2b60692f8a535d5c1
-  data.tar.gz: 4d51dd07a43f5ff7a7ad43bc66cbb1d63b320486a82036d1a8cbfb22412a061b
+  metadata.gz: bfe5a24aad596dbbc699c68d39ffec4417b9199a75738a54292386d80e725525
+  data.tar.gz: 7aa7877384c2df3ee41588660e3db596f807fd5b2b7b781921528f14b0f9fdeb
 SHA512:
-  metadata.gz: 76c075f22df43c0ecfe37775e297f496d2f55fe60e6da95bbece311d92fe3e37e50d867a23f6f52c3ebeb690771e7eb5512c357ca3b0745d83d03a8df892cad7
-  data.tar.gz: 93eb532732729b91437a669fbbe9b0b024397332faa435c82ebe17d50c4ea4a29576108c819010c0a497a5912d74eaa95e87fc0d98b01f9fa0987fbb52b5fa7b
+  metadata.gz: 756ab20dcfdfce97ba6dfdcbf76d1f40c544607312622e0e013ddd38f7a0d201ae0fec69c13017300fba938d7081eb89f5be5d65ad59abcadf17380ae580dad8
+  data.tar.gz: d9facdcb106fe9fa3e2e51574fa2e52168b9c07eb9c1fad1498a6380e9bc783c8a63535c2a715956a894eb39a2b741ff6f9284fb1de71f9e083262b9f4ed42d0

data/lib/openhab/core/{uid.rb → abstract_uid.rb}

@@ -4,7 +4,7 @@ module OpenHAB
   module Core
     java_import org.openhab.core.common.AbstractUID
 
-    # Adds methods to core openHAB AbstractUID to make it more natural in Ruby
+    # A non specific base class for unique identifiers.
     class AbstractUID
       # implicit conversion to string
       alias_method :to_str, :to_s

data/lib/openhab/core/sitemaps/provider.rb

@@ -52,8 +52,6 @@ module OpenHAB
           @registration.unregister
         end
 
-        # rubocop:disable Layout/LineLength
-
         #
         # Enter the Sitemap Builder DSL.
         #
@@ -69,18 +67,45 @@ module OpenHAB
         #       frame label: "Control" do
         #         text label: "Climate", icon: "if:mdi:home-thermometer-outline" do
         #           frame label: "Main Floor" do
-        #             text item: MainFloor_AmbTemp
         #             # colors are set with a hash, with key being condition, and value being the color
-        #             switch item: MainFloorThermostat_TargetMode, label: "Mode", mappings: %w[off auto cool heat], label_color: { "==heat" => "red", "" => "black" }
-        #             # an array of conditions are OR'd together
-        #             switch item: MainFloorThermostat_TargetMode, label: "Mode", mappings: %w[off auto cool heat], label_color: { ["==heat", "==cool"], => "green" }
-        #             setpoint item: MainFloorThermostat_SetPoint, label: "Set Point", visibility: "MainFloorThermostat_TargetMode!=off"
+        #             # The :default key is used when no other condition matches
+        #             text item: MainFloor_AmbTemp,
+        #               label_color: "purple", # A simple string can be used when no conditions are needed
+        #               value_color: { ">=90" => "red", "<=70" => "blue", :default => "black" }
+        #
+        #             # If item name is not provided in the condition, it will default to the widget's Item
+        #             # The operator will default to == if not specified
+        #             switch item: MainFloorThermostat_TargetMode, label: "Mode",
+        #               mappings: %w[off auto cool heat],
+        #               value_color: { "cool" => "blue", "heat" => "red", :default => "black" }
+        #
+        #             # an array of conditions are AND'd together
+        #             setpoint item: MainFloorThermostat_SetPoint, label: "Set Point",
+        #               value_color: {
+        #                 ["MainFloorThermostat_TargetMode!=off", ">80"] => "red", # red if mode!=off AND setpoint > 80
+        #                 ["MainFloorThermostat_TargetMode!=off", ">74"] => "yellow",
+        #                 ["MainFloorThermostat_TargetMode!=off", ">70"] => "green",
+        #                 "MainFloorThermostat_TargetMode!=off" => "blue",
+        #                 :default => "gray"
+        #               }
         #           end
         #           frame label: "Basement" do
         #             text item: Basement_AmbTemp
-        #             switch item: BasementThermostat_TargetMode, label: "Mode", mappings: { OFF: "off", COOL: "cool", HEAT: "heat" }
-        #             # nested arrays are conditions that are AND'd together, instead of OR'd (requires openHAB 4.1)
-        #             setpoint item: BasementThermostat_SetPoint, label: "Set Point", visibility: [["BasementThermostat_TargetMode!=off", "Vacation_Switch!=OFF"]]
+        #             switch item: BasementThermostat_TargetMode, label: "Mode",
+        #               mappings: { OFF: "off", COOL: "cool", HEAT: "heat" }
+        #
+        #             # Conditions within a nested array are AND'd together (requires openHAB 4.1)
+        #             setpoint item: BasementThermostat_SetPoint, label: "Set Point",
+        #               visibility: [["BasementThermostat_TargetMode!=off", "Vacation_Switch==OFF"]]
+        #
+        #             # Additional elements are OR'd
+        #             # The following visibility conditions are evaluated as:
+        #             # (BasementThermostat_TargetMode!=off AND Vacation_Switch==OFF) OR Verbose_Mode==ON
+        #             setpoint item: BasementThermostat_SetPoint, label: "Set Point",
+        #               visibility: [
+        #                 ["BasementThermostat_TargetMode!=off", "Vacation_Switch==OFF"],
+        #                 "Verbose_Mode==ON"
+        #               ]
         #           end
         #         end
         #       end
@@ -90,7 +115,6 @@ module OpenHAB
         def build(update: true, &block)
           DSL::Sitemaps::Builder.new(self, update: update).instance_eval(&block)
         end
-        # rubocop:enable Layout/LineLength
 
         # For use in specs
         # @!visibility private

data/lib/openhab/core/things/abstract_description_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module Core
+    module Things
+      java_import org.openhab.core.thing.type.AbstractDescriptionType
+
+      #
+      # Base class for {ThingType}, {ChannelType}, and {ChannelGroupType}
+      #
+      # @!attribute [r] label
+      #   @return [String]
+      #
+      # @!attribute [r] description
+      #   @return [String, nil]
+      #
+      class AbstractDescriptionType # rubocop:disable Lint/EmptyClass
+      end
+    end
+  end
+end

data/lib/openhab/core/things/channel.rb

@@ -23,6 +23,9 @@ module OpenHAB
       # @!attribute [r] uid
       #   @return [ChannelUID]
       #
+      # @!attribute [r] channel_type_uid
+      #   @return [ChannelTypeUID]
+      #
       class Channel
         extend Forwardable
 
@@ -43,6 +46,12 @@ module OpenHAB
           "#{r}>"
         end
 
+        # @!attribute [r] channel_type
+        # @return [ChannelType]
+        def channel_type
+          ChannelType.registry.get_channel_type(channel_type_uid)
+        end
+
         # @return [String]
         def to_s
           uid.to_s

data/lib/openhab/core/things/channel_definition.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module OpenHAB
+  module Core
+    module Things
+      java_import org.openhab.core.thing.type.ChannelDefinition
+
+      #
+      # {ChannelDefinition} is a part of a {ChannelGroupType} that represents a functionality of it.
+      # Therefore {Item Items} can be linked a to a channel.
+      #
+      # @!attribute [r] id
+      #   @return [String]
+      #
+      # @!attribute [r] label
+      #   @return [String, nil]
+      #
+      # @!attribute [r] description
+      #   @return [String, nil]
+      #
+      # @!attribute [r] channel_type_uid
+      #   @return [ChannelTypeUID]
+      #
+      # @!attribute [r] channel_type
+      #   (see ChannelTypeUID#channel_type)
+      #
+      # @!attribute [r] properties
+      #   @return [Hash<String, String>]
+      #
+      class ChannelDefinition
+        extend Forwardable
+
+        delegate channel_type: :channel_type_uid
+
+        # @!attribute [r] auto_update_policy
+        # @return [:veto, :default, :recommend, nil]
+        def auto_update_policy
+          get_auto_update_policy&.to_s&.downcase&.to_sym
+        end
+
+        # @return [String]
+        def inspect
+          r = "#<OpenHAB::Core::Things::ChannelDefinition #{id}"
+          r += " channel_type_uid=#{channel_type_uid.inspect}" if channel_type_uid
+          r += " #{label.inspect}" if label
+          r += " description=#{description.inspect}" if description
+          r += " auto_update_policy=#{auto_update_policy}" if auto_update_policy
+          r += " properties=#{properties.to_h}" unless properties.empty?
+          "#{r}>"
+        end
+
+        # @return [String]
+        def to_s
+          id.to_s
+        end
+      end
+    end
+  end
+end

data/lib/openhab/core/things/channel_group_definition.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module OpenHAB
+  module Core
+    module Things
+      java_import org.openhab.core.thing.type.ChannelGroupDefinition
+
+      #
+      # {ChannelGroupDefinition} is a part of a {ThingType} that represents a set of channels
+      #
+      # @!attribute [r] id
+      #   @return [String]
+      #
+      # @!attribute [r] label
+      #   @return [String, nil]
+      #
+      # @!attribute [r] description
+      #   @return [String, nil]
+      #
+      # @!attribute [r] channel_group_type_uid
+      #   @return [ChannelGroupTypeUID]
+      #
+      # @!attribute [r] channel_group_type
+      #   (see ChannelGroupTypeUID#channel_group_type)
+      #
+      class ChannelGroupDefinition
+        extend Forwardable
+
+        alias_method :channel_group_type_uid, :type_uid
+
+        delegate channel_group_type: :channel_group_type_uid
+
+        # @return [String]
+        def inspect
+          r = "#<OpenHAB::Core::Things::ChannelGroupDefinition #{id}"
+          r += " channel_group_type_uid=#{channel_group_type_uid.inspect}"
+          r += " #{label.inspect}" if label
+          r += " description=#{description.inspect}" if description
+          "#{r}>"
+        end
+
+        # @return [String]
+        def to_s
+          id.to_s
+        end
+      end
+    end
+  end
+end

data/lib/openhab/core/things/channel_group_type.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module Core
+    module Things
+      java_import org.openhab.core.thing.type.ChannelGroupType
+
+      #
+      # {ChannelGroupType} contains a list of
+      # {ChannelDefinition channel definitions} and further meta information
+      # such as label and description, which are generally used by user
+      # interfaces.
+      #
+      # @!attribute [r] uid
+      #   @return [ChannelGroupTypeUID]
+      #
+      # @!attribute [r] channel_definitions
+      #   @return [Array<ChannelDefinition>]
+      #
+      # @!attribute [r] category
+      #   @return [String, nil]
+      #
+      class ChannelGroupType < AbstractDescriptionType
+        class << self
+          # @!visibility private
+          def registry
+            @registry ||= OSGi.service("org.openhab.core.thing.type.ChannelGroupTypeRegistry")
+          end
+        end
+
+        # @return [String]
+        def inspect
+          r = "#<OpenHAB::Core::Things::ChannelGroupType #{uid}"
+          r += " category=#{category.inspect}" if category
+          "#{r}>"
+        end
+
+        # @return [String]
+        def to_s
+          uid.to_s
+        end
+      end
+    end
+  end
+end

data/lib/openhab/core/things/channel_group_type_uid.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+require_relative "uid"
+
+module OpenHAB
+  module Core
+    module Things
+      java_import org.openhab.core.thing.type.ChannelGroupTypeUID
+
+      #
+      # {ChannelGroupTypeUID} represents a unique identifier for a {ChannelGroupType}.
+      #
+      # @!attribute [r] id
+      #   @return [String]
+      #
+      # @!attribute [r] channel_definitions
+      #   (see ChannelGroupType#channel_definitions)
+      #
+      # @!attribute [r] category
+      #   (see ChannelGroupType#category)
+      #
+      class ChannelGroupTypeUID < UID
+        extend Forwardable
+
+        delegate %i[category channel_definitions] => :channel_group_type
+
+        # @!attribute [r] channel_group_type
+        # @return [ChannelGroupType]
+        def channel_group_type
+          ChannelGroupType.registry.get_channel_group_type(self)
+        end
+      end
+    end
+  end
+end

data/lib/openhab/core/things/channel_group_uid.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+require_relative "uid"
+
+module OpenHAB
+  module Core
+    module Things
+      java_import org.openhab.core.thing.ChannelGroupUID
+
+      #
+      # {ChannelGroupUID} represents a unique identifier for a group of channels.
+      #
+      # @!attribute [r] id
+      #   @return [String]
+      #
+      # @!attribute [r] thing_uid
+      #   @return [ThingUID]
+      #
+      class ChannelGroupUID < UID
+      end
+    end
+  end
+end

data/lib/openhab/core/things/channel_type.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module OpenHAB
+  module Core
+    module Things
+      java_import org.openhab.core.thing.type.ChannelType
+
+      #
+      # {ChannelGroupType} contains a list of
+      # {ChannelDefinition channel definitions} and further meta information
+      # such as label and description, which are generally used by user
+      # interfaces.
+      #
+      # @!attribute [r] uid
+      #   @return [ChannelTypeUID]
+      #
+      # @!attribute [r] item_type
+      #   @return [String]
+      #
+      # @!attribute [r] tags
+      #   @return [Set<String>]
+      #
+      # @!attribute [r] category
+      #   @return [String, nil]
+      #
+      class ChannelType < AbstractDescriptionType
+        class << self
+          # @!visibility private
+          def registry
+            @registry ||= OSGi.service("org.openhab.core.thing.type.ChannelTypeRegistry")
+          end
+        end
+
+        # @!attribute [r] kind
+        # @return [:state, :trigger]
+        def kind
+          get_kind.to_s.to_sym
+        end
+
+        # @!attribute [r] advanced?
+        # @return [true, false]
+        alias_method :advanced?, :advanced
+
+        # @!visibility private
+        alias_method :state_description, :state
+
+        # @!attribute [r] auto_update_policy
+        # @return [:veto, :default, :recommend, nil]
+        def auto_update_policy
+          get_auto_update_policy&.to_s&.downcase&.to_sym
+        end
+
+        # @return [String]
+        def inspect
+          r = "#<OpenHAB::Core::Things::ChannelType #{uid}"
+          r += " (#{kind})" unless kind == :state
+          r += " (advanced)" if advanced?
+          r += " item_type=#{item_type}"
+          r += " tags=(#{tags.join(", ")})" unless tags.empty?
+          r += " category=#{category.inspect}" if category
+          r += " auto_update_policy=#{auto_update_policy}" if auto_update_policy
+          "#{r}>"
+        end
+
+        # @return [String]
+        def to_s
+          uid.to_s
+        end
+      end
+    end
+  end
+end

data/lib/openhab/core/things/channel_type_uid.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+require_relative "uid"
+
+module OpenHAB
+  module Core
+    module Things
+      java_import org.openhab.core.thing.type.ChannelTypeUID
+
+      #
+      # {ChannelTypeUID} represents a unique identifier for a {ChannelType}.
+      #
+      # @!attribute [r] id
+      #   @return [String]
+      #
+      # @!attribute [r] item_type
+      #   (see ChannelType#item_type)
+      #
+      # @!attribute [r] tags
+      #   (see ChannelType#tags)
+      #
+      # @!attribute [r] category
+      #   (see ChannelType#category)
+      #
+      # @!attribute [r] auto_update_policy
+      #   (see ChannelType#auto_update_policy)
+      #
+      class ChannelTypeUID < UID
+        extend Forwardable
+
+        # @!method advanced?
+        #   @return [true, false]
+
+        delegate %i[item_type
+                    tags
+                    category
+                    auto_update_policy
+                    command_description
+                    event_description
+                    state_description
+                    advanced?] => :channel_type
+
+        # @!attribute [r] channel_type
+        # @return [ChannelType]
+        def channel_type
+          ChannelType.registry.get_channel_type(self)
+        end
+      end
+    end
+  end
+end

data/lib/openhab/core/things/channel_uid.rb

@@ -2,15 +2,32 @@
 
 require "forwardable"
 
+require_relative "uid"
+
 module OpenHAB
   module Core
     module Things
       java_import org.openhab.core.thing.ChannelUID
 
       #
-      # {ChannelUID} represents a unique identifier for {Channel channels}.
+      # {ChannelUID} represents a unique identifier for a {Channel}.
+      #
+      # @!attribute [r] id
+      #   @return [String]
+      #
+      # @!attribute [r] id_without_group
+      #   @return [String]
       #
-      class ChannelUID
+      # @!attribute [r] group_id
+      #   @return [String, nil]
+      #
+      # @!attribute [r] thing_uid
+      #   @return [ThingUID]
+      #
+      class ChannelUID < UID
+        # @return [true, false]
+        alias_method :in_group?, :is_in_group
+
         #
         # @attribute [r] thing
         #

data/lib/openhab/core/things/thing.rb

@@ -39,11 +39,14 @@ module OpenHAB
       #
       # @!attribute [r] uid
       #   Return the UID.
-      #   @return [org.openhab.core.thing.ThingUID]
+      #   @return [ThingUID]
       #
       # @!attribute [r] bridge_uid
       #   Return the Bridge UID when available.
-      #   @return [org.openhab.core.thing.ThingUID]
+      #   @return [ThingUID]
+      #
+      # @!attribute [r] thing_type_uid
+      #   @return [ThingTypeUID]
       #
       # @!attribute [r] configuration
       #   Return the thing's configuration.
@@ -156,6 +159,12 @@ module OpenHAB
           enable(enabled: false)
         end
 
+        # @!attribute [r] thing_type
+        # @return [ThingType]
+        def thing_type
+          ThingType.registry.get_thing_type(thing_type_uid)
+        end
+
         # @return [String]
         def inspect
           r = "#<OpenHAB::Core::Things::Thing #{uid}"

data/lib/openhab/core/things/thing_type.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module Core
+    module Things
+      java_import org.openhab.core.thing.type.ThingType
+
+      #
+      # {ThingType} contains a list of
+      # {ChannelGroupDefinition channel group definitions},
+      # {ChannelDefinition channel definitions} and further meta information.
+      #
+      # This description is used as template definition for the creation of the
+      # according concrete {Thing} object.
+      #
+      # @!attribute [r] uid
+      #   @return [ChannelGroupTypeUID]
+      #
+      # @!attribute [r] channel_group_definitions
+      #   @return [Array<ChannelGroupDefinition>]
+      #
+      # @!attribute [r] channel_definitions
+      #   @return [Array<ChannelDefinition>]
+      #
+      # @!attribute [r] supported_bridge_type_uids
+      #   @return [Array<String>]
+      #
+      # @!attribute [r] category
+      #   @return [String, nil]
+      #
+      # @!attribute [r] properties
+      #   @return [Hash<String, String>]
+      #
+      class ThingType < AbstractDescriptionType
+        class << self
+          # @!visibility private
+          def registry
+            @registry ||= OSGi.service("org.openhab.core.thing.type.ThingTypeRegistry")
+          end
+        end
+
+        # @!attribute [r] listed?
+        # @return [true, false]
+        alias_method :listed?, :is_listed
+
+        # @return [String]
+        def inspect
+          r = "#<OpenHAB::Core::Things::ThingType #{uid}"
+          r += " (unlisted)" unless listed?
+          r += " category=#{category.inspect}" if category
+          r += " properties=#{properties.to_h}" unless properties.empty?
+          "#{r}>"
+        end
+
+        # @return [String]
+        def to_s
+          uid.to_s
+        end
+      end
+    end
+  end
+end

data/lib/openhab/core/things/thing_type_uid.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+require_relative "uid"
+
+module OpenHAB
+  module Core
+    module Things
+      java_import org.openhab.core.thing.ThingTypeUID
+
+      #
+      # {ThingTypeUID} represents a unique identifier for a {ThingType}.
+      #
+      # @!attribute [r] id
+      #   @return [String]
+      #
+      # @!attribute [r] channel_group_definitions
+      #   (see ThingType#channel_group_definitions)
+      #
+      # @!attribute [r] channel_definitions
+      #   (see ThingType#channel_definitions)
+      #
+      # @!attribute [r] supported_bridge_type_uids
+      #   (see ThingType#supported_bridge_type_uids)
+      #
+      # @!attribute [r] category
+      #   (see ThingType#category)
+      #
+      # @!attribute [r] properties
+      #   (see ThingType#properties)
+      #
+      class ThingTypeUID < UID
+        extend Forwardable
+
+        # @!method listed?
+        #   @return [true, false]
+
+        delegate %i[channel_group_definitions
+                    channel_definitions
+                    supported_bridge_type_uids
+                    category
+                    properties
+                    listed?] => :thing_type
+
+        # @!attribute [r] thing_type
+        # @return [ThingType]
+        def thing_type
+          ThingType.registry.get_thing_type(self)
+        end
+      end
+    end
+  end
+end