# homebridge-mqtt-blinds-simulation

> Homebridge plugin to control blinds via MQTT with simulation mode

Latest version **0.11.0** (published 2020-11-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install homebridge-mqtt-blinds-simulation
pnpm add homebridge-mqtt-blinds-simulation
yarn add homebridge-mqtt-blinds-simulation
bun add homebridge-mqtt-blinds-simulation
```

## 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.11.0 |
| Published | 2020-11-24 |
| First published | 2020-11-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 11 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | ben4523 |
| Keywords | homebridge-plugin, homebridge, blinds, window-blinds, window-covering, homekit |

## Links

- npm: https://www.npmjs.com/package/homebridge-mqtt-blinds-simulation
- Repository: https://github.com/ben4523/homebridge-mqtt-blinds-simulation
- Homepage: https://github.com/ben4523/homebridge-mqtt-blinds-simulation#readme
- Issues: https://github.com/ben4523/homebridge-mqtt-blinds-simulation/issues
- npm.io page: https://npm.io/package/homebridge-mqtt-blinds-simulation

## Dependencies (3)

- [mqtt](https://npm.io/package/mqtt.md) ^4.2.4
- [underscore](https://npm.io/package/underscore.md) ^1.8.3
- [node-persist](https://npm.io/package/node-persist.md) ^2.1.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.11.0 (latest) — 2020-11-24
- 0.10.0 — 2020-11-24
- 0.9.0 — 2020-11-24
- 0.8.0 — 2020-11-24
- 0.7.0 — 2020-11-04
- 0.6.0 — 2020-11-04
- 0.5.0 — 2020-11-04
- 0.4.0 — 2020-11-04
- 0.3.0 — 2020-11-04
- 0.2.0 — 2020-11-04

## README

# Homebridge MQTT Blinds with simulation

Homebridge plugin to control blinds via MQTT with simulation mode.

## Installation

1. install homebridge
   `npm install -g homebridge`
2. install this plugin
   `npm install -g homebridge-mqtt-blinds-simulation`
3. update your `~/.homebridge/config.json` file (use `sample-config.json` as a reference)

## Configuration

Sample accessory:

```
"accessories": [
  {
    "accessory": "Blinds",
    "name": "Kitchen",
    "topicUp": {
        "url": "",
        "message": ""
    },
    "topicDown": {
    "url": "",
    "message": ""
    },
    "topicStop": {
    "url": "",
    "message": ""
    },
    "durationUp": 27000,
    "durationDown": 25000,
    "durationOffset": 1000,
    "mqttUrl": "mqtt://localhost:1883",
    "mqttUser": "",
    "mqttPass": ""
   }
]
```

Fields:

- `accessory` must always be _Blinds_
- `name` room with blinds, e.g. _Garage_
- `topicUp` topic object for send up message
- `topicDown` topic object for send down message
- `topicStop` topic object for send stop message
- `durationUp` milliseconds to open blinds completely
- `durationDown` milliseconds to close blinds completely
- `durationOffset` [optional, default: *0*] milliseconds added to durationUp and durationDown to make sure that blinds are completely open or closed
- `mqttUrl` URL of your MQTT server
- `mqttUser` [optional] username of your MQTT server
- `mqttPass` [optional] password of your MQTT server

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