Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Position: shades to use open_position by default #66

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 34 additions & 5 deletions common/info.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -939,14 +939,15 @@ description: |

### Properties

- **course_time**: (integer) specifies the amount of time, in milliseconds,
required for the device to fully open or close. Depending on the device
template, this property may or may not be present. Defaults to -1,
meaning unconfigured.
- **open_position**: (bool) (read-only) [added in v2.30.1] if true, then `position`
describes the "open percentage".
If false or not present, then a "closed percentage" is described.

### State Variables

- **position**: (integer) value from 0 to 100: 0 = open, 100 = closed.
- **position**: (integer) value from 0 to 100: 0 = closed, 100 = open.
(Unless `open_position` is false or absent, in which case
0 = open, 100 = closed).

### Actions

Expand All @@ -969,6 +970,34 @@ description: |
so as to avoid integrations from showing a slider interface without
the Bridge having the capability of setting position.

[January 2022] In v2.30.1, we made a switch to "open percentage" to
align with smart shade UIs in HomeKit, Crestron Home, and others.

## CourseTime

The CourseTime feature is used for shades whose RF protocols
do not natively support Position. Bond Bridge Pro emulates
a Position feature using a custom dead reckoning algorithm.
This requires the client to specify the time required for the
shade to open or close.

The CourseTime feature requires the Position feature.

### Properties

- **course_time**: (integer) specifies the amount of time, in milliseconds,
required for the device to fully open or close. Depending on the device
template, this property may or may not be present. Defaults to -1,
meaning unconfigured.

### State Variables

(none)

### Actions

(none)

## FpFan

The FpFan feature controls a fireplace fan. The FpFan feature is independent
Expand Down