node-ambiclimate

A thin Node.js wrapper of the Ambi Climate HTTP API.

Installation

npm install node-ambiclimate --save

OAuth Client

Register a OAuth Client in the Ambi Dev Portal 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.

Usage

This wrapper uses a client for network communication, which in turn handles all requests against the underlying Ambi Climate API.

var ac = require('node-ambiclimate'),
    client;

client = new ac(clientId, clientSecret, username, password);

Option	Type	Description
clientId	String	As per value on Ambi Dev Portal
clientSecret	String	As per value on Ambi Dev Portal
username	String	Ambi Climate User email
password	String	Ambi Climate Password

Power Off

Power off your AC

client.off(settings, [cb])

Option	Type	Description
settings	Object	Object containing the attributes required by the underlying API: room_name and location_name
cb	function	function(err, data) {} Callback function which will be called when the HTTP request to the API is processed

Usage example:

//Using callbacks
client.off({
        room_name: 'Bedroom',
        location_name: 'Home'
    },
    function (err, data) {
        if (err) {
            console.error(err);
            return;
        }
        console.log(data);
    }
);

// Using promises
client.off({
    room_name: 'Bedroom',
    location_name: 'Home'
}).then(console.log, console.error);

Comfort Mode

Enable Comfort mode on your AC

client.comfort(settings, [cb])

Option	Type	Description
settings	Object	Object containing the attributes required by the underlying API: room_name and location_name
cb	function	function(err, data) {} Callback function which will be called when the HTTP request to the API is processed

Usage example:

//Using callbacks
client.comfort({
        room_name: 'Bedroom',
        location_name: 'Home'
    },
    function (err, data) {
        if (err) {
            console.error(err);
            return;
        }
        console.log(data);
    }
);

// Using promises
client.comfort({
    room_name: 'Bedroom',
    location_name: 'Home'
}).then(console.log, console.error);

Comfort Mode Feedback

Send feedback for Comfort mode

client.feedback(settings, [cb])

Option	Type	Description
settings	Object	Object containing the attributes required by the underlying API: room_name, location_name and value. Supported comfort values: too_hot , too_warm , bit_warm , comfortable , bit_cold , too_cold , freezing
cb	function	function(err, data) {} Callback function which will be called when the HTTP request to the API is processed

Usage example:

//Using callbacks
client.feedback({
        room_name: 'Bedroom',
        location_name: 'Home',
        value: 'bit_warm'
    },
    function (err, data) {
        if (err) {
            console.error(err);
            return;
        }
        console.log(data);
    }
);

// Using promises
client.feedback({
    room_name: 'Bedroom',
    location_name: 'Home',
    value: 'but_warm'
}).then(console.log, console.error);

Away Mode - Temperature Lower

Enable Away mode on your AC to stay below target temperature

client.away_temperature_lower(settings, [cb])

Option	Type	Description
settings	Object	Object containing the attributes required by the underlying API: room_name, location_name and value. Value represents the target temperature in celsius
cb	function	function(err, data) {} Callback function which will be called when the HTTP request to the API is processed

Usage example:

//Using callbacks
client.away_temperature_lower({
        room_name: 'Bedroom',
        location_name: 'Home',
        value: 27
    },
    function (err, data) {
        if (err) {
            console.error(err);
            return;
        }
        console.log(data);
    }
);

// Using promises
client.away_temperature_lower({
    room_name: 'Bedroom',
    location_name: 'Home',
    value: 27
}).then(console.log, console.error);

Away Mode - Temperature Upper

Enable Away mode on your AC to stay above target temperature

client.away_temperature_upper(settings, [cb])

Option	Type	Description
settings	Object	Object containing the attributes required by the underlying API: room_name, location_name and value. Value represents the target temperature in celsius
cb	function	function(err, data) {} Callback function which will be called when the HTTP request to the API is processed

Usage example:

//Using callbacks
client.away_temperature_upper({
        room_name: 'Bedroom',
        location_name: 'Home',
        value: 22
    },
    function (err, data) {
        if (err) {
            console.error(err);
            return;
        }
        console.log(data);
    }
);

