balboa_worldwide_app 2.0.7 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f47a4fef9d14e31269c10174f40b6074a78df20acf3e2943ec6915cdad9747b
-  data.tar.gz: ba44d2d0026e8ccab28a5831c4ee6b88c23c14f02de5c6c54b4665f6e7f3b831
+  metadata.gz: 1cac0db450913aecd0a1027147202f01278e8828fce2b1fc86541940a37782f3
+  data.tar.gz: 67e5d9a8f211bb61f7b4c3d783486d03e78eeecac1da6983d43116be0f87d545
 SHA512:
-  metadata.gz: b07aa98141a94f5f53cf7ba797b6e29554de4e6d6704dba9dbabe1b2e683af16753a1aac297f0cac2c093694faf109a6b08cd967f5accca3432c15e3b4e4df8d
-  data.tar.gz: c20a3bf9a5da5adc70a79f9d3c1be001ca5fbee6d62755b994c08611c445f27591b7e1d86e44e8d4ddbbafa11600b165c64cc21d82b604f6f4f4b4126865be22
+  metadata.gz: aed0becca04006dc4288ccd8bf5134d8387edfd51c47444753b57681184acc95d3244a1df506d5cbceb9997ff440550f09907c9f334b3050e1ffe7b31af02eee
+  data.tar.gz: c2870fb8c3d23915c172db962483fb00928562aabc76ed503d9b4641e69f6cc100fe7a64d627cd86883fe76b0650a73c68a62473e4449d74782cc89247fc6f1f

data/exe/bwa_mqtt_bridge

@@ -95,6 +95,7 @@ class MQTTBridge
           property = @homie["spa"][prop.to_s.tr("_", "-")]
           property.value = @bwa.public_send(prop)
         end
+        @homie["spa"]["notification"].value = @bwa.notification || "none"
         2.times do |i|
           @homie["filter-cycle#{i + 1}"]["running"].value = @bwa.status.filter_cycles[i]
         end
@@ -144,8 +145,22 @@ class MQTTBridge
 
       value.to_i if value.match?(/^\d+$/)
     end
+    allowed_items = BWA::Messages::ToggleItem::ITEMS.keys.map(&:to_s)
+    allow_toggles = lambda do |value|
+      next unless allowed_items.include?(value)
+
+      value
+    end
 
     @homie.node("spa", "Hot Tub", @bwa.model) do |spa|
+      spa.property("command",
+                   "Send a command to the tub",
+                   :enum,
+                   format: %w[normal_operation clear_notification],
+                   retained: false,
+                   non_standard_value_check: allow_toggles) do |value|
+        @bwa.toggle_item(value.to_sym)
+      end
       spa.property("hold",
                    "Hold",
                    :boolean,
@@ -157,6 +172,8 @@ class MQTTBridge
         @bwa.hold = value
       end
       spa.property("priming", "Priming", :boolean, @bwa.priming, hass: { binary_sensor: { icon: "mdi:fast-forward" } })
+      spa.property("notification", "Notification", :enum, @bwa.notification || "none",
+                   format: BWA::Messages::Status::NOTIFICATIONS.values.compact + ["none"])
       spa.property("heating-mode",
                    "Heating Mode",
                    :enum,

data/lib/bwa/client.rb

@@ -17,6 +17,7 @@ module BWA
                 hold?
                 priming
                 priming?
+                notification
                 heating_mode
                 temperature_scale
                 twenty_four_hour_time

data/lib/bwa/message.rb

@@ -27,36 +27,6 @@ module BWA
         @messages << klass
       end
 
-      # Ignore (parse and throw away) messages of these types.
-      IGNORED_MESSAGES = [
-        (+"\xbf\x00").force_encoding(Encoding::ASCII_8BIT), # request for new clients
-        (+"\xbf\xe1").force_encoding(Encoding::ASCII_8BIT),
-        (+"\xbf\x07").force_encoding(Encoding::ASCII_8BIT) # nothing to send
-      ].freeze
-
-      # Don't log messages of these types, even in DEBUG mode.
-      # They are very frequent and would swamp the logs.
-      def common_messages
-        @common_messages ||= begin
-          msgs = []
-          unless BWA.verbosity >= 1
-            msgs += [
-              Messages::Status::MESSAGE_TYPE,
-              (+"\xbf\xe1").force_encoding(Encoding::ASCII_8BIT)
-            ]
-          end
-          unless BWA.verbosity >= 2
-            msgs += [
-              (+"\xbf\x00").force_encoding(Encoding::ASCII_8BIT),
-              (+"\xbf\xe1").force_encoding(Encoding::ASCII_8BIT),
-              Messages::Ready::MESSAGE_TYPE,
-              (+"\xbf\x07").force_encoding(Encoding::ASCII_8BIT)
-            ]
-          end
-          msgs
-        end
-      end
-
       def parse(data)
         offset = -1
         message_type = length = nil
@@ -92,17 +62,10 @@ module BWA
 
         message_type = data.slice(offset + 3, 2)
         BWA.logger.debug "discarding invalid data prior to message #{BWA.raw2str(data[0...offset])}" unless offset.zero?
-        unless common_messages.include?(message_type)
-          BWA.logger.debug " read: #{BWA.raw2str(data.slice(offset,
-                                                            length + 2))}"
-        end
 
         src = data[offset + 2].ord
         klass = @messages.find { |k| k::MESSAGE_TYPE == message_type }
 
