homie-mqtt 1.4.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df54d2ae01eb1d1972e4d0f5fb40d05286969feff5ad83547476be6d11db05e2
-  data.tar.gz: 719a2c270af518fd2ee7d7da4941a211da1f4af90d1e5f0daae2a0c50fd1616f
+  metadata.gz: ac2d4aeded4ffe715b8de38705b648c3aa2c80d378f57435f7e5bd854f8eac22
+  data.tar.gz: d4503b114004ebed3cd4987ecc1466ff0c3e6637d474477fb8f9e43eaf4e91b0
 SHA512:
-  metadata.gz: 19fdcadf299dbe73d3bafca37e32d65b27edb006569ae80f27ecae036e6da17370c9e1b0af405f0517fd6649f5cc0c5bcb75912f00ec2560971d17385502408f
-  data.tar.gz: b92d4b4cb05cc96b1a4b0d7e0254476f05db8be89f48d969277bbb09ae56cfcc7e597f5f9ccede42f5279d034bda7a85fe36ad1d652155cf3e38aac961c02667
+  metadata.gz: 02f74510916e8fb1d0ef8d40b3aea41320e9e12973175fb41b004598ab84038f16df3b171bf0c88e22e8fa894096871de17add5ca5aa37194bbda27e1cadecae
+  data.tar.gz: ffe27a55cf9e3e561a9469b17931b989e589a319b3e9e1aa976641640510bcbabe7f71988688922bd7ce77077f79f50ccf85f742a08d34bd73667bfc93eca5fc

data/lib/homie-mqtt.rb

@@ -1,16 +1,3 @@
 # frozen_string_literal: true
 
-module MQTT
-  module Homie
-    class << self
-      def escape_id(id)
-        id.downcase.gsub(/[^a-z0-9\-]/, '-').sub(/^[^a-z0-9]+/, '')
-      end
-    end
-  end
-end
-
-require 'mqtt/homie/base'
-require 'mqtt/homie/device'
-require 'mqtt/homie/node'
-require 'mqtt/homie/property'
+require "mqtt/homie"

data/lib/mqtt/homie/base.rb

@@ -9,18 +9,19 @@ module MQTT
 
       def initialize(id, name)
         raise ArgumentError, "Invalid Homie ID '#{id}'" unless id.is_a?(String) && id =~ Regexp.new("^#{REGEX}$")
+
         @id = id
         @name = name
       end
 
       def name=(value)
-        if name != value
-          name = value
-          if @published
-            device.init do
-              mqtt.publish("#{topic}/$name", name, retain: true, qos: 1)
-            end
-          end
+        return if name == value
+
+        name = value
+        return unless @published
+
+        device.init do
+          mqtt.publish("#{topic}/$name", name, retain: true, qos: 1)
         end
       end
     end

data/lib/mqtt/homie/device.rb

@@ -1,28 +1,31 @@
 # frozen_string_literal: true
 
-require 'mqtt'
+require "mqtt"
+require "ruby2_keywords"
 
 module MQTT
   module Homie
     class Device < Base
+      # the Homie spec version
+      VERSION = "4.0.0"
+
       attr_reader :root_topic, :state, :mqtt
+      attr_accessor :logger, :out_of_band_topic_proc
 
       def initialize(id, name, root_topic: nil, mqtt: nil, clear_topics: true, &block)
         super(id, name)
-        @root_topic = @root_topic || "homie"
+        @root_topic = root_topic || "homie"
         @state = :init
         @nodes = {}
         @published = false
-        @block = block
+        @out_of_band_topic_proc = block
         mqtt = MQTT::Client.new(mqtt) if mqtt.is_a?(String)
         @mqtt = mqtt || MQTT::Client.new
         @mqtt.set_will("#{topic}/$state", "lost", retain: true, qos: 1)
 
         @mqtt.on_reconnect do
           each do |node|
-            node.each do |property|
-              property.subscribe
-            end
+            node.each(&:subscribe)
           end
           mqtt.publish("#{topic}/$state", :init, retain: true, qos: 1)
           mqtt.publish("#{topic}/$state", state, retain: true, qos: 1) unless state == :init
@@ -32,6 +35,10 @@ module MQTT
         self.clear_topics if clear_topics
       end
 
