# node-red-contrib-home-iot-api

> Node-RED node for home-iot-api

Latest version **1.0.0** (published 2022-02-20) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install node-red-contrib-home-iot-api
pnpm add node-red-contrib-home-iot-api
yarn add node-red-contrib-home-iot-api
bun add node-red-contrib-home-iot-api
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-02-20 |
| First published | 2022-02-20 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 99.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Akash Talole |
| Maintainers | akashtalole |
| Keywords | node-red, iot |

## Links

- npm: https://www.npmjs.com/package/node-red-contrib-home-iot-api
- Repository: https://github.com/akashtalole/node-red-contrib-home-iot-api
- Homepage: https://github.com/akashtalole/node-red-contrib-home-iot-api#readme
- Issues: https://github.com/akashtalole/node-red-contrib-home-iot-api/issues
- npm.io page: https://npm.io/package/node-red-contrib-home-iot-api

## Dependencies (3)

- [q](https://npm.io/package/q.md) 1.5.1
- [request](https://npm.io/package/request.md) 2.88.2
- [file-type](https://npm.io/package/file-type.md) 12.1.0

## Recent versions

- 1.0.0 (latest) — 2022-02-20

## README

node-red-contrib-home-iot-api
================

Node-RED node for home-iot-api

The API for the EatBacon IOT project

## Install

To install the stable version use the `Menu - Manage palette - Install` 
option and search for node-red-contrib-home-iot-api, or run the following 
command in your Node-RED user directory, typically `~/.node-red`

    npm install node-red-contrib-home-iot-api

## Usage

### Methods

#### GET /devices

returns all registered devices

    skip : integer
    limit : integer
     
    Accept : 'application/json'
    Content-Type : 'application/json'

#### POST /devices



    device : 
     
    Accept : 'application/json'
    Content-Type : 'application/json'

#### POST /lighting/dimmers/{deviceId}/{value}



    deviceId : string
    value : integer
     
    Accept : 'application/json'
    Content-Type : 'application/json'

#### POST /lighting/dimmers/{deviceId}/{value}/timer/{timeunit}

sets a dimmer to a specific value on a timer

    deviceId : string
    value : integer
    timeunit : integer
    units : string
     
    Accept : 'application/json'
    Content-Type : 'application/json'

#### GET /lighting/switches/{deviceId}



    deviceId : string
     
    Accept : 'application/json'
    Content-Type : 'application/json'

#### POST /lighting/switches/{deviceId}/{value}



    deviceId : string
    value : string
     
    Accept : 'application/json'
    Content-Type : 'application/json'

#### POST /lighting/switches/{deviceId}/{value}/timer/{minutes}

sets a switch to a specific value on a timer

    deviceId : string
    value : string
    minutes : integer
     
    Accept : 'application/json'
    Content-Type : 'application/json'

#### GET /lightingSummary



     
    Accept : 'application/json'
    Content-Type : 'application/json'

#### GET /temperature



     
    Accept : 'application/json'
    Content-Type : 'application/json'

#### GET /temperature/forecast/{days}



    days : integer
     
    Accept : 'application/json'
    Content-Type : 'application/json'

#### GET /temperature/{zoneId}



    zoneId : string
     
    Accept : 'application/json'
    Content-Type : 'application/json'

#### GET /temperature/{zoneId}/heater

gets the state of the heater

    zoneId : string
     
    Accept : 'application/json'
    Content-Type : 'application/json'

#### POST /temperature/{zoneId}/heater/{state}

turns the heater on or off

    zoneId : string
    state : string
     
    Accept : 'application/json'
    Content-Type : 'application/json'

#### GET /zones



     
    Accept : 'application/json'
    Content-Type : 'application/json'

#### GET /zones/{zoneId}/quiet



    zoneId : string
     
    Accept : 'application/json'
    Content-Type : 'application/json'


## License

#### Apache-2.0

---
_Source: https://npm.io/package/node-red-contrib-home-iot-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._