ruuvi_decoder 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5a5c8e7c19d0f0baa600ff7c8c27e72c7dba7540de5bd40f048dd523f191c37
-  data.tar.gz: 7db878cfe01d36f8e00c673b12955dc564d5d45e57447593bb7037620aafc564
+  metadata.gz: 99b8b6bb2f2f5f314e67582f0aabc785fdfc198f24a1c726fdc0a191fb58aa4f
+  data.tar.gz: 99e31ef6fd0f52cf1ca5e92b7bb1f6099f810562030af3499aef51f75f7e499a
 SHA512:
-  metadata.gz: 8a07a24f94e91ac1669a5801a8a553b48fb5426ea4333fa984ab5c532be568acaad62c4be4ed1ab0633777b7578a7135a2a090fd7c8989dc04c63c279b86f35d
-  data.tar.gz: 43dc03770ad562a31f0feafdb57d1d07f84587780af1bad06b4e4ac143200a43401b560f7cb2b1d1ea1b148e463e7dcede7d56f42163c3ebb06aa04afdc7f03d
+  metadata.gz: f7586c315d75b937be794604c1644d0bc99113ada52430d23a98d4b437bef4d80b8279dd37e6017a4e4b4b7fda1efd9b6cf2f64a5f8bf6dd0985231d1db34cc2
+  data.tar.gz: 75f76eff5fb646a841140cfe6575338257ed4c691c5bd475f26bfa82780824b2595c3afb24c33591096a1cf54928e6437abd0d49112e8e9b6747fd5250ef1438

data/.rubocop.yml

@@ -15,4 +15,7 @@ RSpec/MultipleExpectations:
   Enabled: false
 
 Metrics/MethodLength:
-  Max: 20
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 500

data/CHANGELOG.md

@@ -1,4 +1,6 @@
 ## [Unreleased]
+## [1.0.0] - 2025-03-31
+- Support all current data formats, V3, V5, C5, and encrypted V8.
 
 ## [0.1.0] - 2025-03-29
 

data/lib/ruuvi_decoder/base_data.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RuuviDecoder
+  # Abstract base class for decoders.
+  class BaseData
+    def initialize(raw_data)
+      @raw_data = RuuviDecoder.normalize_raw_data(raw_data)
+
+      raise ArgumentError, 'data is not valid for this format' unless self.class.detect(@raw_data)
+    end
+
+    def self.detect(_raw_data)
+      raise 'subclass must implement this method'
+    end
+
+    protected
+
+    attr_reader :raw_data
+
+    def decode_16_bits_signed(bytes, multiplier: 1, invalid: nil, offset: 0)
+      return if !invalid.nil? && bytes == [invalid].pack('s>').bytes
+
+      signed_int = bytes.pack('C*').unpack1('s>')
+      (signed_int + offset) * multiplier
+    end
+
+    def decode_16_bits_unsigned(bytes, multiplier: 1, invalid: nil, offset: 0)
+      return if !invalid.nil? && bytes == [invalid].pack('S>').bytes
+
+      signed_int = bytes.pack('C*').unpack1('S>')
+      (signed_int + offset) * multiplier
+    end
+
+    def decode_bitmasked_unsigned(value, mask, multiplier: 1, invalid: nil, offset: 0)
+      value &= mask
+      return if !invalid.nil? && value == invalid
+
+      (value + offset) * multiplier
+    end
+  end
+end

