Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jeremynoesen/homebridge-dyson-bp01
A Homebridge plugin that adds a Dyson BP01 to HomeKit using a BroadLink RM
https://github.com/jeremynoesen/homebridge-dyson-bp01
apple-home apple-homekit dyson dyson-fan homebridge homebridge-plugin homekit homekit-accessory
Last synced: 3 months ago
JSON representation
A Homebridge plugin that adds a Dyson BP01 to HomeKit using a BroadLink RM
- Host: GitHub
- URL: https://github.com/jeremynoesen/homebridge-dyson-bp01
- Owner: jeremynoesen
- License: gpl-3.0
- Created: 2022-09-06T16:10:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-25T22:25:32.000Z (8 months ago)
- Last Synced: 2024-05-02T05:23:13.552Z (8 months ago)
- Topics: apple-home, apple-homekit, dyson, dyson-fan, homebridge, homebridge-plugin, homekit, homekit-accessory
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/homebridge-dyson-bp01
- Size: 52.3 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
# homebridge-dyson-bp01
## About
This Homebridge plugin adds a Dyson BP01 fan to HomeKit using a BroadLink RM.
## Purpose
There are currently plugins out there that can use a BroadLink RM to control many other devices; however, they break if you try to change more than one characteristic of an accessory at once. This plugin aims to fix this issue to bring a more native HomeKit experience to the IR-controlled Dyson BP01.
## Required Hardware
This plugin is designed to be used with the following devices:
- A BroadLink RM supported by [this library](https://github.com/kiwi-cam/broadlinkjs-rm)
- Note: not all "supported" models are supported. My RM4 Mini works flawlessly, while my RM4 Pro does not.
- A Dyson BP01
## Hardware Setup
### BroadLink RM Setup
1. Set up your BroadLink RM with the BroadLink app.
- For standard setup, follow the full setup process within the app. Then, in device properties, disable `Lock device`.
- For local network setup, follow the in-app setup, but stop at the "Add Devices" page. Do not continue the setup process, and close the app.
2. Place the device so that it has a direct line of sight to the fan's display.
### Dyson BP01 Setup
Using the remote provided with the fan:
1. Set the fan speed to 1.
2. Turn off oscillation.
3. Turn off the fan.
## Required Software
- Node.js 20.12.7 or higher
- Homebridge 1.8.0 or higher
## Building
You can build the project by doing the following:
1. Clone or download this repository.
2. Run `npm run build` in the folder of the repository.
## Installation
There are multiple ways to install this plugin:
- Search for `homebridge-dyson-bp01` in the Homebridge UI and click `Install` on this plugin.
- Run `hb-service add homebridge-dyson-bp01` through the Homebridge terminal.
- Run `npm install homebridge-dyson-bp01` through the Homebridge terminal.
- Run `npm install path/to/project` through the Homebridge terminal if you built the project.
After any of these, restart Homebridge.
## Configuration
It is recommended that you use the Homebridge UI to configure this plugin. Otherwise, add the following under `accessories` in the Homebridge config:
```json
{
"accessory": "DysonBP01",
"name": "Dyson Pure Cool Me",
"serialNumber": "XXX-XX-XXXXXXXX",
"macAddress": "XX:XX:XX:XX:XX:XX",
"exposeSensors": false
}
```
- `accessory` is required. This must be set to "DysonBP01" for the plugin to work.
- `name` is required. You will need to redo the Dyson BP01 hardware setup if you change this later.
- `serialNumber` is optional. Set this to the serial number of your Dyson BP01 to include it in accessory information. If formatted incorrectly, this option will be ignored.
- `macAddress` is optional, but recommended if you have multiple BroadLink RMs, so the plugin can use the right one. If formatted incorrectly, the plugin will not find any BroadLink RMs.
- `exposeSensors` is optional. Set to `true` if your BroadLink RM has the sensor cable to expose the temperature and humidity sensors. Setting to any other value will be treated as `false`. If you do not have the sensor cable, the sensors will show `0` as their values.
Restart Homebridge after changing any of these settings for them to take effect.
## Demonstration
## Troubleshooting
- Make sure your BroadLink RM is allowed through your firewall.
- If your BroadLink RM randomly stops working or does not reconnect after power loss, try assigning it a static IP address.
- If not all signals are sending, check the position of your BroadLink RM and ensure it has a direct line of sight to the fan's display.
- If the fan ever de-syncs from the plugin, use the physical remote to change its state to re-sync it.
- If the previous two events happen often, try running the plugin in a child bridge.