homie-mqtt 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4042205ec4dcc333527273ea2b17ca0864fdc5e39923ab28e3f8244be48670d1
+  data.tar.gz: 606e1ecbd6af409a675f5736397044180d89fb31c297fb131294fb303f7a84aa
+SHA512:
+  metadata.gz: f06a1de02ebad8ac94ccb93cbae7be71282a9f01adc90a18af1b2cbc364ec39460ed54d663eba9ecce1d05dea08367682acccbc30eff4e9f199855770bc30984
+  data.tar.gz: 9cdb336a778df3d78740cad7643deeee7cc4a412d2737d895048294f1f3e0ec37c728828e509a143a1d27c331c61f3aa26e826342f544dcebca36b05c9ac9e67

data/lib/homie-mqtt.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'

data/lib/mqtt/homie/base.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MQTT
+  module Homie
+    class Base
+      REGEX = "[a-z0-9][a-z0-9\-]*"
+
+      attr_reader :id, :name
+
+      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, true, 1)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mqtt/homie/device.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'mqtt'
+
+module MQTT
+  module Homie
+    class Device < Base
+      attr_reader :root_topic, :state, :nodes, :mqtt
+
+      def initialize(id, name, root_topic: nil, mqtt: nil, &block)
+        super(id, name)
+        @root_topic = @root_topic || "homie"
+        @state = :init
+        @nodes = {}
+        @published = false
+        @block = block
+        mqtt = MQTT::Client.new(mqtt) if mqtt.is_a?(String)
+        @mqtt = mqtt || MQTT::Client.new
+        @mqtt.set_will("#{topic}/$state", "lost", true)
+        @mqtt.connect
+      end
+
+      def device
+        self
+      end
+
+      def topic
+        "#{root_topic}/#{id}"
+      end
+
+      def node(*args, **kwargs)
+        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
+          yield node if block_given?
+          if prior_state == :ready
+            node.publish
+            mqtt.publish("#{topic}/$nodes", nodes.keys.join(","), true, 1)
+          end
+        end
+        self
+      end
+
+      def remove_node(id)
+        return unless (node = nodes[id])
+        init do
+          node.unpublish
+          @nodes.delete(id)
+          mqtt.publish("#{topic}/$nodes", nodes.keys.join(","), true, 1) if @published
+        end
+      end
+
+      def publish
+        return if @published
+
+        mqtt.publish("#{topic}/$homie", "4.0.0", true, 1)
+        mqtt.publish("#{topic}/$name", name, true, 1)
+        mqtt.publish("#{topic}/$state", @state.to_s, true, 1)
+
+        @subscription_thread = Thread.new do
+          mqtt.get do |topic, value|
+            match = topic.match(topic_regex)
+            node = nodes[match[:node]] if match
+            property = node.properties[match[:property]] if node
+
+            unless property&.settable?
+              @block&.call(topic, value)
+              next
+            end
+
+            property.set(value)
+          end
+        end
+ 
+        mqtt.publish("#{topic}/$nodes", nodes.keys.join(","), true, 1)
+        nodes.each_value(&:publish)
+        mqtt.publish("#{topic}/$state", (@state = :ready).to_s, true, 1)
+
+        @published = true
+      end
+
+      def disconnect
+        @published = false
+        mqtt.disconnect
+        @subscription_thread&.kill
+      end
+
+      def join
+        @subscription_thread&.join
+      end
+
+      def init
+        if state == :init
+          yield(state)
+          return
+        end
+
+        prior_state = state
+        mqtt.publish("#{topic}/$state", (state = :init).to_s, true, 1)
+        yield(prior_state)
+        mqtt.publish("#{topic}/$state", (state = :ready).to_s, true, 1)
+        nil
+      end
+
+      private
+
+      def topic_regex
+        @topic_regex ||= Regexp.new("^#{Regexp.escape(topic)}/(?<node>#{REGEX})/(?<property>#{REGEX})/set$")
+      end
+    end
+  end
+end

