# @cdmnky/nexia-api

> Api for interfacing with nexia thermostat

Latest version **0.0.2** (published 2018-02-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @cdmnky/nexia-api
pnpm add @cdmnky/nexia-api
yarn add @cdmnky/nexia-api
bun add @cdmnky/nexia-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2018-02-04 |
| First published | 2018-02-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Andrew Graham |
| Maintainers | cdmnky |
| Keywords | thermostat, nexia, api, control |

## Links

- npm: https://www.npmjs.com/package/@cdmnky/nexia-api
- Repository: https://github.com/agrahamg/nexia-thermostat-api
- Homepage: https://github.com/agrahamg/nexia-thermostat-api#readme
- Issues: https://github.com/agrahamg/nexia-thermostat-api/issues
- npm.io page: https://npm.io/package/@cdmnky/nexia-api

## Dependencies (1)

- [request-promise](https://npm.io/package/request-promise.md) ^0.4.3

## Recent versions

- 0.0.2 (latest) — 2018-02-04

## README

Nexia-thermostat-api
=========
An api to control nexia thermostats


Usage
=====

* connect using a mobile id from nexia site
* use api.getHouse() to load basic info
* use commands
 

API
===
to be added soon


Activation
==========

To get the mobile ID and the api key you have to do the following:

1) Login to mynexia.com
2) Go the to Mobile tab
3) Create a new mobile device
4) Click the Get Activation code button for the new mobile device
5) Make a call to `NexiaApi.connect(activation_code)` and log the output

```js
const nexiaApi = require('nexia-api');

const activation_code = 12345;  // get this from the web ui by following directions above

nexiaApi.connect(activation_code).then((api) => {
  console.log(api);
}).catch((e) => {
  console.error(e);
});
```

---
_Source: https://npm.io/package/@cdmnky/nexia-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._