Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.58 KB

README.md

File metadata and controls

40 lines (26 loc) · 1.58 KB
Raw

homebridge-rachio-platform

Rachio plugin for Homebridge

Installation

  1. Install homebridge using: npm install -g homebridge
  2. Install this plugin using: npm install -g homebridge-rachio-platform@beta
  3. Update your configuration file. See sample-config.json snippet below.

Webhook Support

homebridge-rachio-platform uses webhooks to update Homekit accessory status in real-time when a Rachio schedule is executing. Due to how Rachio scheduling works, webhooks are required in order for this plugin to work correctly.

In order to support webhooks, you must know your external network IP address, and have the ability to open/forward a port from that IP address to your internal Homebridge server (typically a modem or router on your local network). Please do not file issues to this repository related to network configuration issues.

If no webhook information is provided in the config file, the plugin will error, and setup will not complete.

Consult the log during setup. The plugin will print out a URL that can be used to test and confirm port forwarding is setup correctly.

API Key

You can acquire your API key from Rachio using this documentation.

Configuration

{
  "platform": "Rachio-Platform",
  "name": "Rachio Controller",
  "api_key": "{API_KEY_OBTAINED_FROM_RACHIO}",
  "internal_webhook_port": 27546, 
  "external_webhook_address": "http://173.452.132.342:12453"
}