Programmer le pcDuino : Pyduino : Réseau : Créer un serveur TCP / Http générant une page HTML intégrant un code Javascript envoyant une requete Ajax vers le serveur, gérant requête ajax et renvoyant une réponse ajax vers le client.

Ce que l’on va faire ici

Dans ce code, je vous montre comment mettre en place un serveur TCP simple générant une page HTML intégrant un code Javascript qui envoie une requête Ajax vers le serveur. Le serveur TCP gère la requête et renvoie une réponse numérique qui est gérée par la page HTML.
On utilise ici :
- une fonction dédiée pour fournir la page HTML+ code Javascript, rendant le code plus facile à maintenir.
- une fonction dédiée pour l’envoi de la requête AJax.

Les « plus » du réseau avec Pyduino

Il n’est pas nécessaire d’installer quoi que ce soit de plus : les fonctions « réseau » sont directement accessibles depuis la librairie Pyduino !
La librairie Pyduino offre une réelle simplicité du code permettant d’implémenter un serveur TCP/Http à la façon « Arduino », de façon totalement personnalisée ! Il existe aussi des solutions plus avancées utilisables au besoin, mais pour rester simple et maîtriser totalement les échanges serveur/client, rien de tel que de coder soi-même son petit serveur « maison » !
D’un point de vue matériel, le mini-PC offre également, via sa carte réseau, une stabilité de la connexion plus robuste qu’avec un shield Arduino Ethernet. Et surtout, même si le serveur ne s’exécute pas correctement, l’accès VNC permet à tout moment de reprendre la main de façon distante sur le mini-PC, de relancer le serveur, chose impossible avec Arduino + shield Ethernet : si la connexion TCP est perdue, un reboot physique est obligatoire sur la carte Arduino !

Note technique

Un peu à la façon des « poupées gigognes » notre code est écrit en Python…
- qui intègre lui-même la page HTML
  - qui intègre elle-même le code Javascript qui sera exécuté côté client !
    - qui intègre elle-même le code gérant l’envoi de la requête Ajax et la gestion de la réponse.
Le serveur TCP gère quand à lui la requête GET initiale et les requêtes Ajax.

Pré-requis

un mini-PC (pcDuino conseillé) avec système Lubuntu opérationnel. Voir si besoin la page d’accueil du pcDuino
Langage Python (2.7) et l’IDE Pyduino ou l’éditeur Geany installés. Voir si besoin : Logiciel pour développer avec Pyduino
ma librairie pyDuino installée : voir si besoin : Télécharger et installer Pyduino sur le pcDuino

Schéma fonctionnel

Le code Pyduino communique avec l’interface réseau du système qui assure la connexion avec le client distant :

Noter que ce code fonctionne aussi bien en éthernet (filaire) qu’en wifi (sans fil) sous réserve que la connexion matérielle soit opérationnelle.

Le réseau utilisé

Note : le poste fixe peut évidemment être le poste depuis lequel vous accédez au pcDuino par VNC, au moins en phase d’essai.

Matériel nécessaire

Système

Le pcDuino
connecté à un réseau local actif associant :
- un routeur (une box internet typiquement) +/- un switch réseau
- d’autres postes sur le réseau, notamment un poste fixe ou une tablette.
- voire un poste distant sur le web
Si on utilise le wifi, on utilisera le dongle wifi ou une clé USB wifi au lieu de l’interface réseau ethernet. Mais pour un simple test, rester en filaire, c’est plus simple !

E/S

Pas utilisées.

Instructions de montage

Simplement connecter le pcDuino au réseau, ce qui est normalement déjà le cas si vous travaillez en accès VNC !

Le montage à réaliser

Le fichier *.py

Copier/coller ce code dans l’éditeur Geany :

#!/usr/bin/python
# -*- coding: utf-8 -*-

# exemple pyDuino – par X. HINAULT – www.mon-club-elec.fr
# Juillet 2013 – Tous droits réservés – GPLv3
# voir : https://github.com/sensor56/pyDuino

# Tester l’envoi d’une requete Ajax, l’envoi d’une reponse et la gestion d’une reponse Ajax

