Project

cocoro

0.0
The project is in a healthy, maintained state
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.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 13.0
~> 3.0
~> 1.3.0
~> 1.7

Runtime

 Project Readme

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:

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 (or any other dev proxy with SSL support, like Charles Proxy). 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:

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:

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.

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.

Similar projects

The only similar project I'm aware of is the python cocoro module. At the time of writing this, the python module can't display any status information like current temperature/humidity.