-        # Ignore these message types
-        return [nil, offset + length + 2] if IGNORED_MESSAGES.include?(message_type)
-
         if klass
           valid_length = if klass::MESSAGE_LENGTH.respond_to?(:include?)
                            klass::MESSAGE_LENGTH.include?(length - 5)
@@ -110,6 +73,8 @@ module BWA
                            length - 5 == klass::MESSAGE_LENGTH
                          end
           unless valid_length
+            BWA.logger.debug " read: #{BWA.raw2str(data.slice(offset, length + 2))}"
+
             raise InvalidMessage.new("Unrecognized data length (#{length}) for message #{klass}",
                                      data)
           end
@@ -124,7 +89,10 @@ module BWA
         message.parse(data.slice(offset + 5, length - 5))
         message.instance_variable_set(:@raw_data, data.slice(offset, length + 2))
         message.instance_variable_set(:@src, src)
-        BWA.logger.debug "from spa: #{message.inspect}" unless common_messages.include?(message_type)
+        if message.log?
+          BWA.logger.debug " read: #{BWA.raw2str(data.slice(offset, length + 2))}"
+          BWA.logger.info "from spa: #{message.inspect}"
+        end
         [message, offset + length + 2]
       end
 
@@ -150,14 +118,17 @@ module BWA
       @src = 0x0a
     end
 
+    def log?
+      true
+    end
+
     def parse(_data); end
 
     def serialize(message = "")
       length = message.length + 5
-      full_message = (+"#{length.chr}#{src.chr}#{self.class::MESSAGE_TYPE}#{message}")
-                     .force_encoding(Encoding::ASCII_8BIT)
+      full_message = "#{length.chr}#{src.chr}#{self.class::MESSAGE_TYPE}#{message}"
       checksum = CRC.checksum(full_message)
-      (+"\x7e#{full_message}#{checksum.chr}\x7e").force_encoding(Encoding::ASCII_8BIT)
+      "\x7e#{full_message}#{checksum.chr}\x7e".b
     end
 
     def inspect
@@ -170,7 +141,10 @@ require "bwa/messages/configuration"
 require "bwa/messages/configuration_request"
 require "bwa/messages/control_configuration"
 require "bwa/messages/control_configuration_request"
+require "bwa/messages/error"
 require "bwa/messages/filter_cycles"
