Skip to content

Commit

Permalink
add Free Mobile documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
William-De71 committed Nov 24, 2024
1 parent 8f6f7bb commit 31ecfbd
Show file tree
Hide file tree
Showing 27 changed files with 138 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/integrations/free-mobile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
id: free-mobile
title: How to configure Free Mobile with Gladys Assistant
sidebar_label: Free Mobile
---

This integration allows you to send SMS to your cell phone with the french mobile operator [Free Mobile](https://mobile.free.fr).

![free-mobile integration](../../static/img/docs/en/configuration/free-mobile/free-mobile.jpg)

## **Prerequisites**

You must go to the [Free Mobile](https://mobile.free.fr) page and click on [Subscriber Area](https://mobile.free.fr/account/v2/login) ![Subscriber Area](../../static/img/docs/en/configuration/free-mobile/free-mobile-subscriber-area.jpg)

You must then to click to the option page.
![my-account](../../static/img/docs/en/configuration/free-mobile/free-mobile-my-account.jpg)

Enable the option `Notifications par SMS`
![options](../../static/img/docs/en/configuration/free-mobile/free-mobile-options.jpg)

:::note
If you disable and re-enable the SMS notification option, please be sure to update your API key in your configuration.
:::

## Enter this key in Gladys Assistant

Go to "Integrations" -> "Free-Mobile".

![Enter this key in Gladys Assistant](../../static/img/docs/en/configuration/free-mobile/free-mobile-integration.jpg)

Enter your Customer ID and API key then click "Save".

![Gladys configuration](../../static/img/docs/en/configuration/free-mobile/free-mobile-configuration.jpg)

## Send your first SMS

You can now use these integration from the [Scenes](../scenes/intro.md).

![Gladys scene](../../static/img/docs/en/configuration/free-mobile/free-mobile-scene-action.jpg)
29 changes: 29 additions & 0 deletions docs/scenes/send-a-sms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
id: send-a-sms-action
title: Send a SMS
sidebar_label: Send a SMS
---

This action allows you to send a SMS to your cell phone with the french mobile operator [Free Mobile](https://mobile.free.fr) in a scene.

## Simple example

To send a SMS, it's very simple, create a "send SMS" action in a scene.

![Send sms](../../static/img/docs/en/scenes/send-a-sms-action/send-a-sms.png)

## Inject a variable into a sms

Say you want to send yourself an alert when the temperature is too low in your home.

You want to inject the current temperature value into the message, in order to know the current temperature value.

To do this, you must add a "retrieve the last state" action to your scene and select the sensor you want to request.

![Get sensor value](../../static/img/docs/en/scenes/send-a-sms-action/get-device-value.jpg)

Then, further in the scene, you can add a "send SMS" action, and in the message you type `{{ ` and select the previously defined variable.

![Get sensor value](../../static/img/docs/en/scenes/send-a-sms-action/inject-variable-demo.png)

When the scene runs, you should get the value in your message 🥳
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
id: free-mobile
title: Comment configurer Free Mobile avec Gladys Assistant
sidebar_label: Free Mobile
---

Cette intégration vous permet d'envoyer des SMS sur votre téléphone portable avec l'opérateur mobile français [Free Mobile](https://mobile.free.fr).

![free-mobile integration](../../../../../static/img/docs/fr/configuration/free-mobile/free-mobile.jpg)

## **Prérequis**

Vous devez vous rendre sur la page de [Free Mobile](https://mobile.free.fr) et cliquer sur [Espace Abonné](https://mobile.free.fr/account/v2/login) ![Espace Abonné](../../../../../static/img/docs/fr/configuration/free-mobile/free-mobile-subscriber-area.jpg)

Vous devez ensuite accéder à la page des options.
![mon-compte](../../../../../static/img/docs/en/configuration/free-mobile/free-mobile-my-account.jpg)

Activer l'option `Notifications par SMS`
![options](../../../../../static/img/docs/fr/configuration/free-mobile/free-mobile-options.jpg)

:::note
Si vous désactivez puis réactivez l'option Notification par SMS, assurez-vous de mettre à jour votre clé API dans votre configuration.
:::

## Saisissez cette clé dans Gladys Assistant

Rendez-vous dans "Intégrations" -> "Free Mobile".

![Entrer une clé dans Gladys Assistant](../../../../../static/img/docs/fr/configuration/free-mobile/free-mobile-integration.jpg)

Entrez votre identifiant client et votre clé API, puis cliquez sur "Sauvegarder".

![Gladys configuration](../../../../../static/img/docs/fr/configuration/free-mobile/free-mobile-configuration.jpg)

## Envoyez votre premier SMS

Vous pouvez maintenant utiliser cette intégration depuis les [Scènes](../scenes/intro.md).

![Gladys scene](../../../../../static/img/docs/fr/configuration/free-mobile/free-mobile-scene-action.jpg)
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
id: send-a-sms-action
title: Envoyer un SMS
sidebar_label: Envoyer un SMS
---

Cette action vous permet d'envoyer un SMS sur votre téléphone portable via l'opérateur mobile français [Free Mobile](https://mobile.free.fr) dans une scène.

## Exemple simple

Pour envoyer un SMS, c'est très simple, créez une action "Envoyer un SMS" dans une scène.

![Envoyer un message](../../../../../static/img/docs/fr/scenes/send-a-sms-action/send-a-sms.png)

## Injecter une variable dans un message

Imaginons que vous voulez vous envoyer une alerte quand la température est trop basse chez vous.

Vous voulez injecter la valeur de la température actuelle dans le message, afin de savoir la valeur de température actuelle.

Pour cela, vous devez dans votre scène ajouter une action "Récupérer le dernier état" puis vous sélectionnez le capteur que vous voulez requêter.

![Récupérer valeur capteur](../../../../../static/img/docs/fr/scenes/send-a-sms-action/get-device-value.jpg)

Ensuite, plus loin dans la scène, vous pouvez ajouter une action "Envoyer un SMS" et dans le message vous tapez `{{ ` puis vous sélectionnez la variable précédemment définie.

![Envoyer un message avec variable injectée](../../../../../static/img/docs/fr/scenes/send-a-sms-action/inject-variable-demo.png)

Lorsque la scène s'exécutera, vous devriez récupérer la valeur dans votre message 🥳
2 changes: 2 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ module.exports = {
"integrations/caldav",
"integrations/camera",
"integrations/enedis",
"integrations/free-mobile",
"integrations/google-home",
"integrations/homekit",
"integrations/mqtt",
Expand Down Expand Up @@ -61,6 +62,7 @@ module.exports = {
"scenes/get-last-device-state-action",
"scenes/wait-action",
"scenes/continue-only-if-action",
"scenes/send-a-sms-action",
"scenes/send-a-message-action",
"scenes/send-a-zigbee2mqtt-message-action",
"scenes/turn-on-off-the-lights-action",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 31ecfbd

Please sign in to comment.