mqtt-homeassistant 0.1.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96765202ae955e74f283eb348c22fed1c8bd4cd792aa9792ef071cc5f4bf68c3
-  data.tar.gz: bfd420db58ba339dd034c177b5352b9dee84063cd2800f7db21fbe5a125ee8ea
+  metadata.gz: dd38ce90b005b89ff546d1f7b790b769ab2976e6ad042e808d1f44f4637fa64d
+  data.tar.gz: ff5ebc4f121e91e868c9b006709af8cd34754de3bd35bd580dc8492551d5ac2f
 SHA512:
-  metadata.gz: bb2f2bd2d70e208ad42a9420723088d16c33cb4607104f7b3edcaaf26a0c7a04211bd2ba04d9c31e26df84cdbd71b726ad1b995b2d34afb580648b6ee540d0fd
-  data.tar.gz: c1ee571c04ddeea59975ea544dddd1690607ae58fd4bd7c7e825879b8357bcaf405389cdb9c7154e6ce91a4f2a1562742676d5aba5d36acd21bcbbd74f7f5f17
+  metadata.gz: 37cc6a6f5b194756a122c7bc82cfbe560a0e7dd41b1c8322810ed6354ea8acdb0f142b6e6547b87578288024a798168a026f8de50f0e6eec76c806b9f8573eb2
+  data.tar.gz: ba760f546fcaf9f8e63d49ef0420004581caa6f2e783f9b6258bdb71396dba2fa9ed7ba3680ff005dcfabd26ffba19a9df89961d0e1b2a380d9ba1d2638dcecb

