homie-mqtt 1.5.0 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8552d2aca44043208c3b3cd06fff9d5376515103d7de423926713441acecd6e0
-  data.tar.gz: a27b5fe2fe50e2975708c308ed9a0f9b5b7d2469667741fe092210adcda8582a
+  metadata.gz: 20210b0338d6fa60e38cea5fbb830a26ae4c9d3a919ab8e7c1d373893afbc792
+  data.tar.gz: 479bbfe1fad83e2d872b319ab5deb22b394ed3ab846876acce0ae46e71b06435
 SHA512:
-  metadata.gz: b10c773d61781b4fb2e5595056e1b5e41373ec579bcf0a152f0c5dc763c3973ad09914964caaaf9c619b079e6cf15f4dc923122caf214f571741b8b6934a8317
-  data.tar.gz: dd8069070124dea54d81f3fc0095b9cce1d28d77ed655d7162182c0a11cdfecbb93cc40c97ea3778b3ebd35508cf960fdfcdd2594cac87f3621fdf11e64845c0
+  metadata.gz: 5ef7fddffafe4f8dfc4cd44551f1d3c1c867bc10762c706121571e3dc3207bb25170edb7054f4058f01393707c7772999335bfe2e0fc47806533f0f6ff6229c4
+  data.tar.gz: 34a8a0aae900bcdef55a03ad878f5261655cbf45e62758cfb72dc658fd0263f962902fc21db6e083f4bbc486928131b754b43c14cbaaa89773105dabfaaceb00

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/device.rb

@@ -19,8 +19,10 @@ module MQTT
         @nodes = {}
         @published = false
         @out_of_band_topic_proc = block
-        mqtt = MQTT::Client.new(mqtt) if mqtt.is_a?(String)
-        @mqtt = mqtt || MQTT::Client.new
+        # retry forever
+        mqtt = MQTT::Client.new(mqtt, reconnect_limit: nil) if mqtt.is_a?(String)
+        mqtt = MQTT::Client.new(reconnect_limit: nil, **mqtt) if mqtt.is_a?(Hash)
+        @mqtt = mqtt || MQTT::Client.new(reconnect_limit: nil)
         @mqtt.set_will("#{topic}/$state", "lost", retain: true, qos: 1)
 
         @mqtt.on_reconnect do
@@ -69,7 +71,7 @@ module MQTT
         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
@@ -86,8 +88,12 @@ module MQTT
         @nodes.count
       end
 
+      def published?
+        @published
+      end
+
       def publish
-        return if @published
+        return if published?
 
         mqtt.batch_publish do
           mqtt.publish("#{topic}/$homie", VERSION, retain: true, qos: 1)
@@ -141,17 +147,17 @@ module MQTT
         return yield state if state == :init
 
         prior_state = state
-        mqtt.publish("#{topic}/$state", (self.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", (self.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)

data/lib/mqtt/homie/node.rb

@@ -44,7 +44,7 @@ module MQTT
         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
@@ -70,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
@@ -84,7 +88,7 @@ module MQTT
       end
 
       def unpublish
-        return unless @published
+        return unless published?
 
         @published = false
 

data/lib/mqtt/homie/property.rb

@@ -1,28 +1,32 @@
 # frozen_string_literal: true
 
+require "time"
+
 module MQTT
   module Homie
     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
+      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?
-        if datatype == :color && !%w[rgb hsv].include?(format.to_s)
-          raise ArgumentError, "format must be either rgb or hsv for colors"
-        end
         if !value.nil? && !retained
           raise ArgumentError, "an initial value cannot be provided for a non-retained property"
         end
@@ -31,11 +35,12 @@ module MQTT
 
         @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
 
@@ -77,14 +82,14 @@ module MQTT
         return if @value == value
 
         @value = value if retained?
-        publish_value if @published
+        publish_value if published?
       end
 
       def unit=(unit)
         return if unit == @unit
 
         @unit = unit
-        return unless @published
+        return unless published?
 
         device.init do
           mqtt.publish("#{topic}/$unit", unit.to_s, retain: true, qos: 1)
@@ -94,8 +99,24 @@ module MQTT
       def format=(format)
         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
+        return unless published?
 
         device.init do
           mqtt.publish("#{topic}/$format", format.to_s, retain: true, qos: 1)
@@ -114,56 +135,56 @@ module MQTT
       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 /^-?\d+$/.match?(value)
-
-          value = value.to_i
-          return if format && !range.include?(value)
-        when :float
-          return unless /^-?(?:\d+|\d+\.|\.\d+|\d+\.\d+)(?:[eE]-?\d+)?$/.match?(value)
-
-          value = value.to_f
-          return if format && !range.include?(value)
+        when :integer, :float
+          casted_value = nil if format && !range.cover?(casted_value)
         when :enum
-          return unless range.include?(value)
+          casted_value = nil if format && !range.include?(casted_value)
         when :color
-          return unless /^\d{1,3},\d{1,3},\d{1,3}$/.match?(value)
-
-          value = value.split(",").map(&:to_i)
-          case format
-          when "rgb"
-            return if value.max > 255
-          when "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)
@@ -184,7 +205,7 @@ module MQTT
       end
 
       def unpublish
-        return unless @published
+        return unless published?
 
         @published = false
 

data/lib/mqtt/homie/version.rb

@@ -2,6 +2,6 @@
 
 module MQTT
   module Homie
-    VERSION = "1.5.0"
+    VERSION = "1.6.2"
   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.5.0
+  version: 1.6.2
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-08 00:00:00.000000000 Z
+date: 2022-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt-ccutrer
@@ -19,7 +19,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: ruby2_keywords
   requirement: !ruby/object:Gem::Requirement
@@ -121,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
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Library for publishing devices that conform to the Homie spec.