balboa_worldwide_app 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1f61d30556c0536efad6d27c229cefc0bccd1293a4dc491230a3e68cfddca13
-  data.tar.gz: 3014c3c575a53cceaa2f9c2903b1977480bffa5cc0db5e44f08bce8fc8671e17
+  metadata.gz: 6c2c576e6a37c43c681729ff2657eb07f9424be814bb1ecbb8a22639f3edb83b
+  data.tar.gz: d3c157c5a9c3776c66d061b15deec4b10d5c51ba4b4866e26ea79e703084e9a8
 SHA512:
-  metadata.gz: 3ff3043cbbdefd778ee2fbea74ce46ad8c73860f8e541c9035911219b6d6048203f817a2f129bac16678334d4f02cddea806814357d13710c4c76fc3e1987b5e
-  data.tar.gz: bb1d5468380c06c7bc38c34cf984cd9c4550fb3a3f1314f1b85617df0cff003ece26ce4603746f59f0e00950ae8244aaf0f477149f3b693ab67b8f6ff30f8602
+  metadata.gz: f42ac7f5102742a13735b6661837611f179e2e8b8c6bbaa7c9938dc451ded4aa277f5314260cf0ee552b4422fc95c8fb669c6ba343f9eaee1216fbd10c4da574
+  data.tar.gz: 6a66e7afff3ce43eb0cc1bfb571f621ce3870547b82da5c0f82aea7f56d582b221e08f34967b1b766499406b36e25e8dc7028172ed8ad0f985d9ff7d310dd2f5

data/exe/bwa_client

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bwa/client"
+require "bwa/discovery"
+
+def watch(spa)
+  loop do
+    message = spa.poll
+    next if message.is_a?(BWA::Messages::Ready)
+
+    puts message.raw_data.unpack1("H*").scan(/[0-9a-f]{2}/).join(" ")
+    puts message.inspect
+    break if block_given? && yield
+  rescue BWA::InvalidMessage => e
+    puts e.message
+    puts e.raw_data.unpack1("H*").scan(/[0-9a-f]{2}/).join(" ")
+    break
+  end
+end
+
+if ARGV.empty?
+  spas = BWA::Discovery.discover
+  if spas.empty?
+    warn "Could not find spa!"
+    exit 1
+  end
+  spa_ip = "tcp://#{spas.first.first}/"
+else
+  spa_ip = ARGV[0]
+end
+
+spa = BWA::Client.new(spa_ip)
+
+spa.request_configuration
+spa.request_control_info
+watch(spa) do
+  spa.last_status
+end
+
+watch(spa)

data/exe/bwa_mqtt_bridge

