Flic Hub Module for Home Assistant

This module uses the Flic Hub SDK to send your Flic Button events and states to the Home Assistant REST API.

If you have any automations running with the flicd add-on from pschmitt’s repository they will continue to work after pairing the same Flic Button to the Flic Hub as the events sent by the module keeps the same type and data.

Set up

First you need to create a module on your Flic Hub using their Online IDE and copy-paste the files under flic_hub_module folder:

• config.js
• constants.js
• ha.js
• main.js
• module.json
• utils.js

It should look something like this:

Then edit the config.js file so the Flic Hub can connect to your Home Assistant REST API.

Param	Value	Description
MIN_EVENTS_OFFSET	Integer	When the time elapsed between two events is less than MIN_EVENTS_OFFSET milliseconds, the most recent event will be ignored. Events like double and hold sometimes trigger a single event when you release the button
SYNC_TIME	Integer	Defines how often (in milliseconds) the state for all the buttons will be reported to Home Assistant
WARNING_BATTERY_LEVEL	Integer	If battery level is below this value (in percentage), a battery warning icon will be shown
SERVER_HOST	String	The URL where your Home Assistant instance is running. Example: http://192.168.XXX.YYY:8123
SERVER_AUTH_TOKEN	String	A Long-Lived Access Token obtained from your profile http://192.168.XXX.YYY:8123/profile

Be sure you have the API component enabled in your Home Asistant instance (enabled by default). In case you have any troubles see their documentation to know how to enable it.

Run automations with your Flics

To run automations using flic_click events your scripts should look like this:

automation:
  - alias: "Turn on lights in the living room on single flic click"
    trigger:
      platform: event
      event_type: flic_click
      event_data:
        button_name: flic_80e4da779fc7
        click_type: single
    action:
      service: homeassistant.turn_on
      target:
        entity_id: group.lights_livingroom

Where the possible values for click_type are: single, double and hold.

Flic button card

It is possible to add a card to your dashboard to check state, battery and connectivity status for your flics

type: entities
title: Flic gamer
entities:
  - entity: binary_sensor.flic_80e4da779fc7
  - entity: sensor.flic_80e4da779fc7_battery
  - entity: binary_sensor.flic_80e4da779fc7_connectivity