homie-mqtt 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd6f3bb8678e0d56ddc578993ba46f8bafb3361e4d5f7b0d5fbede478e640edc
-  data.tar.gz: 4961a257ee03d29d623c009dad99f54ac44ee6701fa1364d2b83d6ce44a3898d
+  metadata.gz: adb5e19afec9a2e2d3525ea4879992306f2cd56632139bbc4d691ccc1e2b6bbb
+  data.tar.gz: ff164da43b91048841edef8488e654108d0c566dfe4e0b8150a1cff423b36214
 SHA512:
-  metadata.gz: 5aedd7bde7d6cc07a8837802eaeef6f563d4d846b912f737df888a8d2d893bbe2556191f7e2847f2a903527b5c3d7342f62d63562175eac7207dde46867877b1
-  data.tar.gz: dfaa32de5c1126801ceeb164fe919a35c266fec727096539e6e3e794c19d380852c0a910a090222ba5d3396edf7a5a25522d25396453c6734cf5ff33b88ff36d
+  metadata.gz: b4cd79531f71ce7cc077b7f06acd181dd41694494eacab571323fb3930755a10aa57254b1d81dfec3d66ab880b39adc5b21af62ce8c66e84304ca52bf2021fc6
+  data.tar.gz: a11b7bf36fdfb34677d9becdb733ddd4c53cf0ed64f51575b44d257e37b04bd7c07599b0ca6c37b0c7da70466d0b3389373b2d9795327947ba93dd2d14761528

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)
@@ -48,6 +49,15 @@ module 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
         mqtt.batch_publish do
           unless @published

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 %s{string integer float boolean enum color datetime duration}
         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.0'
+    VERSION = '1.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: homie-mqtt
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Cody Cutrer
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-20 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: []