data/lib/ruuvi_decoder/c5_data.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module RuuviDecoder
+  # Decoder for V5 formatted data.
+  # https://docs.ruuvi.com/communication/bluetooth-advertisements/data-format-5-rawv2
+  class C5Data < BaseData
+    MANUFACTURER_ID = 0x0499
+    DATA_LENGTH_BYTES = 18
+    VERSION_TAG = 0xC5
+
+    def self.detect(raw_data)
+      raw_data.size == DATA_LENGTH_BYTES && raw_data[0] == VERSION_TAG
+    end
+
+    def mac_address
+      return @mac_address if defined?(@mac_address)
+
+      @mac_address =
+        begin
+          bytes = raw_data[12..17]
+          if bytes.all?(0xff)
+            nil
+          else
+            bytes.map { |b| format('%02x', b) }.join(':')
+          end
+        end
+    end
+
+    def sequence_number
+      return @sequence_number if defined?(@sequence_number)
+
+      @sequence_number = decode_16_bits_unsigned(raw_data[10..11], multiplier: 1, invalid: 65_535)
+    end
+
+    def movement_counter
+      return @movement_counter if defined?(@movement_counter)
+
+      @movement_counter = decode_16_bits_unsigned([0, raw_data[9]], multiplier: 1, invalid: 255)
+    end
+
+    def tx_power_dbm
+      return @tx_power_dbm if defined?(@tx_power_dbm)
+
+      @tx_power_dbm = decode_bitmasked_unsigned(raw_power_info, 0x001F, offset: -20, multiplier: 2, invalid: 31)
+    end
+
+    def battery_v
+      return @battery_v if defined?(@battery_v)
+
+      @battery_v = decode_bitmasked_unsigned(raw_power_info >> 5, 0x07FF, offset: 1600, multiplier: 0.001,
+                                                                          invalid: 2047)
+    end
+
+    def pressure_hpa
+      return @pressure_hpa if defined?(@pressure_hpa)
+
+      @pressure_hpa = decode_16_bits_unsigned(raw_data[5..6], offset: 50_000, invalid: 65_535, multiplier: 0.01)
+    end
+
+    def humidity_pct
+      return @humidity_pct if defined?(@humidity_pct)
+
+      @humidity_pct = decode_16_bits_unsigned(raw_data[3..4], multiplier: 0.0025, invalid: 65_535)
+    end
+
+    def temperature_c
+      return @temperature_c if defined?(@temperature_c)
+
+      @temperature_c = decode_16_bits_signed(raw_data[1..2], multiplier: 0.005, invalid: 0x8000)
+    end
+
+    def inspect
+      <<~INSPECT.chomp
+        <#{self.class.name}
+           temperature: #{temperature_c} C,
+           humidity: #{humidity_pct} %,
+           pressure: #{pressure_hpa} hPa,
+           battery: #{battery_v} V,
+           tx_power: #{tx_power_dbm} dBm,
+           movement_counter: #{movement_counter},
+           sequence_number: #{sequence_number},
+           mac_address: #{mac_address}
+        >
+      INSPECT
+    end
+
+    private
+
+    def raw_power_info
+      @raw_power_info = decode_16_bits_unsigned(raw_data[7..8])
+    end
+  end
+end

data/lib/ruuvi_decoder/v3_data.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module RuuviDecoder
+  # Decoder for V5 formatted data.
+  # https://docs.ruuvi.com/communication/bluetooth-advertisements/data-format-5-rawv2
+  class V3Data < BaseData
+    MANUFACTURER_ID = 0x0499
+    DATA_LENGTH_BYTES = 14
+    VERSION_TAG = 0x03
+
+    def self.detect(raw_data)
+      raw_data.size == DATA_LENGTH_BYTES && raw_data[0] == VERSION_TAG
+    end
+
+    def humidity_pct
+      return @humidity_pct if defined?(@humidity_pct)
+
+      @humidity_pct = raw_data[1] * 0.5
+    end
+
+    def temperature_c
+      return @temperature_c if defined?(@temperature_c)
+
+      sign = raw_data[2].nobits?(0x80) ? 1 : -1
+      decimal = raw_data[2] & 0x7F
+      return @temperature_c = nil if decimal > 127
+
+      fraction = raw_data[3] * 0.01
+      return @temperature_c = nil if raw_data[3] > 99
+
+      @temperature_c = sign * (decimal + fraction)
+    end
+
+    def pressure_hpa
+      return @pressure_hpa if defined?(@pressure_hpa)
+
+      @pressure_hpa = decode_16_bits_unsigned(raw_data[4..5], offset: 50_000, multiplier: 0.01)
+    end
+
+    def acceleration_x_g
+      return @acceleration_x_g if defined?(@acceleration_x_g)
+
+      @acceleration_x_g = decode_16_bits_signed(raw_data[6..7], multiplier: 0.001)
+    end
+
+    def acceleration_y_g
+      return @acceleration_y_g if defined?(@acceleration_y_g)
+
+      @acceleration_y_g = decode_16_bits_signed(raw_data[8..9], multiplier: 0.001)
+    end
+
+    def acceleration_z_g
+      return @acceleration_z_g if defined?(@acceleration_z_g)
+
+      @acceleration_z_g = decode_16_bits_signed(raw_data[10..11], multiplier: 0.001)
+    end
+
+    def battery_v
+      return @battery_v if defined?(@battery_v)
+
+      @battery_v = decode_16_bits_unsigned(raw_data[12..13], multiplier: 0.001)
+    end
+
+    def inspect
+      <<~INSPECT.chomp
+        <#{self.class.name}
+           temperature: #{temperature_c} C,
+           humidity: #{humidity_pct} %,
+           pressure: #{pressure_hpa} hPa,
+           acceleration_x: #{acceleration_x_g} G,
+           acceleration_y: #{acceleration_y_g} G,
+           acceleration_z: #{acceleration_z_g} G,
+           battery: #{battery_v} V,
+        >
+      INSPECT
+    end
+  end
+end

