mqtt-homeassistant 0.0.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63f377ed2f680df05fcdd443d7827be88ad49630b6a2e046a1291f3ccbe1fe41
-  data.tar.gz: 9f48fd3a21b57073ae31bc488c5f8fda3369a2e3d2ef37d41426e1865d1d307a
+  metadata.gz: e4abb16dba6ea2ddab3b0619ded2e0712e2b997d710cc69d367a5234ee00371c
+  data.tar.gz: b22f5a9ddc2fc216c8a57564f6691661fb0cbaeedfa00d3de76548cf23de299f
 SHA512:
-  metadata.gz: e378a1edd2a12093be108cb9b1685393422274fcc65b578dee2e73c0a429a06dc35f17889f113998ac03a3f4a936fb01028a07f201061dc5420b3557b204b0f2
-  data.tar.gz: 82f86cf62752b56a357844149c2b51952a9fa448783a29e2396053a77648d73acae97921db149a7745a423b97edbd606bd53185f8431b865026383d7cb7d2227
+  metadata.gz: 9704e5112d570e0a7cdf255a365af0440a7a24c09376513703eb25726d46f180334e6c78f7ea6ad71ec2faa38adbdc511e4f453430f08840555d44276a1598d0
+  data.tar.gz: ad8ce6569cbd7fccc1fa968061f4f9a966f97710d1d51d723128f67780191d32edeb5f6738f3eb5339d3a8305d9b2e3745b5e52cc92d2b816305e5010faff0a4

data/lib/mqtt/home_assistant/homie/device.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+MQTT::Homie::Device.attr_accessor :home_assistant_device, :home_assistant_discovery_prefix

data/lib/mqtt/home_assistant/homie/node.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module MQTT
+  module HomeAssistant
+    module Homie
+      module Node
+        {
+          climate: %i[action
+                      aux
+                      away_mode
+                      current_temperature
+                      fan_mode
+                      mode
+                      hold
+                      power
+                      swing_mode
+                      temperature
+                      temperature_high
+                      temperature_low],
+          fan: [nil, :oscillation],
+          humidifier: [nil, :target, :mode],
+          light: [nil, :brightness, :color_mode, :color_temp, :effect, :hs, :rgb, :white, :xy]
+        }.each do |(integration, properties)|
+          has_nil = properties.include?(nil)
+          method_arguments = []
+          method_arguments << "property" if has_nil
+          method_arguments.concat(properties.compact.map { |p| "#{p}_property: nil" })
+          transforms = []
+          transforms << "property = self[property] if property.is_a?(String)"
+          transforms.concat(
+            properties.compact.map do |p|
+              "kwargs[:#{p}_property] = #{p}_property.is_a?(String) ? self[#{p}_property] : #{p}_property"
+            end
+          )
+          args_code = has_nil ? "args = [property]" : "args = []"
+
+          class_eval <<~RUBY, __FILE__, __LINE__ + 1
+            def hass_#{integration}(#{method_arguments.join(", ")}, device: nil, discovery_prefix: nil, **kwargs)
+              #{transforms.join("\n")}
+              discovery_prefix ||= self.device.home_assistant_discovery_prefix
+              device = self.device.home_assistant_device.merge(device || {}) if self.device.home_assistant_device
+
+              kwargs[:device] = device
+              kwargs[:discovery_prefix] = discovery_prefix
+              #{args_code}
+              if published?
+                HomeAssistant.publish_#{integration}(*args, **kwargs)
+              else
+                pending_hass_registrations << [:publish_#{integration}, args, kwargs]
+              end
+            end
+          RUBY
+        end
+
+        def publish
+          super.tap do
+            @pending_hass_registrations&.each do |(method, args, kwargs)|
+              HomeAssistant.public_send(method, *args, **kwargs)
+            end
+            @pending_hass_registrations = nil
+          end
+        end
+
+        private
+
+        def pending_hass_registrations
+          @pending_hass_registrations ||= []
+        end
+      end
+    end
+  end
+end
+
+MQTT::Homie::Node.prepend(MQTT::HomeAssistant::Homie::Node)

data/lib/mqtt/home_assistant/homie/property.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module MQTT
+  module HomeAssistant
+    module Homie
+      module Property
+        def initialize(*args, hass: nil, **kwargs)
+          super(*args, **kwargs)
+
+          return unless hass
+
+          case hass
+          when Symbol
+            public_send("hass_#{hass}")
+          when Hash
+            raise ArgumentError, "hass must only contain one item" unless hass.length == 1
+
+            public_send("hass_#{hass.first.first}", **hass.first.last)
+          else
+            raise ArgumentError, "hass must be a Symbol or a Hash of HASS device type to additional HASS options"
+          end
+        end
+
+        %i[binary_sensor fan humidifier light number scene select sensor switch].each do |integration|
+          class_eval <<~RUBY, __FILE__, __LINE__ + 1
+            def hass_#{integration}(device: nil, discovery_prefix: nil, **kwargs)
+              discovery_prefix ||= self.device.home_assistant_discovery_prefix
+              device = self.device.home_assistant_device.merge(device || {}) if self.device.home_assistant_device
+
+              kwargs[:device] = device
+              kwargs[:discovery_prefix] = discovery_prefix
+              if published?
+                HomeAssistant.publish_#{integration}(self, **kwargs)
+              else
+                kwargs[:method] = :publish_#{integration}
+                pending_hass_registrations << kwargs
+              end
+            end
+          RUBY
+        end
+
+        def publish
+          super.tap do
+            @pending_hass_registrations&.each do |entity|
+              method = entity.delete(:method)
+              HomeAssistant.public_send(method, self, **entity)
+            end
+            @pending_hass_registrations = nil
+          end
+        end
+
+        private
+
+        def pending_hass_registrations
+          @pending_hass_registrations ||= []
+        end
+      end
+    end
+  end
+end
+
+MQTT::Homie::Property.prepend(MQTT::HomeAssistant::Homie::Property)

data/lib/mqtt/home_assistant/version.rb

@@ -2,6 +2,6 @@
 
 module MQTT
   module HomeAssistant
-    VERSION = "0.0.1"
+    VERSION = "0.1.2"
   end
 end

data/lib/mqtt/home_assistant.rb

@@ -2,6 +2,11 @@
 
 require "json"
 
+require "mqtt/homie"
+require "mqtt/home_assistant/homie/device"
+require "mqtt/home_assistant/homie/node"
+require "mqtt/home_assistant/homie/property"
+
 module MQTT
   module HomeAssistant
     class << self
@@ -159,8 +164,9 @@ module MQTT
                              entity_category: entity_category,
                              icon: icon)
         config[:unique_id] = "#{node.device.id}_#{id || node.id}"
