README.md

Homebridge AdGuard Home

Display AdGuard Home as a lock or switch accesory.

Notes

1. When updating from 1.5.1 to 1.6.0 you might need to re-add your accessories again in Home app.

Requirements

• Homebridge HomeKit support for the impatient
• AdGuard Home Network-wide ads & trackers blocking DNS server

Example config

{
  "bridge": {
    "name": "Homebridge",
    "username": "CC:22:3D:E3:CE:30",
    "port": 51826,
    "pin": "031-45-154"
  },
  "accessories": [
    {
      "accessory": "AdGuardHome",
      "name": "AdGuard",
      "username": "ADGUARD_USERNAME",
      "password": "ADGUARD_PASSWORD",
      "host": "192.168.1.2",
      "port": 80,
      "https": false,
      "type": "LOCK",
      "autoOnTimer": [1, 2, 0, 5, 10],
      "hideNonTimer": true,
      "stateLogging": false
    }
  ]
}

Available Options

• "accessory": [Mandatory] the plugin name.
• "name": [Mandatory] The name that will appear in Home app. Default: AdGuard Home.
• "username": [Optional] The AdGuard Home login username. Default: empty.
• "password": [Optional] The AdGuard Home login password. Default: empty.
• "host": [Optional] Hostname or IP of the AdGuard Home server. Default: localhost.
• "port": [Optional] The AdGuard Home server port. Default: 80.
• "https": [Optional] To use HTTPS or regular HTTP. Default: HTTP.
• "Type": [Optional] Choose between SWITCH or LOCK. Default: empty.
• "autoOnTimer": [Optional] Auto on timer, 0 timer will be ignored. Will created multiple accessories in Home App. Default: empty.
• "hideNonTimer": [Optional] Hide non timer accesory when you set one or more timer accessory. Default: false.
• "stateLogging": [Optional] Display more log output. Default: false.

Or just use Homebridge Config UI X 👀