from pyduino import * # importe les fonctions Arduino pour Python

# entete declarative
compt=0 # variable de comptage
ipLocale=Ethernet.localIP() # auto – utilise l’ip de l’interface eth0 du systeme

#ipLocale= »192.168.1.25″ # manuel – attention : utiliser la meme IP qu’une interface reseau du systeme
# pour connaitre les interfaces reseau sur le systeme : utiliser la commande $ ifconfig

print ipLocale # affiche l’adresse IP

port=8080 # attention port doit etre au dessus de 1024 sinon permission refusee par securite – 8080 pour http

serverHTTP=EthernetServer(ipLocale, port) # crée un objet serveur utilisant le port 8080 = port HTTP > 1024

#— setup —
def setup():

# — serveur TCP —
global serverHTTP, ipLocale, port

#serverHTTP.begin(10) # initialise le serveur – fixe nombre max connexion voulu
serverHTTP.begin() # initialise le serveur – nombre max connexion par defaut = 5

print (« Serveur TCP actif avec ip : « + ipLocale + » sur port : « + str(port) )
#— fin setup

# — loop —
def loop():

global serverHTTP

print (« Attente nouvelle connexion entrante… »)
clientDistant, ipDistante = serverHTTP.clientAvailable() # attend client entrant
# code bloque ici tant que pas client ! Si present, on recupere d’un coup objet client ET son ip

print « Client distant connecte avec ip : »+str(ipDistante) # affiche IP du client

#— requete client —
requete=serverHTTP.readDataFrom(clientDistant) # lit les donnees en provenance client d’un coup

print requete # affiche requete recue

# analyse de la requete

#====== si requete ajax ======
if requete.startswith(« GET /ajax »): # si la requete recue est une requete ajax

lignesRequete=requete.splitlines() # recupere la requete est list de lignes
print lignesRequete[0] # premiere ligne = la requete utile

#— reponse serveur requete formulaire —
reponse=( # ( … ) pour permettre multiligne..
httpResponse() # entete http OK 200 automatique fournie par la librairie Pyduino

# contenu reponse AJAX
+

reponseAJAX() # voir la fonction separee – pour clarte du code

+« \n« ) # fin reponse

serverHTTP.writeDataTo(clientDistant, reponse) # envoie donnees vers client d’un coup

print « Reponse envoyee au client distant : «
#print (bytes(reponse))
print (reponse) # affiche la reponse envoyee

#====== si requete GET simple = premiere requete => envoi page HTML+JS initiale ======
elif requete.startswith(« GET »): # si la requete commence par GET seul = premiere page

print « Requete GETrecue valide »

#— reponse serveur requete initiale —
reponse=( # ( … ) pour permettre multiligne..
httpResponse() # entete http OK 200 automatique fournie par la librairie Pyduino

# contenu page HTML+ JS initiale
+

pageInitialeHTMLJS() # voir la fonction separee – pour clarte du code

+« \n« ) # fin reponse

serverHTTP.writeDataTo(clientDistant, reponse) # envoie donnees vers client d’un coup

print « Reponse envoyee au client distant : «
#print (bytes(reponse))
print (reponse) # affiche la reponse envoyee

#====== si requete pas valide ======
else : # sinon requete pas valide

print (« Requete pas valide »)

#====== une fois la page envoyée ======
#serverHTTP.close()
# remarque : le socket = serveur doit rester ouvert

# quand on quitte l’application: la connexion TCP reste active un peu donc erreur si re-execution trop rapide du code
# on peut utiliser un port voisin dans ce cas…

delay(10) # entre 2 loop()

# — fin loop —

#========== fonction fournissant la page HTML + JS initiale incluant code javascript AJAX ======
def pageInitialeHTMLJS():

