Python FastAPI - Zigbee2MQTT : apprendre comment piloter un interrupteur ON/OFF en HTML/CSS avec un bouton Zigbee,

Un billet blog de f-leb

Dans un précédent billet (Bouton connecté Zigbee, connexion MQTT en Python avec Eclipse Paho-MQTT), je jouais déjà avec un bouton-poussoir connecté en Zigbee. Je me contentais alors d'afficher la détection du clic sur le bouton dans un terminal.

Cette fois, je crée un serveur qui sert une page Web avec une checkbox HTML décorée en CSS pour représenter un interrupteur ON/OFF. Le but est de faire basculer cet interrupteur à chaque clic sur le bouton sans fil Zigbee.

https://www.youtube.com/watch?v=jiCE9-TaWyM
[Python FastAPI] Comment contrôler un interrupteur HTML/CSS avec un bouton sans fil Zigbee

Le serveur est piloté en Python et le framework web FastAPI. Le serveur gère aussi la connexion MQTT en se mettant en attente des messages à chaque clic du bouton Zigbee. Des messages JSON du type {'state' : true} ou {'state' : false} sont envoyés alternativement par le serveur au client à chaque clic du bouton Zigbee grâce à une liaison WebSocket.

index.html :

<script>
// Création d'une connexion WebSocket à l'URL spécifiée
const ws = new WebSocket("ws://192.168.0.20:8000/ws");

// Fonction appelée lors de la réception d'un message
ws.onmessage = function(event) {
const data = JSON.parse(event.data);
// Met à jour l'état de la checkbox en fonction de la donnée reçue
document.getElementById("btn").checked = data.state;
};





main.py :
from fastapi import FastAPI, WebSocket
from fastapi.staticfiles import StaticFiles
from fastapi.responses import HTMLResponse
import asyncio
from button_client import ButtonSNZB01PClient



app = FastAPI()
app.mount("/static", StaticFiles(directory="static"), name="static")

# instanciation client MQTT : @IP du broker, port et topic
mqtt_client = ButtonSNZB01PClient("raspberrypi.local", 1883, "zigbee2mqtt/fleb-SNZB-01P-switch")

@app.on_event("startup")
def startup_event():
"""
Fonction appelée au démarrage de l'application.
Connecte le client MQTT et démarre la boucle MQTT.
"""
print("Appel de la fonction startup")
mqtt_client.connect()
print("Connexion MQTT effectuée")
mqtt_client.start_mqtt_loop()
print("Boucle MQTT démarrée")



@app.get("/", response_class=HTMLResponse)
async def get():
"""
Endpoint GET pour la racine de l'application.
Lit et renvoie le contenu du fichier index.html.
"""
print("Lecture du fichier index.html")
with open("index.html", "r") as file:
html_content = file.read()
print("index.html lu, envoi du contenu au client")
return HTMLResponse(content=html_content)

@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
"""
Endpoint WebSocket pour gérer les connexions WebSocket.
Accepte la connexion WebSocket et maintient la connexion ouverte.
"""
print("connexion WebSocket établie à l'URL /ws")
await websocket.accept()
print("Connexion Websocket acceptée")
mqtt_client.websocket = websocket
print("Maintien de la connexion Websocket ouverte")
try:
while True:
await asyncio.sleep(1)
except Exception as e:
print(f"Erreur de connexion WebSocket : {e}")
finally:
mqtt_client.websocket = None



button_client.py :
import paho.mqtt.client as mqtt
import json
import asyncio
import threading

class ButtonSNZB01PClient:
"""
Client MQTT pour le bouton Sonoff SNZB-01P.
"""

def __init__(self, broker, port, topic, state=False):
"""
Initialise le client MQTT.

:param broker: Adresse ip du broker MQTT.
:param port: Port du broker MQTT.
:param topic: Topic MQTT à souscrire.
:param state: État initial du switch.
"""
self.broker = broker
self.port = port
self.topic = topic
self.state = state
self.client = mqtt.Client()
self.websocket = None

# fonctions de rappel
self.client.on_connect = self.on_connect
self.client.on_message = self.on_message

def connect(self):
"""
Connecte le client au broker MQTT.
"""
print("Appel de la méthode connect du broker")
self.client.connect(self.broker, self.port, 60)
print("Tentative de connexion au broker...")

def on_connect(self, client, userdata, flags, reason_code, properties=None):
"""
Fonction de rappel appelée lors de la connexion au broker MQTT.
"""
if reason_code == 0:
print("Connexion au broker réussie !")
self.client.subscribe(self.topic)
print(f"Abonné au topic : {self.topic}")
else:
print(f"Echec de la connexion au broker, code d'erreur : {reason_code}")

def on_message(self, client, userdata, msg):
"""
Fonction de rappel appelée lors de la réception d'un message MQTT.
"""
key = 'action'
try:
message = json.loads(msg.payload.decode())
if message.get(key) == "single":
self.state = not self.state
print(f"Changement d'état du switch détecté : {self.state}")
# Envoyer l'état du switch via WebSocket
print("Envoi de l'état du switch via WebSocket")
if self.websocket:
asyncio.run(self.send_switch_state())
else:
print(f"Erreur de clé : {key}")
self.disconnect()
except json.JSONDecodeError:
print(f"Réception de JSON non conforme sur le topic {msg.topic}")
self.disconnect()

