Skip to content

HA-IPFire v0.2.0

Choose a tag to compare

View all tags
@FMainz FMainz released this 31 Aug 20:30
· 65 commits to main since this release
v0.2.0
6eb62ed
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

HA-IPFire v0.2.0

First public release of HA-IPFire, a Home Assistant integration for IPFire.

Features

  • Connects to IPFire using /cgi-bin/speed.cgi

  • Configurable IPFire URL

  • Username/password authentication

  • Optional SSL certificate verification

  • Support for self-signed IPFire certificates

  • Download traffic counter

  • Upload traffic counter

  • Calculated current download speed

  • Calculated current upload speed

  • Home Assistant long-term statistics

  • All sensors grouped into one IPFire device

  • HACS-compatible

Sensors

Sensor | Description | Unit -- | -- | -- Download | Cumulative received traffic | B Upload | Cumulative transmitted traffic | B Download Rate | Current calculated download speed | kB/s Upload Rate | Current calculated upload speed | kB/s

IPFire API

HA-IPFire reads the following IPFire endpoint:

/cgi-bin/speed.cgi

The rx_kbs and tx_kbs values returned by IPFire are intentionally ignored because they may report 0 kb/s.

The current transfer speed is calculated from the cumulative rxb and txb counters instead.

SSL certificates

SSL certificate verification can be disabled to support the self-signed certificates commonly used by IPFire installations.

Verification can be enabled when IPFire uses a trusted certificate.

Installation

HA-IPFire can currently be installed through HACS as a custom repository.

Repository:

FMainz/HA-IPFire

After installation, restart Home Assistant and add HA-IPFire through:

Settings → Devices & services → Add Integration

Validation

This release has successfully passed:

  • Hassfest validation

  • HACS validation

License

MIT License

Assets 2
Loading