SmartCampus2014/Tutoriels

= Liens =


 * Présentation du projet SmartCampus
 * Fiche de suivi du projet
 * Cahier des charges

= Mosquitto =

Mosquitto est une implémentation de MQTT, un protocole de M2M de type publish-subscribe.

Installation

 * Documentation officielle :
 * Pour Debian/Ubuntu et dérivés:
 * Ensuite télécharger le client en ligne de commande:

Exemple de communication

 * Dans un premier terminal on lance le broker :

Sur certaines distributions, mosquitto peut se trouver dans /usr/sbin/.


 * Dans un second terminal on crée un topic "toto" sur lequel on publie des messages.


 * Dans un dernier terminal on publie sur le topic "toto".


 * Pour communiquer entre différents devices, il faut lancer le broker sur chacun d'eux, puis indiquer lors du subscribe l'adresse IP du publisher. Par exemple :

= Comment utiliser openHAB avec Mosquitto ? =

Requis
Il faut en premier lieu ajouter le bundle MQTT bindings (disponible ici) dans le dossier "addons" du runtime openHAB.

Ne pas oublier de lancer le broker Mosquitto (commande mosquitto).

Ajouter l'URL du broker dans le fichier de configuration d'openHAB (e.g. openhab.cfg) :

Subscribe
Lier un item à un topic en indiquant l'alias du broker, le type des messages transmis, et l'action effectuée sur openHAB sur réception des messages :

