homie-mqtt 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c0070a3f65a2d335b3ecaa206e3969a024db3218b8eddb91b03434f0953c712
-  data.tar.gz: d12edaebbf8d5da85e2c67b2ca8c64068daff04bd588770086bcb1d0b24892ea
+  metadata.gz: fd6f3bb8678e0d56ddc578993ba46f8bafb3361e4d5f7b0d5fbede478e640edc
+  data.tar.gz: 4961a257ee03d29d623c009dad99f54ac44ee6701fa1364d2b83d6ce44a3898d
 SHA512:
-  metadata.gz: aaf9bb9ad0d8e5a7c3292570885dd8933325b3127ab1938190e2def744bcb95d95c5f1057f9338f90b3db85d4e8091c0b32a9de835fd20426945f0b1831b5820
-  data.tar.gz: 713b2a20311422b8a8d6e75a4a9ce0c00ae18a556862b38f064f289927c2be364fecfa84450dab1e5120d85e5e2a8d9969c95988a44ab05780db5e3064d547d7
+  metadata.gz: 5aedd7bde7d6cc07a8837802eaeef6f563d4d846b912f737df888a8d2d893bbe2556191f7e2847f2a903527b5c3d7342f62d63562175eac7207dde46867877b1
+  data.tar.gz: dfaa32de5c1126801ceeb164fe919a35c266fec727096539e6e3e794c19d380852c0a910a090222ba5d3396edf7a5a25522d25396453c6734cf5ff33b88ff36d

data/lib/mqtt/homie/base.rb

@@ -18,7 +18,7 @@ module MQTT
           name = value
           if @published
             device.init do
-              mqtt.publish("#{topic}/$name", name, true, 1)
+              mqtt.publish("#{topic}/$name", name, retain: true, qos: 1)
             end
           end
         end

data/lib/mqtt/homie/device.rb

@@ -5,9 +5,9 @@ require 'mqtt'
 module MQTT
   module Homie
     class Device < Base
-      attr_reader :root_topic, :state, :nodes, :mqtt
+      attr_reader :root_topic, :state, :mqtt
 
-      def initialize(id, name, root_topic: nil, mqtt: nil, &block)
+      def initialize(id, name, root_topic: nil, mqtt: nil, clear_topics: true, &block)
         super(id, name)
         @root_topic = @root_topic || "homie"
         @state = :init
@@ -16,8 +16,20 @@ module MQTT
         @block = block
         mqtt = MQTT::Client.new(mqtt) if mqtt.is_a?(String)
         @mqtt = mqtt || MQTT::Client.new
-        @mqtt.set_will("#{topic}/$state", "lost", true)
+        @mqtt.set_will("#{topic}/$state", "lost", retain: true, qos: 1)
+
+        @mqtt.on_reconnect do
+          each do |node|
+            node.each do |property|
+              property.subscribe
+            end
+          end
+          mqtt.publish("#{topic}/$state", :init, retain: true, qos: 1)
+          mqtt.publish("#{topic}/$state", state, retain: true, qos: 1) unless state == :init
+        end
+
         @mqtt.connect
+        self.clear_topics if clear_topics
       end
 
       def device
@@ -36,46 +48,59 @@ module MQTT
           yield node if block_given?
           if prior_state == :ready
             node.publish
-            mqtt.publish("#{topic}/$nodes", nodes.keys.join(","), true, 1)
+            mqtt.publish("#{topic}/$nodes", @nodes.keys.join(","), retain: true, qos: 1)
           end
         end
         self
       end
 
       def remove_node(id)
-        return unless (node = nodes[id])
+        return unless (node = @nodes[id])
         init do
           node.unpublish
           @nodes.delete(id)
-          mqtt.publish("#{topic}/$nodes", nodes.keys.join(","), true, 1) if @published
+          mqtt.publish("#{topic}/$nodes", @nodes.keys.join(","), retain: true, qos: 1) if @published
         end
       end
 
+      def [](id)
+        @nodes[id]
+      end
+
+      def each(&block)
+        @nodes.each_value(&block)
+      end
+
       def publish
         return if @published
 
-        mqtt.publish("#{topic}/$homie", "4.0.0", true, 1)
-        mqtt.publish("#{topic}/$name", name, true, 1)
-        mqtt.publish("#{topic}/$state", @state.to_s, true, 1)
+        mqtt.batch_publish do
+          mqtt.publish("#{topic}/$homie", "4.0.0", retain: true, qos: 1)
+          mqtt.publish("#{topic}/$name", name, retain: true, qos: 1)
+          mqtt.publish("#{topic}/$state", @state.to_s, retain: true, qos: 1)
 
-        @subscription_thread = Thread.new do
-          mqtt.get do |topic, value|
-            match = topic.match(topic_regex)
-            node = nodes[match[:node]] if match
-            property = node.properties[match[:property]] if node
+          @subscription_thread = Thread.new do
+            # you'll get the exception when you call `join`
+            Thread.current.report_on_exception = false
 
-            unless property&.settable?
-              @block&.call(topic, value)
-              next
-            end
+            mqtt.get do |packet|
+              match = packet.topic.match(topic_regex)
+              node = @nodes[match[:node]] if match
+              property = node[match[:property]] if node
 