data/lib/ruuvi_decoder/v5_data.rb

@@ -3,16 +3,10 @@
 module RuuviDecoder
   # Decoder for V5 formatted data.
   # https://docs.ruuvi.com/communication/bluetooth-advertisements/data-format-5-rawv2
-  class V5Data
+  class V5Data < BaseData
     MANUFACTURER_ID = 0x0499
     DATA_LENGTH_BYTES = 24
-    VERSION_TAG = 5
-
-    def initialize(raw_data)
-      @raw_data = RuuviDecoder.normalize_raw_data(raw_data)
-
-      raise ArgumentError, 'data is not valid v5 data' unless self.class.detect(@raw_data)
-    end
+    VERSION_TAG = 0x05
 
     def self.detect(raw_data)
       raw_data.size == DATA_LENGTH_BYTES && raw_data[0] == VERSION_TAG
@@ -113,31 +107,8 @@ module RuuviDecoder
 
     private
 
-    attr_reader :raw_data
-
     def raw_power_info
       @raw_power_info = decode_16_bits_unsigned(raw_data[13..14])
     end
-
-    def decode_16_bits_signed(bytes, multiplier: 1, invalid: nil, offset: 0)
-      return if !invalid.nil? && bytes == [invalid].pack('s>').bytes
-
-      signed_int = bytes.pack('C*').unpack1('s>')
-      (signed_int + offset) * multiplier
-    end
-
-    def decode_16_bits_unsigned(bytes, multiplier: 1, invalid: nil, offset: 0)
-      return if !invalid.nil? && bytes == [invalid].pack('S>').bytes
-
-      signed_int = bytes.pack('C*').unpack1('S>')
-      (signed_int + offset) * multiplier
-    end
-
-    def decode_bitmasked_unsigned(value, mask, multiplier: 1, invalid: nil, offset: 0)
-      value &= mask
-      return if !invalid.nil? && value == invalid
-
-      (value + offset) * multiplier
-    end
   end
 end

