intesisbox 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1fd75a5326195c3ac8d0b6d7dc51730e23d6f3ce6c26a09b7e7b2bb2dad45369
+  data.tar.gz: 3c130bac7dbbca03827c9e8835daf58cb8fb54a5236ee0f6d7473af05060eb96
+SHA512:
+  metadata.gz: 15aee2ce1fb63c3dd5ef737eb6bb270fc6388f275c1cd28c79ded5a3e0678d2aa62490113ef98ccf3456cd7e8d51659317ec3f10e7c9301434585d04901600cc
+  data.tar.gz: 7104c211dbec8652c6b84216f509c3dbdca9695648e671ca2c67a3e0e8d4909f384e202ceb632caa1a5f737a989b531a3ee46143da835343724043c0c5ced49b

data/bin/intesisbox_mqtt_bridge

@@ -0,0 +1,201 @@
+#!/usr/bin/env ruby
+
+require 'intesisbox'
+require 'homie-mqtt'
+
+class MQTTBridge
+  def initialize(mqtt_uri, root_topic: nil)
+    @base_topic = "homie/intesisbox"
+
+    bridge, discovery_property, units_property = nil
+    @device = MQTT::Homie::Device.new("intesisbox", "IntesisBox", root_topic: root_topic, mqtt: mqtt_uri) do |topic, value|
+      if topic == discovery_property.topic
+        @device.mqtt.unsubscribe(topic)
+        discovery_property.set(value) unless @got_discovery
+        @got_discovery = true
+      elsif topic == units_property.topic
+        @device.mqtt.unsubscribe(topic)
+        units_property.set(value) unless @got_units
+        @got_units = true
+      end
+    end
+
+    @wmps = {}
+    @discovery = 300
+    @units = :C
+
+    bridge = nil
+    @device.node("bridge", "Bridge", "Bridge") do |node|
+      (bridge = node).property("discovery", "Auto-Discovery Interval", :integer, format: "0:86400", unit: "s") do |prop, value|
+        next unless value =~ /^\d+$/
+        value = value.to_i
+        next if value > 86400
+        old_value = @discovery
+        prop.value = value
+        @discovery = value
+        if value < old_value || old_value == 0
+          @discovery_thread.kill
+          start_discovery_thread
+        end
+      end.
+      property("units", "Units", :enum, format: "C,F") do |prop, value|
+        next unless %w{C F}.include?(value)
+        if prop.value != value
+          prop.value = value
+          @units = value
+          next if @wmps.empty?
+          @device.init do
+            @wmps.each do |(mac, wmp)|
+              node = @device.nodes[mac]
+              setptemp = node.properties['setptemp']
+              setptemp.value = convert_units(wmp.setptemp)
+              setptemp.unit = "º#{@units}"
+              setptemp.format = wmp.limits[:setptemp].map { |lim| convert_units(lim) }.join(":")
+              if wmp.ambtemp
+                ambtemp = node.properties['ambtemp']
+                ambtemp.value = convert_units(wmp.ambtemp)
+                ambtemp.unit = "º#{@units}"
+              end
+            end
+          end
+        end
+      end
+    end
+    discovery_property = bridge.properties['discovery']
+    units_property = bridge.properties['units']
+    @device.publish
+    # use MQTT itself as our state store
+    @device.mqtt.subscribe("#{discovery_property.topic}")
+    @device.mqtt.subscribe("#{units_property.topic}")
+
+    setup_discovery
+    start_discovery_thread
+
+    @device.join
+  end
+
+  def start_discovery_thread
+    @discovery_thread = Thread.new do
+      @discovery_object.discover
+      loop do
+        break if @discovery == 0
+        sleep(@discovery)
+        @discovery_object.discover
+      end
+    end
+  end
+
+  def setup_discovery
+    @discovery_object = IntesisBox::Discovery.new do |details|
+      # force a reconnect to WMPs that have moved
+      mac = MQTT::Homie.escape_id(details[:mac])
+      known_wmp = @wmps[mac]
+      if known_wmp && known_wmp.ip != details[:ip]
+        @wmps.delete(mac)
+      end
+
+      next true if @wmps.key?(mac)
+
+      wmp = IntesisBox::Client.new(details[:ip])
+
+      loop do
+        break if wmp.mac
+        unless wmp.poll(1)
+          puts "unable to talk to #{wmp.mac}"
+          break
+        end
+      end
+      next true unless wmp.mac
+
+      puts "Found new WMP #{wmp.mac} (#{wmp.devicename})"
+      @wmps[MQTT::Homie.escape_id(wmp.mac)] = wmp
+      node = publish_wmp(wmp)
+
+      Thread.new do
+        iter = 0
+        loop do
+          next wmp.ping unless wmp.poll
+
+          node.name = wmp.devicename
+          node.properties['ip'].value = wmp.ip
+          node.properties['onoff'].value = wmp.onoff
+          node.properties['mode'].value = wmp.mode if wmp.limits[:mode]&.length.to_i > 0
+          node.properties['fansp'].value = wmp.fansp if wmp.limits[:fansp]&.length.to_i > 0
+          node.properties['vaneud'].value = wmp.vaneud if wmp.limits[:vaneud]&.length.to_i > 0
+          node.properties['vanelr'].value = wmp.vanelr if wmp.limits[:vanelr]&.length.to_i > 0
+          node.properties['setptemp'].value = convert_units(wmp.setptemp) if wmp.setptemp
+          node.properties['ambtemp'].value = convert_units(wmp.ambtemp) if wmp.ambtemp
+          node.properties['errstatus'].value = wmp.errstatus
+          node.properties['errcode'].value = wmp.errcode
+          node.properties['devicename'].value = wmp.devicename
+        end
+      rescue => e
+        puts "Lost connection to #{wmp.mac} (#{wmp.devicename}): #{e}"
+        remove_wmp(wmp)
+      end
+      true
+    end
+  end
+
+  def publish_wmp(wmp)
+    generic_property = ->(prop, value) do
+      wmp = @wmps[prop.node.id]
+      wmp.send("#{prop.id}=", value)
+    end
+
+    node = nil
+    @device.node(MQTT::Homie.escape_id(wmp.mac), wmp.devicename, wmp.model) do |n|
+      node = n
+      node.property("devicename", "Device Name", :string, &generic_property).
+        property("ip", "IP Address", "string").
+        property("onoff", "AC unit On or Off", "boolean") do |prop, value|
+        wmp = @wmps[prop.node.id]
+        wmp.onoff = value == 'true'
+      end
+
+      if wmp.limits[:mode]&.length.to_i > 0
+        node.property("mode", "Mode (heat, cool, fan, dry or auto)", :enum, format: wmp.limits[:mode].join(","), &generic_property)
+      end
+
+      if wmp.limits[:fansp]&.length.to_i > 0
+        node.property("fansp", "Fan speed", :enum, format: wmp.limits[:fansp].join(","), &generic_property)
+      end
+
+      if wmp.limits[:vaneud]&.length.to_i > 0
+        node.property("vaneud", "Up/Down vane position", :enum, format: wmp.limits[:vaneud].join(","), &generic_property)
+      end
+
+      if wmp.limits[:vanelr]&.length.to_i > 0
+        node.property("vanelr", "Left/Right vane position", :enum, format: wmp.limits[:vanelr].join(","), &generic_property)
+      end
+
+      node.property("setptemp", "Set point temperature", :float, unit: "º#{@units}", format: wmp.limits[:setptemp].map { |lim| convert_units(lim) }.join(":")) do |prop, value|
+        wmp = @mps[prop.node.id]
+        wmp.setptemp = convert_units_set(value.to_f)
+      end.
+        property("ambtemp", "Ambient temperature", :float, unit: "º#{@units}").
+        property("errstatus", "Shows if any error occurs", :string).
+        property("errcode", "Error code", :integer)
+    end
+    node
+  end
+
+  def remove_wmp(wmp)
+    mac = MQTT::Homie.escape_id(wmp.mac)
+    @wmps.delete(mac)
+    @device.remove_node(mac)
+  end
+
+  def convert_units(value)
+    return value if @units == :C
+    value * 9/5.0 + 32
+  end
+
+  def convert_units_set(value)
+    return value if @units == :C
+    (value - 32) * 5/9.0
+  end
+end
+
+mqtt_uri = ARGV[0]
+MQTTBridge.new(mqtt_uri)

