ruuvi_decoder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5a5c8e7c19d0f0baa600ff7c8c27e72c7dba7540de5bd40f048dd523f191c37
+  data.tar.gz: 7db878cfe01d36f8e00c673b12955dc564d5d45e57447593bb7037620aafc564
+SHA512:
+  metadata.gz: 8a07a24f94e91ac1669a5801a8a553b48fb5426ea4333fa984ab5c532be568acaad62c4be4ed1ab0633777b7578a7135a2a090fd7c8989dc04c63c279b86f35d
+  data.tar.gz: 43dc03770ad562a31f0feafdb57d1d07f84587780af1bad06b4e4ac143200a43401b560f7cb2b1d1ea1b148e463e7dcede7d56f42163c3ebb06aa04afdc7f03d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+plugins:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-29
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Simo Leone
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# RuuviDecoder
+Decode data from Ruuvi sensors. 
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add ruuvi_decoder
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install ruuvi_decoder
+```
+
+## Usage
+
+The easiest way to use this library is to call `RuuviDecoder.decode` with an array of bytes or
+a binary-encoded string (from a bluetooth advertisement's vendor data). It will automatically detect the data 
+format and return an appropriate instance of a decoder class. If you know the data format
+in advance you can also directly instantiate a decoder class such as `RuuviDecoder::V5Data`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruuvi_decoder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ruuvi_decoder/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/ruuvi_decoder/v5_data.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module RuuviDecoder
+  # Decoder for V5 formatted data.
+  # https://docs.ruuvi.com/communication/bluetooth-advertisements/data-format-5-rawv2
+  class V5Data
+    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
+
+    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[18..24]
+          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[16..17], 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[15]], 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 acceleration_x_g
+      return @acceleration_x_g if defined?(@acceleration_x_g)
+
+      @acceleration_x_g = decode_16_bits_signed(raw_data[7..8], invalid: 0x8000, 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[9..10], invalid: 0x8000, 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[11..12], invalid: 0x8000, multiplier: 0.001)
+    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,
+           acceleration_x: #{acceleration_x_g} G,
+           acceleration_y: #{acceleration_y_g} G,
+           acceleration_z: #{acceleration_z_g} G,
+           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
+
+    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/version.rb

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

data/lib/ruuvi_decoder.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'ruuvi_decoder/version'
+require_relative 'ruuvi_decoder/v5_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
+# on the version tag.
+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) }
+    raise 'no decoder found' if decoder_class.nil?
+
+    decoder_class.new(raw_data)
+  end
+
+  def self.normalize_raw_data(raw_data)
+    case raw_data
+    when Enumerable
+      raw_data
+    when String
+      unless raw_data.encoding == Encoding::ASCII_8BIT
+        raise ArgumentError,
+              'raw_data must ASCII_8BIT (binary) encoded'
+      end
+
+      raw_data.bytes
+    else
+      raise ArgumentError, "raw_data must be an Enumerable of bytes or a binary-encoded String, got #{raw_data.class}"
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: ruuvi_decoder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simo Leone
+bindir: exe
+cert_chain: []
+date: 2025-03-30 00:00:00.000000000 Z
+dependencies: []
+email:
+- simo.leone@iki.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruuvi_decoder.rb
+- lib/ruuvi_decoder/v5_data.rb
+- lib/ruuvi_decoder/version.rb
+homepage: https://github.com/simoleone/ruuvi_decoder
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/simoleone/ruuvi_decoder
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Decoder for Ruuvi sensor bluetooth data packets.
+test_files: []