Skip to content

Commit

Permalink
Add LAN Manager documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Pierre-Gilles committed Oct 31, 2024
1 parent 08d3db3 commit ae44772
Show file tree
Hide file tree
Showing 3 changed files with 124 additions and 0 deletions.
61 changes: 61 additions & 0 deletions docs/integrations/lan-manager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
id: lan-manager
title: Manage presence by scanning your Wi-Fi network
sidebar_label: Lan-Manager
---

The LAN Manager integration lets you scan your network at regular intervals to determine whether you’re home or away by detecting the presence of your phone, tablet, or computer.

:::note
This method may result in false negatives if your phone is not always connected to Wi-Fi (for instance, if it goes into sleep mode).
:::

:::warning
This method does not work on iPhones.

For iPhone, I recommend using the “Shortcuts” app to send a request to Gladys when you leave home.
:::

## Adding Your Phone

Go to the “LAN Manager” integration, then click “LAN Discovery” and select “Network Search.”

Then create the device by clicking on "Save."

If this search doesn’t yield any results, check the following:

- That your Gladys installation is on the correct network
- That your Gladys container is running in “network=host” mode, which is the case if you launched Gladys using the official docker run command
- That the CIDR range to scan is correct (this can be modified in the integration settings)

## Manage presence in scenes

### A "homecoming" scene

We are now going to create a `scene` that will mark a user as "present at home" when your phone is detected.

Go to the "Scenes" tab, and create a scene like this:

![Return home scene](../../static/img/docs/en/configuration/bluetooth/back-at-home-scene.png)

The scene is very simple.

WHEN "Phone is detected" THEN "put user 'Tony' as present at home".

### A "leaving home" scene

To manage the departure of the user from the house, we recommend you make a scene executed periodically, which will check if your phone has been detected recently at home.

If Gladys detects the device's presence, it won't do anything. If not, Gladys will mark the user as absent.

The scene should look like this:

![Scene leaving home](../../static/img/docs/en/configuration/bluetooth/left-home-scene.png)

You can play around with the settings to suit your home. If you feel that 10 minutes is too short to be put as absent, you can extend it to 20 minutes to avoid "false positives" 😀

## Display presence on the dashboard

You can display the presence of selected users on the dashboard. To do so, you can use the "Users present" widget:

![Presence dashboard](../../static/img/docs/en/configuration/bluetooth/user-presence-dashboard.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
id: lan-manager
title: Gérer la présence en scannant votre réseau
sidebar_label: Lan-Manager
---

L'intégration LAN Manager vous permet de scanner votre réseau à interval régulier, afin de déterminer si vous êtes à la maison où si vous n'êtes pas là, grâce à la présence de votre téléphone/tablette/ordinateur.

:::note
Cette méthode peut avoir des faux négatifs, si votre téléphone n'est pas tout le temps connecté au Wi-Fi (passe en veille par exemple).
Ce n'est pas une méthode très fiable.
:::

:::warning
Cette méthode ne fonctionne pas sur iPhone.

Sur iPhone, je vous conseille d'utiliser l'application "Raccourci" et d'envoyer une requête à Gladys quand vous quittez la maison.
:::

## Ajouter votre téléphone Android

Rendez-vous dans l'intégration "LAN Manager", puis cliquez sur "Découverte LAN" puis "Recherche sur le réseau".

Puis créer l'appareil en cliquant sur "Sauvegarder".

Si cette recherche ne donne rien, vérifiez:

- Que votre installation Gladys est bien sur le bon réseau
- Que votre container Gladys tourne bien en "network=host", ce qui est le cas si tu as lancé Gladys avec le docker run officiel.
- Que le CIDR à scanner est bien le bon (à modifier dans les paramètres de cette intégration)

## Gérer la présence dans les scènes

### Une scène "retour à la maison"

Maintenant, nous allons créer une scène qui va vous marquer comme "présent à la maison" quand ce téléphone est détecté.

Rendez-vous dans l'onglet "Scènes", et créez une scène comme celle-ci:

![Scène retour à la maison](../../../../../static/img/docs/fr/configuration/bluetooth/retour-maison-scene.png)

La scène est très simple.

QUAND "Le téléphone est détecté" ALORS "mettre l'utilisateur Tony comme présent à la maison".

### Une scène "départ de la maison"

Pour gérer le départ de la maison, je vous recommande de faire une scène exécutée périodiquement qui va vérifier si votre téléphone a été détecté récemment à la maison, ou pas.

Si oui, Gladys ne fera rien. Si non, Gladys marquera l'utilisateur comme absent.

La scène doit ressembler à ça :

![Scène départ de la maison](../../../../../static/img/docs/fr/configuration/bluetooth/depart-maison-scene.png)

Vous pouvez jouer avec les réglages en fonction de votre maison. Si vous estimez que 10 minutes c'est trop court pour être mis comme absent, vous pouvez rallonger à 20 minutes pour éviter les "faux-départs" :)

## Afficher la présence sur le tableau de bord

Maintenant, si vous voulez afficher la présence des différents utilisateurs à la maison, vous pouvez utiliser la box "Utilisateurs présents":

![Présence dashboard](../../../../../static/img/docs/fr/configuration/bluetooth/presence-dashboard.png)
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ module.exports = {
"integrations/google-home",
"integrations/homekit",
"integrations/mqtt",
"integrations/lan-manager",
"integrations/nextcloud-talk",
"integrations/netatmo",
"integrations/node-red",
Expand Down

0 comments on commit ae44772

Please sign in to comment.