Repository files navigation

Orbit B-hyve component forHome Assistant.

If this integration has been useful to you, please consider chipping in and buying me a coffee!

This integration works with:

The following controllers have been verified as compatible with this integration, either by the author or members of the community. By virtue that this is an unofficial project which is not supported by the company, there is no guarantee of continued compatibility for current or future devices.

• Orbit 21004 B-hyve Smart Hose Faucet Timer with Wi-Fi Hub. The Wifi hub is required to provide the faucet timer with internet connectivity. Bluetooth connectivity with the timer is not supported.
• Orbit 57946 B-hyve Smart Indoor/Outdoor 6-Station WiFi Sprinkler System Controller.
• Orbit 57925 B-hyve Smart 8-Zone Indoor-Mount Sprinkler Controller.
• Orbit 57995 B-hyve XR.
• Orbit B-hyve XD (with the Gen 2 Wifi hub).

Note: The Wifi hub is required to provide the faucet controllers with internet connectivity.

• Orbit 71000 B-hyve Smart Flood Sensors with Wi-Fi Hub.

Note: The Wifi hub is required to provide the flood sensors with internet connectivity.

• sensor for measuring battery levels and watering history ofsprinkler_timer devices as well as the device on/off state (not to be confused with zone on/off switches).
• temperature sensor for measuring the temperature at the device.
• switch for turning a zone on/off, enabling/disabling rain delays and toggling pre-configured programs.
• binary_sensor forflood_sensor devices which provide liquid detection and temperature alerts when out of threshold.

Recommended installation is via theHome Assistant Community Store (HACS).

If you do not wish to use HACS, then please download the latest version from thereleases page and proceed to Step 2.

1. Navigate to the HACS add-on
2. Search for theOrbit B-hyve integration and install it
3. Restart Home Assistant

1. Navigate to Home Assistant Settings > Devices & Services
2. Click+ Add Integration
3. Search forOrbit B-hyve
4. Complete the guided configuration

Some common errors in set up include:

• Assuming that installing the integration via HACS is all that is required - it still needs to be configured!
• Not restarting Home Assistant after installing the integraion via HACS

Abatterysensor entity is created for any device which has a battery level to report.

Adevice statesensor entity is created for each device. This reports the state of the device, for exampleauto oroff. A device may be switched tooff either manually through the B-hyve app, or may be automatically set when battery levels are too low to operate the device correctly.

Azone historysensor entity is created for each zone. This reports the history of zone watering.

The following attributes are set on zone history sensor entities:

The BHyve flood sensor provides the followingbinary_sensor entities:

Abinary_sensor that turns on if water is detected.

Abinary_sensor that turns on if the detected temperature is over or under the set threshold. The threshold values should be set using the BHyve app.

Azoneswitch entity is created for each zone of asprinkler_timer device. This switch enables starting/stopping irrigation of a zone. Turning on the switch will enable watering of the zone for a "default" amount of time.

This default is often indicated by themanual_preset_runtime attribute, and this can be set using theset_manual_preset_runtime service or configured in the B-hyve app.

The following attributes are set on zone switch entities:

^† Only applicable if a Smart Watering program is enabled. Any rain delays or other custom programs must be considered separately.

Any watering programs which are configured for a zone switch are made available as an attribute. TheX denotes the letter of the program slot. ValuesA,B andC are well known custom slots. ProgramE is reserved for the Smart Watering plan. SlotD does not have a known use at this stage.

Please seeprogram switches below for more details.

Arain delayswitch entity is created for each discoveredsprinkler_timer device. This entity will beon whenever B-hyve reports that a device's watering schedule will be delayed due to weather conditions.

Enabling the switch will set a 24 hour rain delay on the device — for a custom rain delay, please use theenable_rain_delay service.

The following attributes are set onswitch.*_rain_delay entities, if the sensor is on:

Aprogramswitch entity is created for each program attached to each zone. These switches can be switched on or off. They can be configured using the official B-hyve app.

^† Not available onSmart Watering programs

This integration provides the following services:

Bundled in this repository is apython_script which calculates a device's next watering time and when a rain delay is scheduled to finish.

Note: HACS does not install the script automatically and they must be added manually to your HA instance.

Calculates:

1. When the next scheduled watering is for a zone by considering all enabled watering programs
2. When a device's active rain delay will finish, orNone if there is no active delay

This script creates or updates entities namedsensor.{zone_name}_next_watering andsensor.{device_name}_rain_delay_finishing.

Usage:

service:python_script.bhyve_next_wateringdata:entity_id:switch.backyard_zone

Hook these scripts up to automations to update as required:

automation:  -alias:B-hyve next watering & rain delay finishing updatertrigger:      -platform:stateentity_id:switch.backyard_zone, switch.rain_delay_lawn      -platform:homeassistantevent:startaction:      -service:python_script.bhyve_next_wateringdata:entity_id:switch.backyard_zone

To debug this integration and provide device integration for future improvements, please enable debugging in Home Assistant'sconfiguration.yaml

logger:logs:custom_components.bhyve:debugpybhyve:debug