Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kmaehashi committed Jul 11, 2020
1 parent 3ecae72 commit 43fffa6
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# homebridge-nature-remo-aircon
[![npm](https://img.shields.io/npm/v/homebridge-nature-remo-cloud-aircon?style=for-the-badge)](https://www.npmjs.com/package/homebridge-nature-remo-cloud-aircon)

Homebridge Plug-in for Air Conditioner Managed by Nature Remo
# homebridge-nature-remo-cloud-aircon

Homebridge Plug-in for Air Conditioner Managed by Nature Remo.

```
npm install -g homebridge-nature-remo-cloud-aircon
```

Example:

Expand All @@ -22,4 +28,4 @@ Example:

* Please get your access token at https://home.nature.global/ and set it to `access_token`.
* `appliance_id` can be left blank if you only have one aircon.
* `skip_command_request_if_no_change` can be omitted (Default: true). With this option enabled, homebridge-nature-remo-aircon does not send command request (e.g. mode or temperature change) to Nature Remo API if the request will change nothing by comparing it with the current AC state managed by Nature Remo. You may want to turn this false if you control your AC using _both_ Nature Remo and factory hardware remotes in your Home since the latest AC state in the Nature Remo might be incorrect.
* `skip_command_request_if_no_change` can be omitted (Default: true). With this option enabled, command request (e.g. mode or temperature change) will not be sent to Nature Remo API if the request will change nothing by comparing it with the current AC state managed by Nature Remo. You may want to turn this false if you control your AC using _both_ Nature Remo and factory hardware remotes in your Home since the latest AC state in the Nature Remo might be incorrect.
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ let hap;

module.exports = homebridge => {
hap = homebridge.hap;
homebridge.registerAccessory('homebridge-nature-remo-aircon', 'NatureRemoAircon', NatureRemoAircon);
homebridge.registerAccessory('homebridge-nature-remo-cloud-aircon', 'NatureRemoAircon', NatureRemoAircon);
};

class NatureRemoAircon {
Expand Down

0 comments on commit 43fffa6

Please sign in to comment.