mqtt-homie 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e92a85d38e5d824f9e40a7afe8ec0bbe51f4a7a483d01fa66ee7765812b5939
-  data.tar.gz: 56356ede9f137963ff41f26a7cc046e0223c647cec0da5703a57da165f4337ac
+  metadata.gz: ccd07988b5eafc7e3387a4a545d986dcea8f1d1355d9b6dd48bf4de2231eda61
+  data.tar.gz: 3889c445feaee69b229c8fe8c08d4c619cc0a83eb389f150aba2430c406bb39b
 SHA512:
-  metadata.gz: d019acaf6ec7b635bfc50eb53be9d185b40a80926f74b36dbfbd8770ed2325d480cf27e05bf6eaeb5f37007c97ad60d4b5385e27aaba4657074409b9fd21e7ad
-  data.tar.gz: cb4c85f3c03ea59b28a7f9ecda820a7d03a3f6f1e77cc8e2abde98daabcd21f0dea0bbdda3c9d76939c03b5e4fd80546762928a49de2e586465f62576670b69b
+  metadata.gz: 2ed023aa563488d443537cb4ec9fd1656c8b91218bee305883489cb54ed380567c164e7731f3a1a4e7795c0dcb6e1aea6b0cb0b5f5926e8db90d23f47de60aa6
+  data.tar.gz: f5bb67c340d10e4413a68e4517383cbbad57b84f410adcd0b1e9f9d1b5be6000da0b73c1561d7e2ebe0fe820724dd88f499dc2739e28c39a5a52fd94fd6fde7f

data/.gitignore

