Skip to content

docs: expand the Home Assistant MQTT section in the README #406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gnacho merged 1 commit into from
Sep 23, 2026
Merged

docs: expand the Home Assistant MQTT section in the README #406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions README.es.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,18 @@ aparece etiquetado como NetGrip en su flota sin instalar nada más. Es una
capacidad adicional, no un requisito: si no usas NetPulse, nada cambia.

**MQTT y Home Assistant, si los quieres.** Opcional y desactivado por defecto:
apúntalo a un broker MQTT y Home Assistant descubre el router solo, con
sensores (CPU, temperatura, memoria, uptime, modo, versión) e interruptores
para WiFi de invitados, banIP, IPv6 y SQM, además de botones para recargar los
feeds de banIP y reiniciar. Se configura desde la tarjeta MQTT de la página
Sistema y no se publica nada hasta que lo actives.
apúntalo a un broker MQTT y Home Assistant descubre el router solo. Publica el
estado en `netgrip/<router>/state` y crea **23 entidades**: 17 sensores (CPU,
núcleo más cargado, temperatura, memoria, uptime, modo, versión, clientes
totales/WiFi/cable/débil, señal WiFi mínima y media, y tráfico de entrada y
salida de la red local), 4 interruptores (WiFi de invitados, banIP, IPv6 y SQM)
y 2 botones (recargar los feeds de banIP y reiniciar). Los interruptores y
botones actúan: Home Assistant manda la orden por `netgrip/<router>/command/...`
y el router contesta en `netgrip/<router>/result`.

Se configura desde la tarjeta MQTT de la página Sistema, o escribiendo
`/etc/netgrip/mqtt.env` (permisos 600). Sin TLS: pensado para un broker de tu
red local. No se publica nada hasta que lo actives.

## Ponlo en tu router

Expand Down
17 changes: 12 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,11 +111,18 @@ router shows up labeled as NetGrip in its fleet with no extra install. It is
a capability, not a requirement: if you do not use NetPulse, nothing changes.

**MQTT and Home Assistant, if you want them.** Optional and off by default:
point it at an MQTT broker and Home Assistant discovers the router on its own,
with sensors (CPU, temperature, memory, uptime, mode, version) and switches
for guest Wi-Fi, banIP, IPv6 and SQM, plus buttons to reload the banIP feeds
and reboot. It is configured from the MQTT card on the System page and nothing
is published until you enable it.
point it at an MQTT broker and Home Assistant discovers the router on its own.
It publishes the state on `netgrip/<router>/state` and creates **23 entities**:
17 sensors (CPU, busiest core, temperature, memory, uptime, mode, version,
total/WiFi/wired/weak clients, weakest and average WiFi signal, and local
network in/out traffic), 4 switches (guest Wi-Fi, banIP, IPv6 and SQM) and
2 buttons (reload the banIP feeds and reboot). The switches and buttons act:
Home Assistant sends the command on `netgrip/<router>/command/...` and the
router replies on `netgrip/<router>/result`.

It is configured from the MQTT card on the System page, or by writing
`/etc/netgrip/mqtt.env` (mode 600). No TLS: meant for a broker on your local
network. Nothing is published until you enable it.

## Get it on your router

Expand Down
Loading