+require "bwa/messages/new_client_clear_to_send"
+require "bwa/messages/nothing_to_send"
 require "bwa/messages/ready"
 require "bwa/messages/set_target_temperature"
 require "bwa/messages/set_temperature_scale"

data/lib/bwa/messages/configuration.rb

@@ -3,7 +3,7 @@
 module BWA
   module Messages
     class Configuration < Message
-      MESSAGE_TYPE = (+"\xbf\x94").force_encoding(Encoding::ASCII_8BIT)
+      MESSAGE_TYPE = "\xbf\x94".b
       MESSAGE_LENGTH = 25
 
       def inspect

data/lib/bwa/messages/configuration_request.rb

@@ -3,7 +3,7 @@
 module BWA
   module Messages
     class ConfigurationRequest < Message
-      MESSAGE_TYPE = (+"\xbf\x04").force_encoding(Encoding::ASCII_8BIT)
+      MESSAGE_TYPE = "\xbf\x04".b
       MESSAGE_LENGTH = 0
 
       def inspect

data/lib/bwa/messages/control_configuration.rb

@@ -3,7 +3,7 @@
 module BWA
   module Messages
     class ControlConfiguration < Message
-      MESSAGE_TYPE = (+"\xbf\x24").force_encoding(Encoding::ASCII_8BIT)
+      MESSAGE_TYPE = "\xbf\x24".b
       MESSAGE_LENGTH = 21
 
       attr_accessor :model, :version
@@ -25,7 +25,7 @@ module BWA
     end
 
     class ControlConfiguration2 < Message
-      MESSAGE_TYPE = (+"\xbf\x2e").force_encoding(Encoding::ASCII_8BIT)
+      MESSAGE_TYPE = "\xbf\x2e".b
       MESSAGE_LENGTH = 6
 
       attr_accessor :pumps, :lights, :circulation_pump, :blower, :mister, :aux

data/lib/bwa/messages/control_configuration_request.rb

@@ -3,7 +3,7 @@
 module BWA
   module Messages
     class ControlConfigurationRequest < Message
-      MESSAGE_TYPE = (+"\xbf\x22").force_encoding(Encoding::ASCII_8BIT)
+      MESSAGE_TYPE = "\xbf\x22".b
       MESSAGE_LENGTH = 3
 
       attr_accessor :type

data/lib/bwa/messages/error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BWA
+  module Messages
+    class Error < Message
+      MESSAGE_TYPE = "\xbf\xe1".b
+      MESSAGE_LENGTH = 1
+
+      def log?
+        BWA.verbosity >= 1
+      end
+
+      def inspect
+        "#<BWA::Messages::Error>"
+      end
+    end
+  end
+end

data/lib/bwa/messages/filter_cycles.rb

@@ -7,7 +7,7 @@ module BWA
                     :cycle2_enabled, :cycle2_start_hour, :cycle2_start_minute, :cycle2_duration
       alias_method :cycle2_enabled?, :cycle2_enabled
 
-      MESSAGE_TYPE = (+"\xbf\x23").force_encoding(Encoding::ASCII_8BIT)
+      MESSAGE_TYPE = "\xbf\x23".b
       MESSAGE_LENGTH = 8
 
       def parse(data)

data/lib/bwa/messages/new_client_clear_to_send.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BWA
+  module Messages
+    class NewClientClearToSend < Message
+      MESSAGE_TYPE = "\xbf\0".b
+      MESSAGE_LENGTH = 0
+
+      def log?
+        BWA.verbosity >= 2
+      end
+
+      def inspect
+        "#<BWA::Messages::NewClientClearToSend>"
+      end
+    end
+  end
+end

data/lib/bwa/messages/nothing_to_send.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BWA
+  module Messages
+    class NothingToSend < Message
+      MESSAGE_TYPE = "\xbf\x07".b
+      MESSAGE_LENGTH = 0
+
+      def log?
+        BWA.verbosity >= 2
+      end
+
+      def inspect
+        "#<BWA::Messages::NothingToSend>"
+      end
+    end
+  end
+end

