Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bartekpacia/fhome
Unofficial library to communicate with F&Home API – the worst smart home system ever.
https://github.com/bartekpacia/fhome
Last synced: 22 days ago
JSON representation
Unofficial library to communicate with F&Home API – the worst smart home system ever.
- Host: GitHub
- URL: https://github.com/bartekpacia/fhome
- Owner: bartekpacia
- License: mit
- Created: 2022-03-27T11:54:49.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-23T23:04:20.000Z (about 1 month ago)
- Last Synced: 2024-11-30T11:23:49.560Z (about 1 month ago)
- Language: Go
- Homepage:
- Size: 354 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> 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.
# fhome
[![Go Reference][go-reference-badge]][go-reference-link]
[![Go Report][go-report-badge]][go-report-link]
Package and CLI to communicate with [F&Home – a smart home system][fhome].
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.
## Package
The `api` package implements the F&Home API.
Use it if you want to make your own program interact with it.
## Command-line apps
### fhome
Command-line program to easily interact with your F&Home-enabled devices.
Depends on the `api` package.
**Build**
```console
$ go build -o fhome ./cmd/fhome/*.go
```
**Install**
```console
$ go install ./cmd/fhome
```
**Help**
```console
$ fhome help
```
### fhomed
Provides integration between F&Home and HomeKit. Intended to be used as a
background daemon.
Depends on the `api` package.
**Registering with systemd**
1. Copy the binary to a common location
```console
$ sudo cp ./fhomed /usr/local/bin
```
2. Create a service file
```console
$ sudo cp ./fhomed.service /etc/systemd/system
```
3. Reload changes
```console
$ sudo systemctl daemon-reload
```
**Extracing status logs from journald**
```console
$ journalctl \
_SYSTEMD_UNIT=fhomed.service \
--no-pager \
--output json-pretty \
| jq --slurp \
--compact-output \
'.[] | {timestamp: .__REALTIME_TIMESTAMP, msg: .MESSAGE}'
```
Or in a single line:
```console
$ journalctl _SYSTEMD_UNIT=fhomed.service --no-pager -o json-pretty | jq -s -c '.[] | {timestamp: .__REALTIME_TIMESTAMP, msg: .MESSAGE}'
```
**Build**
```console
$ go build -o fhomed ./cmd/fhomed/*.go
```
**Install**
```console
$ go install ./cmd/fhomed
```
[go-reference-badge]: https://pkg.go.dev/badge/github.com/bartekpacia/fhome.svg
[go-reference-link]: https://pkg.go.dev/github.com/bartekpacia/fhome
[go-report-badge]: https://goreportcard.com/badge/github.com/bartekpacia/fhome
[go-report-link]: https://goreportcard.com/report/github.com/bartekpacia/fhome
[fhome]: https://www.fhome.pl