@@ -6,6 +6,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
+/Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -1,68 +1,68 @@
-# MQTT::Homie
-
-A ruby interface for creating a device conforming to the MQTT [Homie] convention.
-This gem builds upon the [ruby-mqtt] ruby gem.
-
-The [Homie] convention defines a standardized way of how IoT devices and services announce themselves and their data to a MQTT broker.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'mqtt-homie'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install mqtt-homie
-
-## Quick Start
-
-~~~ ruby
-require 'rubygems'
-require 'mqtt/homie'
-
-# Set up a device, with a node and properties
-device = MQTT::Homie.device_builder(id: 'device', name: 'Device'
-        localip: '192.168.1.1',
-        mac: '80:1f:02:cc:15:dd'
-      ).node(id: "gate", name: "Front gate", type: "Gate")
-        .property(id: "state", name: "Gate state", enum: [:open, :closed, :opening, :closing], value: :closed)
-        .property(id: "position", name: "Gate position", datatype: :integer, unit: "%", value: 0)
-        .property(id: "command", name: "Send gate command", settable: true, enum: [:open, :close]).build
-
-# Create a client and connect to a MQTT broker
-client = MQTT::Homie::Client.new(device: device, host: 'localhost')
-client.connect
-
-# access nodes and properties of the device
-node = device.node('gate')
-state = node.property('state')
-state.value = :open  # publishes new state to MQTT
-
-# listen for changes to properties via the Observer interface
-node.property('command').add_observer(self)
-~~~
-
-## Overview
-
-TODO
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Mqtt::Homie project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mqtt-homie/blob/master/CODE_OF_CONDUCT.md).
-
-
-
-[Homie]: https://homieiot.github.io/
-[MQTT]:  http://www.mqtt.org/
+[![Build Status](https://travis-ci.com/sobakasu/mqtt-homie.svg?branch=develop)](https://travis-ci.com/sobakasu/mqtt-homie)
+
+# MQTT::Homie
+
+A ruby interface for creating a device conforming to the MQTT [Homie] convention.
+This gem builds upon the [ruby-mqtt] ruby gem.
+
+The [Homie] convention defines a standardized way of how IoT devices and services announce themselves and their data to a MQTT broker.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mqtt-homie'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mqtt-homie
+
+## Quick Start
+
+~~~ ruby
+require 'rubygems'
+require 'mqtt/homie'
+
+# Set up a device, with a node and properties
+device = MQTT::Homie.device_builder(id: 'device', name: 'Device')
+  .node(id: "gate", name: "Front gate", type: "Gate")
+  .property(id: "state", name: "Gate state", enum: [:open, :closed, :opening, :closing], value: :closed)
+  .property(id: "position", name: "Gate position", datatype: :integer, unit: "%", value: 0)
+  .property(id: "command", name: "Send gate command", settable: true, enum: [:open, :close]).build
+
+# Create a client and connect to a MQTT broker
+client = MQTT::Homie::Client.new(device: device, host: 'localhost')
+client.connect
+
+# access nodes and properties of the device
+node = device.node('gate')
+state = node.property('state')
+state.value = :open  # publishes new state to MQTT
+
+# listen for changes to properties via the Observer interface
+node.property('command').add_observer(self)
+~~~
+
+## Overview
+
+TODO
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mqtt::Homie project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mqtt-homie/blob/master/CODE_OF_CONDUCT.md).
+
+
+
+[Homie]: https://homieiot.github.io/
+[MQTT]:  http://www.mqtt.org/
 [ruby-mqtt]: https://github.com/njh/ruby-mqtt

data/lib/mqtt/homie/client.rb

@@ -1,162 +1,173 @@
-module MQTT
-  module Homie
-    # https://homieiot.github.io/specification/
-
-    class Client
-      DEFAULT_ROOT_TOPIC = "homie"
-
-      attr_accessor :host, :root_topic
-      attr_reader :device
-
-      def initialize(options = {})
-        @device = options[:device]
-        @host = options[:host]
-        @root_topic = options[:root_topic] || DEFAULT_ROOT_TOPIC
-        raise "device required" unless @device
-
-        # observe all node properties so we can publish values when they change
-        @device.nodes.each do |node|
-          node.properties.each do |property|
-            property.add_observer(self)
-          end
-        end
-      end
-
-      def connect
-        return if connected?
-
-        @device.state = :init
-        @client = create_mqtt_client
-        @client.connect
-
-        publish(@device, topic)
-        publish_statistics
-
-        @threads = []
-
-        # run a thread to publish statistics
-        @threads << Thread.new { run_statistics }
-
-        # run a thread to listen for settings
-        @threads << Thread.new { run_set_listener }
-
-        @device.state = :ready
-        publish_state
-      end
-
-      def disconnect
-        @device.state = :disconnected
-        publish_state
-
-        @client.disconnect
-        @client = nil
-
-        @threads.each { |i| i[:done] = true }
-        @threads = []
-      end
-
-      def topic
-        @root_topic + "/" + @device.id
-      end
-
-      def connected?
-        @device.state == :ready
-      end
-
-      def update(time, object)
-        if object.kind_of?(MQTT::Homie::Property)
-          publish_property_value(object)
-        end
-      end
-
-      private
-
-      def create_mqtt_client
-        client = ::MQTT::Client.new
-        client.host = @host
-        client.will_topic = topic + "/$state"
-        client.will_payload = :lost
-        client.will_retain = true
-        client
-      end
-
-      def run_set_listener
-        # subscribe to 'set' topics for all settable properties
-        @device.nodes.each do |node|
-          node.properties.each do |property|
-            if property.settable?
-              set_topic = topic + "/" + node.topic + "/" + property.topic + "/set"
-              debug("subscribe #{set_topic}")
-              @client.subscribe(set_topic) if @client
-            end
-          end
-        end
-
-        if @client
-          @client.get do |topic, message|
-            debug("received message: #{topic}, message: #{message}")
-            property = find_property_by_set_topic(topic)
-            property.value = message if property
-            break if Thread.current[:done]
-          end
-        end
-        debug("set listener thread exiting")
-      end
-
-      def run_statistics
-        while !Thread.current[:done]
-          publish_statistics
-          sleep @device.interval
-        end
-        debug("statistics thread exiting")
-      end
-
-      def find_property_by_set_topic(set_topic)
-        @device.nodes.each do |node|
-          node.properties.each do |property|
-            return property if set_topic == topic + "/" + node.topic + "/" + property.topic + "/set"
-          end
-        end
-        nil
-      end
-
-      def publish_statistics
-        publish(@device.statistics, topic + "/$stats")
-      end
-
-      def publish_property_value(property)
-        node = @device.nodes.find { |i| i.properties.include?(property) }
-        data = {
-          property.id => property.value,
-        }
-        publish(data, topic + "/" + node.topic)
-      end
-
-      def publish_state
-        data = {
-          "$state" => @device.state,
-        }
-        publish(data, topic)
-      end
-
-      def publish(object, prefix = nil)
-        data = {}
-        if object.respond_to?(:homie_attributes)
-          data = object.homie_attributes
-        else
-          data = object
-        end
-
-        data.each do |k, v|
-          topic = prefix + "/" + k
-          debug("mqtt publish #{topic} -> #{v}")
-          @client.publish(topic, v, true)
-        end
-      end
-
-      def debug(message)
-        MQTT::Homie.debug(message)
-      end
-    end
-  end
-end
+module MQTT
+  module Homie
+    # https://homieiot.github.io/specification/
+
+    class Client
+      DEFAULT_ROOT_TOPIC = "homie"
+
+      attr_accessor :host, :root_topic
+      attr_reader :device
+
+      def initialize(options = {})
+        @device = options[:device]
+        @host = options[:host]
+        @root_topic = options[:root_topic] || DEFAULT_ROOT_TOPIC
+
+        raise "device required" unless @device
+
+        # next version of homie doesn't use stats or firmware details
+        @use_stats = true
+        if options[:develop]
+          @device.use_stats = false
+          @device.use_fw = false
+          @use_stats = false
+        end
+
+        # observe all node properties so we can publish values when they change
+        @device.nodes.each do |node|
+          node.properties.each do |property|
+            property.add_observer(self)
+          end
+        end
+      end
+
+      def connect
+        return if connected?
+
+        @device.state = :init
+        @client = create_mqtt_client
+        @client.connect
+
+        publish(@device, topic)
+        publish_statistics if @use_stats
+
+        @threads = []
+
+        # run a thread to publish statistics
+        @threads << Thread.new { run_statistics } if @use_stats
+
+        # run a thread to listen for settings
+        @threads << Thread.new { run_set_listener }
+
+        @device.state = :ready
+        publish_state
+      end
+
+      def disconnect
+        @device.state = :disconnected
+        publish_state
+
+        @client.disconnect
+        @client = nil
+
+        @threads.each { |i| i[:done] = true }
+        @threads = []
+      end
+
+      def topic
+        @root_topic + "/" + @device.id
+      end
+
+      def connected?
+        @device.state == :ready
+      end
+
+      def update(time, object)
+        if object.kind_of?(MQTT::Homie::Property)
+          publish_property_value(object)
+        end
+      end
+
+      private
+
+      def create_mqtt_client
+        client = ::MQTT::Client.new
+        client.host = @host
+        client.will_topic = topic + "/$state"
+        client.will_payload = :lost
+        client.will_retain = true
+        client
+      end
+
+      def run_set_listener
+        # subscribe to 'set' topics for all settable properties
+        @device.nodes.each do |node|
+          node.properties.each do |property|
+            if property.settable?
+              set_topic = topic + "/" + node.topic + "/" + property.topic + "/set"
+              debug("subscribe #{set_topic}")
+              @client.subscribe(set_topic) if @client
+            end
+          end
+        end
+
+        if @client
+          @client.get do |topic, message|
+            debug("received message: #{topic}, message: #{message}")
+            property = find_property_by_set_topic(topic)
+            property.value = message if property
+            break if Thread.current[:done]
+          end
+        end
+        debug("set listener thread exiting")
+      end
+
+      def run_statistics
+        while !Thread.current[:done]
+          publish_statistics
+
+          # halve interval, if we miss a notification then we will be marked as offline
+          sleep @device.stats.interval / 2
+        end
+        debug("statistics thread exiting")
+      end
+
+      def find_property_by_set_topic(set_topic)
+        @device.nodes.each do |node|
+          node.properties.each do |property|
+            return property if set_topic == topic + "/" + node.topic + "/" + property.topic + "/set"
+          end
+        end
+        nil
+      end
+
+      def publish_statistics
+        publish(@device.stats, topic + "/$stats")
+      end
+
+      def publish_property_value(property)
+        node = @device.nodes.find { |i| i.properties.include?(property) }
+        data = {
+          property.id => property.value,
+        }
+        publish(data, topic + "/" + node.topic)
+      end
+
+      def publish_state
+        data = {
+          "$state" => @device.state,
+        }
+        publish(data, topic)
+      end
+
+      def publish(object, prefix = nil)
+        data = {}
+        if object.respond_to?(:homie_attributes)
+          data = object.homie_attributes
+        else
+          data = object
+        end
+
+        data.each do |k, v|
+          topic = prefix + "/" + k
+          debug("mqtt publish #{topic} -> #{v}")
+          @client.publish(topic, v, true)
+        end
+      end
+
+      def debug(message)
+        MQTT::Homie.debug(message)
+      end
+    end
+  end
+end