data/lib/mqtt/homie/node.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module MQTT
+  module Homie
+    class Node < Base
+      attr_reader :device, :type, :properties
+
+      def initialize(device, id, name, type)
+        super(id, name)
+        @device = device
+        @type = type
+        @properties = {}
+        @published = false
+      end
+
+      def topic
+        "#{device.topic}/#{id}"
+      end
+
+      def property(*args, **kwargs, &block)
+        device.init do |prior_state|
+          property = Property.new(self, *args, **kwargs, &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
+        end
+        self
+      end
+
+      def remove_property(id)
+        return unless (property = properties[id])
+        init do
+          property.unpublish
+          @properties.delete(id)
+          mqtt.publish("#{topic}/$properties", properties.keys.join(","), true, 1) if @published
+        end
+      end
+
+      def mqtt
+        device.mqtt
+      end
+
+      def publish
+        unless @published
+          mqtt.publish("#{topic}/$name", name, true, 1)
+          mqtt.publish("#{topic}/$type", @type.to_s, true, 1)
+          @published = true
+        end
+ 
+        mqtt.publish("#{topic}/$properties", properties.keys.join(","), true, 1)
+        properties.each_value(&:publish)
+      end
+
+      def unpublish
+        return unless @published
+        @published = false
+
+        properties.each_value(&:unpublish)
+      end
+    end
+  end
+end

data/lib/mqtt/homie/property.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+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 %s{string integer float boolean enum color}
+        raise ArgumentError, "retained must be boolean" unless [true, false].include?(retained)
+        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)
+        super(id, name)
+        @node = node
+        @datatype = datatype
+        @format = format
+        @retained = retained
+        @unit = unit
+        @value = value
+        @published = false
+        @block = block
+      end
+
+      def device
+        node.device
+      end
+
+      def topic
+        "#{node.topic}/#{id}"
+      end
+
+      def retained?
+        @retained
+      end
+
+      def settable?
+        !!@block
+      end
+
+      def value=(value)
+        if @value != value
+          @value = value
+          mqtt.publish(topic, value.to_s, retained?, 1) if @published
+        end
+      end
+
+      def unit=(unit)
+        if unit != @unit
+          @unit = unit
+          if @published
+            device.init do
+              mqtt.publish("#{topic}/$unit", unit.to_s, true, 1)
+            end
+          end
+        end
+      end
+
+      def format=(format)
+        if format != @format
+          @format = format
+          if @published
+            device.init do
+              mqtt.publish("#{topic}/$format", format.to_s, true, 1)
+            end
+          end
+        end
+      end
+
+      def set(value)
+        @block.call(self, value)
+      end
+
+      def mqtt
+        node.mqtt
+      end
+
+      def publish
+        return if @published
+
+        mqtt.publish("#{topic}/$name", name, true, 1)
+        mqtt.publish("#{topic}/$datatype", datatype.to_s, true, 1)
+        mqtt.publish("#{topic}/$format", format, true, 1) if format
+        mqtt.publish("#{topic}/$settable", "false", true, 1) unless settable?
+        mqtt.publish("#{topic}/$retained", "false", true, 1) unless retained?
+        mqtt.publish("#{topic}/$unit", unit, true, 1) if unit
+        mqtt.subscribe("#{topic}/set") if settable?
+        mqtt.publish(topic, value.to_s, retained?, 1) if value
+
+        @published = true
+      end
+
+      def unpublish
+        return unless @published
+        @published = false
+
+        mqtt.unsubscribe("#{topic}/set") if settable?
+      end
+    end
+  end
+end

data/lib/mqtt/homie/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module MQTT
+  module Homie
+    VERSION = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: homie-mqtt
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cody Cutrer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description:
+email: cody@cutrer.com'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/homie-mqtt.rb
+- lib/mqtt/homie/base.rb
+- lib/mqtt/homie/device.rb
+- lib/mqtt/homie/node.rb
+- lib/mqtt/homie/property.rb
+- lib/mqtt/homie/version.rb
+homepage: https://github.com/ccutrer/homie-mqtt
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Library for publishing devices that conform to the Homie spec.
+test_files: []