homie-mqtt 1.0.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c0070a3f65a2d335b3ecaa206e3969a024db3218b8eddb91b03434f0953c712
-  data.tar.gz: d12edaebbf8d5da85e2c67b2ca8c64068daff04bd588770086bcb1d0b24892ea
+  metadata.gz: 64cfaf8cbbff82a3059c8fcfa639efc39f006241cd79aaadb6bce200eb82a9cc
+  data.tar.gz: d9045a9c729515c2912aeb11b20c5ecad9885b7e0f4df95263e688d74d72f077
 SHA512:
-  metadata.gz: aaf9bb9ad0d8e5a7c3292570885dd8933325b3127ab1938190e2def744bcb95d95c5f1057f9338f90b3db85d4e8091c0b32a9de835fd20426945f0b1831b5820
-  data.tar.gz: 713b2a20311422b8a8d6e75a4a9ce0c00ae18a556862b38f064f289927c2be364fecfa84450dab1e5120d85e5e2a8d9969c95988a44ab05780db5e3064d547d7
+  metadata.gz: 04ea1126fe4310cc758ddf23fe859f380a0250baf0998a1fab3d695c6f18e6087028dd35de8f619414ec0512d46ac24fb6fb91cae2821729c18b2a91b209455d
+  data.tar.gz: 6200b420bed16a9267cdde8f7192c52d8cd72568dcb72e35247620bd4b71031069a12986b41290329c199bfbf0fc7abdbf25a81d8fdbe1bcce7906b09a883673

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
@@ -28,54 +40,70 @@ module MQTT
         "#{root_topic}/#{id}"
       end
 
-      def node(*args, **kwargs)
+      def node(id, *args, **kwargs)
+        raise ArgumentError, "Node '#{id}' already exists" if @nodes.key?(id)
+
         init do |prior_state|
-          node = Node.new(self, *args, **kwargs)
-          raise ArgumentError, "Node '#{node.id}' already exists" if @nodes.key?(node.id)
-          @nodes[node.id] = node
+          node = Node.new(self, id, *args, **kwargs)
+
+          @nodes[id] = node
           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
+          node
         end
-        self
       end
 
       def remove_node(id)
-        return unless (node = nodes[id])
+        return false 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
+        true
+      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
+
+              unless property&.settable?
+                @block&.call(topic, packet.payload)
+                next
+              end
 
-            property.set(value)
+              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,19 +116,36 @@ module MQTT
 
       def join
         @subscription_thread&.join
+      rescue => e
+        e.set_backtrace(e.backtrace + ["<from Homie MQTT thread>"] + caller)
+        raise e
       end
 
       def init
         if state == :init
-          yield(state)
-          return
+          return yield state
         end
 
         prior_state = state
-        mqtt.publish("#{topic}/$state", (state = :init).to_s, true, 1)
-        yield(prior_state)
-        mqtt.publish("#{topic}/$state", (state = :ready).to_s, true, 1)
-        nil
+        mqtt.publish("#{topic}/$state", (state = :init).to_s, retain: true, qos: 1)
+        result = nil
+        mqtt.batch_publish do
+          result = yield prior_state
+        end
+        mqtt.publish("#{topic}/$state", (state = :ready).to_s, retain: true, qos: 1)
+        result
+      end
+
+      def clear_topics
+        raise ArgumentError, "cannot clear topics once published" if @published
+
+        @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
+        true
       end
 
       private

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)
@@ -23,39 +23,63 @@ module MQTT
           raise ArgumentError, "Property '#{property.id}' already exists on '#{id}'" if @properties.key?(property.id)
           @properties[property.id] = property
           property.publish if prior_state == :ready
+          property
         end
-        self
       end
 
       def remove_property(id)
-        return unless (property = properties[id])
+        return false 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
+        true
+      end
+
+      def [](id)
+        @properties[id]
+      end
+
+      def each(&block)
+        @properties.each_value(&block)
       end
 
       def mqtt
         device.mqtt
       end
 
+      # takes a hash with property names as keys, and values as values
+      def batch_update(hash)
+        mqtt.batch_publish do
+          hash.each do |(k, v)|
+            self[k].value = v
+          end
+        end
+      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,20 @@ 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)
+        raise ArgumentError, "an initial value cannot be provided for a non-retained property" if !value.nil? && !retained
+
         super(id, name)
+
         @node = node
         @datatype = datatype
         @format = format
@@ -39,8 +50,8 @@ module MQTT
 
       def value=(value)
         if @value != value
-          @value = value
-          mqtt.publish(topic, value.to_s, retained?, 1) if @published
+          @value = value if retained?
+          mqtt.publish(topic, value.to_s, retain: retained?, qos: 1) if @published
         end
       end
 
@@ -49,7 +60,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 +71,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 +121,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) unless value.nil?
+          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.nil? && retained?
       end
     end
   end

data/lib/mqtt/homie/version.rb

@@ -2,6 +2,6 @@
 
 module MQTT
   module Homie
-    VERSION = '1.0.1'
+    VERSION = '1.3.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.3.0
 platform: ruby
 authors:
 - Cody Cutrer
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-27 00:00:00.000000000 Z
+date: 2021-07-16 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
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-description:
+description: 
 email: cody@cutrer.com'
 executables: []
 extensions: []
@@ -68,7 +68,7 @@ homepage: https://github.com/ccutrer/homie-mqtt
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +83,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Library for publishing devices that conform to the Homie spec.
 test_files: []