-            property.set(value)
+              unless property&.settable?
+                @block&.call(topic, packet.payload)
+                next
+              end
+
+              property.set(packet.payload)
+            end
           end
+
+          mqtt.publish("#{topic}/$nodes", @nodes.keys.join(","), retain: true, qos: 1)
+          @nodes.each_value(&:publish)
+          mqtt.publish("#{topic}/$state", (@state = :ready).to_s, retain: true, qos: 1)
         end
- 
-        mqtt.publish("#{topic}/$nodes", nodes.keys.join(","), true, 1)
-        nodes.each_value(&:publish)
-        mqtt.publish("#{topic}/$state", (@state = :ready).to_s, true, 1)
 
         @published = true
       end
@@ -88,6 +113,9 @@ module MQTT
 
       def join
         @subscription_thread&.join
+      rescue => e
+        e.set_backtrace(e.backtrace + ["<from Homie MQTT thread>"] + caller)
+        raise e
       end
 
       def init
@@ -97,14 +125,23 @@ module MQTT
         end
 
         prior_state = state
-        mqtt.publish("#{topic}/$state", (state = :init).to_s, true, 1)
+        mqtt.publish("#{topic}/$state", (state = :init).to_s, retain: true, qos: 1)
         yield(prior_state)
-        mqtt.publish("#{topic}/$state", (state = :ready).to_s, true, 1)
+        mqtt.publish("#{topic}/$state", (state = :ready).to_s, retain: true, qos: 1)
         nil
       end
 
       private
 
+      def clear_topics
+        @mqtt.subscribe("#{topic}/#")
+        @mqtt.unsubscribe("#{topic}/#", wait_for_ack: true)
+        while !@mqtt.queue_empty?
+          packet = @mqtt.get
+          @mqtt.publish(packet.topic, retain: true, qos: 0)
+        end
+      end
+
       def topic_regex
         @topic_regex ||= Regexp.new("^#{Regexp.escape(topic)}/(?<node>#{REGEX})/(?<property>#{REGEX})/set$")
       end

data/lib/mqtt/homie/node.rb

@@ -3,7 +3,7 @@
 module MQTT
   module Homie
     class Node < Base
-      attr_reader :device, :type, :properties
+      attr_reader :device, :type
 
       def initialize(device, id, name, type)
         super(id, name)
@@ -28,34 +28,48 @@ module MQTT
       end
 
       def remove_property(id)
-        return unless (property = properties[id])
+        return unless (property = @properties[id])
         init do
           property.unpublish
           @properties.delete(id)
-          mqtt.publish("#{topic}/$properties", properties.keys.join(","), true, 1) if @published
+          mqtt.publish("#{topic}/$properties", @properties.keys.join(","), retain: true, qos: 1) if @published
         end
       end
 
+      def [](id)
+        @properties[id]
+      end
+
+      def each(&block)
+        @properties.each_value(&block)
+      end
+
       def mqtt
         device.mqtt
       end
 
       def publish
-        unless @published
-          mqtt.publish("#{topic}/$name", name, true, 1)
-          mqtt.publish("#{topic}/$type", @type.to_s, true, 1)
-          @published = true
+        mqtt.batch_publish do
+          unless @published
+            mqtt.publish("#{topic}/$name", name, retain: true, qos: 1)
+            mqtt.publish("#{topic}/$type", @type.to_s, retain: true, qos: 1)
+            @published = true
+          end
+
+          mqtt.publish("#{topic}/$properties", @properties.keys.join(","), retain: true, qos: 1)
+          @properties.each_value(&:publish)
         end
- 
-        mqtt.publish("#{topic}/$properties", properties.keys.join(","), true, 1)
-        properties.each_value(&:publish)
       end
 
       def unpublish
         return unless @published
         @published = false
 
-        properties.each_value(&:unpublish)
+        mqtt.publish("#{topic}/$name", retain: true, qos: 0)
+        mqtt.publish("#{topic}/$type", retain: true, qos: 0)
+        mqtt.publish("#{topic}/$properties", retain: true, qos: 0)
+
+        @properties.each_value(&:unpublish)
       end
     end
   end

data/lib/mqtt/homie/property.rb

@@ -8,9 +8,19 @@ module MQTT
       def initialize(node, id, name, datatype, value = nil, format: nil, retained: true, unit: nil, &block)
         raise ArgumentError, "Invalid Homie datatype" unless %s{string integer float boolean enum color}
         raise ArgumentError, "retained must be boolean" unless [true, false].include?(retained)
+        format = format.join(",") if format.is_a?(Array) && datatype == :enum
+        if %i{integer float}.include?(datatype) && format.is_a?(Range)
+          raise ArgumentError "only inclusive ranges are supported" if format.exclude_end?
+          format = "#{format.begin}:#{format.end}"
+        end
         raise ArgumentError, "format must be nil or a string" unless format.nil? || format.is_a?(String)
         raise ArgumentError, "unit must be nil or a string" unless unit.nil? || unit.is_a?(String)
