Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/schemers/homebridge-hunterdouglas-platinum

Hunter Douglas Platinum Blinds plugin for HomeBridge
https://github.com/schemers/homebridge-hunterdouglas-platinum

blind homebridge homebridge-hunterdouglas-platinum

Last synced: 3 months ago
JSON representation

Hunter Douglas Platinum Blinds plugin for HomeBridge

Host: GitHub
URL: https://github.com/schemers/homebridge-hunterdouglas-platinum
Owner: schemers
License: mit
Created: 2020-01-08T04:15:49.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2023-03-05T01:40:58.000Z (almost 2 years ago)
Last Synced: 2023-08-24T03:05:17.685Z (over 1 year ago)
Topics: blind, homebridge, homebridge-hunterdouglas-platinum
Language: TypeScript
Size: 230 KB
Stars: 3
Watchers: 3
Forks: 2
Open Issues: 6
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# homebridge-hunterdouglas-platinum

[![NPM version](https://img.shields.io/npm/v/homebridge-hunterdouglas-platinum)](https://npmjs.org/package/homebridge-hunterdouglas-platinum)
![License](https://img.shields.io/npm/l/homebridge-hunterdouglas-platinum)
[![Downloads](https://img.shields.io/npm/dm/homebridge-hunterdouglas-platinum.svg)](https://npmjs.org/package/homebridge-hunterdouglas-platinum)

## Note

I no longer have a platinum bridge, so I not maintaing/updating this plugin as of 6/11/21. If someone wants to fork and maintain I can update this REAMDE to point to a new repository.

## Hunter Douglas Platinum plug-in for [Homebridge](https://github.com/nfarina/homebridge)

## Requirements

This plugin was recently rewritten in Typescript to use the latest capabilities of Homebridge 1.x, so it requires at a minimum:

1. Homebridge >= 1.0.0
2. Node >= 10.17.0

## Installation

1. Install homebridge using: `npm install -g homebridge`
1. Install this plug-in using: `npm install -g homebridge-hunterdouglas-platinum`
1. Update your configuration file. See example `config.json` snippet below.

## Configuration

Configuration samples (edit `~/.homebridge/config.json`):

### Direct connection via IP Address

Use this when you know the local static IP address.

```json
"platforms": [
{
"platform": "HunterDouglasPlatinum",
"ip_address": "192.168.0.100"
}
],
```

## Optional fields:

- `"statusPollingSeconds"` time in seconds to poll for blind positions. Default is 60 seconds.

* `"setPositionDelayMsecs"` time in msecs to delay actuually setting a blind position after it has changed. This smooths things out when you are dragging slider for a given slide. Default is 2500 msecs.

* `"setPositionThrottleRateMsecs"` rate limits how often we send set position commands to the gateway. Default is 5000 msecs.

* `"createVirtualRoomBlind"` Creates a virtual blind for each room that contains all the blinds in the room. Default is true. Changing this blind will change all blinds in the room. Position is set to the average position of all blinds in the room.

* `"createDiscreteBlinds"` Creates a blind for each real blind. Default is true. You might want to turn this off if you want only the virtual room blind.

* `"prefixRoomNameToBlindName"` Prefix the room name to each discrete blind name. Default is true.

* `"visibleBlindNames"` Comma-seperated list of blind names (prefixed with room name) to make visible. All other blinds are ignored. Only used when `createDiscreteBlinds` is true.

* `"topDownBottomUpBehavior"` Choose the desired behavior for Top-Down / Bottom-Up blinds. If `"topDown"` is specified, the slider will control the middle rail, and the blind will open downward. If `"bottomUp"` is specified, the slider will control the bottom rail, and the blind will open upward. Default is `"topDown"`. This setting has no effect on standard blinds (i.e., blinds with only "Bottom-Up" functionality).

## Sample config

```json
{
"platform": "HunterDouglasPlatinum",
"ip_address": "192.168.86.143",
"statusPollingSeconds": 60,
"createVirtualRoomBlind": true,
"createDiscreteBlinds": true,
"prefixRoomNameToBlindName": true
}
```

# Implemented HomeKit Accessory Types

## WindowCovering

- creates a _WindowCovering_ accessory for each discovered blind if `createDiscreteBlinds` is true

- creates a _WindowCovering_ accessory for each discovered room if `createVirtualRoomBlind` is true