data/lib/intesis_box.rb

@@ -0,0 +1,2 @@
+require 'intesis_box/client'
+require 'intesis_box/discovery'

data/lib/intesis_box/client.rb

@@ -0,0 +1,86 @@
+require 'socket'
+
+module IntesisBox
+  class Client
+    attr_reader :ip, :model, :mac, :version, :rssi
+    attr_reader :limits
+    attr_reader :devicename
+    attr_reader :onoff, :mode, :fansp, :vaneud, :vanelr, :setptemp, :ambtemp, :errstatus, :errcode
+
+    def initialize(ip, port = 3310)
+      @limits = {}
+      @ip = ip
+      @io = TCPSocket.new(ip, port)
+
+      @io.puts("LIMITS:*")
+      poll(1)
+      @io.puts("CFG:DEVICENAME")
+      poll(1)
+      @io.puts("GET,1:*")
+      poll(1)
+      # this is purposely last, since mac is what we check for it being ready
+      @io.puts("ID")
+      poll(1)
+    end
+
+    def poll(timeout = 30)
+      return false if @io.wait_readable(timeout).nil?
+
+      loop do
+        line = @io.readline.strip
+        cmd, args = line.split(':', 2)
+        case cmd
+        when "ID"
+          @model, @mac, _ip, _protocol, @version, @rssi = args.split(',')
+        when "LIMITS"
+          function, limits = args.split(",",2)
+          limits = limits[1...-1].split(",")
+          next if function == 'ONOFF'
+          limits.map! { |l| l.to_f / 10 } if %w{SETPTEMP AMBTEMP}.include?(function)
+          @limits[function.downcase.to_sym] = limits
+        when "CHN,1"
+          function, value = args.split(",")
+          value = value == 'ON' if function == 'ONOFF'
+          value = value.to_f / 10 if %w{SETPTEMP AMBTEMP}.include?(function)
+          value = value.to_i if function == 'ERRCODE'
+          value = nil if value == -3276.8
+          instance_variable_set(:"@#{function.downcase}", value)
+        when "CFG"
+          function, value = args.split(",", 2)
+          @devicename = value if function == 'DEVICENAME'
+        end
+        break unless @io.ready?
+      end
+      true
+    end
+
+    def ping
+      @io.puts("PING")
+    end
+
+    def onoff=(value)
+      @io.puts("SET,1:ONOFF,#{value ? 'ON' : 'OFF'}")
+    end
+
+    %w{mode fansp vaneud vanelr}.each do |function|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{function}=(value)
+          return if limits[:#{function}] && !limits[:#{function}].include?(value.to_s)
+          @io.puts("SET,1:#{function.upcase},\#{value}")
+        end
+      RUBY
+    end
+
+    def setptemp=(value)
+      value = value.round
+      return if limits[:setptemp] && (value < limits[:setptemp].first || value > limits[:setptemp].last)
+      @io.puts("SET,1:SETPTEMP,#{value * 10}")
+    end
+
+    def devicename=(value)
+      @io.puts("CFG:DEVICENAME,#{value}")
+      # have to re-query to ensure it got the new value
+      @io.puts("CFG:DEVICENAME")
+    end
+  end
+end

data/lib/intesis_box/discovery.rb

@@ -0,0 +1,69 @@
+require 'socket'
+
+module IntesisBox
+  class Discovery
+    class << self
+      def discover(timeout: 1, expected_count: nil, expect: nil)
+        wmps = {}
+        discovery = new(timeout: timeout) do |wmp|
+          wmps[wmp[:mac]] = wmp
+          next false if wmps.length == expected_count
+          next false if expect && wmp[:mac] == expect
+          true
+        end
+        wmps
+      ensure
+        discovery&.close
+      end
+    end
+
+    def initialize(timeout: nil)
+      @socket = UDPSocket.new
+      @socket.bind("0.0.0.0", 3310)
+      @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
+      @found = []
+
+      receive_lambda = -> do
+        loop do
+          if IO.select([@socket], nil, nil, timeout)
+            @socket.wait_readable
+            msg, _ = @socket.recvfrom(128)
+            next unless msg.start_with?("DISCOVER:")
+            msg = msg[9..-1]
+
+            model, mac, ip, protocol, version, rssi, name, _, _ = msg.split(",")
+            wmp = { mac: mac, model: model, ip: ip, protocol: protocol, version: version, rssi: rssi, name: name }
+            if block_given?
+              break unless yield wmp
+            else
+              @found << wmp
+            end
+          else
+            break
+          end
+        end
+      end
+
+      if timeout
+        discover
+        receive_lambda.call
+      else
+        @receive_thread = Thread.new(&receive_lambda)
+      end
+    end
+
+    def close
+      @receive_thread&.kill
+      @socket.close
+    end
+
+    def discover
+      @socket.sendmsg("DISCOVER\r\n", 0, Socket.sockaddr_in(3310, '255.255.255.255'))
+    end
+
+    def pending_discoveries
+      result, @found = @found, []
+      result
+    end
+  end
+end

data/lib/intesis_box/version.rb

@@ -0,0 +1,3 @@
+module IntesisBox
+  VERSION = '0.0.2'
+end

data/lib/intesisbox.rb

@@ -0,0 +1 @@
+require 'intesis_box'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: intesisbox
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+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: homie-mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.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:
+- intesisbox_mqtt_bridge
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/intesisbox_mqtt_bridge
+- lib/intesis_box.rb
+- lib/intesis_box/client.rb
+- lib/intesis_box/discovery.rb
+- lib/intesis_box/version.rb
+- lib/intesisbox.rb
+homepage: https://github.com/ccutrer/intesisbox
+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 communication with IntesisBox
+test_files: []