View  Edit  Attributes  History  Attach  Print  Search

ACCUEIL | ARDUINO > S'INSTALLER > DEBUTER > APPROFONDIR | PROCESSING | MECATRONIQUE | MATERIEL | OUTILS | TESTS | Plus...|
Python > Shell > ATELIERS Python + Qt > PyQt apps > PyQt+Arduino | Mes Robots | RepRap | Mes lib'Arduino | Mes shields Arduino | Mes distros | Les Mini-PC |
ATELIERS ARDUINO| VIDEOS | COMPRENDRE | REFERENCES | CODER | TECHNIQUE | GNU/LINUX | LIENS | Rien à voir |

Programmer le pcDuino : Pyduino : Réseau : Créer un serveur TCP / Http générant un formulaire HTML simple.

Par X. HINAULT - Juillet 2013

Ce que l'on va faire ici

  • Dans ce code, je vous montre comment mettre en place un serveur TCP simple générant un formulaire HTML. Ici, le serveur reçoit la requête Http reçue du client distant (le navigateur de votre choix sur un autre poste du réseau), l'analyse sommairement (GET simple ou réponse de formulaire ?) et envoie une réponse contenant :
    • une page HTML avec le formulaire si il s'agit d'une requête GET simple
    • la requête de formulaire brute si il s'agit d'une requête de formulaire.

Ce qui est "génial" en Python (entre autres choses...), c'est qu'il est possible d'intégrer du code HTML "as is" par simple copier/coller grâce aux chaînes multilignes, encadrées par des """ """. Ainsi la mise en place d'un serveur générant une page HTML avec Pyduino va consister à mettre la page HTML au point dans un éditeur HTML (qui fournit tous les outils facilitant l'écriture du code) puis une fois le résultat voulu obtenu, la copier/coller dans le code Python.

Ecrire un tel code avec Pyduino est une "ballade de santé" comparativement à la même chose réalisée avec Arduino + shield Ethernet. UN ATOUT TRES REEL : L'accès VNC permet de visualiser tout ce qui se passe sur le serveur (exécuté sur le mini-PC) de façon distante : il est facile de repérer un problème grâce aux messages d'erreur de corriger le code sur le miniPC, de relancer, etc... le tout par accès distant ! Le navigateur exécuté sur le poste fixe permet ainsi de développer le serveur et de tester le client sur un seul et même poste de travail !

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 !

Pré-requis

Activité préparatoire

  • Avant de générer votre page HTML avec pyduino, vous pouvez la créer et la tester sur votre poste fixe.
  • Si vous ne connaissez pas l'HTML, voir les tutos PDF dédiés au réseau. Vous trouverez également sur internet de nombreuses sources très bien faîtes.
  • Commencer par lancer l'éditeur HTML de votre choix. Sous Gnu/Linux, je vous conseille bluefish, simple et efficace. Puis copier/coller et enregistrer le code HTML suivant :

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8" />
        <title>Titre</title>
    </head>

    <body>    
        Mon premier formulaire HTML
        <form method=get action="http://192.168.1.12:8080">
            <INPUT type="checkbox" value="ON" name="CaseACocher"> Case
            <br>
            <INPUT type="submit" value="Envoi" name="Envoi">
        </form>
        </body>

</html>
 
[$[Get Code]]
  • Ensuite ouvrez cette page dans votre navigateur : vous devez la visualiser correctement.

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

# test Ethernet Server

from pyduino import * # importe les fonctions Arduino pour Python

# entete declarative

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():
        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 formulaire ======
        if requete.startswith("GET /?"): # si la requete recue est une reponse de formulaire

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

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

                # contenu page
                +"Requete formulaire recue : " + lignesRequete[0]
                +"\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 simple = premiere requete ======
        elif requete.startswith("GET"): # si la requete commence par GET seul = premiere page

                print "Requete recue valide"

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

                # contenu page
                +
"""
<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8" />
        <title>Titre</title>
    </head>

    <body>    
        Mon premier formulaire HTML
        <form method=get action="http://"""+ Ethernet.localIP()+""":8080">
            <INPUT type="checkbox" value="ON" name="CaseACocher"> Case
            <br>
            <INPUT type="submit" value="Envoi" name="Envoi">
        </form>
        </body>

</html>
"""
                +"\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 --



#--- 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/EthernetServerAnalyseForm.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 contenant le formulaire HTML basique
  • Du côté client, la page HTML doit s'afficher
  • Si on clique sur le bouton ENVOI de formulaire, le serveur renvoie la requete de formulaire recue. Constater que la réponse est de la forme GET /?CaseACocher=ON&Envoi=Envoi si la case est cochée et sinon de la forme GET /?Envoi=Envoi
  • Il est possible également d'éditer le source de la page permettant de s'assurer que le code HTML 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.

Discussion technique

Ecrire un tel code avec Pyduino est une "ballade de santé" comparativement à la même chose réalisée avec Arduino + shield Ethernet. UN ATOUT TRES REEL : L'accès VNC permet de visualiser tout ce qui se passe sur le serveur (exécuté sur le mini-PC) de façon distante : il est facile de repérer un problème grâce aux messages d'erreur de corriger le code sur le miniPC, de relancer, etc... le tout par accès distant ! Le navigateur exécuté sur le poste fixe permet ainsi de développer le serveur et de tester le client sur un seul et même poste de travail !