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);

Appliance States

Get Ambi Climate's last N appliance states

client.appliance_states(settings, [cb])

Option	Type	Description
`settings`	Object	Object containing the attributes required by the underlying API: `room_name`, `location_name`, `limit` and `offset`. Limit controls the number of states to be returned, and offset shifts the results by a number of slots.
`cb`	function	`function(err, data) {}` Callback function which will be called when the HTTP request to the API is processed

Returns an object with several parts:

paging: Object with two attributes
- limit: Reflects the input parameter of the same name
- offset: Reflects the input parameter of the same name
data: Array of state objects, where each state object has the following attributes:
- created_on: A timestamp of the reading
- power: Air conditioner power state (On, Off)
- mode: Air conditioner mode (Fan, Dry, Heat, Auto, Cool)
- swing: The operational swing state (Oscillate, Off)
- fan: The operational fan state (Auto, High, Med-High, Med, Med-low, Low, Quiet)
- temperature: The recorded temperature
error: Error message

Usage example:

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

// Using promises
client.appliance_states({
  room_name: 'Bedroom',
  location_name: 'Home',
  limit: 5,
  offset: 0
}).then(console.log, console.error);

Devices

Get users Ambi Climate device information

client.devices([cb])

Option	Type	Description
`cb`	function	`function(err, data) {}` Callback function which will be called when the HTTP request to the API is processed

Returns an object with several parts:

data: Array of device objects, where each device object has the following attributes:
- device_id: Internal identifier for the device
- room_name
- location_name
error: Error message

Usage example:

//Using callbacks
client.devices(
  function (err, data) {
    if (err) {
      console.error(err);
      return;
    }
    console.log(data);
  }
);

// Using promises
client.devices().then(console.log, console.error);

IR Feature

Get Ambi Climate's appliance IR feature - it returns list of values rather than current state

client.ir_feature(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 object with several parts:

paging: Null
data: Multi-layer object reflect current IR settings:
- auto: Object
  - fan:
    - ftype: Static value of select_option
    - value: Array of values (auto, high, med-high, med, med-low, low, quiet)
  - louver:
    - ftype: Static value of select_option
    - value: Array of values (oscillate, off)
  - swing:
    - ftype: Static value of select_option
    - value: Array of values (oscillate, off)
  - temperature:
    - ftype: Static value of select_option
    - value: Array of values (18 through to 30)
- cool: As per auto
- dry: As per auto
- fan: As per auto
- heat: As per auto
error: Error message

Usage example:

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

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

Deployment

Create deployment for appliance with Ambi Climate

client.deployment(settings, [cb])

Option	Type	Description
`settings`	Object	Object containing the attributes required by the underlying API: `room_name`, `location_name`, `mode`, `power`, and `feature`. `feature` is object with the following attributes `temperature`, `fan` and `louver`.
`cb`	function	`function(err, data) {}` Callback function which will be called when the HTTP request to the API is processed

Returns an object with several parts:

paging: Null
data: String
error: Error message

Usage example:

//Using callbacks
client.deployment(
  {
    room_name: 'Bedroom',
    location_name: 'Home',
    mode: 'cool',
    power: 'on',
    {
      temperature: 18,
      fan: 'med',
      louver, 'off'
    }
  },
  function (err, data) {
    if (err) {
      console.error(err);
      return;
    }
    console.log(data);
  }
);

// Using promises
client.devices({
  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

Name		Name	Last commit message	Last commit date
Latest commit History 48 Commits
test		test
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
ambi-auth.js		ambi-auth.js
ambi.js		ambi.js
package.json		package.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

node-ambiclimate

Installation

OAuth Client

Usage

Power Off

Comfort Mode

Comfort Mode Feedback

Away Mode - Temperature Lower

Away Mode - Temperature Upper

Away Mode - Humidity Upper

Temperature Mode

Sensor Temperature

Sensor Humidity

Mode

Appliance States

Devices

IR Feature

Deployment

Acknowledgements

About

Releases

Packages

Languages

License

alisdairjsmyth/node-ambiclimate

Folders and files

Latest commit

History

Repository files navigation

node-ambiclimate

Installation

OAuth Client

Usage

Power Off

Comfort Mode

Comfort Mode Feedback

Away Mode - Temperature Lower

Away Mode - Temperature Upper

Away Mode - Humidity Upper

Temperature Mode

Sensor Temperature

Sensor Humidity

Mode

Appliance States

Devices

IR Feature

Deployment

Acknowledgements

About

Topics

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages