ojelectronics 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4efc56c71825ce41000181e47bc73ba623038635d937247421189b39ba909de4
+  data.tar.gz: 9aaa6318abc98289c21a657f82edaea20a65c6e9c695d73bbe28c6ddeb923041
+SHA512:
+  metadata.gz: aee4126a865ff834204d5e861da08989cc95388464c33e078a7ce940553496d783ef8a844b88a8471c7e6f5c82959f78570fe48749ebb544c27e6f36abeef9d5
+  data.tar.gz: 724a221232dd8a1dcc4a1623f1247920c488901dcfedddb946fc9a7f0ff080e68ca4d795295ab1b3441c82d44fd22ca5052cc57e6bfee817459e641277c2ef8e

data/exe/oj_electronics_mqtt_bridge

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "ojelectronics"
+require "homie-mqtt"
+require "optparse"
+
+brand = nil
+
+options = OptionParser.new do |opts|
+  opts.banner = "Usage: oj_electronics_mqtt_bridge USERNAME PASSWORD MQTT_URI [options]"
+
+  opts.on("--brand=BRAND", "Provide the brand. Either oj_electronics or schluter") do |v|
+    brand = v.to_sym
+  end
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end
+
+options.parse!
+
+unless ARGV.length == 3
+  puts options
+  exit 1
+end
+
+client = OJElectronics::Client.new(ARGV[0], ARGV[1], brand: brand)
+
+homie = MQTT::Homie::Device.new(MQTT::Homie.escape_id(brand&.to_s || "oj_electronics"),
+                                "OJ Electronics Thermostats",
+                                mqtt: ARGV[2])
+
+client.thermostats.each_value do |t|
+  homie.node(t.serial_number, t.room, "Thermostat") do |n|
+    n.property("temperature", "Current Temperature", :float, t.temperature, unit: "°C")
+    n.property("set-point-temperature",
+               "Set Point Temperature",
+               :float,
+               t.set_point_temperature,
+               unit: "°C",
+               format: 5..40) do |v|
+      t.set_point_temperature = v
+    end
+    n.property("online", "Online", :boolean, t.online)
+    n.property("heating", "Heating", :boolean, t.heating)
+    n.property("regulation-mode", "Regulation Mode", :enum, t.regulation_mode,
+               format: OJElectronics::Thermostat::REGULATION_MODES)
+  end
+end
+homie.publish
+
+PROPERTIES = %i[temperature set_point_temperature online heating regulation_mode].freeze
+
+loop do
+  t = client.long_poll
+  next unless t
+
+  homie.mqtt.batch_publish do
+    n = homie[t.serial_number]
+    PROPERTIES.each do |prop|
+      n[prop.to_s.tr("_", "-")].value = t.send(prop)
+    end
+  end
+end