data/lib/ruuvi_decoder/v8_data.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
+module RuuviDecoder
+  # Decoder for V8 formatted encrypted data. (DRAFT specification subject to change!)
+  # https://docs.ruuvi.com/communication/bluetooth-advertisements/data-format-8-encrypted-environmental
+  class V8Data < BaseData
+    MANUFACTURER_ID = 0x0499
+    DATA_LENGTH_BYTES = 24
+    VERSION_TAG = 0x08
+    # https://github.com/ruuvi/ruuvi.endpoints.c/blob/master/src/ruuvi_endpoints.c#L8
+    CRC8_TABLE = [ # rubocop:disable Metrics/CollectionLiteralLength
+      0x00, 0x07, 0x0E, 0x09, 0x1C, 0x1B, 0x12, 0x15,
+      0x38, 0x3F, 0x36, 0x31, 0x24, 0x23, 0x2A, 0x2D,
+      0x70, 0x77, 0x7E, 0x79, 0x6C, 0x6B, 0x62, 0x65,
+      0x48, 0x4F, 0x46, 0x41, 0x54, 0x53, 0x5A, 0x5D,
+      0xE0, 0xE7, 0xEE, 0xE9, 0xFC, 0xFB, 0xF2, 0xF5,
+      0xD8, 0xDF, 0xD6, 0xD1, 0xC4, 0xC3, 0xCA, 0xCD,
+      0x90, 0x97, 0x9E, 0x99, 0x8C, 0x8B, 0x82, 0x85,
+      0xA8, 0xAF, 0xA6, 0xA1, 0xB4, 0xB3, 0xBA, 0xBD,
+      0xC7, 0xC0, 0xC9, 0xCE, 0xDB, 0xDC, 0xD5, 0xD2,
+      0xFF, 0xF8, 0xF1, 0xF6, 0xE3, 0xE4, 0xED, 0xEA,
+      0xB7, 0xB0, 0xB9, 0xBE, 0xAB, 0xAC, 0xA5, 0xA2,
+      0x8F, 0x88, 0x81, 0x86, 0x93, 0x94, 0x9D, 0x9A,
+      0x27, 0x20, 0x29, 0x2E, 0x3B, 0x3C, 0x35, 0x32,
+      0x1F, 0x18, 0x11, 0x16, 0x03, 0x04, 0x0D, 0x0A,
+      0x57, 0x50, 0x59, 0x5E, 0x4B, 0x4C, 0x45, 0x42,
+      0x6F, 0x68, 0x61, 0x66, 0x73, 0x74, 0x7D, 0x7A,
+      0x89, 0x8E, 0x87, 0x80, 0x95, 0x92, 0x9B, 0x9C,
+      0xB1, 0xB6, 0xBF, 0xB8, 0xAD, 0xAA, 0xA3, 0xA4,
+      0xF9, 0xFE, 0xF7, 0xF0, 0xE5, 0xE2, 0xEB, 0xEC,
+      0xC1, 0xC6, 0xCF, 0xC8, 0xDD, 0xDA, 0xD3, 0xD4,
+      0x69, 0x6E, 0x67, 0x60, 0x75, 0x72, 0x7B, 0x7C,
+      0x51, 0x56, 0x5F, 0x58, 0x4D, 0x4A, 0x43, 0x44,
+      0x19, 0x1E, 0x17, 0x10, 0x05, 0x02, 0x0B, 0x0C,
+      0x21, 0x26, 0x2F, 0x28, 0x3D, 0x3A, 0x33, 0x34,
+      0x4E, 0x49, 0x40, 0x47, 0x52, 0x55, 0x5C, 0x5B,
+      0x76, 0x71, 0x78, 0x7F, 0x6A, 0x6D, 0x64, 0x63,
+      0x3E, 0x39, 0x30, 0x37, 0x22, 0x25, 0x2C, 0x2B,
+      0x06, 0x01, 0x08, 0x0F, 0x1A, 0x1D, 0x14, 0x13,
+      0xAE, 0xA9, 0xA0, 0xA7, 0xB2, 0xB5, 0xBC, 0xBB,
+      0x96, 0x91, 0x98, 0x9F, 0x8A, 0x8D, 0x84, 0x83,
+      0xDE, 0xD9, 0xD0, 0xD7, 0xC2, 0xC5, 0xCC, 0xCB,
+      0xE6, 0xE1, 0xE8, 0xEF, 0xFA, 0xFD, 0xF4, 0xF3
+    ].freeze
+
+    def initialize(raw_data, ruuvi_tag_id, password)
+      super(raw_data)
+
+      @ruuvi_tag_id = RuuviDecoder.normalize_raw_data(ruuvi_tag_id)
+      @password = case password
+                  when String
+                    password.bytes
+                  when Enumerable
+                    password
+                  else
+                    raise 'password must be a String or Enumerable of bytes'
+                  end
+
+      raise ArgumentError, 'ruuvi_tag_id must be 8 bytes' if @ruuvi_tag_id.size != 8
+      # fixed 16 byte key size is a quirk
+      # https://github.com/ruuvi/ruuvi.firmware.c/blob/f5e159e82d150f76988a41acf39f9d2699debc85/src/app_dataformats.c#L34
+      raise ArgumentError, 'password must be at least 8 bytes' if @password.size != 16
+    end
+
+    def self.detect(raw_data)
+      raw_data.size == DATA_LENGTH_BYTES && raw_data[0] == VERSION_TAG
+    end
+
+    def temperature_c
+      return @temperature_c if defined?(@temperature_c)
+
+      @temperature_c = decode_16_bits_signed(decrypted_raw_data[0..1], multiplier: 0.005, invalid: 0x8000)
+    end
+
+    def humidity_pct
+      return @humidity_pct if defined?(@humidity_pct)
+
+      @humidity_pct = decode_16_bits_unsigned(decrypted_raw_data[2..3], multiplier: 0.0025, invalid: 65_535)
+    end
+
+    def pressure_hpa
+      return @pressure_hpa if defined?(@pressure_hpa)
+
+      @pressure_hpa = decode_16_bits_unsigned(decrypted_raw_data[4..5], offset: 50_000, invalid: 65_535,
+                                                                        multiplier: 0.01)
+    end
+
+    def tx_power_dbm
+      return @tx_power_dbm if defined?(@tx_power_dbm)
+
+      @tx_power_dbm = decode_bitmasked_unsigned(raw_power_info, 0x001F, offset: -20, multiplier: 2, invalid: 31)
+    end
+
+    def battery_v
+      return @battery_v if defined?(@battery_v)
+
+      @battery_v = decode_bitmasked_unsigned(raw_power_info >> 5, 0x07FF, offset: 1600, multiplier: 0.001,
+                                                                          invalid: 2047)
+    end
+
+    def movement_counter
+      return @movement_counter if defined?(@movement_counter)
+
+      @movement_counter = decode_16_bits_unsigned(decrypted_raw_data[8..9], invalid: 65_535)
+    end
+
+    def sequence_number
+      return @sequence_number if defined?(@sequence_number)
+
+      @sequence_number = decode_16_bits_unsigned(decrypted_raw_data[10..11], invalid: 65_535)
+    end
+
+    def mac_address
+      return @mac_address if defined?(@mac_address)
+
+      @mac_address =
+        begin
+          bytes = raw_data[18..24]
+          if bytes.all?(0xff)
+            nil
+          else
+            bytes.map { |b| format('%02x', b) }.join(':')
+          end
+        end
+    end
+
+    def inspect
+      <<~INSPECT.chomp
+        <#{self.class.name}
+           temperature: #{temperature_c} C,
+           humidity: #{humidity_pct} %,
+           pressure: #{pressure_hpa} hPa,
+           battery: #{battery_v} V,
+           tx_power: #{tx_power_dbm} dBm,
+           movement_counter: #{movement_counter},
+           sequence_number: #{sequence_number},
+           mac_address: #{mac_address}
+        >
+      INSPECT
+    end
+
+    private
+
+    def aes_key
+      return @aes_key if defined?(@aes_key)
+
+      aes_key = @password.dup
+      (0...8).each do |idx|
+        aes_key[idx] = aes_key[idx] ^ @ruuvi_tag_id[idx]
+      end
+      @aes_key = aes_key.pack('C*')
+    end
+
+    def decrypted_raw_data
+      return @decrypted_raw_data if defined?(@decrypted_raw_data)
+
+      cipher = OpenSSL::Cipher.new('AES-128-ECB').decrypt
+      cipher.key = aes_key
+      cipher.padding = 0 # disable padding
+      @decrypted_raw_data = cipher.update(raw_data[1..16].pack('C*'))
+      @decrypted_raw_data << cipher.final
+      @decrypted_raw_data = @decrypted_raw_data.bytes
+      check_crc8!
+      @decrypted_raw_data
+    end
+
+    def check_crc8!
+      crc = @decrypted_raw_data.reduce(0x00) { |crc, byte| CRC8_TABLE[crc ^ byte] }
+      raise 'calculated CRC-8 does not match.' if crc != raw_data[17]
+    end
+
+    def raw_power_info
+      @raw_power_info = decode_16_bits_unsigned(decrypted_raw_data[6..7])
+    end
+  end
+end

