Skip to content

Briiv documentation #38548

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: current
Choose a base branch
from
Draft

Briiv documentation #38548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 10 additions & 4 deletions Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,13 @@ GEM
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.17.1-aarch64-linux-gnu)
ffi (1.17.1-arm64-darwin)
ffi (1.17.1-x86_64-linux-gnu)
forwardable-extended (2.6.0)
google-protobuf (4.30.2-aarch64-linux)
bigdecimal
rake (>= 13)
google-protobuf (4.30.2-arm64-darwin)
bigdecimal
rake (>= 13)
Expand Down Expand Up @@ -86,6 +90,8 @@ GEM
multi_json (1.15.0)
mustermann (3.0.3)
ruby2_keywords (~> 0.0.1)
nokogiri (1.18.7-aarch64-linux-gnu)
racc (~> 1.4)
nokogiri (1.18.7-arm64-darwin)
racc (~> 1.4)
nokogiri (1.18.7-x86_64-linux-gnu)
Expand Down Expand Up @@ -142,10 +148,9 @@ GEM
ruby2_keywords (0.0.5)
safe_yaml (1.0.5)
sass (3.4.25)
sass-embedded (1.86.3-arm64-darwin)
google-protobuf (~> 4.30)
sass-embedded (1.86.3-x86_64-linux-gnu)
sass-embedded (1.86.3)
google-protobuf (~> 4.30)
rake (>= 13)
sass-globbing (1.1.5)
sass (>= 3.1)
sassc (2.1.0)
Expand All @@ -172,6 +177,7 @@ GEM
webrick (1.9.1)

PLATFORMS
aarch64-linux
arm64-darwin-23
x86_64-linux

Expand Down Expand Up @@ -199,4 +205,4 @@ RUBY VERSION
ruby 2.6.2p47

BUNDLED WITH
2.5.3
2.5.3
50 changes: 50 additions & 0 deletions source/_integrations/briiv.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: Briiv
description: Instructions on how to integrate Briiv air purifier into Home Assistant.
ha_category:
- Environment
- Health
- Sensor
- Fan
ha_release: 2025.2.4
ha_iot_class: Local Polling
ha_codeowners:
- '@JWFIVE'
- '@FiveCreate'
ha_domain: briiv
ha_config_flow: true
ha_platforms:
- sensor
- fan
ha_integration_type: device
---

The **Briiv** {% term integration %} allows you to control a [Briiv air purifier](https://www.briiv.co.uk).

{% include integrations/config_flow.md %}

Upon initial instalation of the **Briiv** integration, it will automatically scan for available devices on the network. As a fallback, it will allow manual entry of the devices’ IP addresses or a re-scan of the network. You will then be presented with a list of new devices and pre-existing ones. Select one and associate it with a room. Afterward, the device will be added and accessible via normal means.

Note that the device may have a schedule. Any interaction with Home Assistant will suspend the schedule for exactly one hour. After this lapse, the **Briiv** device will resume its internal schedule routine. If you want Home Assistant to determine the schedule behavior, it is recommended to remove all schedules from our native app and set desired states using Home Assistant.

It is also crucial to ensure that both Home Assistant and **Briiv** are connected to the same Wi-Fi network.

## Sensors

Currently, the integration supports the following sensors:

| Sensor metric | Unit of measurement |
|----------------------|---------------------|
| Temperature | °C |
| Humidity | %RH |
| CO2 | ppm |
| NO2 | ppm |
| VOC | ppm |
| PM1, PM2.5, PM10 | µg/m³ |

## Actions

### Fan control actions

Available actions:
`fan.set_percentage`, `fan.turn_on`, `fan.turn_off`, `fan.increase_speed`, `fan.decrease_speed`