# pimatic-homegear-ws

> Plugin to interface devices via Homegear WS.

Latest version **0.1.8** (published 2017-08-31) · 0 weekly downloads

## Install

```sh
npm install pimatic-homegear-ws
pnpm add pimatic-homegear-ws
yarn add pimatic-homegear-ws
bun add pimatic-homegear-ws
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2017-08-31 |
| First published | 2017-07-19 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >0.8.x |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Pascal Heinrich |
| Maintainers | pheinrich |
| Keywords | node, homegear, pimatic |

## Links

- npm: https://www.npmjs.com/package/pimatic-homegear-ws
- Repository: https://github.com/hei-pa/pimatic-homegear-ws
- Homepage: https://github.com/hei-pa/pimatic-homegear-ws#readme
- Issues: https://github.com/hei-pa/pimatic-homegear-ws/issues
- npm.io page: https://npm.io/package/pimatic-homegear-ws

## Dependencies (4)

- [ws](https://npm.io/package/ws.md) ^3.0.0
- [rxjs](https://npm.io/package/rxjs.md) ^5.4.2
- [uuid](https://npm.io/package/uuid.md) ^3.1.0
- [random-number](https://npm.io/package/random-number.md) 0.0.7

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.1.8 (latest) — 2017-08-31
- 0.1.2 (beta) — 2017-07-20
- 0.1.7 — 2017-08-30
- 0.1.6 — 2017-08-29
- 0.1.5 — 2017-07-20
- 0.1.4 — 2017-07-20
- 0.1.3 — 2017-07-20
- 0.1.1 — 2017-07-19
- 0.1.0 — 2017-07-19

## README

Pimatic Homegear WebSocket Plugin
=================================

Plugin to interface with homegear (https://www.homegear.eu) to control Homematic Switches/Thermostates.

Configuration
-------------
You can load the plugin by editing your `config.json` to include (host = Homegear IP port=Homegear Port (default:2001)).

````javascript
{
   "plugin": "homegear-ws",
   "username": "your-username", // (blank string if auth none)
   "password": "your-password", // (blank string if auth none)
   "host": "127.0.0.1",
   "port": 2001
}
````

Use the debug output in pimatic to find out the peerId and channel of the devices.
Or use `homegear -r` to bring up the homegear console, select the bidcosfamily `families select 0`
and show up your peers with `peers list`.

Switches can be defined by adding them to the `devices` section in the config file.
Set the `class` attribute to `HomematicSwitch` or `HomematicPowerSwitch`. For example:

```javascript
{
  "id": "switch-1",
  "class": "HomematicSwitch",
  "name": "TV Switch",
  "peerId": 1
}
```
```javascript
{
  "id": "power-switch-1",
  "class": "HomematicPowerSwitch",
  "name": "Light Power Switch",
  "peerId": 2
}
```

Thermostates also can be defined by adding them to the `devices` section in the config file.
Set the `class` attribute to `HomematicThermostate`. For example:

```javascript
{
  "id": "thermostate-1",
  "class": "HomematicThermostate",
  "name": "Thermostate kitchen",
  "peerId": 3
}
```

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