async def send_switch_state(self):
"""
Envoie l'état du switch via WebSocket.
"""
if self.websocket:
print(f"Envoi du JSON via websocket : {{'state' : {self.state}}}")
await self.websocket.send_json({"state": self.state})


def start_mqtt_loop(self):
""" Démarre la boucle MQTT dans un thread séparé. """
print("Démarrage de la boucle MQTT dans un thread séparé")
thread = threading.Thread(target=self.client.loop_forever)
thread.start()


def disconnect(self):
"""
Déconnecte le client du broker MQTT.
"""
self.client.disconnect()
print("Client MQTT déconnecté.")


/static/style.css, d'après https://codepen.io/josetxu/pen/Poxwpme :

/*
Modern Lighted Toggle - CSS
Josetxu

https://codepen.io/josetxu/pen/Poxwpme
*/

@import url('https://fonts.googleapis.com/css2?family=Roboto:wght@500&display=swap');

:root {
--sz: 10vmin; /* size */
--on: #2eddf3; /* color on */
--of: #68838d; /* color off */
--tr: all 0.25s ease 0s;
}

* {
box-sizing: border-box;
transition: var(--tr);
}

body {
margin: 0;
padding: 0;
width: 100vw;
height: 100vh;
overflow: hidden;
display: flex;
align-items: center;
justify-content: center;
background: linear-gradient(45deg, #486c7d, #dafbff);
font-family: Roboto, Arial, Helvetica, serif;
}

.toggle {
position: relative;
width: calc(var(--sz) * 4);
height: calc(var(--sz) * 2);
display: flex;
align-items: center;
justify-content: center;
}

input {
display: none;
}

label {
position: absolute;
width: calc(var(--sz) * 4);
height: calc(var(--sz) * 2);
background: linear-gradient(180deg, #888, #fff);
border-radius: var(--sz);
padding: calc(var(--sz) / 5);
box-shadow: 0 0 calc(var(--sz) / 50) calc(var(--sz) / 50) #0002;
}

#btn:checked + label {
box-shadow:
0 calc(var(--sz) / 50) calc(var(--sz) / 5) #fff9,
0 0 calc(var(--sz) / 50) calc(var(--sz) / 50) #0002;
}

label:after {
content: "";
position: absolute;
width: calc(100% - calc(calc(var(--sz) / 5) * 12));
height: calc(100% - calc(calc(var(--sz) / 5) * 2));
box-shadow: 0 0 calc(var(--sz) / 2) calc(var(--sz) / 10) var(--on), 0 0 calc(var(--sz) / 2) calc(var(--sz) / 10) #fff;
border-radius: var(--sz);
z-index: 0;
opacity: 0;
transition: var(--tr);
animation: move-shadow 3s ease 0s 1;
}

#btn:checked + label:after {
opacity: 1;
width: calc(100% - calc(calc(var(--sz) / 5) * 4));
}


.track {
position: absolute;
width: calc(calc(var(--sz) * 4) - calc(var(--sz) / 2.5));
height: calc(calc(var(--sz) * 2) - calc(var(--sz) / 2.5));
border-radius: var(--sz);
overflow: hidden;
}

.track:before {
content: "";
position: absolute;
width: calc(200% - calc(calc(var(--sz) * 2) - calc(var(--sz) / 3)));
height: 100%;
left: -50%;
transition: var(--tr);
background: linear-gradient(90deg, var(--on) 50%, var(--of) 50%);
animation: move-color 3s ease 0s 1;
}

.track:after {
content: "";
position: absolute;
width: 100%;
height: 100%;
border-radius: var(--sz);
box-shadow: 0 calc(var(--sz) / -10) calc(var(--sz) / 10) 0 #0005 inset, 0 calc(var(--sz) / 10) calc(var(--sz) / 10) 0 #0005 inset;
}

#btn:checked + label .track:before {
left: 0%;
}


