0.1.0 • Published 4 years ago

@benncarroll/homebridge-rf-fan v0.1.0

Weekly downloads
-
License
ISC
Repository
github
Last release
4 years ago

@benncarroll/homebridge-rf-fan

Homebridge plugin for utilising RF-controllable fans (yypically 433MHz). This plugin interfaces with @benncarroll/homebridge-rf-fan-api, which works by first learning the RF codes, and sending them out to control the fan and lights in the desired way.

Installation

This doc assumes you alreayd have homebridge up and running, as well as the API.

  1. Install this plugin using: npm install -g @benncarroll/homebridge-rf-fan
  2. Edit config as per below
  3. Run/restart homebridge

Homebridge Configuration:

Example config

  "accessories": [
      {
          "accessory": "RF-Remote Fan",
          "name": "Bedroom Fan",
          "light_name": "Bedroom Light",
          "host": "192.168.1.50:5010",
          "id": 1,
          "speeds": 3
      },
      ...
   ]

Parameters

PropertyDescription
accessoryRequired. Must be "RF-Remote Fan"
nameRequired. Desired name of your device, e.g. "Bedroom Fan"
light_nameOptional. Name of Light. If not set, will be name + " Light"
hostRequired. IP Address & Port of API Instance
idRequired. Device ID as configured on API (One API instance can support multiple fans)
speedsRequired. Number of fan speeds, e.g. 3 for Fan with Off, Low, Med, High