cocoro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45dac1b85f589ac09c01682a1edc38cb0176736c09c7925a840f9dc2f1ccdbc9
+  data.tar.gz: 9a184111ee00c3491226efbef049b925bbd7f2e2322cfa3bf3c70645fe157e65
+SHA512:
+  metadata.gz: abc7cf5682668a46f109acab88449a7266c6c2cd08f9503c7234b2c71760f1778c8eff6cb81eb7ebe5b074d17f2da256ece113e2e4ee2e9f9864157f715e9152
+  data.tar.gz: 834021cdc1a98adeb9156961f2d36dc1098572dee7a468b62b4df0522897024a321802201758a7bd3fbfca6c7ccdb2e094987d2041ec0d406f6c4b560528e0c0

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/BlockLength:
+  Exclude:
+  - spec/**/*_spec.rb

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cocoro.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    cocoro (0.1.0)
+      faraday (~> 1.8)
+      faraday-cookie_jar (>= 0.0.7)
+      faraday_middleware (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-cookie_jar (0.0.7)
+      faraday (>= 0.8.0)
+      http-cookie (~> 1.0.0)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    multipart-post (2.1.1)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.24.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  cocoro!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec-its (~> 1.3.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Tomasz Szczęśniak-Szlagowski
+
+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,73 @@
+# Cocoro
+
+Cocoro is a Ruby gem for controlling some of SHARP's air purifiers and humidifiers that you can normally control using Cocoro Air mobile apps.
+The gem uses the same API that the mobile apps do, except it's totally unofficial, unsupported and not affiliated with SHARP in any way.
+The moment they change the APIs the gem may break completely, so use it at your own risk.
+
+I've only tested this on SHARP KI-LS70.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cocoro'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cocoro
+
+## Getting the API credentials
+
+You do need to use the official Cocoro Air mobile app first, register your device etc.
+Once you've done that, you need to find out what _app secret_ and _terminal app id key_ your Cocoro Air mobile app is using.
+To do that, you'll have to look inside the HTTPS requests that it's making. You can use
+[mitmproxy](https://mitmproxy.org/) (or any other dev proxy with SSL support, like [Charles Proxy](https://www.charlesproxy.com/)).
+On Android there'll be another obstacle - you'll need to modify the apk to allow user added CA certificates.
+
+My app secret is 43 alphanumeric characters followed by a `=` and my terminal app id key is 43 alphanumeric characters.
+
+## Usage
+
+First use the credentials to log in, get a list of your devices and choose the one you want to control:
+
+```ruby
+cocoro = Cocoro::Client.new(
+  app_secret: 'REPLACE_WITH_YOUR_CREDENTIALS',
+  terminal_app_id_key: 'REPLACE_WITH_YOUR_CREDENTIALS'
+)
+cocoro.login
+device = cocoro.devices.first
+```
+
+Now you can do various things like:
+```ruby
+device.fetch_status!.air_volume # => 'medium'
+device.set_air_volume!('quiet')
+device.fetch_status!.air_volume # => 'quiet'
+device.fetch_status!.to_h # => a hash of all the latest status information
+```
+
+## 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/spect88/cocoro.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Similar projects
+
+The only similar project I'm aware of is the [python cocoro module](https://github.com/rcmdnk/cocoro).
+At the time of writing this, the python module can't display any status information like current temperature/humidity.

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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "cocoro"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cocoro.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/cocoro/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cocoro"
+  spec.version       = Cocoro::VERSION
+  spec.authors       = ["Tomasz Szczęśniak-Szlagowski"]
+  spec.email         = ["spect88@gmail.com"]
+
+  spec.summary       = "An unofficial Cocoro Air client"
+  spec.description   = "A client library talking to the same API that the Cocoro Air mobile apps " \
+                       "do. Not affiliated with SHARP, this is a completely unofficial library " \
+                       "which may break at any moment, so use it at your own risk."
+  spec.homepage      = "https://github.com/spect88/cocoro"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/spect88/cocoro"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "faraday", "~> 1.8"
+  spec.add_dependency "faraday-cookie_jar", ">= 0.0.7"
+  spec.add_dependency "faraday_middleware", "~> 1.2"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its", "~> 1.3.0"
+  spec.add_development_dependency "rubocop", "~> 1.7"
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/cocoro/client.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require "cgi"
+require "logger"
+require "faraday"
+require "faraday_middleware"
+require "faraday-cookie_jar"
+
+require_relative "device"
+require_relative "error"
+
+module Cocoro
+  # A client for the Cocoro Air API that the official mobile apps use.
+  class Client
+    BASE_URL = "https://hms.cloudlabs.sharp.co.jp/hems/pfApi/ta"
+    BASE_HEADERS = {
+      "Content-Type": "application/json; charset=utf-8",
+      Accept: "*/*",
+      "Accept-Language" => "ja-jp",
+      "User-Agent" => <<~UA.gsub(/[\r\n ]+/, " ")
+        smartlink_v200i Mozilla/5.0
+        (iPhone; CPU iPhone OS 14_4 like Mac OS X)
+        AppleWebKit/605.1.15 (KHTML, like Gecko)
+        Mobile/15E148
+      UA
+    }.freeze
+    DEFAULT_RESULT_CHECK_INTERVAL = 0.7 # seconds
+    DEFAULT_RESULT_CHECK_MAX_ATTEMPTS = 20
+
+    def initialize(app_secret:, terminal_app_id_key:, logger: nil)
+      @app_secret = app_secret
+      @terminal_app_id_key = terminal_app_id_key
+      @logger = logger || Logger.new($stdout).tap do |l|
+        l.level = Logger::WARN
+      end
+      @client = Faraday.new(
+        url: BASE_URL,
+        headers: BASE_HEADERS
+      ) do |f|
+        f.use :cookie_jar
+        f.request :json
+        f.response :logger, @logger, { bodies: true, log_level: :debug }
+        f.response :raise_error
+        f.response :json
+        f.adapter :net_http
+      end
+    end
+
+    def login
+      body = {
+        "terminalAppId" =>
+          "https://db.cloudlabs.sharp.co.jp/clpf/key/#{@terminal_app_id_key}"
+      }
+      @client.post(
+        "setting/login?appSecret=#{CGI.escape(@app_secret)}",
+        body,
+        {}
+      )
+    end
+
+    def devices
+      response = @client.get(
+        "setting/boxInfo?appSecret=#{CGI.escape(@app_secret)}&mode=other"
+      )
+      json = response.body
+      json["box"].flat_map do |box|
+        box["echonetData"].map do |data|
+          Cocoro::Device.new(
+            client: self,
+            box_id: box["boxId"],
+            device_id: data["deviceId"],
+            echonet_node: data["echonetNode"],
+            echonet_object: data["echonetObject"],
+            name: data["labelData"]["name"]
+          )
+        end
+      end
+    end
+
+    def device_status(device:)
+      query_params = {
+        appSecret: @app_secret,
+        boxId: device.box_id,
+        echonetNode: device.echonet_node,
+        echonetObject: device.echonet_object
+      }.map { |k, v| [k, CGI.escape(v)].join("=") }
+      response = @client.get(
+        "control/deviceStatus?#{query_params.join("&")}"
+      )
+      json = response.body
+      Cocoro::Status.new(json["deviceStatus"]["status"])
+    end
+
+    def control_device(
+      device:,
+      changes: [],
+      result_check_interval: DEFAULT_RESULT_CHECK_INTERVAL,
+      result_check_max_attempts: DEFAULT_RESULT_CHECK_MAX_ATTEMPTS
+    )
+      request_id = make_control_request!(device, changes)
+      finished = false
+      attempt = 0
+      until finished
+        attempt += 1
+        result = fetch_control_result!(device, request_id)
+        finished = result["status"] == "success" || result["status"] == "unmatch"
+        next if finished
+        raise Cocoro::Error, "Device not responding" if attempt >= result_check_max_attempts
+
+        sleep result_check_interval
+      end
+    end
+
+    protected
+
+    def make_control_request!(device, changes)
+      query_params = {
+        appSecret: @app_secret,
+        boxId: device.box_id
+      }.map { |k, v| [k, CGI.escape(v)].join("=") }
+      response = @client.post(
+        "control/deviceControl?#{query_params.join("&")}",
+        controlList: [
+          {
+            deviceId: device.device_id,
+            echonetNode: device.echonet_node,
+            echonetObject: device.echonet_object,
+            status: changes
+          }
+        ]
+      )
+      response.body["controlList"].first["id"]
+    end
+
+    def fetch_control_result!(device, request_id)
+      query_params = {
+        appSecret: @app_secret,
+        boxId: device.box_id
+      }.map { |k, v| [k, CGI.escape(v)].join("=") }
+      response = @client.post(
+        "control/controlResult?#{query_params.join("&")}",
+        resultList: [{ id: request_id }]
+      )
+      result = response.body["resultList"].first
+      @logger.info("Status: #{result["status"]}")
+      raise Cocoro::Error, "Error code: #{result["errorCode"]}" if result["status"] == "error"
+
+      result
+    end
+  end
+end

data/lib/cocoro/device.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "status"
+require_relative "payloads"
+
+module Cocoro
+  Device = Struct.new(
+    :client,
+    :box_id,
+    :device_id,
+    :echonet_node,
+    :echonet_object,
+    :name,
+    keyword_init: true
+  ) do
+    def status
+      @status || fetch_status!
+    end
+
+    def fetch_status!
+      client.control_device(device: self)
+
+      @status = client.device_status(device: self)
+    end
+
+    # rubocop:disable Naming/AccessorMethodName
+    def set_power_on!(value)
+      send_payload!(:power_on, value)
+    end
+
+    def set_humidifier_on!(value)
+      send_payload!(:humidifier_on, value)
+    end
+
+    def set_air_volume!(value)
+      send_payload!(:air_volume, value)
+    end
+    # rubocop:enable Naming/AccessorMethodName
+
+    protected
+
+    def send_payload!(type, value)
+      valid_values = Cocoro::PAYLOADS[type].keys
+      unless valid_values.include?(value)
+        raise Cocoro::Error, "Invalid #{type} value: #{value}. Valid values: #{valid_values}"
+      end
+
+      payload = Cocoro::PAYLOADS[type][value]
+      client.control_device(device: self, changes: payload)
+    end
+  end
+end

data/lib/cocoro/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Cocoro
+  class Error < StandardError
+  end
+end

data/lib/cocoro/payloads.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Cocoro
+  PAYLOADS = {
+    power_on: {
+      false => [{
+        statusCode: "80",
+        valueType: "valueSingle",
+        valueSingle: {
+          code: "31"
+        }
+      }, {
+        statusCode: "f3",
+        valueType: "valueBinary",
+        valueBinary: {
+          code: "000300000000000000000000000000000000000000000000000000"
+        }
+      }],
+      true => [{
+        statusCode: "80",
+        valueType: "valueSingle",
+        valueSingle: {
+          code: "30"
+        }
+      }, {
+        statusCode: "f3",
+        valueType: "valueBinary",
+        valueBinary: {
+          code: "00030000000000000000000000FF00000000000000000000000000"
+        }
+      }]
+    },
+    humidifier_on: {
+      false => [{
+        statusCode: "f3",
+        valueType: "valueBinary",
+        valueBinary: {
+          code: "000900000000000000000000000000000000000000000000000000"
+        }
+      }],
+      true => [{
+        statusCode: "f3",
+        valueType: "valueBinary",
+        valueBinary: {
+          code: "000900000000000000000000000000FF0000000000000000000000"
+        }
+      }]
+    },
+    air_volume: {
+      "auto" => [{
+        statusCode: "f3",
+        valueType: "valueBinary",
+        valueBinary: {
+          code: "010100001000000000000000000000000000000000000000000000"
+        }
+      }],
+      "night" => [{
+        statusCode: "f3",
+        valueType: "valueBinary",
+        valueBinary: {
+          code: "010100001100000000000000000000000000000000000000000000"
+        }
+      }],
+      "pollen" => [{
+        statusCode: "f3",
+        valueType: "valueBinary",
+        valueBinary: {
+          code: "010100001300000000000000000000000000000000000000000000"
+        }
+      }],
+      "quiet" => [{
+        statusCode: "f3",
+        valueType: "valueBinary",
+        valueBinary: {
+          code: "010100001400000000000000000000000000000000000000000000"
+        }
+      }],
+      "medium" => [{
+        statusCode: "f3",
+        valueType: "valueBinary",
+        valueBinary: {
+          code: "010100001500000000000000000000000000000000000000000000"
+        }
+      }],
+      "strong" => [{
+        statusCode: "f3",
+        valueType: "valueBinary",
+        valueBinary: {
+          code: "010100001600000000000000000000000000000000000000000000"
+        }
+      }],
+      "omakase" => [{
+        statusCode: "f3",
+        valueType: "valueBinary",
+        valueBinary: {
+          code: "010000002000000000000000000000000000000000000000000000"
+        }
+      }],
+      "powerful" => [{
+        statusCode: "f3",
+        valueType: "valueBinary",
+        valueBinary: {
+          code: "010100004000000000000000000000000000000000000000000000"
+        }
+      }]
+    }
+  }.freeze
+end

data/lib/cocoro/status.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Cocoro
+  # Wrapper for device's status info format. Includes translation of the binary values.
+  class Status
+    LOCATIONS = {
+      # key: [property code, byte_offset, byte_length]
+      # Offset is 1-based because that's how logs API works too
+      temperature: ["F1", 4, 1], # °C
+      humidity: ["F1", 5, 1], # %
+      total_air_cleaned: ["F1", 22, 4], # m^3
+      pm25: ["F1", 28, 2], # ug/m^3 : sometimes weird values because of the first byte
+      f2unknown1: ["F2", 1, 1],
+      smell: ["F2", 15, 1], # 0/33/66/100 (100=dirty)
+      dust: ["F2", 16, 1], # 0/25/50/75/100 (100=dirty)
+      overall_cleanliness: ["F2", 18, 1], # 0/25/50/75/100 (100=dirty)
+      f2unknown19: ["F2", 19, 1],
+      enough_water: ["F2", 20, 1],
+      light_detected: ["F2", 21, 1],
+      air_volume: ["F3", 5, 1],
+      power_on: ["F3", 14, 1],
+      humidifier_on: ["F3", 16, 1],
+      f3unknown20: ["F3", 20, 1]
+    }.freeze
+    VALUES = {
+      enough_water: { 0 => false, 255 => true },
+      light_detected: { 0 => false, 255 => true },
+      air_volume: {
+        16 => "auto",
+        17 => "night",
+        19 => "pollen",
+        20 => "quiet",
+        21 => "medium",
+        22 => "strong",
+        32 => "omakase",
+        64 => "powerful"
+      },
+      power_on: { 0 => false, 255 => true },
+      humidifier_on: { 0 => false, 255 => true }
+    }.freeze
+
+    BOOLEAN_FIELDS = %i[enough_water light_detected power_on humidifier_on].freeze
+    NON_BOOLEAN_FIELDS = %i[
+      temperature humidity total_air_cleaned pm25 smell dust overall_cleanliness air_volume
+    ].freeze
+
+    def initialize(array_of_status_data)
+      @array = array_of_status_data
+    end
+
+    BOOLEAN_FIELDS.each do |field|
+      define_method(:"#{field}?") { read_value(field) }
+    end
+
+    NON_BOOLEAN_FIELDS.each do |field|
+      define_method(field) { read_value(field) }
+    end
+
+    # Get other data that we're not sure what it means, but could be useful for debugging
+    def unknowns
+      LOCATIONS
+        .keys
+        .select { |key| key.to_s =~ /unknown/ }
+        .map { |key| [key, read_value(key)] }
+        .to_h
+        .merge(
+          f1: read_binary_status("F1"),
+          f2: read_binary_status("F2"),
+          f3: read_binary_status("F3")
+        )
+    end
+
+    def to_h
+      (BOOLEAN_FIELDS + NON_BOOLEAN_FIELDS)
+        .map { |f| [f, read_value(f)] }
+        .to_h
+        .merge(unknowns)
+    end
+
+    protected
+
+    def read_value(name)
+      code, byte_offset, byte_length = LOCATIONS[name]
+      hex_code = read_binary_status(code)
+      return nil if hex_code.nil?
+
+      number = hex_code[(byte_offset - 1) * 2, byte_length * 2].to_i(16)
+      if VALUES[name]&.key?(number)
+        VALUES[name][number]
+      else
+        number
+      end
+    end
+
+    def read_binary_status(code)
+      @array
+        .find { |s| s["statusCode"] == code }
+        &.dig("valueBinary", "code")
+    end
+  end
+end

data/lib/cocoro/version.rb

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

data/lib/cocoro.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "cocoro/version"
+require_relative "cocoro/client"
+
+# Wrapping module. Check out Cocoro::Client for the main part.
+module Cocoro
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: cocoro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomasz Szczęśniak-Szlagowski
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: faraday-cookie_jar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: A client library talking to the same API that the Cocoro Air mobile apps
+  do. Not affiliated with SHARP, this is a completely unofficial library which may
+  break at any moment, so use it at your own risk.
+email:
+- spect88@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cocoro.gemspec
+- lib/cocoro.rb
+- lib/cocoro/client.rb
+- lib/cocoro/device.rb
+- lib/cocoro/error.rb
+- lib/cocoro/payloads.rb
+- lib/cocoro/status.rb
+- lib/cocoro/version.rb
+homepage: https://github.com/spect88/cocoro
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/spect88/cocoro
+  source_code_uri: https://github.com/spect88/cocoro
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: An unofficial Cocoro Air client
+test_files: []