// Using promises
client.away_temperature_upper({
    room_name: 'Bedroom',
    location_name: 'Home',
    value: 22
}).then(console.log, console.error);

Away Mode - Humidity Upper

Enable Away mode on your AC to stay above target humidity

client.away_humidity_upper(settings, [cb])

Option	Type	Description
settings	Object	Object containing the attributes required by the underlying API: room_name, location_name and value. Value represents the target relative humidity
cb	function	function(err, data) {} Callback function which will be called when the HTTP request to the API is processed

Usage example:

//Using callbacks
client.away_humidity_upper({
        room_name: 'Bedroom',
        location_name: 'Home',
        value: 70
    },
    function (err, data) {
        if (err) {
            console.error(err);
            return;
        }
        console.log(data);
    }
);

// Using promises
client.away_humidity_upper({
    room_name: 'Bedroom',
    location_name: 'Home',
    value: 70
}).then(console.log, console.error);

Temperature Mode

Enable Temperature mode on your AC

client.temperature(settings, [cb])

Option	Type	Description
settings	Object	Object containing the attributes required by the underlying API: room_name, location_name and value. Value represents the target temperature in celsius
cb	function	function(err, data) {} Callback function which will be called when the HTTP request to the API is processed

Usage example:

//Using callbacks
client.temperature({
        room_name: 'Bedroom',
        location_name: 'Home',
        value: 24
    },
    function (err, data) {
        if (err) {
            console.error(err);
            return;
        }
        console.log(data);
    }
);

// Using promises
client.temperature({
    room_name: 'Bedroom',
    location_name: 'Home',
    value: 24
}).then(console.log, console.error);

Sensor Temperature

Get latest sensor temperature data

client.sensor_temperature(settings, [cb])

Option	Type	Description
settings	Object	Object containing the attributes required by the underlying API: room_name, and location_name.
cb	function	function(err, data) {} Callback function which will be called when the HTTP request to the API is processed

Returns an array of objects with two attributes:

• created_on: timestamp of last recorded temperature value
• value: temperature is celsius

Usage example:

//Using callbacks
client.sensor_temperature({
        room_name: 'Bedroom',
        location_name: 'Home'
    },
    function (err, data) {
        if (err) {
            console.error(err);
            return;
        }
        console.log(data);
    }
);

// Using promises
client.sensor_temperature({
    room_name: 'Bedroom',
    location_name: 'Home'
}).then(console.log, console.error);

Sensor Humidity

Get latest sensor humidity data

client.sensor_humidity(settings, [cb])

Option	Type	Description
settings	Object	Object containing the attributes required by the underlying API: room_name, and location_name.
cb	function	function(err, data) {} Callback function which will be called when the HTTP request to the API is processed

Returns an array of objects with two attributes:

• created_on: timestamp of recorded humdity value
• value: last recorded relative humidity

Usage example:

//Using callbacks
client.sensor_humidity({
        room_name: 'Bedroom',
        location_name: 'Home'
    },
    function (err, data) {
        if (err) {
            console.error(err);
            return;
        }
        console.log(data);
    }
);

// Using promises
client.sensor_humidity({
    room_name: 'Bedroom',
    location_name: 'Home'
}).then(console.log, console.error);

Mode

Get Ambi Climate's current working mode

client.mode(settings, [cb])

Option	Type	Description
settings	Object	Object containing the attributes required by the underlying API: room_name, and location_name.
cb	function	function(err, data) {} Callback function which will be called when the HTTP request to the API is processed

Returns an array of objects with two attributes:

• mode: Current mode
• value: Value associated with mode

Usage example:

//Using callbacks
client.mode({
        room_name: 'Bedroom',
        location_name: 'Home'
    },
    function (err, data) {
        if (err) {
            console.error(err);
            return;
        }
        console.log(data);
    }
);

// Using promises
client.mode({
    room_name: 'Bedroom',
    location_name: 'Home'
}).then(console.log, console.error);

Acknowledgements

Thanks to gbrooker for developing the OAUTH2 Client for the Ambi Climate API