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

Feature: Tilt and Tilt Position #43

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
78 changes: 78 additions & 0 deletions common/info.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -948,6 +948,84 @@ description: |
so as to avoid integrations from showing a slider interface without
the Bridge having the capability of setting position.

## Tilt

The Tilt feature is used to describe a device that can control its
position in a sloping way.
The common use case is motorized blinds.

The Tilt feature requires the Open feature.

### Properties

(none)

### State Variables

(none)

### Actions

- **TiltClose()**: Close the device by tilting in one preset step.
- **TiltOpen()**: Open the device by tilting in one preset step.

### Notes

[May 2021] At this time, the Tilt feature is available only for
certain Motorized Blinds on the Bond Bridge and Bond Bridge Pro.

The feature may be
enabled or disabled via the feature toggle property `feature_tilt`,
analogous to the other feature toggles.


## Tilt Position

The Tilt Position feature is used to describe a device that can control its
position in a sloping way to specific positions as a percentage.
The common use case is motorized blinds.

The Tilt feature requires the Open feature.

### Properties

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

### State Variables

- **tilt_position**: (integer) value from -100 to +100: 0 = open,
[1, 100] = closed in the default direction, [-100, -1] = closed in the
alternative direction

### Actions

- **SeTiltPosition(tilt_position)**: Set device tilt position to
specified percentage.
- **TiltClose(amount)**: Close the device by tilting for the specified
percentage of the full range in the default direction.
- **TiltOpen(amount)**: Open the deviceby tilting for the specified
percentage of the full range in the default direction.
- **TiltAltClose(amount)**: Close the device by tilting for the specified
percentage of the full range in the alternative direction.
- **TiltAltOpen(amount)**: Open the deviceby tilting for the specified
percentage of the full range in the alternative direction.

### Notes

[May 2021] At this time, the Tilt Position feature is available only for
certain Motorized Blinds on the Bond Bridge Pro.

The feature may be
enabled or disabled via the feature toggle property `feature_tilt_position`,
analogous to the other feature toggles.
However, if `tilt_course_time` is present, it will need to also be set to a
non-negative value before the actions and state variables will be exposed,
so as to avoid integrations from showing a slider interface without
the Bridge having the capability of setting tilt position.

## FpFan

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