homebridge-ambiclimate
v2.2.1
Published
Ambi Climate plugin for Homebridge
Downloads
23
Maintainers
Readme
homebridge-ambiclimate
Ambi Climate plugin for homebridge. This plugin presently supports:
- Current Temperature (implementation of Temperature Sensor Service)
- Current Relative Humidity (Implementation of Humidity Sensor Service)
- Current Fan state (Implementation of Fan Service)
- Turn On/Off (Implementation of Switch) - where "off" and "on" modes are configurable
as such each physical device appears within HomeKit Apps as four logical devices with the same name.
A separate plugin for Ambi Climate is available - homebridge-ambiclimate-thermostat exposes Ambi Climate devices as a Thermostat services within Homekit.
Installation
npm install -g homebridge-ambiclimate
This plugin augments a pre-existing implementation of homebridge. Refer to nfarina/homebridge for installation instructions.
Register a OAuth Client in the Ambi Dev Portal for each Ambi Climate device by following the steps on the Quick Start page. You require the Client Id and Client Secret of that client in order to use this wrapper.
Update your homebridge configuration file (as below).
Configuration
"accessories" : [
{
"accessory": "AmbiClimate",
"name": "<Name for Accessory>",
"roomName": "<Name of Ambi Climate Device>",
"locationName": "<Name of Ambi Climate Location>",
"clientId": "<Ambi Climate OAuth Client Id>",
"clientSecret": "<Ambi Climate OAuth Client Secret>",
"username": "<Ambi Climate Username>",
"password": "<Ambi Climate Password>",
"onMode": "Comfort",
"offMode": "Away_Temperature_Upper",
"offValue": 25
}
]
Separate homebridge accessories can be defined for each Ambi Climate device to be controlled.
accessory
: Must be "AmbiClimate"name
: Can be anything, this will be the name of the Accessory within HomeKit Appsroom_name
: Must match the value within the Ambi Climate Applocation_name
: Must match the value within the Ambi Climate AppclientId
: The Client Id value for the OAUTH Client obtained from Ambi Dev PortalclientSecret
: The Client Secret value for the OAUTH Client obtained from Ambi Dev Portalusername
: Your Ambi Climate usernamepassword
: Your Ambi Climate passwordonMode
: (Optional) The mode to put Ambi Climate into when turning it on - defaults to ComfortonValue
: (Optional) Value associated with the on modeoffMode
: (Optional) The mode to put Ambi Climate into when turning it offMode - defaults to OffoffValue
: (Optional) Value associated with the off mode
The following values are supported for onMode
and offMode
:
Comfort
Off
Away_Temperature_Upper
Away_Temperature_Lower
Away_Humidity_Upper
Temperature
To Do
- Refactor to a Platform plugin. This is predicated on Ambi Labs exposing a capability in their public API to retrieve all devices installed in a given location.
- Implement Fan Service set capabilities. This is predicated on Ambi Labs exposing a capability in their public API to set fan state.