@@ -0,0 +1,394 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "sd_notify"
+require "set"
+require "json"
+require "mqtt/home_assistant"
+
+require "bwa/logger"
+require "bwa/client"
+require "bwa/discovery"
+require "bwa/version"
+
+class MQTTBridge
+  SIMPLE_PROPERTIES = %i[hold
+                         priming
+                         heating_mode
+                         twenty_four_hour_time
+                         heating
+                         temperature_range
+                         current_temperature
+                         target_temperature].freeze
+  private_constant :SIMPLE_PROPERTIES
+
+  def initialize(mqtt_uri, bwa, device_id: "bwa", root_topic: "homie")
+    Thread.abort_on_exception = true
+
+    @homie = MQTT::Homie::Device.new(device_id, "BWA Link", mqtt: mqtt_uri, root_topic: root_topic)
+    @bwa = bwa
+
+    # spin until we have a full configuration
+    loop do
+      message = @bwa.poll
+      next if message.is_a?(BWA::Messages::Ready)
+
+      if message.is_a?(BWA::Messages::Status)
+        @bwa.request_control_info unless @bwa.control_configuration
+        @bwa.request_control_info2 unless @bwa.configuration
+        @bwa.request_filter_configuration unless @bwa.filter_cycles
+      end
+
+      break if @bwa.full_configuration?
+    end
+
+    @homie.home_assistant_device = {
+      manufacturer: "Balboa Water Group",
+      sw_version: BWA::VERSION,
+      model: @bwa.model
+    }
+
+    publish_basic_attributes
+    @homie.publish
+
+    # Tell systemd we've started up OK. Ignored if systemd not in use.
+    BWA.logger.warn "Balboa MQTT Bridge running (version #{BWA::VERSION})"
+    SdNotify.ready
+
+    loop do
+      message = @bwa.poll
+      next if message.is_a?(BWA::Messages::Ready)
+
+      case message
+      when BWA::Messages::FilterCycles
+        2.times do |i|
+          node = @homie["filter-cycle#{i + 1}"]
+          node["start-hour"].value = message.public_send(:"cycle#{i + 1}_start_hour")
+          node["start-minute"].value = message.public_send(:"cycle#{i + 1}_start_minute")
+          node["duration"].value = message.public_send(:"cycle#{i + 1}_duration")
+          node["enabled"].value = message.cycle2_enabled? if i == 1
+        end
+      when BWA::Messages::Status
+        # make sure time is in sync
+        now = Time.now
+        now_minutes = (now.hour * 60) + now.min
+        spa_minutes = (message.hour * 60) + message.minute
+        # check the difference in both directions
+        diff = [(spa_minutes - now_minutes) % 1440, 1440 - ((spa_minutes - now_minutes) % 1440)].min
+
+        # allow a skew of 1 minute, since the seconds will always be off
+        if diff > 1
+          spa_time_str = format("%02d:%02d", message.hour, message.minute)
+          now_str = format("%02d:%02d", now.hour, now.min)
+          BWA.logger.info "Spa time #{spa_time_str}, actually #{now_str}; correcting difference of #{diff} min"
+          @bwa.set_time(now.hour, now.min, twenty_four_hour_time: message.twenty_four_hour_time)
+        end
+
+        if @bwa.temperature_scale != @homie["spa"]["temperature-scale"].value
+          @homie.init do
+            @homie["spa"]["temperature-scale"].value = @bwa.temperature_scale
+            update_temperature_scale
+          end
+        end
+
+        SIMPLE_PROPERTIES.each do |prop|
+          property = @homie["spa"][prop.to_s.tr("_", "-")]
+          property.value = @bwa.public_send(prop)
+        end
+        2.times do |i|
+          @homie["filter-cycle#{i + 1}"]["running"].value = @bwa.status.filter_cycles[i]
+        end
+
+        @homie["spa"]["circulation-pump"].value = @bwa.circulation_pump if @bwa.configuration.circulation_pump
+        case @bwa.configuration.blower
+        when 0
+          # not present
+        when 1
+          @homie["spa"]["blower"].value = !@bwa.blower.zero?
+        else
+          @homie["spa"]["blower"].value = @bwa.blower
+        end
+        @homie["spa"]["mister"].value = @bwa.mister if @bwa.configuration.mister
+
+        @bwa.configuration.pumps.each_with_index do |speeds, i|
+          next if speeds.zero?
+
+          property = @homie["spa"]["pump#{i + 1}"]
+          property.value = speeds == 1 ? @bwa.pumps[i] != 0 : @bwa.pumps[i]
+        end
+        @bwa.configuration.lights.each_with_index do |exists, i|
+          next unless exists
+
+          @homie["spa"]["light#{i + 1}"].value = @bwa.lights[i]
+        end
+        @bwa.configuration.aux.each_with_index do |exists, i|
+          next unless exists
+
+          @homie["spa"]["aux#{i + 1}"].value = @bwa.lights[i]
+        end
+
+        # Tell systemd we are still alive and kicking. Ignored if systemd not in use.
+        SdNotify.watchdog
+      end
+    end
+  end
+
+  def publish_basic_attributes
+    allow_toggle = lambda do |value|
+      next value if value == "toggle"
+    end
+
+    @homie.node("spa", "Hot Tub", @bwa.model) do |spa|
+      spa.property("hold",
+                   "Hold",
+                   :boolean,
+                   @bwa.hold,
+                   hass: { switch: { icon: "mdi:pause-octagon" } },
+                   non_standard_value_check: allow_toggle) do |value|
+        next @bwa.toggle_hold if value == "toggle"
+
+        @bwa.hold = value
+      end
+      spa.property("priming", "Priming", :boolean, @bwa.priming, hass: { binary_sensor: { icon: "mdi:fast-forward" } })
+      spa.property("heating-mode",
+                   "Heating Mode",
+                   :enum,
+                   @bwa.heating_mode,
+                   format: BWA::Client::HEATING_MODES,
+                   hass: { select: { icon: "mdi:cog-play" } },
+                   non_standard_value_check: allow_toggle) do |value|
+        next @bwa.toggle_heating_mode if value == "toggle"
+
+        @bwa.heating_mode = value.to_sym
+      end
+      spa.property("temperature-scale",
+                   "Temperature Scale",
+                   :enum,
+                   @bwa.temperature_scale,
+                   format: %w[fahrenheit celsius],
+                   hass: :select) do |value|
+        @bwa.temperature_scale = value.to_sym
+      end
+      spa.property("twenty-four-hour-time",
+                   "24 Hour Time",
+                   :boolean,
+                   @bwa.twenty_four_hour_time?,
+                   hass: { switch: { icon: "mdi:timer-cog" } }) do |value|
+        now = Time.now
+        @bwa.set_time(now.hour, now.min, twenty_four_hour_time: value)
+      end
+      spa.property("heating",
+                   "Heating",
+                   :boolean,
+                   @bwa.heating?,
+                   hass: {
+                     binary_sensor: { device_class: :running, icon: "mdi:hot-tub" }
+                   })
+      spa.property("temperature-range",
+                   "Temperature Range",
+                   :enum,
+                   @bwa.temperature_range,
+                   format: %i[high low],
+                   hass: { select: { icon: "mdi:thermometer-lines" } },
+                   non_standard_value_check: allow_toggle) do |value|
+        next @bwa.toggle_temperature_range if value == "toggle"
+
+        @bwa.temperature_range = value.to_sym
+      end
+      spa.property("current-temperature", "Current Water Temperature", :float, @bwa.current_temperature)
+      spa.property("target-temperature", "Target Water Temperature", :float, @bwa.target_temperature) do |value|
+        @bwa.target_temperature = value
+      end
+      update_temperature_scale
+
+      unless @bwa.configuration.blower.zero?
+        if @bwa.configuration.blower == 1
+          args = [:boolean, !@bwa.blower.zero?]
+          kwargs = { hass: { switch: { icon: "mdi:chart-bubble" } } }
+        else
+          args = [:integer, @bwa.blower]
+          kwargs = {
+            format: 0..@bwa.configuration.blower,
+            hass: { number: { icon: "mdi:chart-bubble" } }
+          }
+        end
+
+        spa.property("blower",
+                     "Blower",
+                     *args,
+                     non_standard_value_check: allow_toggle,
+                     **kwargs) do |value|
+          next @bwa.toggle_blower if value == "toggle"
+
+          @bwa.blower = value
+        end
+      end
+
+      if @bwa.configuration.mister
+        spa.property("mister",
+                     "Mister",
+                     :boolean,
+                     @bwa.mister,
+                     hass: { switch: { icon: "mdi:sprinkler-fire" } },
+                     non_standard_value_check: allow_toggle) do |value|
+          next @bwa.toggle_mister if value == "toggle"
+
+          @bwa.mister = value
+        end
+      end
+
+      if @bwa.configuration.circulation_pump
+        spa.property("circulation-pump",
+                     "Circulation Pump Running",
+                     :boolean,
+                     @bwa.circulation_pump,
+                     hass: { binary_sensor: { device_class: :running, icon: "mdi:sync" } })
+      end
+
+      single_pump = @bwa.configuration.pumps.count { |speeds| !speeds.zero? } == 1
+      @bwa.configuration.pumps.each_with_index do |speeds, i|
+        next if speeds.zero?
+
+        if speeds == 1
+          args = [:boolean, !@bwa.pumps[i].zero?]
+          kwargs = { hass: { switch: { icon: "mdi:chart-bubble" } } }
+        else
+          args = [:integer, @bwa.pumps[i]]
+          kwargs = { format: 0..speeds,
+                     hass: { number: { icon: "mdi:chart-bubble" } } }
+        end
+        name = single_pump ? "Pump" : "Pump #{i + 1}"
+        spa.property("pump#{i + 1}",
+                     name,
+                     *args,
+                     non_standard_value_check: allow_toggle,
+                     **kwargs) do |value|
+          next @bwa.toggle_pump(i) if value == "toggle"
+
+          @bwa.set_pump(i, value)
+        end
+      end
+
+      single_light = @bwa.configuration.lights.count(&:itself)
+      @bwa.configuration.lights.each_with_index do |exists, i|
+        next unless exists
+
+        name = single_light ? "Lights" : "Lights #{i + 1}"
+        spa.property("light#{i + 1}",
+                     name,
+                     :boolean,
+                     @bwa.lights[i],
+                     hass: { light: { icon: "mdi:car-parking-lights" } },
+                     non_standard_value_check: allow_toggle) do |value|
+          next @bwa.toggle_light(i) if value == "toggle"
+
+          @bwa.set_light(i, value)
+        end
+      end
+
+      @bwa.configuration.aux.each_with_index do |exists, i|
+        next unless exists
+
+        spa.property("aux#{i + 1}",
+                     "Auxiliary #{i + 1}",
+                     :boolean,
+                     @bwa.aux[i],
+                     hass: :switch,
+                     non_standard_value_check: allow_toggle) do |value|
+          next @bwa.toggle_aux(i) if value == "toggle"
+
+          @bwa.set_aux(i, value)
+        end
+      end
+    end
+
+    2.times do |i|
+      @homie.node("filter-cycle#{i + 1}", "Filter Cycle #{i + 1}", "Filter Cycle") do |cycle|
+        cycle.property("running",
+                       "Running",
+                       :boolean,
+                       @bwa.status.filter_cycles[i],
+                       hass: { binary_sensor: { icon: "mdi:air-filter" } })
+        cycle.property("start-hour",
+                       "Start Hour",
+                       :integer,
+                       @bwa.filter_cycles.public_send(:"cycle#{i + 1}_start_hour"),
+                       format: 0...24,
+                       unit: "hours",
+                       hass: { number: { icon: "mdi:clock" } }) do |value|
+          update_filter_cycles(:"cycle#{i + 1}_start_hour", value)
+        end
+        cycle.property("start-minute",
+                       "Start Minute",
+                       :integer,
+                       @bwa.filter_cycles.public_send(:"cycle#{i + 1}_start_minute"),
+                       format: 0...60,
+                       unit: "minutes",
+                       hass: { number: { icon: "mdi:clock" } }) do |value|
+          update_filter_cycles(:"cycle#{i + 1}_start_minute", value)
+        end
+        cycle.property("duration",
+                       "Duration",
+                       :integer,
+                       @bwa.filter_cycles.public_send(:"cycle#{i + 1}_duration"),
+                       format: 0...1440,
+                       unit: "minutes",
+                       hass: { number: { icon: "mdi:clock" } }) do |value|
+          update_filter_cycles(:"cycle#{i + 1}_duration", value)
+        end
+
+        next unless i == 1
+
+        cycle.property("enabled",
+                       "Enabled",
+                       :boolean,
+                       hass: { switch: { icon: "mdi:filter-check" } }) do |value|
+          update_filter_cycles(:cycle2_enabled, value)
+        end
+      end
+    end
+  end
+
+  def update_filter_cycles(prop, value)
+    new_config = @bwa.filter_cycles.dup
+    new_config.public_send("#{prop}=", value)
+    @bwa.update_filter_cycles(new_config)
+  end
+
+  def update_temperature_scale
+    @homie["spa"]["current-temperature"].unit =
+      @homie["spa"]["target-temperature"].unit =
+        "°#{@bwa.temperature_scale.to_s[0].upcase}"
+    if @bwa.temperature_scale == :celsius
+      @homie["spa"]["current-temperature"].format = 0..42
+      @homie["spa"]["target-temperature"].format = 10..40
+    else
+      @homie["spa"]["current-temperature"].format = 32..108
+      @homie["spa"]["target-temperature"].format = 50..106
+    end
+
+    @homie["spa"]["current-temperature"].hass_sensor(device_class: :temperature)
+    @homie["spa"]["target-temperature"].hass_number(icon: "mdi:thermometer")
+  end
+end
+
+mqtt_uri = ARGV.shift
+
+if ARGV.empty?
+  spas = BWA::Discovery.discover
+  if spas.empty?
+    BWA.logger.fatal "Could not find spa!"
+    warn "Could not find spa!"
+    exit 1
+  end
+  spa_ip = "tcp://#{spas.first.first}/"
+else
+  spa_ip = ARGV[0]
+end
+
+spa = BWA::Client.new(spa_ip)
+
+spa.request_configuration
+spa.request_filter_configuration
+
+MQTTBridge.new(mqtt_uri, spa)

data/{bin → exe}/bwa_proxy

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'bwa/discovery'
-require 'bwa/proxy'
+require "bwa/discovery"
+require "bwa/proxy"
 
 Thread.new do
   BWA::Discovery.advertise

data/{bin → exe}/bwa_server

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'bwa/discovery'
-require 'bwa/server'
+require "bwa/discovery"
+require "bwa/server"
 
 Thread.new do
   BWA::Discovery.advertise

data/lib/balboa_worldwide_app.rb

@@ -1 +1,3 @@
-require 'bwa/client'
+# frozen_string_literal: true
+
+require "bwa/client"