https://github.com/youridijk/homebridge-kaku-ics2000
HomeKit support for Klik Aan Klik Uit ICS-2000
https://github.com/youridijk/homebridge-kaku-ics2000
homebridge homebridge-kaku-ics2000 ics-2000 ics2000 kaku klikaanklikuit
Last synced: about 2 months ago
JSON representation
HomeKit support for Klik Aan Klik Uit ICS-2000
- Host: GitHub
- URL: https://github.com/youridijk/homebridge-kaku-ics2000
- Owner: youridijk
- License: apache-2.0
- Created: 2022-01-09T14:08:41.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-07T08:37:41.000Z (6 months ago)
- Last Synced: 2025-04-13T12:05:52.161Z (about 2 months ago)
- Topics: homebridge, homebridge-kaku-ics2000, ics-2000, ics2000, kaku, klikaanklikuit
- Language: TypeScript
- Homepage:
- Size: 822 KB
- Stars: 21
- Watchers: 6
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Klik Aan Klik Uit ICS-2000 Homebridge plugin
This plugin adds HomeKit support for the ICS-2000 from Klik Aan Klik Uit (KAKU). Although this plugin communicates
directly to the ICS-2000 in your local network, it still needs your KAKU credentials, because the current state of every
device is stored on your KAKU account. In addition, the credentials are used to get the encryption key which encrypts
every message send to the ICS-2000 and decrypts the current state data from the cloud.
An example config.json with all required keys:
```json
{
"platform": "KAKU-ICS2000",
"name": "ICS-2000",
"email": "[email protected]",
"password": "password123"
}
```
In addition, there are a few optional options:
- `deviceBlacklist` - A list of entityIDs of devices you don't want to show up in HomeKit.
- `localBackupAddress` - A backup IP-address that will be used if the IP-address of your ICS-2000 can't be found
automatically.
- `deviceConfigOverrides` - An object containing override or additional configs. The key is the device type, the value an object according to the [DeviceConfig interface](https://github.com/youridijk/ICS-2000-NodeJS/blob/main/src/kaku/model/DeviceConfig.ts).
An example config.json with those keys:
```json
{
"platform": "KAKU-ICS2000",
"name": "ICS-2000",
"email": "[email protected]",
"password": "password123",
"deviceBlacklist": [
22204109,
21053004,
20108785
],
"localBackupAddress": "192.168.1.5",
"deviceConfigOverrides": {
"6": {
"modelName": "ACDB 7000A doorbell",
"onOffFunction": 0
}
}
}
```
## TODO
| Done? | Feature |
|-------|-------------------------------------------------------------------------------------------------------------------------|
| ✅ | Proper per device hardcoded config like is dimmable, has color temp, dim function, on/off function, color temp function |
| ✅ | User configurable config per device (same config as point above) |
| ❌ | CLI script to control KAKU devices, get status and decrypt messages and start REST server |
| ✅ | REST server to control KAKU devices, get status and decrypt messages |
| ✅ | Split KAKU API code into separate NPM package |
## Contributing
At boot, this plugin will show some information for every device that it adds to HomeKit. If you want to help, you can
put your device types with a short description of the device (e.g. Zigbee dimmer, KAKU smart plug) and optionally a link
to a product page of the product, in a comment
at [issue #12](https://github.com/youridijk/homebridge-kaku-ics2000/issues/12).
If you have devices that don't respond to the commands of this plugin,
try to identify the functions it uses and open up a PR to add it to
[DeviceConfigs.ts](https://github.com/youridijk/ICS-2000-NodeJS/blob/main/src/kaku/model/DeviceConfig.ts) or open up an issue.
## ICS2000-Python
A big thanks to Stijn-Jacobs for his research on controlling the ICS-2000. This plugin is created using his research, so
checkout [ICS2000-Python](https://github.com/Stijn-Jacobs/ICS2000-Python) on GitHub.