Note

Community-maintained fork of nickbreaton/homebridge-modern-forms.

Modern Forms Homebridge Plugin (rbraddes)

Add support for Modern Forms fans to Homekit using Homebridge.

Install

npm install -g homebridge-modern-forms-ceiling-fans

Containerized Homebridge v2 test environment

This repository includes a Docker Compose test rig for Homebridge v2 (homebridge@next) plus a mock Modern Forms fan endpoint.

1. Start the environment: npm run docker:hbv2:up
2. Watch Homebridge logs: npm run docker:hbv2:logs
3. Stop and clean up: npm run docker:hbv2:down

Notes:

• Homebridge runs with this plugin preinstalled from the local source tree.
• The mock fan listens at 172.28.0.10 and responds on POST /mf.
• The test Homebridge config is at docker/homebridge-v2/config.json.
• The build tries HOMEBRIDGE_VERSION first, then auto-falls back to beta, then latest if the tag does not exist.
• To force a specific Homebridge tag/version: HOMEBRIDGE_VERSION=beta npm run docker:hbv2:up HOMEBRIDGE_VERSION=2.0.0-beta.27 npm run docker:hbv2:up

Migration from original plugin

1. Uninstall the archived plugin: npm uninstall -g homebridge-modern-forms
2. Install this fork: npm install -g homebridge-modern-forms-ceiling-fans
3. Update your Homebridge config.json platform value from "ModernForms" to "ModernFormsCeilingFan".

Prerequisites

• Have Homebridge setup

Setup

1. Add any fans you'd like to control to your home network.

   1. Download the Modern Forms iOS or Android app.
   2. Follow the instructions to pair your fan.
   3. Verify your fans show up in the app and can be controlled.
   4. Optionally, delete the app.

2. Add the following to your Homebridge config.json under platforms.

   {
       "platform": "ModernFormsCeilingFan"
   }

3. Verify your config.json looks similar to the following.

   {
       "bridge": {
           "name": "Name",
           "username": "XX:XX:XX:XX:XX:XX",
           "port": 00000,
           "pin": "000-00-000"
       },
       "platforms": [
           {
               "platform": "ModernFormsCeilingFan"
           }
       ]
   }

4. You’re all set! Any fans you saw in the Modern Forms app should appear in the Home app automatically.

Configuration

Specifying Fan IP Addresses

If any of your fans are not automatically found, try specifiying their IP addresses in the following format.

{
    "platform": "ModernFormsCeilingFan",
    "fans": [
        {
            "ip": "192.168.0.10"
        },
        {
            "ip": "192.168.0.11"
        }
    ]
}

Disabling Auto Discovery

If you would like to disable the automatic discovery of fans on your network, specify the following option. You will need to specify the IP address of your fans manually as shown above.

{
    "platform": "ModernFormsCeilingFan",
    "autoDiscover": false
}