.thumb {
position: absolute;
width: calc(calc(var(--sz) * 2) - calc(var(--sz) / 3));
height: calc(calc(var(--sz) * 2) - calc(var(--sz) / 3));
top: calc(calc( var(--sz) / 10) + calc(var(--sz) / 15));
left: calc(calc( var(--sz) / 10) + calc(var(--sz) / 15));
background: linear-gradient(180deg, #fff, #afafaf);
border-radius: var(--sz);
box-shadow: 0 0 0 calc(var(--sz) / 50) #0002, 0 calc(var(--sz) / 10) calc(var(--sz) / 10) 0 #0008;
cursor: pointer;
font-size: calc(var(--sz) / 2);
display: flex;
align-items: center;
justify-content: center;
text-indent: calc(var(--sz) * -0.025);
text-shadow:
calc(var(--sz) / -8000) calc(var(--sz) / -150) calc(var(--sz) / 50) #0008,
calc(var(--sz) / 150) calc(var(--sz) / 100) calc(var(--sz) / 50) #fff;
color: #7d7c7c;
z-index: 1;
animation: move-thumb 3s ease 0s 1;
}

#btn:checked + label .thumb {
left: calc(calc(100% - calc(calc(var(--sz) * 2) - calc(var(--sz) / 3))) - calc(calc( var(--sz) / 10) + calc(var(--sz) / 15)));
color: var(--on);
background:
radial-gradient(circle at 7% 50%, #fff calc(var(--sz) / 50), #fff0 calc(var(--sz) / 2)),
radial-gradient(circle at 0 50%, var(--on) 10%, #fff0 60%),
linear-gradient(180deg, #fff, #afafaf);
text-shadow:
0 0 calc(var(--sz) / 10) var(--on), 0 0 calc(var(--sz) / 5) #fff,
calc(var(--sz) / -8000) calc(var(--sz) / -150) calc(var(--sz) / 50) #0008,
calc(var(--sz) / 150) calc(var(--sz) / 100) calc(var(--sz) / 50) #fff;
}

.thumb:before {
content: "";
display: block;
width: 70%;
height: 70%;
background: linear-gradient(180deg, #0008, #ccc, #fff);
position: absolute;
z-index: -1;
border-radius: var(--sz);
border: calc(var(--sz) / 50) solid #ddd;
}


.txt:before,
.txt:after {
content: "";
position: absolute;
left: calc(var(--sz) / 2);
top: 25%;
content: "ON";
transition: var(--tr);
font-size: calc(var(--sz) / 1.5);
color: #000;
opacity: 0.4;
text-shadow: 0px -1px 1px #000, 0px 1px 2px #fff;
}

.txt:after {
content: "OFF";
left: calc(100% - calc(var(--sz) / 0.625));
}


/* initial animation */
@keyframes move-thumb {
0%, 20%, 80%, 100% {
left: calc(calc( var(--sz) / 10) + calc(var(--sz) / 15));
color: #7d7c7c;
background: linear-gradient(180deg, #fff, #afafaf);
text-shadow:
calc(var(--sz) / -8000) calc(var(--sz) / -150) calc(var(--sz) / 50) #0008,
calc(var(--sz) / 150) calc(var(--sz) / 100) calc(var(--sz) / 50) #fff;
}
30%, 70% {
left: calc(calc(100% - calc(calc(var(--sz) * 2) - calc(var(--sz) / 3))) - calc(calc( var(--sz) / 10) + calc(var(--sz) / 15)));
color: var(--on);
background:
radial-gradient(circle at 7% 50%, #fff calc(var(--sz) / 50), #fff0 calc(var(--sz) / 2)),
radial-gradient(circle at 0 50%, var(--on) 10%, #fff0 60%),
linear-gradient(180deg, #fff, #afafaf);
text-shadow:
0 0 calc(var(--sz) / 10) var(--on), 0 0 calc(var(--sz) / 5) #fff,
calc(var(--sz) / -8000) calc(var(--sz) / -150) calc(var(--sz) / 50) #0008,
calc(var(--sz) / 150) calc(var(--sz) / 100) calc(var(--sz) / 50) #fff;
}
}

@keyframes move-color {
0%, 20%, 80%, 100% { left: -50%; }
30%, 70% { left: 0%; }
}


@keyframes move-shadow {
0%, 20%, 80%, 100% {
opacity: 0;
width: calc(100% - calc(calc(var(--sz) / 5) * 12));
}
30%, 70% {
opacity: 1;
width: calc(100% - calc(calc(var(--sz) / 5) * 4));
}
}


Au démarrage de l'application, la fonction startup_event connecte le client MQTT (ButtonSNZB01_client) au broker MQTT. La boucle MQTT est démarrée et fonctionne en arrière-plan, en attente de messages MQTT du topic qui mettront à jour l'état de la checkbox de la page Web en conséquence.

Quand un client se connecte depuis un navigateur, le serveur Web sert la page Web au client qui se connecte à l'endpoint Websocket /ws. Le serveur accepte la connexion Websocket et la maintient. La connexion Websocket est assignée au client MQTT.

Lorsque l'utilisateur clique sur le bouton Zigbee, un message {'action' : 'single', ...} est envoyé par le broker au client MQTT. Si le message contient l'action 'single' (appui simple du bouton), l'état de l'interrupteur est inversé (méthode on_message). La méthode send_switch_state est appelée pour envoyer le nouvel état de l'interrupteur via Websocket. Le client Websocket reçoit le nouvel état et met à jour la checkbox de la page Web.


Conclusion : Le code de cette application de démonstration n'est sans doute pas optimisé de la meilleure des façons, mais il montre tout de même comment gérer de façon asynchrone les interactions entre le client Web, FastAPI, le client MQTT et le broker MQTT, afin d'éviter les situations bloquantes. Je vais donc poursuivre l'expérience...