data/lib/oj_electronics/client.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext/enumerable"
+require "faraday_middleware"
+
+module OJElectronics
+  class Client
+    class AuthenticationError < RuntimeError
+      class << self
+        def create(error_code)
+          klass, message = case error_code
+                           when 1 then [InvalidUsernameError, "Invalid Username"]
+                           when 2 then [IncorrectPasswordError, "Incorrect password"]
+                           else
+                             [self, nil]
+                           end
+          klass.new(error_code, message)
+        end
+      end
+
+      attr_reader :error_code
+
+      def initialize(error_code, message = nil)
+        @error_code = error_code
+        super(message || "Unable to authenticate: ErrorCode #{error_code}")
+      end
+    end
+
+    class IncorrectPasswordError < AuthenticationError; end
+    class InvalidUsernameError < AuthenticationError; end
+
+    BRANDS = {
+      oj_electronics: 0,
+      schluter: 8
+    }.freeze
+
+    attr_reader(*%i[username session_id brand expires thermostats])
+
+    def initialize(username, password, session_id: nil, expires: nil, brand: :oj_electronics)
+      raise ArgumentError, "unrecognized brand #{brand.inspect}" unless BRANDS.key?(brand)
+
+      @brand = brand
+      @username = username
+      @password = password
+      @session_id = session_id
+      @expires = expires
+      @api = Faraday.new(url: "https://mythermostat.info/api/") do |f|
+        f.request :json
+        f.request :retry
+        f.response :raise_error
+        f.response :json
+        f.adapter :net_http_persistent
+      end
+      @thermostats = {}
+
+      refresh
+    end
+
+    def expired?
+      @session_id.nil? || @expires.nil? || @expires < Time.now
+    end
+
+    # refresh all thermostats
+    def refresh
+      thermostats = api.get("thermostats", sessionid: session_id)
+                       .body["Groups"]
+                       .flat_map { |g| g["Thermostats"] }
+                       .index_by { |t| t["SerialNumber"] }
+      missing = @thermostats.keys - thermostats.keys
+      missing.each { |sn| @thermostats.delete(sn) }
+
+      additional = thermostats.keys - @thermostats.keys
+      additional.each do |sn|
+        @thermostats[sn] = Thermostat.new(self, sn)
+      end
+
+      thermostats.each do |sn, json|
+        @thermostats[sn].refresh(json)
+      end
+    end
+
+    # returns nil if nothing changed; otherwise the thermostat that changed
+    def long_poll
+      response = api.get("notification", sessionid: session_id).body
+      json = response["Thermostat"]
+      return if json.nil?
+
+      @thermostats[json["SerialNumber"]].tap { |t| t.refresh(json) }
+    end
+
+    # !@visibility private
+    def api
+      reauth
+      @api
+    end
+
+    private
+
+    def reauth
+      return unless expired?
+
+      auth = @api.post("authenticate/user",
+                       Email: username,
+                       Password: @password,
+                       Application: BRANDS[brand]).body
+      raise AuthenticationError.create(auth["ErrorCode"]) unless auth["ErrorCode"] == 0 # rubocop:disable Style/NumericPredicate
+
+      @session_id = auth["SessionId"]
+      @expires = Time.now + 3600
+    end
+  end
+end

data/lib/oj_electronics/thermostat.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OJElectronics
+  class Thermostat
+    REGULATION_MODES = %i[schedule temporary_hold permanent_hold vacation_hold].freeze
+    attr_reader(*%i[serial_number temperature set_point_temperature room online heating regulation_mode])
+
+    def initialize(client, serial_number)
+      @client = client
+      @serial_number = serial_number
+    end
+
+    def refresh(json)
+      @temperature = json["Temperature"].to_f / 100
+      @set_point_temperature = json["SetPointTemp"].to_f / 100
+      @room = json["Room"]
+      @online = json["Online"]
+      @heating = json["Heating"]
+      @regulation_mode = REGULATION_MODES[json["RegulationMode"] - 1]
+    end
+
+    def set_point_temperature=(value) # rubocop:disable Naming/AccessorMethodName
+      @client.api.post("thermostat?sessionid=#{@client.session_id}&serialnumber=#{serial_number}",
+                       RegulationMode: 3,
+                       VacationEnabled: false,
+                       ManualTemperature: (value * 100).to_i)
+    end
+  end
+end

data/lib/oj_electronics/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OJElectronics
+  VERSION = "0.0.2"
+end

data/lib/oj_electronics.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "oj_electronics/client"
+require "oj_electronics/thermostat"
+
+module OJElectronics
+end

data/lib/ojelectronics.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "oj_electronics"

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: ojelectronics
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Cody Cutrer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: homie-mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.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'
+- !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:
+- oj_electronics_mqtt_bridge
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/oj_electronics_mqtt_bridge
+- lib/oj_electronics.rb
+- lib/oj_electronics/client.rb
+- lib/oj_electronics/thermostat.rb
+- lib/oj_electronics/version.rb
+- lib/ojelectronics.rb
+homepage: https://github.com/ccutrer/ruby-ojelectronics
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Interact with OJ Electronics/DITRA HEAT floor thermostats via MQTT
+test_files: []