Name	Name	Last commit message	Last commit date
Latest commit History 227 Commits
.github	.github
cert	cert
img	img
src	src
.eslintrc.json	.eslintrc.json
.gitignore	.gitignore
.npmignore	.npmignore
LICENSE	LICENSE
README.md	README.md
package-lock.json	package-lock.json
package.json	package.json
tsconfig.json	tsconfig.json

daikin-controller-cloud

NPM version Downloads Test and Release

Library to generate/retrieve tokens to communicate with the Daikin cloud and to control Daikin devices via the cloud adapters like (BRP069C4x). The Library uses the new Daikin Europe Developer cloud API since v2.0.0.

Disclaimer

All product and company names or logos are trademarksTM or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them or any associated subsidiaries! This personal project is maintained in spare time and has no business goal. Daikin is a trademark of DAIKIN INDUSTRIES, LTD.

Description

The newer Daikin devices sold since 2020 contain a newer Wifi Adapter (e.g. BRP069C4x) which only connects to the Daikin Cloud and is no longer reachable locally. These devices are only controllable through the Daikin Onecta API, which uses the OpenID Connect (OIDC) protocol for client authentication and authorization purposes.

This library facilitates interacting with the Onecta API by providing an abstraction over OIDC flows and token management.

Note: For devices with older WLAN-Adapters like BRP069A4x which can only be used by the Daikin Controller App please use the Daikin-Controller lib instead.

IMPORTANT information and best practices

The Onecta API limits each client application to 200 requests per day. Please make sure to not exceed this limit, as the API will block further requests for the day.

Because of this we propose the following usage limits to be implemented by the applications using this library:

DO NOT generate more requests while being rate limited because else the unblock time increases! Use the retryAfter property of the RateLimitError to determine how long to wait for the next request.
Better always read the full device details rather than single devices to make best use of the rate limit
A default polling interval of 15 minutes should be sufficient for most use cases while leaving some space for controlling the devices too.
Consider using a (longer) slow polling interval for timeframes where updated data are not that important - with this the normal polling interval could be faster.
After you have "set" a value, wait at least 1-2 minutes before you read the updated values again because executing commands and updating the cloud data can take some time
Ideally have at least 10 minutes time between switching the device power status because else thats bad for the moving parts of the devices

Pre-requisites

This library acts as an OIDC client towards the Onecta API and uses OIDC's Authorization grant to obtain the initial pair of OIDC tokens. As such, you'll have to provide the following:

The Client ID and Client Secret of a registered application tied to your Daiking Developer account. If you do not have such an account, yet, you can create one in the Daikin Developer Portal
The ability for the process that uses this library to listen on a local TCP port (configurable) in order to start an HTTP server that your browser will be redirected to at the end of the Authorization grant flow
A domain name or an IP that resolves to the machine that hosts the process using this library (if running locally you will not be able to use localhost or 127.0.0.1 as it is rejected by the Onecta API)

You will have to combine the port (point 2.) and domain name (point 3.) to create the URL to be set as the application's Redirect URI in the Daikin Developer portal. Note that the same URL must also be passed as a configuration parameter of the DaikinCloudController class or is build automatically from the provided values. Also note that the Redirect URI must use the secure https: protocol and that this library ships with its own self-signed SSL/TLS certificate, which will cause your browser to present you with a security warning.

Install

npm i daikin-controller-cloud

Code-Usage example

See src/example.ts.