Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rcmdnk/cocoro
Tools for COCORO API (SHARP products)
https://github.com/rcmdnk/cocoro
Last synced: 17 days ago
JSON representation
Tools for COCORO API (SHARP products)
- Host: GitHub
- URL: https://github.com/rcmdnk/cocoro
- Owner: rcmdnk
- License: apache-2.0
- Created: 2021-02-21T12:37:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T15:04:45.000Z (about 1 month ago)
- Last Synced: 2024-10-12T11:08:16.504Z (about 1 month ago)
- Language: Python
- Homepage: https://pypi.org/project/cocoro/
- Size: 235 KB
- Stars: 15
- Watchers: 3
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# cocoro
[](https://badge.fury.io/py/cocoro)
[](https://github.com/rcmdnk/cocoro/actions/workflows/cocoro-test.yml)
Tools for COCORO API (SHARP products).
## Install and Usage
### Using pip
$ pip install cocoro
### Using source code
Use poetry to setup the environment.
$ pip install poetry
$ git clone https://github.com/rcmdnk/cocoro.git
$ cd cocoro
$ poetry install
## Appliances
API commands were taken for Sharp, KI-JS50 (humidifying air purifier, [KI-JS50 加湿空気清浄機/空気清浄機：シャープ](https://jp.sharp/kuusei/products/kijs50/)).
It may work for other (humidifying) air purifiers.
## Requirement
You need to get `appSecret` and `terminalAppIdKey` to control appliances.
To get them, you can use [mitmproxy](https://mitmproxy.org/).
By using mitmproxy, you will see following `POST` command while you are controlling COCORO in your smart phone:
POST https://hms.cloudlabs.sharp.co.jp/hems/pfApi/ta/setting/login/?appSecret=XXXXXXXXX…
← 200 application/json 38b 308ms
Open this command and you will see following in `Request tab:
2021-02-21 21:55:40 POST https://hms.cloudlabs.sharp.co.jp/hems/pfApi/ta/setting/login/?app
Secret=<*************appSecret**********************>&serviceName=
iClub
← 200 OK application/json 38b 308ms
Request Response Detail
Host: hms.cloudlabs.sharp.co.jp
Content-Type: application/json; charset=utf-8
Connection: keep-alive
Accept: */*
User-Agent: smartlink_v200i Mozilla/5.0 (iPhone; CPU iPhone OS 14_4 like Mac OS X)
AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148
Content-Length: 110
Accept-Language: ja-jp
Accept-Encoding: gzip, deflate, br
JSON [m:auto]
{
"terminalAppId":
"https://db.cloudlabs.sharp.co.jp/clpf/key/<************terminalAppIdKey*************>"
}
Find `appSecret` and `terminalAppIdKey` values from above details.
Then, make following configuration file as **~/.config/cocoro/config.yml**:
```yml
---
appSecret: <*************appSecret**********************>
terminalAppIdKey: <************terminalAppIdKey*************>
```
## Usage
If you installed cocoro by `pip`, do:
$ cocoro [options]
If you installed from source code, go to cocoro directory, then do:
$ poetry run cocoro [options]
Available commands (``) are:
* `switch `: Control switch. Available targets: `on`, `off`.
* `humidification `: Control humidification. Available targets: `on`, `off`.
* `humi ` : Alias of humidification.
* `mode ` : Control mode. Available targets: `auto`, `sleep`, `pollen`,
`quiet`, `medium`, `high`, `recommendation`, `effective`
* `info [key]` : Show the appliance information. The available keys are:
`full`(full echonetData), `labelData`, `maker`, `model`,
`deviceType`, `name`, `place`, `yomi`, `zipCd`
If no key is give, labelData is shown.
* `version`: Show version.
* `help`: Show help.
Other options:
* `--config_file `: Set configuration file. Default file path is `~/.config/cocoro/config.yml`.
* `--appSecret `: Set appSecret (overwrite the value of config_file).
* `--terminalAppIdKey `: Set terminalAppIdKey (overwrite the value of config_file).
* `--name `: Set name of the device. If no name is given, the first device is used.
* `--log_level `: Set log level. The available levels are: `debug`, `info`, `warning` `fatal`.
## Examples
$ cocoro switch on
[INFO][Cocoro] Succeeded to control js50: switch on
$ cocoro humi off
[INFO][Cocoro] Succeeded to control js50: humidification off
$ cocoro mode auto
[INFO][Cocoro] Succeeded to control js50: mode auto
$ cocoro info
[INFO][Cocoro] Device information
{'id': 123456, 'place': 'リビング', 'name': 'my js50', 'deviceType': 'AIR_CLEANER', 'zipCd': '7890123', 'yomi': '', 'lSubInfo': '{"room_data":{"size": 10.0, "struct": "prefab", "unit": "tatami"}}'}
$ cocoro info model --log_level=warning
KIJS50
$ cocoro info maker --log_level=warning
SHARP