+      def inspect
+        "#<MQTT::Homie::Device #{topic} name=#{name.inspect}, $state=#{state.inspect}>"
+      end
+
       def device
         self
       end
@@ -40,11 +47,11 @@ module MQTT
         "#{root_topic}/#{id}"
       end
 
-      def node(id, *args, **kwargs)
+      ruby2_keywords def node(id, *args)
         raise ArgumentError, "Node '#{id}' already exists" if @nodes.key?(id)
 
         init do |prior_state|
-          node = Node.new(self, id, *args, **kwargs)
+          node = Node.new(self, id, *args)
 
           @nodes[id] = node
           yield node if block_given?
@@ -58,10 +65,11 @@ module MQTT
 
       def remove_node(id)
         return false unless (node = @nodes[id])
+
         init do
           node.unpublish
           @nodes.delete(id)
-          mqtt.publish("#{topic}/$nodes", @nodes.keys.join(","), retain: true, qos: 1) if @published
+          mqtt.publish("#{topic}/$nodes", @nodes.keys.join(","), retain: true, qos: 1) if published?
         end
         true
       end
@@ -74,11 +82,19 @@ module MQTT
         @nodes.each_value(&block)
       end
 
+      def count
+        @nodes.count
+      end
+
+      def published?
+        @published
+      end
+
       def publish
-        return if @published
+        return if published?
 
         mqtt.batch_publish do
-          mqtt.publish("#{topic}/$homie", "4.0.0", retain: true, qos: 1)
+          mqtt.publish("#{topic}/$homie", VERSION, retain: true, qos: 1)
           mqtt.publish("#{topic}/$name", name, retain: true, qos: 1)
           mqtt.publish("#{topic}/$state", @state.to_s, retain: true, qos: 1)
 
@@ -87,12 +103,13 @@ module MQTT
             Thread.current.report_on_exception = false
 
             mqtt.get do |packet|
+              logger&.debug("received packet at #{packet.topic} with payload #{packet.payload.inspect}")
               match = packet.topic.match(topic_regex)
               node = @nodes[match[:node]] if match
               property = node[match[:property]] if node
 
               unless property&.settable?
-                @block&.call(packet.topic, packet.payload)
+                @out_of_band_topic_proc&.call(packet.topic, packet.payload)
                 next
               end
 
@@ -102,6 +119,9 @@ module MQTT
 
           mqtt.publish("#{topic}/$nodes", @nodes.keys.join(","), retain: true, qos: 1)
           @nodes.each_value(&:publish)
+
+          yield if block_given?
+
           mqtt.publish("#{topic}/$state", (@state = :ready).to_s, retain: true, qos: 1)
         end
 
@@ -122,26 +142,24 @@ module MQTT
       end
 
       def init
-        if state == :init
-          return yield state
-        end
+        return yield state if state == :init
 
         prior_state = state
-        mqtt.publish("#{topic}/$state", (state = :init).to_s, retain: true, qos: 1)
+        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)
+        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
+        raise ArgumentError, "cannot clear topics once published" if published?
 
         @mqtt.subscribe("#{topic}/#")
         @mqtt.unsubscribe("#{topic}/#", wait_for_ack: true)
-        while !@mqtt.queue_empty?
+        until @mqtt.queue_empty?
           packet = @mqtt.get
           @mqtt.publish(packet.topic, retain: true, qos: 0)
         end

data/lib/mqtt/homie/node.rb

@@ -13,14 +13,25 @@ module MQTT
         @published = false
       end
 
+      def inspect
+        "#<MQTT::Homie::Node #{topic} name=#{full_name.inspect}, type=#{type.inspect}>"
+      end
+
+      def full_name
+        return name if device.count == 1
+
+        "#{device.name} #{name}"
+      end
+
       def topic
         "#{device.topic}/#{id}"
       end
 
-      def property(*args, **kwargs, &block)
+      ruby2_keywords def property(*args, &block)
         device.init do |prior_state|
-          property = Property.new(self, *args, **kwargs, &block)
+          property = Property.new(self, *args, &block)
           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
@@ -29,10 +40,11 @@ module MQTT
 
       def remove_property(id)
         return false unless (property = @properties[id])
+
         init do
           property.unpublish
           @properties.delete(id)