contenuPageInitialeHTMLJS=( # debut page HTML
« » »
<!DOCTYPE html>
<html>
<head>
<meta charset= »utf-8″ />
<title>Test reponse Ajax</title>

<!– Debut du code Javascript –>
<script language= »javascript » type= »text/javascript »>
<!–

var delai=1000; // delai auto entre 2 requete Ajax en ms

//———- fonction initiale executee au lancement —–
window.onload = function () { // au chargement de la page
setTimeout(function () {requeteAjax(manageReponseAjax);}, delai); // setTimeOut avec fonction inline : 1er appel de la fonction requete Ajax
// nb : setTimeout() n’applique delai qu’une fois
} // fin onload

//———- fonction de requete AJAX —–
function requeteAjax(callback) { // la fonction recoit en parametre la fonction de callback qui gere la reponse Ajax
// la fonction de callback appelee sera celle definie dans setTimeOut : manageAjaxData
var xhr = XMLHttpRequest(); // declare objet de requete AJAX – OK Firefox

xhr.open(« GET », « /ajax », true); // definition de la requete envoyee au serveur ici : GET /ajax
xhr.send(null); // envoi de la requete

xhr.onreadystatechange = function() { // fonction de gestion de l’evenement onreadystatechange
if (xhr.readyState == 4 && xhr.status == 200) { // si reponse OK
callback(xhr.responseText); // appel fonction gestion reponse en passant texte reponse en parametre
} // fin if
}; // fin function onreadystatechange

} // fin fonction requeteAjax

//—— fonction qui sera utilisee en fonction de callback = gestion de la reponse Ajax
function manageReponseAjax(stringDataIn) { // la fonction recoit en parametre la chaine de texte de la reponse Ajax

var newtext = document.createTextNode(stringDataIn); // defini objet DOM pour ajout texte a la page HTML
document.body.appendChild(newtext); // ajout texte a la page
document.body.appendChild(document.createElement(« br »)); // ajoute saut de ligne

setTimeout(function () {requeteAjax(manageReponseAjax);}, delai); // relance delai avant nouvelle requete Ajax

} // fin fonction gestion de la reponse Ajax

//–>
</script>
<!– Fin du code Javascript –>

</head>

<body>

<br/>
Serveur Ajax Pyduino : Test de gestion de la reponse a une requete Ajax
<br/>

</body>

</html>
« » »

) # fin page HTML+JS initiale
return contenuPageInitialeHTMLJS # la fonction renvoie la page HTML

#===================== Reponse AJAX ==================

#— fonction fournissant la page de reponse AJAX
def reponseAJAX():

# definition des variables a uiliser dans la reponse
global compt
compt=compt+1

# la reponse
reponseAjax=( # debut page reponse AJAX
# » » »123, 456, 789″ » »
str(compt)
) # fin page reponse AJAX
return reponseAjax# la fonction renvoie la page HTML

#— obligatoire pour lancement du code —
if __name__==« __main__ »: # pour rendre le code executable
setup() # appelle la fonction setup
while not noLoop: loop() # appelle fonction loop sans fin

[$[Get Code]]

Ce code est également disponible ici : https://raw.github.com/sensor56/pyduino-exemples/master/Ethernet/EthernetServerAnalyseAjax.py

Utilisation

Connecter le mini-PC au réseau
Appuyer sur le bouton exécuter dans Geany
Une fenêtre de Terminal doit apparaître : un message indique que le serveur attend un client entrant.
Ouvrir alors sur le poste client un navigateur, par exemple firefox, et saisir l’adresse ip du mini-PC suivie de :8080 ce qui donne par exemple 192.168.1.13:8080. On utilise ici le port 8080 d’où le :8080…
A ce moment là, on doit voir sur le mini-PC les messages attestant de la connexion du client ainsi que le requête reçue
Puis le serveur envoie sa réponse intégrant l’entête http et la page HTML
Du côté client, la page HTML doit s’afficher : ici, une valeur s’affiche à intervalle régulier et s’ajoute à la page qui ne se rafraîchit pas car la valeur est reçue par requête Ajax.
Il est possible également d’éditer le source de la page permettant de s’assurer que le code HTML + javascript envoyé par le code pyduino est correct

Noter que le poste fixe peut simultanément accéder au mini-PC par VNC (qui utilise le port 5900) et par le navigateur client ( qui utilise le port 8080) !
Simple et efficace.