data/lib/mqtt/home_assistant/client.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module MQTT
+  module HomeAssistant
+    module Client
+      KNOWN_ATTRIBUTES.each_key do |platform|
+        class_eval <<~RUBY, __FILE__, __LINE__ + 1
+          def publish_hass_#{platform}(object_id, platform: #{platform.inspect}, **kwargs)
+            raise ArgumentError, "platform must be #{platform.inspect}" unless platform == #{platform.inspect}
+
+            publish_hass_component(object_id, platform: platform, **kwargs)
+          end
+
+          def unpublish_hass_#{platform}(object_id, platform: #{platform.inspect}, **kwargs)
+            raise ArgumentError, "platform must be #{platform.inspect}" unless platform == #{platform.inspect}
+
+            unpublish_hass_component(object_id, platform: platform, **kwargs)
+          end
+        RUBY
+      end
+
+      def unpublish_hass_component(object_id, platform:, discovery_prefix: "homeassistant", node_id: nil)
+        node_and_object_id = node_id ? "#{node_id}/#{object_id}" : object_id
+        unless KNOWN_ATTRIBUTES.key?(platform)
+          raise ArgumentError, "Unknown platform #{platform} for #{node_and_object_id}"
+        end
+
+        publish("#{discovery_prefix || "homeassistant"}/#{platform}/#{node_and_object_id}/config",
+                "",
+                retain: true,
+                qos: 1)
+      end
+
+      def publish_hass_component(object_id, platform:, discovery_prefix: "homeassistant", node_id: nil, **kwargs)
+        node_and_object_id = node_id ? "#{node_id}/#{object_id}" : object_id
+        unless KNOWN_ATTRIBUTES.key?(platform)
+          raise ArgumentError, "Unknown platform #{platform} for #{node_and_object_id}"
+        end
+
+        required_attributes = attributes_for_schema(REQUIRED_ATTRIBUTES, platform, kwargs)
+        if required_attributes
+          missing_attributes = required_attributes - kwargs.keys
+          unless missing_attributes&.empty?
+            raise ArgumentError,
+                  "Missing attribute(s) #{missing_attributes.join(", ")} for #{platform}/#{node_and_object_id}"
+          end
+        end
+
+        known_attributes = attributes_for_schema(KNOWN_ATTRIBUTES, platform, kwargs)
+        unknown_attributes = kwargs.keys - SPECIAL_ATTRIBUTES[:common] - known_attributes
+        unless unknown_attributes.empty?
+          raise ArgumentError,
+                "Unknown attribute(s) #{unknown_attributes.join(", ")} for #{platform}/#{node_and_object_id}"
+        end
+
+        if (availability_list = kwargs[:availability])
+          unless (kwargs.keys & %i[availability_mode
+                                   availability_template
+                                   availability_topic
+                                   payload_available
+                                   payload_not_available]).empty?
+            raise ArgumentError,
+                  "availability cannot be used together with availability topic for #{platform}/#{node_and_object_id}"
+          end
+
+          availability_list = [availability_list] if availability_list.is_a?(Hash)
+          unless availability_list.is_a?(Array)
+            raise ArgumentError, "availability must be an array for #{platform}/#{node_and_object_id}"
+          end
+
+          availability_list.each do |availability|
+            unless availability.key?(:topic)
+              raise ArgumentError, "availability must have a topic for #{platform}/#{node_and_object_id}"
+            end
+
+            unless (extra_keys = availability.keys - SPECIAL_ATTRIBUTES[:availability]).empty?
+              raise ArgumentError,
+                    "Unknown attribute(s) #{extra_keys} for #{platform}/#{node_and_object_id}'s availability"
+            end
+          end
+        end
+
+        if (device = kwargs[:device])
+          raise ArgumentError, "device must be a hash for #{platform}/#{node_and_object_id}" unless device.is_a?(Hash)
+          unless (extra_keys = device.keys - SPECIAL_ATTRIBUTES[:device]).empty?
+            raise ArgumentError, "Unknown attribute(s) #{extra_keys} for #{platform}/#{node_and_object_id}'s device"
+          end
+        end
+
+        INCLUSION_VALIDATIONS[:common].merge(INCLUSION_VALIDATIONS[platform] || {}).each do |attr, valid_values|
+          if (value = kwargs[attr]) && !valid_values.include?(value)
+            raise ArgumentError, "Unrecognized #{attr} #{value} for #{platform}/#{node_and_object_id}"
+          end
+        end
+        SUBSET_VALIDATIONS[platform]&.each do |attr, valid_values|
+          if (values = kwargs[attr]) && !(extra_values = values - valid_values).empty?
+            raise ArgumentError, "Invalid #{attr} #{extra_values.join(", ")} for #{platform}/#{node_and_object_id}"
+          end
+        end
+
+        VALIDATIONS[platform]&.call(**kwargs)
+
+        RANGE_ATTRIBUTES[platform]&.each do |attr, prefix_or_suffix|
+          if (range = kwargs.delete(:"#{attr}_range"))
+            case prefix_or_suffix
+            when :prefix
+              kwargs[:"min_#{attr}"] = range.begin
+              kwargs[:"max_#{attr}"] = range.end
+            when :suffix
+              kwargs[:"#{attr}_min"] = range.begin
+              kwargs[:"#{attr}_max"] = range.end
+            when :singleton
+              kwargs[:min] = range.begin
+              kwargs[:max] = range.end
+            end
+          end
+        end
+
+        publish("#{discovery_prefix || "homeassistant"}/#{platform}/#{node_and_object_id}/config",
+                kwargs.to_json,
+                retain: true,
+                qos: 1)
+      end
+
+      private
+
+      def attributes_for_schema(hash, platform, kwargs)
+        attributes = hash[platform]
+        if attributes.is_a?(Hash)
+          schema = kwargs[:schema] || :default
+          attributes = attributes[schema]
+          raise ArgumentError, "Invalid schema #{schema} for platform #{platfomr}" unless attributes
+        end
+
+        attributes
+      end
+    end
+  end
+  Client.include(HomeAssistant::Client)
+end

data/lib/mqtt/home_assistant/version.rb

@@ -2,6 +2,6 @@
 
 module MQTT
   module HomeAssistant
-    VERSION = "0.1.5"
+    VERSION = "1.0.0"
   end
 end