-          mqtt.publish("#{topic}/$properties", @properties.keys.join(","), retain: true, qos: 1) if @published
+          mqtt.publish("#{topic}/$properties", @properties.keys.join(","), retain: true, qos: 1) if published?
         end
         true
       end
@@ -58,9 +70,13 @@ module MQTT
         end
       end
 
+      def published?
+        @published
+      end
+
       def publish
         mqtt.batch_publish do
-          unless @published
+          unless published?
             mqtt.publish("#{topic}/$name", name, retain: true, qos: 1)
             mqtt.publish("#{topic}/$type", @type.to_s, retain: true, qos: 1)
             @published = true
@@ -72,7 +88,8 @@ module MQTT
       end
 
       def unpublish
-        return unless @published
+        return unless published?
+
         @published = false
 
         mqtt.publish("#{topic}/$name", retain: true, qos: 0)

data/lib/mqtt/homie/property.rb

@@ -5,33 +5,61 @@ module MQTT
     class Property < Base
       attr_reader :node, :datatype, :format, :unit, :value
 
-      def initialize(node, id, name, datatype, value = nil, format: nil, retained: true, unit: nil, &block)
-        raise ArgumentError, "Invalid Homie datatype" unless %i[string integer float boolean enum color datetime duration].include?(datatype)
+      def initialize(node,
+                     id,
+                     name,
+                     datatype,
+                     value = nil,
+                     format: nil,
+                     retained: true,
+                     unit: nil,
+                     non_standard_value_check: nil,
+                     &block)
+        raise ArgumentError, "Invalid Homie datatype" unless %i[string
+                                                                integer
+                                                                float
+                                                                boolean
+                                                                enum
+                                                                color
+                                                                datetime
+                                                                duration].include?(datatype)
         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
+        if !value.nil? && !retained
+          raise ArgumentError, "an initial value cannot be provided for a non-retained property"
+        end
 
         super(id, name)
 
         @node = node
         @datatype = datatype
-        @format = format
+        self.format = format
         @retained = retained
         @unit = unit
         @value = value
         @published = false
+        @non_standard_value_check = non_standard_value_check
         @block = block
       end
 
+      def inspect
+        result = +"#<MQTT::Homie::Property #{topic} name=#{full_name.inspect}, datatype=#{datatype.inspect}"
+        result << ", format=#{format.inspect}" if format
+        result << ", unit=#{unit.inspect}" if unit
+        result << ", settable=true" if settable?
+        result << if retained?
+                    ", value=#{value.inspect}"
+                  else
+                    ", retained=false"
+                  end
+        result << ">"
+        result.freeze
+      end
+
+      def full_name
+        "#{node.full_name} #{name}"
+      end
+
       def device
         node.device
       end
@@ -49,89 +77,110 @@ module MQTT
       end
 
       def value=(value)
-        if @value != value
-          @value = value if retained?
-          publish_value if @published
-        end
+        return if @value == value
+
+        @value = value if retained?
+        publish_value if published?
       end
 
       def unit=(unit)
-        if unit != @unit
-          @unit = unit
-          if @published
-            device.init do
-              mqtt.publish("#{topic}/$unit", unit.to_s, retain: true, qos: 1)
-            end
-          end
+        return if unit == @unit
+
+        @unit = unit
+        return unless published?
+
+        device.init do
+          mqtt.publish("#{topic}/$unit", unit.to_s, retain: true, qos: 1)
         end
       end
 
       def format=(format)
-        if format != @format
-          @format = format
-          if @published
-            device.init do
-              mqtt.publish("#{topic}/$format", format.to_s, retain: true, qos: 1)
-            end
-          end
+        return if format == @format
+
+        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.last.is_a?(Float) && format.exclude_end?
+
+          last = format.end
+          last -= 1 if format.exclude_end?
+
+          format = "#{format.begin}:#{last}"
+        end
+        raise ArgumentError, "format must be nil or a string" unless format.nil? || format.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?
+        if datatype == :color && !%w[rgb hsv].include?(format.to_s)
+          raise ArgumentError, "format must be either rgb or hsv for colors"
+        end
+
+        @format = format
+        return unless published?
+
+        device.init do
+          mqtt.publish("#{topic}/$format", format.to_s, retain: true, qos: 1)
         end
       end
 
       def range
+        return nil unless format
+
         case datatype
