Skip to content

Commit

Permalink
Add new MQTT API
Browse files Browse the repository at this point in the history
  • Loading branch information
Pierre-Gilles committed Oct 30, 2023
1 parent cdbba87 commit 4b0e768
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 6 deletions.
22 changes: 19 additions & 3 deletions docs/api/3_mqtt_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ If you have configured a MQTT Broker with your Gladys installation, you will hav

Here are all the MQTT topics available, each one with an example message to send:

#### Push a decimal device state
### Push a decimal device state

Say you have a temperature sensor sending data to Gladys, you'll have to send it's temperature values to:

Expand All @@ -17,7 +17,7 @@ Topic: gladys/master/device/:device_external_id/feature/:device_feature_external
Body: 22.2
```

#### Push a text device state
### Push a text device state

If you want, you can send text to Gladys to display it on the dashboard!

Expand All @@ -30,7 +30,7 @@ Topic: gladys/master/device/:device_external_id/feature/:device_feature_external
Body: Hello Gladys!
```

#### Push a state to a device
### Push a state to a device

Say you have a MQTT light, and you want it to be controlled in Gladys.

Expand All @@ -55,3 +55,19 @@ Or
```

Meaning "The light needs to be turned off".

### Launch a scene with MQTT

You can now launch a scene using MQTT by posting a message on the topic:

```
gladys/master/scene/SCENE_SELECTOR/start
```

By replacing `SCENE_SELECTOR` with the scene selector, which can be found in the scene edition URL.

For example, for the scene `http://192.168.1.10/dashboard/scene/cinema`, you'll need to send a message to the topic:

```
gladys/master/scene/cinema/start
```
22 changes: 19 additions & 3 deletions i18n/fr/docusaurus-plugin-content-docs/current/api/3_mqtt_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: MQTT API

Si vous avez configurer un broker MQTT avec Gladys, vous pouvez communiquer avec Gladys via MQTT.

#### Envoyer un nouvel état décimal
### Envoyer un nouvel état décimal

Si vous avez un capteur de température qui doit retourner des valeurs en MQTT, vous pouvez envoyer vos valeurs sur le topic suivant:

Expand All @@ -15,7 +15,7 @@ Topic: gladys/master/device/:device_external_id/feature/:device_feature_external
Body: 22.2
```

#### Envoyer un nouvel état textuel
### Envoyer un nouvel état textuel

Si vous voulez afficher du texte sur le tableau de bord Gladys, c'est possible avec l'intégration MQTT !

Expand All @@ -28,7 +28,7 @@ Topic: gladys/master/device/:device_external_id/feature/:device_feature_external
Body: Magnifique
```

#### Contrôler un périphérique depuis Gladys
### Contrôler un périphérique depuis Gladys

Imaginons que vous êtes une ampoule contrôlable via MQTT.

Expand All @@ -53,3 +53,19 @@ Ou
```

Ce qui veut dire "Gladys demande à la lampe de s'éteindre".

### Lancer une scène en MQTT

Vous pouvez désormais lancer une scène en MQTT en publiant un message sur le topic:

```
gladys/master/scene/SCENE_SELECTOR/start
```

En remplaçant `SCENE_SELECTOR` par le selector de la scène, qui peut-être trouvé dans l'URL de l'édition de la scène.

Par exemple, pour la scène `http://192.168.1.10/dashboard/scene/cinema`, il faudra envoyer un message dans le topic:

```
gladys/master/scene/cinema/start
```

0 comments on commit 4b0e768

Please sign in to comment.