nikdoof/hapz2m
1
0
Fork 0
mirror of https://github.com/nikdoof/hapz2m.git synced 2026-01-30 00:58:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Darell Tan
2024-11-22 19:20:45 +08:00
parent 9404fa6161
commit b11ab07fbb
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -2,7 +2,7 @@ hap-z2m Bridge
=============== ===============
A HomeKit <-> Zigbee2MQTT bridge written in Go, so I don't have to install more NodeJS rubbish. A HomeKit <-> Zigbee2MQTT bridge written in Go, so I don't have to install more NodeJS rubbish.
It is essentially a Homebridge + homebride-z2m replacement. It is essentially a Homebridge + homebridge-z2m replacement.
It compiles down to a <10 MB static binary instead of another 200++ MB Docker container. It compiles down to a <10 MB static binary instead of another 200++ MB Docker container.
It uses the [hap library](https://github.com/brutella/hap) for interfacing with HomeKit. It uses the [hap library](https://github.com/brutella/hap) for interfacing with HomeKit.
@@ -51,12 +51,20 @@ The pairing code for the server is generated dynamically on first startup
and printed to the console (or systemd journal). Alternatively, you can specify and printed to the console (or systemd journal). Alternatively, you can specify
it using `Pin` in the config file to have it fixed. it using `Pin` in the config file to have it fixed.
Debugging
==========
Checking the Zigbee2MQTT persisted state:
jq -r 'map_values(@base64d)' < /var/lib/hapz2m/db/z2m_state
License License
======== ========
hap-z2m is licensed under the GNU General Public License v3. hap-z2m is licensed under the GNU General Public License v3.
Copyright (C) 2023 Darell Tan Copyright (C) 2023-24 Darell Tan
This program is free software: you can redistribute it and/or modify it under This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software the terms of the GNU General Public License as published by the Free Software