-        when :enum; format.split(',')
-        when :integer; Range.new(*format.split(':').map(&:to_i))
-        when :float; Range.new(*format.split(':').map(&:to_f))
+        when :enum then format.split(",")
+        when :integer then Range.new(*format.split(":").map(&:to_i))
+        when :float then Range.new(*format.split(":").map(&:to_f))
         else; raise MethodNotImplemented
         end
       end
 
       def set(value)
+        casted_value = case datatype
+                       when :boolean
+                         %w[true false].include?(value) ? value == "true" : nil
+                       when :integer
+                         /^-?\d+$/.match?(value) && value.to_i
+                       when :float
+                         /^-?(?:\d+|\d+\.|\.\d+|\d+\.\d+)(?:[eE]-?\d+)?$/.match?(value) && value.to_f
+                       when :enum
+                         value
+                       when :color
+                         /^\d{1,3},\d{1,3},\d{1,3}$/.match?(value) && value = value.split(",").map(&:to_i)
+                       when :datetime
+                         begin
+                           value = Time.parse(value)
+                         rescue ArgumentError
+                           nil
+                         end
+                       when :duration
+                         begin
+                           value = ActiveSupport::Duration.parse(value)
+                         rescue ActiveSupport::Duration::ISO8601Parser::ParsingError
+                           nil
+                         end
+                       end
         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 :integer, :float, :enum
+          casted_value = nil if format && !range.include?(casted_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
-        when :datetime
-          begin
-            value = Time.parse(value)
-          rescue ArgumentError
-            return
-          end
-        when :duration
-          begin
-            value = ActiveSupport::Duration.parse(value)
-          rescue ActiveSupport::Duration::ISO8601Parser::ParsingError
-            return
-          end
+          casted_value = nil if (format == "rgb" && value.max > 255) ||
+                                (format == "hsb" && (value.first > 360 || value[1..2].max > 100))
         end
 
-        @block.arity == 2 ? @block.call(value, self) : @block.call(value)
+        casted_value = @non_standard_value_check&.call(value) if casted_value.nil?
+        return if casted_value.nil?
+
+        @block.arity == 2 ? @block.call(casted_value, self) : @block.call(casted_value)
       end
 
       def mqtt
         node.mqtt
       end
 
+      def published?
+        @published
+      end
+
       def publish
-        return if @published
+        return if published?
 
         mqtt.batch_publish do
           mqtt.publish("#{topic}/$name", name, retain: true, qos: 1)
@@ -152,7 +201,8 @@ module MQTT
       end
 
       def unpublish
-        return unless @published
+        return unless published?
+
         @published = false
 
         mqtt.publish("#{topic}/$name", retain: true, qos: 0)
@@ -170,8 +220,10 @@ module MQTT
       def publish_value
         serialized = value
         serialized = serialized&.iso8601 if %i[datetime duration].include?(datatype)
+        serialized = serialized.to_s
 
-        mqtt.publish(topic, serialized.to_s, retain: retained?, qos: 1)
+        node.device.logger&.debug("publishing #{serialized.inspect} to #{topic}")
+        mqtt.publish(topic, serialized, retain: retained?, qos: 1)
       end
     end
   end

data/lib/mqtt/homie/version.rb

@@ -2,6 +2,6 @@
 
 module MQTT
   module Homie
-    VERSION = '1.4.2'
+    VERSION = "1.6.0"
   end
 end

data/lib/mqtt/homie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module MQTT
+  module Homie
+    class << self
+      def escape_id(id)
+        id.downcase.gsub(/[^a-z0-9\-]/, "-").sub(/^[^a-z0-9]+/, "")
+      end
+    end
+  end
+end
+
+require "mqtt/homie/base"
+require "mqtt/homie/device"
+require "mqtt/homie/node"
+require "mqtt/homie/property"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: homie-mqtt
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-26 00:00:00.000000000 Z
+date: 2021-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt-ccutrer
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: ruby2_keywords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +72,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: 
 email: cody@cutrer.com'
 executables: []
@@ -59,6 +121,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/homie-mqtt.rb
+- lib/mqtt/homie.rb
 - lib/mqtt/homie/base.rb
 - lib/mqtt/homie/device.rb
 - lib/mqtt/homie/node.rb
@@ -67,7 +130,8 @@ files:
 homepage: https://github.com/ccutrer/homie-mqtt
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -76,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="