homie-mqtt 1.6.3 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb087a1fa491f77b56c7231be4578549e946f243546544d26eb02b729ff0f1e0
-  data.tar.gz: 21aeb256936a4425c10262bfbb695712708c607358391ff8c7cc886aa9d5cbbf
+  metadata.gz: 580fba09d7d9a5fa0de4f8cf86a6a63b6d9cb1d62871b869b67df1fffcd16bf8
+  data.tar.gz: 1c286151ba1eed536ca0ff415523d9e5c22c6d650e25cf1f4c832cb3423e95f5
 SHA512:
-  metadata.gz: ad9843d1d1d2210050dd0e1149bd77ac83213bab6916e168514f632c809f1609192d3d4091f5bac6f1801441d6ba7c95e129b33f6a9f6e32df310ce8e671d1e8
-  data.tar.gz: 933767440a03109805b509d9486a3b299c94b713652c4910310d02275a97309a764f98372dbbcd9c6d8c4be0ecd77f26a74161897e9861b2eb2dde145e0cc8d2
+  metadata.gz: f69b585e7f81866e37e061a9d217f3e0dfa491d8413ea96e4dde3d542548fe642b75cbab9764d4fb16c88080cd3a5487e41cb89459e5b053e129dd2195560fa0
+  data.tar.gz: 8ac03bfdfcff14982f27725b20dbe19597883aa81831ebcfd53a93d358ce5d353437399fd3939bb8a834a47ebcc879d8473d70368a2e0d88d0ddb9e604d1f19e

data/lib/mqtt/homie/base.rb

@@ -3,7 +3,7 @@
 module MQTT
   module Homie
     class Base
-      REGEX = "[a-z0-9][a-z0-9\-]*"
+      REGEX = "[a-z0-9][a-z0-9-]*"
 
       attr_reader :id, :name
 

data/lib/mqtt/homie/device.rb

@@ -12,13 +12,14 @@ module MQTT
       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)
+      def initialize(id, name, root_topic: nil, mqtt: nil, clear_topics: true, metadata: true, &block)
         super(id, name)
         @root_topic = root_topic || "homie"
         @state = :init
         @nodes = {}
         @published = false
         @out_of_band_topic_proc = block
+        @metadata = metadata
         # 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)
@@ -88,16 +89,26 @@ module MQTT
         @nodes.count
       end
 
+      def empty?
+        @nodes.empty?
+      end
+
       def published?
         @published
       end
 
+      def metadata?
+        @metadata
+      end
+
       def publish
         return if published?
 
         mqtt.batch_publish do
-          mqtt.publish("#{topic}/$homie", VERSION, retain: true, qos: 1)
-          mqtt.publish("#{topic}/$name", name, retain: true, qos: 1)
+          if metadata?
+            mqtt.publish("#{topic}/$homie", VERSION, retain: true, qos: 1)
+            mqtt.publish("#{topic}/$name", name, retain: true, qos: 1)
+          end
           mqtt.publish("#{topic}/$state", @state.to_s, retain: true, qos: 1)
 
           @subscription_thread = Thread.new do
@@ -119,7 +130,7 @@ module MQTT
             end
           end
 
-          mqtt.publish("#{topic}/$nodes", @nodes.keys.join(","), retain: true, qos: 1)
+          mqtt.publish("#{topic}/$nodes", @nodes.keys.join(","), retain: true, qos: 1) if metadata?
           @nodes.each_value(&:publish)
 
           yield if block_given?

data/lib/mqtt/homie/node.rb

@@ -57,6 +57,14 @@ module MQTT
         @properties.each_value(&block)
       end
 
+      def count
+        @properties.count
+      end
+
+      def empty?
+        @properties.empty?
+      end
+
       def mqtt
         device.mqtt
       end
@@ -76,18 +84,21 @@ module MQTT
 
       def publish
         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
+          if device.metadata?
+            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)
           end
-
-          mqtt.publish("#{topic}/$properties", @properties.keys.join(","), retain: true, qos: 1)
           @properties.each_value(&:publish)
         end
       end
 
       def unpublish
+        return unless device.metadata?
         return unless published?
 
         @published = false

data/lib/mqtt/homie/property.rb

@@ -16,6 +16,7 @@ module MQTT
                      retained: true,
                      unit: nil,
                      non_standard_value_check: nil,
+                     optimistic: false,
                      &block)
         raise ArgumentError, "Invalid Homie datatype" unless %i[string
                                                                 integer
@@ -41,6 +42,7 @@ module MQTT
         @value = value
         @published = false
         @non_standard_value_check = non_standard_value_check
+        @optimistic = optimistic
         @block = block
       end
 
@@ -54,6 +56,7 @@ module MQTT
                   else
                     ", retained=false"
                   end
+        result << ", optimistic=true" if optimistic?
         result << ">"
         result.freeze
       end
@@ -78,6 +81,10 @@ module MQTT
         !!@block
       end
 
+      def optimistic?
+        @optimistic
+      end
+
       def value=(value)
         return if @value == value
 
@@ -172,7 +179,8 @@ module MQTT
         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)
+        (@block.arity == 2) ? @block.call(casted_value, self) : @block.call(casted_value)
+        self.value = casted_value if optimistic?
       end
 
       def mqtt
@@ -187,12 +195,14 @@ module MQTT
         return if published?
 
         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
+          if device.metadata?
+            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
+          end
           publish_value(value) unless value.nil?
           subscribe
         end
@@ -209,12 +219,14 @@ module MQTT
 
         @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
+        if device.metadata?
+          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
+        end
         mqtt.unsubscribe("#{topic}/set") if settable?
         mqtt.publish(topic, retain: retained?, qos: 0) if !value.nil? && retained?
       end

data/lib/mqtt/homie/version.rb

@@ -2,6 +2,6 @@
 
 module MQTT
   module Homie
-    VERSION = "1.6.3"
+    VERSION = "1.8.0"
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: homie-mqtt
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.8.0
 platform: ruby
 authors:
 - Cody Cutrer
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-26 00:00:00.000000000 Z
+date: 2025-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt-ccutrer
@@ -44,20 +43,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.5
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,49 +57,6 @@ 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: []
 extensions: []
@@ -132,7 +74,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -147,8 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Library for publishing devices that conform to the Homie spec.
 test_files: []