où est soit "command" soit "state" (pour l'update), et où est "default".

Par exemple :

On peut alors publier avec "mosquitto_pub" sur le topic défini (e.g. "temperature") et voir le changement dans l'interface openHAB.

Publish
Le principe est relativement semblable. On lance "mosquitto_sub" sur le topic voulu (e.g. "light"). Lier un item à un topic en indiquant l'alias du broker, le type des messages transmis, le déclencheur de l'envoi de message, et la transformation :

Par exemple :

Ici, lorsque l'interrupteur de la lumière du garage est actionné, le subscriber Mosquitto reçoit 0 ou 1.

Pour plus d'informations, voir le wiki officiel ici.

= Comment se connecter en SSH à la carte Galileo = Voir le tutoriel officiel d'Intel : [[Media:Galileo_GettingStarted.pdf | Galileo_GettingStarted.pdf]]

Configuration de la carte Galileo

 * Avant tout, il est important de toujours alimenter la carte Galileo avant de la brancher à l’ordinateur !
 * Connecter le Galileo à l’ordinateur avec le câble USB (port USB client de la carte).
 * Lancer l'IDE Arduino et sélectionner le port série (Outils > Port série). Si le port série n'est pas reconnu, essayez de relancer l'IDE en Administrateur.
 * Updater le firmware via l’IDE Arduino (Aide > Firmware Update). Cette étape est primordiale pour pouvoir se connecter en SSH. Il est aussi important de ne pas lancer de sketchs avant ou pendant la mise à jour.
 * Créer un nouveau sketch :

Attention, il faut garder la boucle loop dans le code, même vide, pour ne pas avoir d'erreur. Dans cet exemple, nous lançons le service Telnet mais si on utilise seulement SSH, cette ligne n'est pas nécessaire.


 * Flasher ce code sur la carte Galileo.


 * Configurer le PC en mode routeur (en root sous Linux) :


 * Activer le NAT sur le PC (en root sous Linux) :


 * Sur Galileo, si la résolution d'adresse ne fonctionne pas (e.g. ping www.google.com ne marche pas), configurer le DNS en ajoutant à /etc/resolv.conf :

''Attention : les domaines ci-dessus sont valables seulement pour un PC connecté à wifi-campus. Sur un autre réseau, il suffit (sur un système UNIX) de copier le contenu de /etc/resolv.conf''

Connexion en SSH

 * Relier le Galileo à l’ordinateur avec le câble Ethernet.
 * Sur windows la connexion se fera automatiquement, mais sur Linux il faut changer l’adresse IP de la carte Ethernet pour être sur le même réseau que le Galileo :


 * Faire un ping vers l’adresse ip 169.254.1.1 pour vérifier que la connexion fonctionne (si cela ne marche pas, il peut être judicieux de déconnecter la prise secteur de la carte et de la rebrancher).


 * Lorsque le ping fonctionne, il est possible de se connecter en root à la carte Galileo, soit en utilisant un client SSH de type PuTTY, ou via la commande :

= Mis en place d'une base de donnée mongodb (en local) =

Installation et lancement
Par la suite il est possible d'accéder à différentes informations de votre BD via l'url :
 * http://localhost:28017/

Accéder au contenu
Pour accéder au contenu d'une collection de votre base de donnée, lancer la base de donnée en utilisant la commande :

puis dans votre navigateur, accéder à l'URL :
 * http://localhost:28017/nomDeVotreBD/nomDeVotreCollection/

Ajouter une base de donnée
Pour ajouter une base de donnée lancer mongo en version shell :

Pour visualiser l'ensemble des bases de données :

Afin de créer une base de donnée ou se connecter à l'une d'elle :

= Mise en place NodeJs Mongoose =

Prérequis
Effectuer le point précédent Lancer les commandes :

Connexion à la BD

 * Afin de se connecter à la BD réalisée précédemment :


 * On définit le schéma d'une collection en définissant son id et un champs


 * Création du modèle


 * Ajout d'un élèment dans la base de donnée.

= Mise en place NodeJs Mongoose MQTT =

Prérequis
Installation de mqtt

Utilisation
On fait appel à la librairie mqtt :

Connexion au broker sur le port 1883 :

On subscribe au topic 'temperature', et à chaque réception de ce topic on affiche ce qui a été reçu dans la console:

On peut également publier sur le topic 'light' l'info 'On' :

En lançant ces commandes le texte 'On' devrait apparaître sur votre console.

= Utilisation de NodeJS Mongoose MQTT et Mosquitto =

Prérequis
Suivre le tuto sur mosquitto, NodeJS Mongoose MQTT et Mosquitto. Lancer MongoDB. Ajouter une DB dans mongo "Client" (cf tuto NodeJS Mongoose MQTT).

Test
Dans le .js Node ajouter le code suivant :

Lancer ceci avec Node.

Lancer mosquitto et publier sur le topic 'light' :

Par la suite, vous devriez voir le message "25°C" dans la console. De plus, à l'adresse http://localhost:28017/Client/temperatures/ vous devriez apercevoir l'ajout d'un objet JSON contenant en paramètre 'temp' à 25.

= Carte interactive =

Google Maps
Voir la documentation de l'API.


 * Intégrer la carte :


 * Ajouter un POI et une infobulle :

Leaflet


Voir la documentation de l'API.


 * Intégrer la carte (+ marqueurs et popups) :

<!-- = Installation d'un OS basé sur Linux (LSB - Linux Standard Base) sur Intel Galileo =

Prérequis
Avoir mis à jour le firmware.

Traitement sur sa carte SD
Suivre le tuto ici afin que la carte SD respecte le bon format.

Utilisation d'un Linux sur la carte SD
Attention à l'heure actuelle, en utilisant cette solution l'IDE Arduino Galileo ne reconnaitra pas la carte Galileo.

Il existe deux solutions possibles pour installer un linux sur votre OS. La première consiste à créer votre propre OS sur mesure avec Yocto Project mais cela demande plus de 4h avec une machine ayant un i7 haswell (4700hq). Une autre solution est de télécharger les images pré-buildées qui pourraient correspondre à vos besoin.

Créer votre propre OS sur mesure
Grâce à ce pdf, pas à pas, il est expliqué comment réaliser son propre OS basé sur Linux.

OS pré-buildé
Des OS pré-buildés sont également disponibles ici selon ce que vous voulez faire. Une fois l'une des archives téléchargées il suffit de le dézipper, et de le copier sur sa carte mini-SD. Une fois ces commandes effectuées, il est possible d'utiliser la carte en suivant ces instructions : Sur la carte Galileo, l'adresse IP de la carte Galileo est "settée" grâce au protocole DHCP, ce qui permet ainsi d'y accéder en ssh une fois que l'on a trouvé l'adresse IP donnée à sa carte Galileo.
 * Brancher le câble ethernet au routeur ;
 * Mettre la mini carte SD ;
 * Brancher la carte Galileo au secteur.

Utilisation des sketchs
La solution pour lancer des sketchs sur Galileo il faut utiliser les GPIO (General Purpose Input/Output) de la carte, via un langage de programmation. Exemple :
 * langageC
 * python.

Utilisation d'un Debian
Nous n'avons pas testé l'utilisation d'un OS Debian car selon la communauté Intel, cela rendrait la carte trop lente.

Utilisation de Java, Openhab, Mosquitto
-->
 * Effectuer ce qui est indiqué dans la section OS-prébuildé en téléchargeant le lien "Yocto Project Linux image w/ Clanton-full kernel + general SDKs + OpenJDK-6".
 * Se connecter en ssh à la carte Galileo
 * Ajuster la date de la carte à celle de votre ordinateur avec la commande : "date DateSurOrdi"
 * Depuis une autre console, copier le dossier openhab runtime sur la carte Galileo : "scp -r openhabruntime root@ipAdressGalileo:."
 * Télécharger les sources de mosquitto ici
 * Copier les sources mosquitto sur Galileo
 * Les décompresser depuis ssh
 * Accéder à ce dossier
 * Effectuer la commande make
 * Accéder à src/mosquitto.conf avec vi (ou votre éditeur préféré) et ajouter user root
 * Lancer mosquitto : "./src/mosquitto -c src/mosquitto.conf"
 * Lancer openhab : "sh start.sh"
 * Après l'affichage de "started classic UI at /openhab.app", vous pouvez accéder à http://@ipGalileo:8080/openhab.app?sitemap=demo

=Création d'une route personnalisée avec Express (framework node.js) =

Prérequis
Installer nodejs et npm.  Ensuite : npm install express
 * nodejs et Express installés

Introduction
Express est un framework Node.js MVC. Il s'organise autour de trois dossiers principaux : routes, views et public.
 * views : regroupe l'ensemble des vues ; dans notre présentation une simple page HTML.
 * routes : le modèle où l'on définit les fonctionnalités de chaque "route"
 * public : rassemble les éléments statiques (js, css, ...)

Une route désigne une adresse adresse:port/une/route/personnalisee.

Le fichier principal fait office de contrôleur.

Un hello world avec Express
Un simple hello world avec Express.

serveur.js

Pour lancer l'application nodejs serveur.js Allez sur http://localhost:4242/

Organiser le routage
L'ensemble des routes peut être décrit dans le fichier principal serveur.js. Cependant pour plus de clarté les routes sont généralement définies dans le dossier /routes.

serveur.js

/routes/index.js

views/une_page.html