data/lib/bwa/messages/ready.rb

@@ -3,9 +3,13 @@
 module BWA
   module Messages
     class Ready < Message
-      MESSAGE_TYPE = (+"\xbf\06").force_encoding(Encoding::ASCII_8BIT)
+      MESSAGE_TYPE = "\xbf\06".b
       MESSAGE_LENGTH = 0
 
+      def log?
+        BWA.verbosity >= 2
+      end
+
       def inspect
         "#<BWA::Messages::Ready>"
       end

data/lib/bwa/messages/set_target_temperature.rb

@@ -3,7 +3,7 @@
 module BWA
   module Messages
     class SetTargetTemperature < Message
-      MESSAGE_TYPE = (+"\xbf\x20").force_encoding(Encoding::ASCII_8BIT)
+      MESSAGE_TYPE = "\xbf\x20".b
       MESSAGE_LENGTH = 1
 
       attr_accessor :temperature

data/lib/bwa/messages/set_temperature_scale.rb

@@ -3,7 +3,7 @@
 module BWA
   module Messages
     class SetTemperatureScale < Message
-      MESSAGE_TYPE = (+"\xbf\x27").force_encoding(Encoding::ASCII_8BIT)
+      MESSAGE_TYPE = "\xbf\x27".b
       MESSAGE_LENGTH = 2
 
       attr_accessor :scale

data/lib/bwa/messages/set_time.rb

@@ -3,7 +3,7 @@
 module BWA
   module Messages
     class SetTime < Message
-      MESSAGE_TYPE = (+"\xbf\x21").force_encoding(Encoding::ASCII_8BIT)
+      MESSAGE_TYPE = "\xbf\x21".b
       MESSAGE_LENGTH = 2
 
       attr_accessor :hour, :minute, :twenty_four_hour_time

data/lib/bwa/messages/status.rb

@@ -5,6 +5,7 @@ module BWA
     class Status < Message
       attr_accessor :hold,
                     :priming,
+                    :notification,
                     :heating_mode,
                     :twenty_four_hour_time,
                     :filter_cycles,
@@ -25,16 +26,24 @@ module BWA
       alias_method :twenty_four_hour_time?, :twenty_four_hour_time
       alias_method :heating?, :heating
 
-      MESSAGE_TYPE = (+"\xaf\x13").force_encoding(Encoding::ASCII_8BIT)
+      MESSAGE_TYPE = "\xaf\x13".b
       # additional features have been added in later versions
       MESSAGE_LENGTH = (24..32).freeze
 
+      NOTIFICATIONS = {
+        0x00 => nil,
+        0x0a => :ph,
+        0x04 => :filter,
+        0x09 => :sanitizer
+      }.freeze
+
       def initialize
         super
 
         @src = 0xff
         self.hold = false
         self.priming = false
+        self.notification = nil
         self.heating_mode = :ready
         @temperature_scale = :fahrenheit
         self.twenty_four_hour_time = false
@@ -50,18 +59,22 @@ module BWA
         self.target_temperature = 100
       end
 
+      def log?
+        BWA.verbosity >= 1
+      end
+
       def parse(data)
         flags = data[0].ord
         self.hold = (flags & 0x05 != 0)
 
-        flags = data[1].ord
-        self.priming = (flags & 0x01 == 0x01)
+        self.priming = data[1].ord == 0x01
         flags = data[5].ord
         self.heating_mode = case flags & 0x03
                             when 0x00 then :ready
                             when 0x01 then :rest
                             when 0x02 then :ready_in_rest
                             end
+        self.notification = data[1].ord == 0x03 && NOTIFICATIONS[data[6].ord]
         flags = data[9].ord
         self.temperature_scale = (flags & 0x01 == 0x01) ? :celsius : :fahrenheit
         self.twenty_four_hour_time = (flags & 0x02 == 0x02)
@@ -104,10 +117,17 @@ module BWA
       def serialize
         data = "\x00" * 24
         data[0] = (hold ? 0x05 : 0x00).chr