data/lib/ruuvi_decoder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RuuviDecoder
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/lib/ruuvi_decoder.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
 require_relative 'ruuvi_decoder/version'
+require_relative 'ruuvi_decoder/base_data'
+require_relative 'ruuvi_decoder/v3_data'
+require_relative 'ruuvi_decoder/c5_data'
 require_relative 'ruuvi_decoder/v5_data'
+require_relative 'ruuvi_decoder/v8_data'
 
 # Decoders for various binary data formats emitted by Ruuvi bluetooth sensors.
 # Use classes directly or the static decode method to automatically select one based
@@ -10,10 +14,16 @@ module RuuviDecoder
   def self.decode(raw_data)
     raw_data = normalize_raw_data(raw_data)
 
-    # TODO(simo): implement more formats :)
-    decoder_class = [V5Data].find { |data_format| data_format.detect(raw_data) }
+    decoder_class = [
+      V3Data,
+      V5Data,
+      C5Data,
+      V8Data
+    ].find { |data_format| data_format.detect(raw_data) }
     raise 'no decoder found' if decoder_class.nil?
 
+    raise 'instantiate V8Data directly, with tag id and password' if decoder_class == V8Data
+
     decoder_class.new(raw_data)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruuvi_decoder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Simo Leone
@@ -22,7 +22,11 @@ files:
 - README.md
 - Rakefile
 - lib/ruuvi_decoder.rb
+- lib/ruuvi_decoder/base_data.rb
+- lib/ruuvi_decoder/c5_data.rb
+- lib/ruuvi_decoder/v3_data.rb
 - lib/ruuvi_decoder/v5_data.rb
+- lib/ruuvi_decoder/v8_data.rb
 - lib/ruuvi_decoder/version.rb
 homepage: https://github.com/simoleone/ruuvi_decoder
 licenses: