Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 2.22 KB

README.md

File metadata and controls

58 lines (41 loc) · 2.22 KB
Raw

If this doesn't work for you, please try this fork, reports are that it works with the latest updates from both Flic and Home Assistant.

THIS version is not currently maintained anymore. I'm happy that someone else has taken the reigns!

Fork: https://github.com/asosnovsky/flic2hass

flic2hass

A Flic SDK utility to publish all of your Flic buttons to Home Assistant via MQTT

Requirements:

  • A Flic Hub
  • A functional MQTT server

Basic Steps:

1. Connect to Flic Hub IDE:

2. Create MQTT module:

  • One in the Web IDE, click "Create Module".
  • Give the new module a name. "MQTT" is a good option but anything will work.

3. Insert main.js and mqtt.js:

  • Copy content from main.js in this repo to main.js in the flic IDE.
  • Right-click the folder in the left pane and select "New File".
  • Name the file mqtt.js (IT MUST BE NAMED THIS).
  • Copy content from mqtt.js in this repo to mqtt.js in the flic IDE.

4. Update variables in main.js:

  • Modify server server_options, hatopic with your details. Uncomment username and password if MQTT server requires authentication. If server runs on the non-standard port, update the port details. 
    var server = "domain_or_ip_address";
var server_options = {
    //"username": "",
    //"password": "",
    "port": 1883,
}
var hatopic = "homeassistant";
    Refer to flic-hub-sdk-mqtt-js documentation for the list of available options.

5. Run Module

  • Start the module in the IDE by clicking the green play button, and watch the Console output (it's extremely verbose right now)

    If the module didn't start correctly, try powercycling your Flic Hub and reconnect. Verify the Module saved properly and is running.

  • Once the module has started, and you have verified it is working as expected, turn on the "restart after crash" checkbox to ensure the module is always running after any unexpected crash or hub power cycle.