+        raise ArgumentError, "format is required for enums" if datatype == :enum && format.nil?
+        raise ArgumentError, "format is required for colors" if datatype == :color && format.nil?
+        raise ArgumentError, "format must be either rgb or hsv for colors" if datatype == :color && !%w{rgb hsv}.include?(format.to_s)
+
         super(id, name)
+
         @node = node
         @datatype = datatype
         @format = format
@@ -40,7 +50,7 @@ module MQTT
       def value=(value)
         if @value != value
           @value = value
-          mqtt.publish(topic, value.to_s, retained?, 1) if @published
+          mqtt.publish(topic, value.to_s, retain: retained?, qos: 1) if @published
         end
       end
 
@@ -49,7 +59,7 @@ module MQTT
           @unit = unit
           if @published
             device.init do
-              mqtt.publish("#{topic}/$unit", unit.to_s, true, 1)
+              mqtt.publish("#{topic}/$unit", unit.to_s, retain: true, qos: 1)
             end
           end
         end
@@ -60,14 +70,47 @@ module MQTT
           @format = format
           if @published
             device.init do
-              mqtt.publish("#{topic}/$format", format.to_s, true, 1)
+              mqtt.publish("#{topic}/$format", format.to_s, retain: true, qos: 1)
             end
           end
         end
       end
 
+      def range
+        case datatype
+        when :enum; format.split(',')
+        when :integer; Range.new(*format.split(':').map(&:to_i))
+        when :float; Range.new(*format.split(':').map(&:to_f))
+        else; raise MethodNotImplemented
+        end
+      end
+
       def set(value)
-        @block.call(self, value)
+        case datatype
+        when :boolean
+          return unless %w{true false}.include?(value)
+          value = value == 'true'
+        when :integer
+          return unless value =~ /^-?\d+$/
+          value = value.to_i
+          return unless range.include?(value) if format
+        when :float
+          return unless value =~ /^-?(?:\d+|\d+\.|\.\d+|\d+\.\d+)(?:[eE]-?\d+)?$/
+          value = value.to_f
+          return unless range.include?(value) if format
+        when :enum
+          return unless range.include?(value)
+        when :color
+          return unless value =~ /^\d{1,3},\d{1,3},\d{1,3}$/
+          value = value.split(',').map(&:to_i)
+          if format == 'rgb'
+            return if value.max > 255
+          elsif format == 'hsv'
+            return if value.first > 360 || value[1..2].max > 100
+          end
+        end
+
+        @block.arity == 2 ? @block.call(value, self) : @block.call(value)
       end
 
       def mqtt
@@ -77,23 +120,36 @@ module MQTT
       def publish
         return if @published
 
-        mqtt.publish("#{topic}/$name", name, true, 1)
-        mqtt.publish("#{topic}/$datatype", datatype.to_s, true, 1)
-        mqtt.publish("#{topic}/$format", format, true, 1) if format
-        mqtt.publish("#{topic}/$settable", "true", true, 1) if settable?
-        mqtt.publish("#{topic}/$retained", "false", true, 1) unless retained?
-        mqtt.publish("#{topic}/$unit", unit, true, 1) if unit
-        mqtt.subscribe("#{topic}/set") if settable?
-        mqtt.publish(topic, value.to_s, retained?, 1) if value
+        mqtt.batch_publish do
+          mqtt.publish("#{topic}/$name", name, retain: true, qos: 1)
+          mqtt.publish("#{topic}/$datatype", datatype.to_s, retain: true, qos: 1)
+          mqtt.publish("#{topic}/$format", format, retain: true, qos: 1) if format
+          mqtt.publish("#{topic}/$settable", "true", retain: true, qos: 1) if settable?
+          mqtt.publish("#{topic}/$retained", "false", retain: true, qos: 1) unless retained?
+          mqtt.publish("#{topic}/$unit", unit, retain: true, qos: 1) if unit
+          mqtt.publish(topic, value.to_s, retain: retained?, qos: 1) if value
+          subscribe
+        end
 
         @published = true
       end
 
+      def subscribe
+        mqtt.subscribe("#{topic}/set") if settable?
+      end
+
       def unpublish
         return unless @published
         @published = false
 
+        mqtt.publish("#{topic}/$name", retain: true, qos: 0)
+        mqtt.publish("#{topic}/$datatype", retain: true, qos: 0)
+        mqtt.publish("#{topic}/$format", retain: true, qos: 0) if format
+        mqtt.publish("#{topic}/$settable", retain: true, qos: 0) if settable?
+        mqtt.publish("#{topic}/$retained", retain: true, qos: 0) unless retained?
+        mqtt.publish("#{topic}/$unit", retain: true, qos: 0) if unit
         mqtt.unsubscribe("#{topic}/set") if settable?
+        mqtt.publish(topic, retain: retained?, qos: 0) if value && retained?
       end
     end
   end

data/lib/mqtt/homie/version.rb

@@ -2,6 +2,6 @@
 
 module MQTT
   module Homie
-    VERSION = '1.0.1'
+    VERSION = '1.2.0'
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: homie-mqtt
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-27 00:00:00.000000000 Z
+date: 2021-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mqtt
+  name: mqtt-ccutrer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement