# deconz-typescript

> Asynchronous implementation of the deCONZ REST API in Typescript.

Latest version **1.2.4** (published 2022-10-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install deconz-typescript
pnpm add deconz-typescript
yarn add deconz-typescript
bun add deconz-typescript
```

## 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.2.4 |
| Published | 2022-10-20 |
| First published | 2022-10-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 76.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | thallosaurus |

## Links

- npm: https://www.npmjs.com/package/deconz-typescript
- Homepage: https://gitlab.com/thallosaurus/deconz-typescript
- npm.io page: https://npm.io/package/deconz-typescript

## Dependencies (4)

- [ws](https://npm.io/package/ws.md) ^8.9.0
- [axios](https://npm.io/package/axios.md) ^1.1.2
- [node-fetch](https://npm.io/package/node-fetch.md) ^3.2.10
- [command-line-args](https://npm.io/package/command-line-args.md) ^5.2.1

## Recent versions

- 1.2.4 (latest) — 2022-10-20
- 1.2.3 — 2022-10-20
- 1.2.2 — 2022-10-20
- 1.2.1 — 2022-10-20

## README

# deconz-ts
Asynchronous implementation of the deCONZ REST API in Typescript.

## Prerequesites
- [RaspBee I or II Zigbee shields for Raspberry Pi](https://phoscon.de/de/raspbee2) or
- [Conbee I or II Zigbee USB Gateway](https://phoscon.de/de/conbee2)
- A working instance of [deConz](https://www.dresden-elektronik.de/funk/software/deconz.html)
- node >= 16.13

## Installing
NPM: `coming soon maybe`
From Source: 
```bash
git clone https://gitlab.com/thallosaurus/deconz-typescript.git
cd deconz-typescript
yarn
```
## Running the development playground:
`yarn dev`

## Documentation
A documentated version of the api of this release is found in the docs folder after running `yarn generate:docs`. An auto-generated version that gets uploaded after every push to main can you find at [https://thallosaurus.gitlab.io/deconz-typescript/](https://thallosaurus.gitlab.io/deconz-typescript/)

## Visual Studio Code Run Config
A Run-Config for `code` is provided in `.vscode/launch.json`

## Pairing?
### Automatically (recommended)
The Pairing happens automatically. The script requests an api key from the first gateway it finds if no `config.json` file is found. If pairing is successful (alas the link button was pressed on the Web UI) it saves it into the mentioned `config.json` file and connects using it.

### Manual
Create the `config.json` file in the root of the project and fill it with the following content. Change values accordingly:

### Via Command-Line
Any program that implements this library should have a `--link` option automatically. This overrides the existing `config.json` file.

## Configuration
For default, the script searches the `process.cwd()/config.json` path for the script. Alternativly, if you want to export this to a UNIX executable, override the launch parameter like so:

```
CONFIG_PATH=/etc/ts-lights/config.conf node index.js
```

This sets the config variable globally and enables system-wide installation.

The config looks like so:
```json
{
    "host":"127.0.0.1:80",
    "apikey":"0123456789"
}
```

## Example:
```ts
import { getGroups } from "./index";

            //You can do es6 async/await...
        let d = await getGroups();
        for (let group of d) {
            let lights = await group.getLights();
            lights.forEach((light) => {
                if (light.hascolor && light.state.reachable) {
                    light.state.setState("on", true);

                    let r = Math.floor(Math.random() * 255);
                    let g = Math.floor(Math.random() * 255);
                    let b = Math.floor(Math.random() * 255);

                    let xy = ColorConverter.rgbToXy(r, g, b);
                    console.log(light.id, xy);

                    //...or use .then and .catch
                    light.state.setState("xy", [xy.x, xy.y]).then(() => {
                    }).catch(err => {
                        console.error(err, light);
                    });
                }
            })

            setTimeout(() => {
                lights.forEach(light => {
                    if (light.state.reachable) {
                        //Might throw an error if the light is not reachable
                        light.state.setState("on", false);
                    }
                })
            }, 1000);

        }
```

## What works/TODO?
- [x] Pairing
- [x] REST Datastructures inconsistencies
- [x] Attributes Setting and Getting
- [x] Lights Power State
- [x] Lights Color
- [x] Groups Power State
- [x] Groups Color
- [x] All Other States (Should work as it is implemented, if not please send a Pull Request)
- [ ] Item Operations (Deleting, creating etc)
- [ ] Rules
- [ ] Scenes
- [ ] Sensors
- [ ] Switches
- [ ] Button Events
- [ ] Touchlink
- [ ] Websocket Listener (Low Prio)

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