Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vectronic/homebridge-velux-kfx210
A Homebridge plugin integrating with a Velux KFX 210 control panel via RaspberryPi + Pimoroni Automation HAT
https://github.com/vectronic/homebridge-velux-kfx210
automation-hat homebridge homebridge-plugin velux
Last synced: about 1 month ago
JSON representation
A Homebridge plugin integrating with a Velux KFX 210 control panel via RaspberryPi + Pimoroni Automation HAT
- Host: GitHub
- URL: https://github.com/vectronic/homebridge-velux-kfx210
- Owner: vectronic
- License: mit
- Created: 2019-07-30T16:12:17.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-16T17:18:52.000Z (over 1 year ago)
- Last Synced: 2024-11-13T11:50:01.359Z (about 2 months ago)
- Topics: automation-hat, homebridge, homebridge-plugin, velux
- Language: JavaScript
- Homepage:
- Size: 13.7 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# homebridge-velux-KFX210
> A [Homebridge](https://github.com/nfarina/homebridge) plugin integrating with a
> [Velux Smoke Vent](https://www.velux.co.uk/professional/products/roof-windows/special-function/smoke-ventilation-for-sloping-roof)
> KFX 210 control panel via RaspberryPi + [Pimoroni Automation HAT](https://shop.pimoroni.com/products/automation-hat).
### Aim
Provides:
* contact sensor for alarm state
* contact sensor for error state
* open/close switch for comfort mode
The Pimoroni Automation HAT is controlled via the provided Python API with some extremely simple Python scripts which are spawned as required by
this NodeJS plugin.
The KFX 210 control panel does not provide the ability to sense the current open/close comfort state of the
smoke vent. The state for this plugin defaults to closed on startup, so if you ensure the vent is indeed
closed at this point AND only use this plugin to open/close, the state will remain in sync.
Otherwise, you can use a separate Homekit sensor to maintain track of the vent comfort state.
### Installation
1. Install Homebridge using: `npm install -g homebridge`
1. Install this plugin using: `npm install -g homebridge-velux-kfx210`
1. Update your configuration file. See a sample `config.json` snippet below.
1. Ensure `python` is installed and on the path.
### Configuration
Example `config.json` entry:
```
"platforms": [
{
"platform": "KFX210",
"state_poll_interval": 3,
"comfort_switch_time": 0.5,
"python_path": "/usr/local/python"
}
]
```
Where:
* `state_poll_interval` is the polling interval in seconds for the `alarm` and `error` states. Default is `3`.
* `comfort_switch_time` is the time in seconds for the comfort open or close relay to be switched on. Default is `0.5`.
* `python_path` is the path to python for invoking automation HAT API. Default is `/usr/bin/python`.
**NOTE**: The `comfort_switch_time` should be set to 0.5 seconds to simulate a momentary push of a comfort button.
Any longer and it will be treated as a button hold and therefore should be set to several seconds.
### Velux Integration
The pinout for the Automation HAT is available [here](https://pinout.xyz/pinout/automation_hat)
The installation manual for Velux control panel ([PDF](https://weshare.velux.com/A/We%20Share/67803?encoding=UTF-8%C2%A0)) provides connector block information.
* Connect 5V from Automation HAT to the Common Terminals on Alarm (terminal 4) and Error (terminal 2) Velux connector blocks.
* Connect Alarm output (terminal 5) on Alarm Velux connector block to Buffered Input 1 on the Automation HAT.
* Connect Error output (terminal 3) on Error Velux connector block to Buffered Input 2 on the Automation HAT.
* Connect terminal 1 on Comfort Velux connector block to Normally Open Relay 1 on the Automation HAT.
* Connect terminal 2 on Comfort Velux connector block to Normally Open Relay 2 on the Automation HAT.
* Connect terminal 3 on Comfort Velux connector block to Common on Relay 1 and Relay 2 on the Automation HAT.