Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/henry-spanka/homebridge-freeathome
Platform Plugin to manage free@home accessories via HomeBridge
https://github.com/henry-spanka/homebridge-freeathome
busch-jaeger buschjaeger freeathome homebridge homebridge-plugin homekit smarthome
Last synced: 2 months ago
JSON representation
Platform Plugin to manage free@home accessories via HomeBridge
- Host: GitHub
- URL: https://github.com/henry-spanka/homebridge-freeathome
- Owner: henry-spanka
- License: mit
- Created: 2018-03-06T16:23:52.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-13T19:19:16.000Z (over 1 year ago)
- Last Synced: 2024-05-01T01:20:18.804Z (8 months ago)
- Topics: busch-jaeger, buschjaeger, freeathome, homebridge, homebridge-plugin, homekit, smarthome
- Language: JavaScript
- Homepage:
- Size: 456 KB
- Stars: 54
- Watchers: 15
- Forks: 10
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[Install Homebridge]: https://github.com/nfarina/homebridge#installation
[Install free@home API]: https://github.com/henry-spanka/freeathome-api
[Configuration]: #Configuration
[sstadlberger]: https://github.com/sstadlberger
[Home Hub]: https://support.apple.com/en-us/HT207057
# homebridge-freeathome
Homebridge platform plugin for free@home SmartHome devices.
[](https://npmjs.org/package/homebridge-freeathome)
**IMPORTANT:** If you upgrade from `< 2.0.0` please read the [Upgrade Notes](CHANGELOG.md) carefully before installing this plugin.
# Features
* Control your Busch-Jaeger Lights, Outlets, Blinds and more with Apple devices with Homekit
* Setup automations with the HomeKit UI
* Ask Siri to control your devices
# Supported accessories
- Binary Sensors
- Outlets
- Lights
- Dimmable Lights
- Thermostats
- Door Locks
- Media Players (Sonos)
- Smoke Sensors
- Blinds / Shutters
- Window Contact Sensors
- Motion Sensors
# Custom Actuators
- A switch actuator can be exposed as a (video) DoorBell.
- A switch actuator can be exposed as a Garage Door.
# Requirements
* free@home Access Point
* A linux-based server on your home network that runs 24/7 like a Raspberry Pi.
# Setup / Installation
1. [Install Homebridge]
2. `npm install homebridge-freeathome`
3. Edit `config.json` and configure platform. See [Configuration](#configuration) section.
4. Start Homebridge
5. Star the repository ;)
# Configuration
To configure the plugin add the following json in the platform section in `config.json`.
```json
{
"platform": "free@home",
"sysIP": "",
"username": "",
"password": "",
"mappings": {},
"debug": false
}
```
Replace `` with the IP of your System Access Point.
You can configure the *mappings* if you want to ignore an actuator or channel if they are not connected/unused to hide them from the HomeKit UI. However this is only needed in rare cases. Usually you can leave this blank.
```json
{
"platform": "free@home",
"sysIP": "",
"username": "",
"password": "",
"mappings": {
"": {
"blacklist": ["ch0000", "ch0001"],
},
"": {
"blacklist": ["*"],
}
}
}
```
You can find the actuator serial in the web interface of the free@home SysAp Interface.
## (Video) DoorBell
See the [DoorBell Tutorial](docs/DoorBellTutorial.md) on how to setup the free@home DoorBell in HomeKit.
## Garage Door
See the [GarageDoor Tutorial](docs/GarageDoorTutorial.md) on how to expose a Switch actuator as a GarageDoor accessory.
## ContactSensor
The Contact Sensor uses the datapoint `odp0000` by default which might work for you and the Contact Sensor will always be shown as *Closed* in HomeKit. Unfortunately the free@home devices are not consistent and for some Contact Sensors you need to override the used datapoint. So far I've found that either *odp0000* (default) or *odp000C* works, your model might use a different datapoint. You find find the right datapoint by enabling debug mode and opening/closing the Contact Sensor. Look for the datapoint that changes it's value to either *1* or *0* depending on whether you open or close the contact.
```json
{
....
"mappings": {
"": { // e.g. ABB123456789
"contactsensor": {
"" { // e.g. ch0001
"datapoint": "" // e.g. odp000C
}
}
}
}
}
```
# Limitations
* ~~The door can not be controlled with HomeKit as the bus is not connected to the SysAp.~~
*Already implemented via free@HomeTouch 7 Panel*
* The door camera can not be accessed. You may want to use IP cameras that support the rtsp protocol and use
the video door bell.
# Notes
* The accessories can only be controlled when you're at home in your local WiFi network.
To manage your accessories remotely you need to setup an iPad/Homepod or Apple TV as a [Home Hub].
# Tips & Tricks
* Do not restart Homebridge if you are either updating the SysAp or an actuator as the accessory may be removed from
HomeKit if it is not detected during discovery.
* If the HomeKit UI does not respond to manual changes (switch pressed) or the accessory doesn't update itself log into the System Access Point interface and log out again. The SysAp might disable websocket notifications if the connection is idle for too long.
# Changelog
The changelog can be viewed [here](CHANGELOG.md).
# Upgrade Notes
Upgrade Notes can be found in the [CHANGELOG](CHANGELOG.md).
# Help
If you have any questions or help please open an issue on the GitHub project page.
# Contributing
Pull requests are always welcome. If you have a device that is not supported yet please open an issue or open a pull request with
your modifications.
# Donation
If you find my work useful you can support the ongoing development of this project by buying me a [cup of coffee](https://www.paypal.me/Hspanka)
# License
The project is subject to the MIT license unless otherwise noted. A copy can be found in the root directory of the project [LICENSE](LICENSE).