Welcome to F&Home – the worst smart home system ever.

– me

I did this thing not because it's easy, but because I thought it would be easy.

Package and CLI to communicate with F&Home – a smart home system.

F&Home doesn't provide any kind of API, but I managed to figure out how it works using Chrome Devtools and by looking at the messages it sends over websockets.

Then I started putting together this project.

The api package implements the F&Home API. Use it if you want to make your own program interact with it.

Both fhome, fhome-homekit, fhome-web, and fhome-exporter read configuration from TOML files. Config files are loaded in order (later overrides earlier), and environment variables override file values.

Config file locations

• /etc/fhome/config.toml
• ~/.config/fhome/config.toml

(these locations are common for all CLI apps)

Required keys

Example config

FHOME_EMAIL = "[email protected]"
FHOME_CLOUD_PASSWORD = "your-cloud-password"
FHOME_RESOURCE_PASSWORD = "your-resource-password"

Command-line program to easily interact with your F&Home-enabled devices.

Depends on the api package.

Build

$ go build -o fhome ./cmd/fhome/*.go

Install

$ go install ./cmd/fhome

Help

$ fhome help

HomeKit bridge for F&Home. Provides bidirectional sync between F&Home devices and Apple HomeKit. Intended to be used as a background daemon.

Depends on the api package.

Build

$ go build -o fhome-homekit ./cmd/fhome-homekit

Install

$ go install ./cmd/fhome-homekit

Register with systemd

1. Copy the binary to a common location

   $ sudo cp ./fhome-homekit /usr/local/bin

2. Create a service file

   $ sudo cp ./fhome-homekit.service /etc/systemd/system

3. Reload changes

   $ sudo systemctl daemon-reload

Extract status logs from journald

$ journalctl \
  _SYSTEMD_UNIT=fhome-homekit.service \
  --no-pager \
  --output json-pretty \
  | jq --slurp \
    --compact-output \
     '.[] | {timestamp: .__REALTIME_TIMESTAMP, msg: .MESSAGE}'

Or in a single line:

$ journalctl _SYSTEMD_UNIT=fhome-homekit.service --no-pager -o json-pretty | jq -s -c  '.[] | {timestamp: .__REALTIME_TIMESTAMP, msg: .MESSAGE}'

Prometheus exporter that exposes F&Home temperature sensor data at /metrics.

Reads the same config files as the other CLI apps.

Metrics example

# HELP fhome_room_temperature_celsius Room temperature in degrees Celsius
# TYPE fhome_room_temperature_celsius gauge
fhome_room_temperature_celsius{panel="Ogrzewanie",room="Bartek",cell_id="439"} 22.5

Build

$ go build -o fhome-exporter ./cmd/fhome-exporter

Install

$ go install ./cmd/fhome-exporter

Docker

$ docker build -t fhome-exporter -f cmd/fhome-exporter/Dockerfile .
$ docker run -p 9222:9222 -v ~/.config/fhome:/root/.config/fhome:ro fhome-exporter

Flags

A (currently dummy) web server for F&Home device preview. Provides a simple web UI for viewing devices and a /gate endpoint for quick device control.

Depends on the api package.

Build

$ go build -o fhome-web ./cmd/fhome-web

Install

$ go install ./cmd/fhome-web