-        data[1] = (priming ? 0x01 : 0x00).chr
+        data[1] = if priming
+                    0x01
+                  elsif notification
+                    0x04
+                  else
+                    0x00
+                  end.chr
         data[5] = { ready: 0x00,
                     rest: 0x01,
                     ready_in_rest: 0x02 }[heating_mode].chr
+        data[6] = NOTIFICATIONS.invert[notification].chr
         flags = 0
         flags |= 0x01 if temperature_scale == :celsius
         flags |= 0x02 if twenty_four_hour_time
@@ -169,6 +189,7 @@ module BWA
 
         items << "hold" if hold
         items << "priming" if priming
+        items << "notification=#{notification}" if notification
         items << self.class.format_time(hour, minute, twenty_four_hour_time: twenty_four_hour_time)
         items << "#{current_temperature || "--"}/#{target_temperature}°#{temperature_scale.to_s[0].upcase}"
         items << "filter_cycles=#{filter_cycles.inspect}"

data/lib/bwa/messages/toggle_item.rb

@@ -3,7 +3,7 @@
 module BWA
   module Messages
     class ToggleItem < Message
-      MESSAGE_TYPE = (+"\xbf\x11").force_encoding(Encoding::ASCII_8BIT)
+      MESSAGE_TYPE = "\xbf\x11".b
       MESSAGE_LENGTH = 2
       ITEMS = {
         normal_operation: 0x01,
@@ -32,13 +32,22 @@ module BWA
         self.item = item
       end
 
+      def log?
+        return true if BWA.verbosity >= 2
+        # dunno why we receive this, but somebody is spamming the bus
+        # trying to toggle an item we don't know
+        return false if item == 0 # rubocop:disable Style/NumericPredicate could be a symbol
+
+        true
+      end
+
       def parse(data)
         self.item = ITEMS.invert[data[0].ord] || data[0].ord
       end
 
       def serialize
         data = +"\x00\x00"
-        data[0] = if item.is_a? Integer
+        data[0] = if item.is_a?(Integer)
                     item.chr
                   else
                     ITEMS[item].chr

data/lib/bwa/proxy.rb

@@ -25,7 +25,7 @@ module BWA
     end
 
     def shuffle_messages(socket1, socket2, tag)
-      leftover_data = (+"").force_encoding(Encoding::ASCII_8BIT)
+      leftover_data = "".b
       loop do
         if leftover_data.length < 2 || leftover_data.length < leftover_data[1].ord + 2
           begin

data/lib/bwa/server.rb

@@ -20,9 +20,9 @@ module BWA
 
     def send_message(socket, message)
       length = message.length + 2
-      full_message = (+"#{length.chr}#{message}").force_encoding(Encoding::ASCII_8BIT)
+      full_message = "#{length.chr}#{message}"
       checksum = CRC.checksum(full_message)
-      socket.send((+"\x7e#{full_message}#{checksum.chr}\x7e").force_encoding(Encoding::ASCII_8BIT), 0)
+      socket.send("\x7e#{full_message}#{checksum.chr}\x7e".b, 0)
     end
 
     def run_client(socket)

data/lib/bwa/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BWA
-  VERSION = "2.0.7"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: balboa_worldwide_app
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.1.0
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ccutrer-serialport
@@ -180,7 +180,10 @@ files:
 - lib/bwa/messages/configuration_request.rb
 - lib/bwa/messages/control_configuration.rb
 - lib/bwa/messages/control_configuration_request.rb
+- lib/bwa/messages/error.rb
 - lib/bwa/messages/filter_cycles.rb
+- lib/bwa/messages/new_client_clear_to_send.rb
+- lib/bwa/messages/nothing_to_send.rb
 - lib/bwa/messages/ready.rb
 - lib/bwa/messages/set_target_temperature.rb
 - lib/bwa/messages/set_temperature_scale.rb