# @benncarroll/homebridge-rf-fan

> Homebridge plugin for utilising RF-controllable fans.

Latest version **0.1.0** (published 2020-03-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install @benncarroll/homebridge-rf-fan
pnpm add @benncarroll/homebridge-rf-fan
yarn add @benncarroll/homebridge-rf-fan
bun add @benncarroll/homebridge-rf-fan
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2020-03-17 |
| First published | 2020-03-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Ben Carroll |
| Maintainers | benncarroll |
| Keywords | homebridge-plugin |

## Links

- npm: https://www.npmjs.com/package/@benncarroll/homebridge-rf-fan
- Repository: https://github.com/benncarroll/homebridge-rf-fan
- Homepage: https://github.com/benncarroll/homebridge-rf-fan#readme
- Issues: https://github.com/benncarroll/homebridge-rf-fan/issues
- npm.io page: https://npm.io/package/@benncarroll/homebridge-rf-fan

## Dependencies (1)

- [request](https://npm.io/package/request.md) ^2.74.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2020-03-17

## README

# @benncarroll/homebridge-rf-fan

Homebridge plugin for utilising RF-controllable fans (yypically 433MHz). This plugin interfaces with [@benncarroll/homebridge-rf-fan-api](https://github.com/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](https://github.com/benncarroll/homebridge-rf-fan-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

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

#### Parameters

| Property   | Description                                                                                         |
|------------|-----------------------------------------------------------------------------------------------------|
| accessory  | Required. Must be "RF-Remote Fan"                                                                   |
| name       | Required. Desired name of your device, e.g. "Bedroom Fan"                                           |
| light_name | Optional. Name of Light. If not set, will be `name + " Light"`                                      |
| host       | Required. IP Address & Port of [API Instance](https://github.com/benncarroll/homebridge-rf-fan-api) |
| id         | Required. Device ID as configured on API (One API instance can support multiple fans)               |
| speeds     | Required. Number of fan speeds, e.g. 3 for Fan with Off, __Low__, __Med__, __High__                  |

---
_Source: https://npm.io/package/@benncarroll/homebridge-rf-fan · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._