https://github.com/joeshaw/adguardhome-homekit

HomeKit support for AdGuard Home
https://github.com/joeshaw/adguardhome-homekit

adguard-home adguardhome homecontrol homekit homekit-accessory

Last synced: 16 days ago
JSON representation

HomeKit support for AdGuard Home

• Host: GitHub
• URL: https://github.com/joeshaw/adguardhome-homekit
• Owner: joeshaw
• License: mit
• Created: 2021-12-20T03:35:03.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-20T03:47:51.000Z (about 3 years ago)
• Last Synced: 2024-06-20T06:32:37.075Z (7 months ago)
• Topics: adguard-home, adguardhome, homecontrol, homekit, homekit-accessory
• Language: Go
• Homepage:
• Size: 4.88 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# adguardhome-homekit

HomeKit support for [AdGuard Home](https://adguard.com/en/adguard-home/overview.html).

This service publishes a HomeKit switch accessory for enabling or

disabling adblocking.

Once paired with your iOS or Mac home app, you can control it with any

service that integrates with HomeKit, including Siri, Shortcuts, and the

Apple Watch.

## Installing

The tool can be installed with:

    go install github.com/joeshaw/adguardhome-homekit@latest

You will need to create a `config.json` file with your AdGuard Home URL,

username, and password:

```json

{

   "url": "http://192.168.1.100",

   "username": "example",

   "password": "hunter2"

}

```

Then run the service:

    adguardhome-homekit -config config.json

The service will make an initial call to AdGuard Home and update its

state every 15 seconds.

To pair, open up your Home iOS app, click the + icon, choose "Add

Accessory" and then tap "Don't have a Code or Can't Scan?"  You should

see the "switch" under "Nearby Accessories."  Tap that and enter the PIN

00102003 (or whatever you chose in your config file).

## Contributing

Issues and pull requests are welcome.  When filing a PR, please make

sure the code has been run through `gofmt`.

## License

Copyright 2021 Joe Shaw

`adguardhome-homekit` is licensed under the MIT License.  See the

LICENSE file for details.