+        read_only_props = %i[action current_temperature]
         properties.each do |prefix, property|
-          add_property(config, property, prefix, templates)
+          add_property(config, property, prefix, templates: templates, read_only: read_only_props.include?(prefix))
         end
         temp_properties = [
           temperature_property,
@@ -210,13 +216,13 @@ module MQTT
                              entity_category: entity_category,
                              icon: icon,
                              templates: {})
-        add_property(config, oscillation_property, :oscillation_property, templates)
-        add_property(config, percentage_property, :percentage, templates)
+        add_property(config, oscillation_property, :oscillation_property, templates: templates)
+        add_property(config, percentage_property, :percentage, templates: templates)
         if percentage_property&.range
           config[:speed_range_min] = percentage_property.range.begin
           config[:speed_range_max] = percentage_property.range.end
         end
-        add_property(config, preset_mode_property, :preset, templates)
+        add_property(config, preset_mode_property, :preset, templates: templates)
         add_enum(config, preset_mode_property, :preset)
 
         publish(node.mqtt, "fan", config, discovery_prefix: discovery_prefix)
@@ -300,6 +306,7 @@ module MQTT
                              device: device,
                              entity_category: entity_category,
                              icon: icon)
+        config[:unique_id] = "#{property.device.id}_#{property.node.id}_#{property.id}"
         add_property(config, property)
         case property.datatype
         when :boolean
@@ -310,21 +317,21 @@ module MQTT
         when :float
           config[:payload_off] = "0.0"
         end
-        add_property(config, brightness_property, :brightness, templates)
+        add_property(config, brightness_property, :brightness, templates: templates)
         config[:brightness_scale] = brightness_property.range.end if brightness_property&.range
-        add_property(config, color_mode_property, :color_mode, templates)
-        add_property(config, color_temp_property, :color_temp, templates)
+        add_property(config, color_mode_property, :color_mode, templates: templates)
+        add_property(config, color_temp_property, :color_temp, templates: templates)
         if color_temp_property&.range && color_temp_property.unit == "mired"
           config[:min_mireds] = color_temp_property.range.begin
           config[:max_mireds] = color_temp_property.range.end
         end
-        add_property(config, effect_property, :effect, templates)
+        add_property(config, effect_property, :effect, templates: templates)
         config[:effect_list] = effect_property.range if effect_property&.datatype == :enum
-        add_property(config, hs_property, :hs, templates)
-        add_property(config, rgb_property, :rgb, templates)
-        add_property(config, white_property, :white, templates)
+        add_property(config, hs_property, :hs, templates: templates)
+        add_property(config, rgb_property, :rgb, templates: templates)
+        add_property(config, white_property, :white, templates: templates)
         config[:white_scale] = white_property.range.end if white_property&.range
-        add_property(config, xy_property, :xy, templates)
+        add_property(config, xy_property, :xy, templates: templates)
         config[:on_command_type] = on_command_type if on_command_type
 
         publish(property.mqtt, "light", config, discovery_prefix: discovery_prefix)
@@ -472,16 +479,17 @@ module MQTT
 
       private
 
-      def add_property(config, property, prefix = nil, templates = {})
+      def add_property(config, property, prefix = nil, templates: {}, read_only: false)
         return unless property
 
         prefix = "#{prefix}_" if prefix
-        config[:"#{prefix}state_topic"] = property.topic if property.retained?
-        if property.settable?
+        state_prefix = "state_" unless read_only
+        config[:"#{prefix}#{state_prefix}topic"] = property.topic if property.retained?
+        if !read_only && property.settable?
           config[:"#{prefix}command_topic"] = "#{property.topic}/set"
           config[:"#{prefix}command_template"] = "{{ value | round(0) }}" if property.datatype == :integer
         end
-        config.merge!(templates.slice(:"#{prefix}_template", :"#{prefix}_command_template"))
+        config.merge!(templates.slice(:"#{prefix}template", :"#{prefix}command_template"))
       end
 
       def add_enum(config, property, prefix = nil, valid_set = nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mqtt-homeassistant
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-08 00:00:00.000000000 Z
+date: 2021-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: homie-mqtt
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +116,9 @@ extra_rdoc_files: []
 files:
 - lib/mqtt-homeassistant.rb
 - lib/mqtt/home_assistant.rb
+- lib/mqtt/home_assistant/homie/device.rb
+- lib/mqtt/home_assistant/homie/node.rb
+- lib/mqtt/home_assistant/homie/property.rb
 - lib/mqtt/home_assistant/version.rb
 homepage: https://github.com/ccutrer/ruby-mqtt-homeassistant
 licenses: