mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-25 19:46:52 +00:00
d2c328c817
Co-authored-by: Franck Nijhof <frenck@frenck.nl> Co-authored-by: Austin Brunkhorst <austin@xbox.com>
110 lines
2.9 KiB
Markdown
110 lines
2.9 KiB
Markdown
---
|
|
title: Snooz
|
|
description: Instructions on how to integrate SNOOZ devices into Home Assistant.
|
|
ha_category:
|
|
- Fan
|
|
ha_bluetooth: true
|
|
ha_release: '2022.11'
|
|
ha_iot_class: Local Push
|
|
ha_codeowners:
|
|
- '@AustinBrunkhorst'
|
|
ha_domain: snooz
|
|
ha_config_flow: true
|
|
ha_platforms:
|
|
- fan
|
|
ha_integration_type: integration
|
|
---
|
|
|
|
Integrates [SNOOZ](https://getsnooz.com/) devices into Home Assistant.
|
|
|
|
{% include integrations/config_flow.md %}
|
|
|
|
The SNOOZ integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
|
|
|
|
## Supported devices
|
|
|
|
- [SNOOZ White Noise Machine](https://getsnooz.com/products/snooz-white-noise-machine)
|
|
|
|
## Setup
|
|
|
|
Once a device is discovered, it needs to be put into pairing mode to complete setup.
|
|
|
|
### Entering pairing mode
|
|
|
|
1. Ensure the device is not connected to a mobile app or any other Bluetooth controller.
|
|
2. Hold your finger on the power button until all buttons begin pulsing on and off (~ 5 seconds).
|
|
|
|
<p class='img'>
|
|
<img src='/images/integrations/snooz/pairing_mode.jpg' alt='Top down view of a SNOOZ White Noise Machine, highlighting the power button.'>
|
|
</p>
|
|
|
|
## Platforms
|
|
|
|
### Fan
|
|
|
|
Devices are exposed as Fan entities with a persistent connection to the device.
|
|
|
|
Fan speed percentage is mapped to the device volume level.
|
|
|
|
<div class='note'>
|
|
Speed percentages less than 10 have no effect - they all map to a value of 1 on the device.
|
|
</div>
|
|
|
|
## Services
|
|
|
|
### Service `snooz.transition_on`
|
|
|
|
Transition the volume level over the specified duration. If the device is powered off, the transition will start at the lowest volume level.
|
|
|
|
{% my developer_call_service badge service="snooz.transition_on" %}
|
|
|
|
| Service data attribute | Optional | Description |
|
|
| ---------------------- | -------- | ----------- |
|
|
| `duration` | yes | Number of seconds to transition to target volume.
|
|
| `volume` | yes | Percentage volume level. If not specified, the volume on the device is used.
|
|
|
|
#### Automation example
|
|
|
|
```yaml
|
|
automation:
|
|
- trigger:
|
|
- platform: time
|
|
at: "04:20:00"
|
|
action:
|
|
- service: snooz.transition_on
|
|
target:
|
|
entity_id: fan.snooz_abcd
|
|
data:
|
|
volume: 33
|
|
duration: 120
|
|
```
|
|
|
|
### Service `snooz.transition_off`
|
|
|
|
Transition the volume level to the lowest setting over the specified duration, then power off the device.
|
|
|
|
<div class='note'>
|
|
Once the transition completes, the volume level is restored to the value before the transition started.
|
|
</div>
|
|
|
|
{% my developer_call_service badge service="snooz.transition_off" %}
|
|
|
|
| Service data attribute | Optional | Description |
|
|
| ---------------------- | -------- | ----------- |
|
|
| `duration` | yes | Number of seconds to complete the transition.
|
|
|
|
#### Automation example
|
|
|
|
```yaml
|
|
automation:
|
|
- trigger:
|
|
- platform: time
|
|
at: "16:20:00"
|
|
action:
|
|
- service: snooz.transition_off
|
|
target:
|
|
entity_id: fan.snooz_abcd
|
|
data:
|
|
duration: 120
|
|
```
|