This repo provides the pview executable whose primary purpose is to act as a
bridge between a Hunter Douglas PowerView
Hub and
Home Assistant, via the Home Assistant MQTT Integration.
pview also provides a few subcommands that can be used to interact with the
PowerView hub via the CLI.
So why do this?
- this polling issue that hangs the hub has no one working to resolve it, and causes chronic recurring issues in my home.
pviewis able to use the/api/homeautomationwebhook interface that is partially documented in the REST API to receive notifications from the hub, and allow the hub to intelligently refresh shades that fail post-move validation checks, eliminating the problematic need to manage force-refreshing of shade data.- I'm much more comfortable and productive in a single Rust repo than working across the two separate Python projects that are required for home assistant development.
To run the mqtt bridge:
-
Ensure that you have configured the MQTT integration:
-
Prepare a
.envfile with your mqtt information:
# If you want to turn up debugging, uncomment the next line
#RUST_LOG=pview=debug
# Always colorize output when running in docker
RUST_LOG_STYLE=always
# The hostname or IP address of your mqtt broker
PV_MQTT_HOST=mqtt.localdomain
PV_MQTT_PORT=1883
# If you use authentication, uncomment and fill these out
#PV_MQTT_USER=username
#PV_MQTT_PASSWORD=password- Set up your
docker-compose.yml:
version: '3.8'
services:
pv2mqtt:
image: ghcr.io/wez/pview-no-tls:latest
container_name: pv2mqtt
restart: unless-stopped
env_file:
- .env
# Host networking is required
network_mode: host- Launch it:
$ docker compose up -d- Your shades and scenes will now populate into home assistant
The docker image is currently only built for x86-64. If you run on another architecture, or don't want to use docker, then you must build it yourself:
$ cargo build --releaseYou can then install target/release/pview wherever you like.
$ pview --help
Usage: pview <COMMAND>
Commands:
list-scenes List scenes and their associated shades
list-shades List shades and their current positions
inspect-shade Show diagnostic information about a shade
move-shade Move or set the position of a shade
activate-scene Activate a scene
serve-mqtt Launch the pv2mqtt bridge, adding your hub to Home Assistant
hub-info Show diagnostic information for the hub
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help$ pview list-shades --help
List shades and their current positions
Usage: pview list-shades [OPTIONS]
Options:
--room <ROOM> Only return shades in the specified room
-h, --help Print help$ pview list-shades
ROOM SHADE POSITION
Zen Room Zen Room Middle 0%
Zen Room Zen Room Middle Middle Rail 26%
Zen Room Zen Room Right 0%
Zen Room Zen Room Right Middle Rail 25%
Bedroom 1 BedRoom 1 Left 0%
Bedroom 1 BedRoom 1 Left Middle Rail 25%
Bedroom 1 Bedroom 1 Right 0%
Bedroom 1 Bedroom 1 Right Middle Rail 25%Move or set the position of a shade
$ pview move-shade --help
Usage: pview move-shade <--motion <MOTION>|--percent <PERCENT>> <NAME>
Arguments:
<NAME> The name or id of the shade to open. Names will be compared ignoring case
Options:
--motion <MOTION> [possible values: down, heart, jog, left-tilt, right-tilt, stop, up, calibrate]
--percent <PERCENT>
-h, --help Print help$ pview move-shade --motion up "bedroom 1 left"$ pview inspect-shade --help
Show diagnostic information about a shade
Usage: pview inspect-shade <NAME>
Arguments:
<NAME> The name or id of the shade to inspect. Names will be compared ignoring case
Options:
-h, --help Print help$ pview inspect-shade "Zen room middle"
Primary(
ShadeData {
battery_status: High,
battery_strength: 181,
firmware: Some(
ShadeFirmware {
build: 3147,
index: Some(
3,
),
revision: 2,
sub_revision: 3,
},
),
capabilities: TopDownBottomUp,
battery_kind: HardWiredPowerSupply,
smart_power_supply: SmartPowerSupply {
status: 0,
id: 0,
port: 0,
},
signal_strength: None,
motor: None,
group_id: 37321,
id: 59066,
name: Some(
Base64Name(
"Zen Room Middle",
),
),
order: None,
positions: Some(
ShadePosition {
pos_kind_1: PrimaryRail,
pos_kind_2: Some(
SecondaryRail,
),
position_1: 0,
position_2: Some(
17040,
),
},
),
room_id: Some(
60490,
),
secondary_name: None,
shade_type: DuetteTopDownBottomUp,
},
)$ pview list-scenes --help
List scenes and their associated shades
Usage: pview list-scenes [OPTIONS]
Options:
--room <ROOM> Only return shades in the specified room
-h, --help Print help$ pview list-scenes
SCENE/SHADES POSITION
Open Guest
BedRoom 1 Left 0% 25%
Bedroom 1 Right 0% 25%
Zen Room Middle 0% 25%
Zen Room Right 0% 25%
$ pview activate-scene --help
Activate a scene
Usage: pview activate-scene <NAME>
Arguments:
<NAME> The name or id of the shade to inspect. Names will be compared ignoring case
Options:
-h, --help Print help$ pview hub-info --help
Show diagnostic information for the hub
Usage: pview hub-info
Options:
-h, --help Print help$ pview serve-mqtt --help
Launch the pv2mqtt bridge, adding your hub to Home Assistant
Usage: pview serve-mqtt [OPTIONS]
Options:
--host <HOST>
The mqtt broker hostname or address. You may also set this via the PV_MQTT_HOST environment variable
--port <PORT>
The mqtt broker port You may also set this via the PV_MQTT_PORT environment variable. If unspecified, uses 1883
--username <USERNAME>
The username to authenticate against the broker You may also set this via the PV_MQTT_USER environment variable
--password <PASSWORD>
The password to authenticate against the broker You may also set this via the PV_MQTT_PASSWORD environment variable
--bind-address <BIND_ADDRESS>
--discovery-prefix <DISCOVERY_PREFIX>
[default: homeassistant]
-h, --help
Print helpRecommendation is to put the mqtt options into a .env file and launch without parameters:
$ pview serve-mqtt- I can only directly test on the hardware that I have.
There is a reasonable chance that if you have shades with
tilt or other functionality that the behavior may not be optimal.
Please file an issue and be prepared to do grab some diagnostics via
curl.
