homie-mqtt 1.2.1 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92d413dfd5ecc9f6b6e5d672a9990cb9673b294439013e971ce338bb894444ef
-  data.tar.gz: 5c67d8163c54926ede876caf75d6aa762a98f4377db5ba700954ba596d00d8ca
+  metadata.gz: 000cc1744d0e9520830ebd44954dd56f68e571803bf82539f3ca47a1d89c6bdf
+  data.tar.gz: 28c8a7530bda1c962c30918c13bdf9cffa71a99f070833959541dfde9806802b
 SHA512:
-  metadata.gz: 1e37e57a63dd2797ae8d598716844105a060abf04dd04b79b23cbe8c880f67a40315b9e07d99feb7e9a5b874d376d4421620b02ab27b192c9105a4122fa011d7
-  data.tar.gz: 5bbb25e06d7001c9e4fb54124e9fcb51b1e0eddd7b6161bfa655cf5c8bd17707cfe6bb8b6e16e82f3503a2581b3f13f0e3674a95b7ad402b7bbf4df6ce46712b
+  metadata.gz: '02591ff555e0ff41b4b5476bef010da8b5ff6e3e5d665c1f22c6a5b02f85e023ad53f243d04748dd4a186c4e212b81071b89925f1a0932dac7fb1098657e1843'
+  data.tar.gz: 873266a8d592ad4bc47b4e2a4639b599709c0a98b22756477f9683b4a7450b54ebf3f1b60380a1462d5176749ea56cdd69367c7e086b74cb8173910bac7dde57

data/lib/mqtt/homie/device.rb

@@ -40,27 +40,30 @@ 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(","), 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(","), retain: true, qos: 1) if @published
         end
+        true
       end
 
       def [](id)
@@ -120,28 +123,33 @@ module MQTT
 
       def init
         if state == :init
-          yield(state)
-          return
+          return yield state
         end
 
         prior_state = state
         mqtt.publish("#{topic}/$state", (state = :init).to_s, retain: true, qos: 1)
-        yield(prior_state)
+        result = nil
+        mqtt.batch_publish do
+          result = yield prior_state
+        end
         mqtt.publish("#{topic}/$state", (state = :ready).to_s, retain: true, qos: 1)
-        nil
+        result
       end
 
-      private
-
       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
+
       def topic_regex
         @topic_regex ||= Regexp.new("^#{Regexp.escape(topic)}/(?<node>#{REGEX})/(?<property>#{REGEX})/set$")
       end

data/lib/mqtt/homie/node.rb

@@ -23,17 +23,18 @@ 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(","), retain: true, qos: 1) if @published
         end
+        true
       end
 
       def [](id)

data/lib/mqtt/homie/property.rb

@@ -6,7 +6,7 @@ module MQTT
       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 %s{string integer float boolean enum color}
+        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)
@@ -18,6 +18,7 @@ module MQTT
         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)
 
@@ -49,8 +50,8 @@ module MQTT
 
       def value=(value)
         if @value != value
-          @value = value
-          mqtt.publish(topic, value.to_s, retain: retained?, qos: 1) if @published
+          @value = value if retained?
+          publish_value if @published
         end
       end
 
@@ -108,6 +109,18 @@ module MQTT
           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
         end
 
         @block.arity == 2 ? @block.call(value, self) : @block.call(value)
@@ -127,7 +140,7 @@ module MQTT
           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
+          publish_value unless value.nil?
           subscribe
         end
 
@@ -149,7 +162,16 @@ module MQTT
         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?
+        mqtt.publish(topic, retain: retained?, qos: 0) if !value.nil? && retained?
+      end
+
+      private
+
+      def publish_value
+        serialized = value
+        serialized = serialized&.iso8601 if %i[datetime duration].include?(datatype)
+
+        mqtt.publish(topic, serialized.to_s, retain: retained?, qos: 1)
       end
     end
   end

data/lib/mqtt/homie/version.rb

@@ -2,6 +2,6 @@
 
 module MQTT
   module Homie
-    VERSION = '1.2.1'
+    VERSION = '1.4.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: homie-mqtt
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.4.1
 platform: ruby
 authors:
 - Cody Cutrer
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt-ccutrer
@@ -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: []