https://github.com/northernman54/homebridge-hampton-bay

Homebridge Plugin for Hampton Bay Ceiling Fans
https://github.com/northernman54/homebridge-hampton-bay

Last synced: 17 days ago
JSON representation

Homebridge Plugin for Hampton Bay Ceiling Fans

• Host: GitHub
• URL: https://github.com/northernman54/homebridge-hampton-bay
• Owner: NorthernMan54
• Created: 2017-12-05T02:57:48.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-12-28T16:18:44.000Z (almost 4 years ago)
• Last Synced: 2024-10-10T12:04:23.981Z (29 days ago)
• Language: JavaScript
• Homepage:
• Size: 562 KB
• Stars: 24
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# homebridge-hampton-bay Plugin

[![NPM Downloads](https://img.shields.io/npm/dm/homebridge-hampton-bay.svg?style=flat)](https://npmjs.org/package/homebridge-hampton-bay)

I wrote this plugin as a wrapper around mdhiggins ESP8266-HTTP-IR-Blaster to control my Hampton Bay Ceiling fan. This particular fan uses a 303Mhz RF Remote control. To use this plugin, you need to build this ESP8266 based IR Blaster device https://github.com/mdhiggins/ESP8266-HTTP-IR-Blaster, except you need to substitute the LED with a 303Mhz RF Transmitter module.

To source the 303Mhz transmitter module, I sacrificed a Hampton Bay remote, and removed the 303Mhz SAW Resonator from the transmitter module.  I then on a 315Mhz Transmitter module, removed the 315Mhz SAW Resonator and replaced it with the 303Mhz SAW Resonator. Creating my own 303Mhz Transmitter module.

# Circuit Diagram

## RF Transmitter

![RF-LED](ESP%208266%20-%20RF%20Transmitter_bb.jpg)

![DHT-YL](ESP%208266%20-%20RF%20Transmitter_schem.jpg)

## Breadboard view

![img_1611](https://user-images.githubusercontent.com/19808920/33053269-aee42054-ce40-11e7-9c74-7fee8e975782.JPG)

# Installation

1. sudo npm install -g homebridge-hampton-bay

# configuration

Example config.json:

```

{

 "platform": "HBay",

 "devices": [{

   "lightName": "Ceiling Two",

   "fanName": "Fan Two",

   "irBlaster": "ESP_8695EC.local",

   "remote_code": "0000",

   "out": 3

   },

   {

   "lightName": "Ceiling One",

   "fanName": "Fan One",

   "irBlaster": "ESP_8695EC.local",

   "remote_code": "1000",

   "out": 3

   }]

 }

```

## Required settings

* platform     - This must be "HBay"

* name          - Name of the device ( or fanname / lightname )

* irBlaster     - Name or ip address of your IRBlaster Device

* remote_code   - This is the 4 Bit unique code for your fan controlled by the dip switches. 0 is switch UP and 1 is switch down.

## Optional settings

* dimmable  - Is the light dimmable, defaults to false

* light     - Does the fan support a light, defaults to true

* out       - out setting for IR Blaster, defaults to 1

* fanName   - Name for fan device

* lightName - Name for light device

# Finding remote code for your remote / fan

This is the dip switches on your control module.

# Credits

* https://github.com/mdhiggins - Creating the ESP8266 based IR Blaster, sharing your plans and source.

* nfarina - For creating the dummy plugin which I used as base for this plugin.