Teddy Payet

MagicMirror², configuration scriptée, 2ème partie

Teddy Payet — 2020-04-14T22:55:42Z

Comme vous le savez tous, nous sommes en confinement depuis mi-mars. Pour m'occuper un peu en chômage partiel, en plus de ma vie de famille, je me suis inscris à une groupe d'entraide sur le MagicMirror sur Facebook. J'ai eu l'agréable surprise de voir qu'un article de mon blog était cité. Merci de la confiance de ces utilisateurs !
Après quelques échanges, j'ai proposé d'expliquer plus en détail mon installation scriptée et notamment ce à quoi correspond mes différents principaux scripts.

Tout a été déposé sur github (vous pourrez trouver le lien en bas de l'article). Je reprends ici plus ou moins le contenu du fichier Readme.

Cet article est un exemple d'automatisation de la maintenance de mon installation de MagicMirror. Le dépôt github a pour but de montrer la possibilité d'automatiser la maintenance d'une installation d'un MagicMirror.

Introduction

Le dépôt s'appelle mm_config_automate. Son existence n'est que pédagogique. Il n'est en aucun cas un module de MagicMirror.

De plus, je ne suis pas responsable d'une altération de vos données. Il vous faudra tester et adapter chaque script pour correspondre à VOS attentes.

Liste des scripts

L'ensemble des scripts sont en bash. Ils restent simples à comprendre et à prendre en main avec un peu de patience et de lecture. Voici la liste des scripts :

first_install.sh
mm_reset.sh
mm_update.sh
update_files_config.sh
disk_usage.sh

first_install.sh

Ce script permet d'installer l'ensemble des éléments de base pour qu'un MagicMirror puisse fonctionner. Il est à lancer sur une installation toute belle, toute neuve d'un Raspberry Pi 3. Je n'ai pas testé sur un Raspberry Pi 4 pour le moment. Il prend en compte un Raspbian basé sur un Debian Buster (10) mis à disposition des utilisateurs en février 2020.

Il fera dans l'ordre :

sudo apt update -y : Récupère la liste des mises à jour disponibles
sudo apt upgrade -y : Installe quelques mises à jour, ne supprime pas les packages
sudo apt autoremove -y : Supprime tous les anciens paquets qui ne sont plus nécessaires
sudo apt clean -y : Cette commande de terminal libère de l'espace disque en nettoyant les fichiers .deb téléchargés du référentiel local.

Puis :

On active le son par le HDMI ;
Forcer le HDMI ;
Forcer l'affichage vertical de l'écran ;
Enlever des programmes inutiles ;
Installation de quelques packages ;
Installation de Nodejs et NPM selon la méthode indiquée ici : https://github.com/audstanley/NodeJs-Raspberry-Pi
Ajouter les binaires de node dans le PATH ;
Installation de PM2 ;
Enregistrer les variables d'environnement (le home de MagicMirror, ainsi que de PM2) ;
Création du fichier mm.sh dans /home/pi/ ;
Exécution du script d'installation du MagicMirror ;
Sauvegarder les réglages de pm2 et lancement des scripts au démarrage ;

Et enfin, on enregistre le contenu du fichier crontab.txt dans le crontab de l'utilisateur en cours.

mm_reset.sh

Ce script installe MagicMirror à partir du dépôt github dudit projet. Il s'appelle "mm_reset" au lieu de "mm_install" car il supprime le répertoire /home/pi/MagicMirror/ s'il existe. Donc, il faut faire attention à ce point si vous désirez garder une précédente installation.

A son tour, ce script va lancer une série de commandes :

Arrêt de MM grâce à pm2 stop mm ;
Effacer le répertoire de MagicMirror si existant ;
Récupération du dépôt de MagicMirror ;
Passer sur la branche develop de MagicMirror ;
Création des liens symboliques dans MM (custom.css et config.js) ;
Installation des dépendances de MM grâce à npm ;
Lancement du script d'update des modules de MM (cf. update_files_config.sh) ;
Relancer MM sur pm2.

Liens symboliques

Dans le script mm_reset.sh, il est présumé que le fichier "config.js" et le fichier de personnalisation de css vitaux à MagicMirror soient présents dans votre répertoire /home/pi/mm_config_automate/. Un lien symbolique dans /home/pi/MagicMirror/css/ et /home/pi/MagicMirror/config/ sera fait pointant vers votre répertoire mm_config_automate.

MagicMirror n'y verra que du feu !

mm_update.sh

Ce script est plus rapide. Dans ce dépôt d'exemple, il n'est pas utilisé dans le crontab. Il est à utiliser manuellement lorsque MM doit être mis à jour.

Il arrête MM par pm2, puis va dans le répertoire de MagicMirror. A partir de là, le dépôt git est mis à jour avec les derniers fichiers. Une installation et une mise à jour des packages npm sont lancées.

Cela fait, on relance MM sur pm2.

update_files_config.sh

Ce script bash est le nerf de la guerre. Crontab appellera dans notre exemple le fichier update_files_config.sh tous les jours à 00h15.

Ce script contient 2 fonctions clés :

import_module ;
delete_modules.

Après l'utilisation de ces fonctions, une boucle est lancée pour vérifier l'existence du module MMM-AlarmClock. Ce dernier peut utiliser des fichiers mp3 comme sonnerie d'alarme.

Si vous désirez ajouter des fichiers mp3 à votre convenance, il vous suffira de les copier dans le répertoire sounds de votre dépôt "mm_config_automate". Automatiquement, tous les soirs (selon le crontab mis en place), chaque fichier mp3 présent sera copié dans /home/pi/MagicMirror/modules/MMM-AlarmClock/sounds/. Vous n'aurez plus à vous soucier d'autres choses que sa bonne utilisation dans votre fichier config.js

update_files_config.sh : fonction import_module

Cette fonction bash attend un paramètre : l'url vers le dépôt git du module que vous désirez installer sur votre MagicMirror.

Par exemple, si vous désirez utiliser le module de pages de MM, vous devez indiquer dans le fichier update_files_config.sh la commande suivante :

import_module https://github.com/edward-shen/MMM-pages.git

Elle ira dans le répertoire /home/pi/MagicMirror/modules/, vérifiera si le module existe déjà (en gros l'existence du répertoire "MMM-pages") ou pas. S'il n'existe pas, elle clonera le répertoire. Puis :

Accéder au répertoire du module ;
Si un fichier package.json existe, l'installation des packages npm est lancée.

Il faudra utiliser cette fonction autant de fois que de modules désirés. Vous trouverez des exemples dans ledit fichier.
Cerise sur le gateau, si le module existe déjà, il le mettra à jour avec les derniers fichiers provenant du dépôt que vous avez indiqué en paramètre.

update_files_config.sh : fonction delete_modules

Cette fonction se lance après l'ensemble des appels à import_module. Elle a pour but de supprimer les modules présents dans /home/pi/MagicMirror/modules/ devenus obsolètes.

Comme vous le savez, pour utiliser un module dans MagicMirror, nous devons l'avoir téléchargé d'une part dans /home/pi/MagicMirror/modules/ mais d'autre part l'avoir indiqué dans notre fichier config.js.

Si le répertoire /home/pi/MagicMirror/modules/nom_repertoire/ n'est pas indiqué dans ce fichier, le répertoire sera considéré comme obsolète. Donc, qu'il peut être supprimé. La présente fonction vérifiera chaque répertoire dans modules/ à l'exclusion de :

default/
node_modules/

Cela préservera l'espace disque de votre Raspberry Pi et évitera des erreurs dans votre MagicMirror.

disk_usage.sh

Ce script permet de savoir le pourcentage d'utilisation d'espace disque. Dans le présent exemple, si le taux d'utilisation arrive à 90% de sa capacité, un email est envoyé (je vous laisse le soin de configurer le serveur d'envoi d'emails).

Il faut savoir que pm2 écrit beaucoup d'information dans les logs (cela dépend surtout des applications lancées sous pm2 mais c'est un autre sujet). En prenant cela en compte, si le taux d'utilisation excède les 90%, le script lance en premier lieu la commande pm2 flush pour vider l'ensemble des fichiers logs de pm2. Puis vérifie à nouveau le taux de remplissage. Si la commande n'a pas changé la donne, l'email est envoyé.

crontab.txt

Ce petit bout de fichier vous permet d'indiquer l'heure à laquelle vos routines doivent être mises en place.

Dans le présent exemple, voici les routines :

A 0h00 : On vérifie d'abord l'espace disque
A 0h05 : On met à jour les fichiers de mm_config_automate
A 0h10 : On importe le contenu du fichier crontab.txt dans le crontab à 00h10
A 0h15 : On peut maintenant lancer les scripts de routine (update_files_config.sh)
A 0h20 : On relance MagicMirror pour prendre en compte la configuration à jour.
Tous les mois, on redémarre le Raspberry Pi

Si vous êtes parents et/ou assujetti à des périodes de vacances et un planning différents durant ces périodes, il est possible de mettre en place un fichier de config dédié à cette période.

Dans notre exemple, le contenu de config.js et config_vac.js sont identiques. Le but est d'illustrer l'existence des fichiers selon la période. En ayant en tête les dates de vacances qui vous intéressent, vous pouvez ajouter une ligne dédiée dans crontab pour que le lien symbolique de /home/pi/MagicMirror/config/config.js pointe vers le fichier /home/pi/mm_config_automate/config_vac.js au lieu de /home/pi/mm_config_automate/config.js. Le jour où vous devez revenir au travail (donc la fin de votre période de vacances) à 00h30, il suffira de remettre le lien symbolique vers /home/pi/mm_config_automate/config.js

Exemple pour les vacances de l'Ascension de la zone C :

############### # Vacances Ascension : 20 mai 30 0 20 5 0 cd /home/pi/MagicMirror/config/; rm -rf config.js; ln -s /home/pi/mm_config_automate/config_vac.js config.js; pm2 restart mm # Rentrée : 25 mai 30 0 25 5 * cd /home/pi/MagicMirror/config/; rm -rf config.js; ln -s /home/pi/mm_config_automate/config.js config.js; pm2 restart mm

Voilà. A vous de prendre en main ce projet en le copiant dans un dépôt personnel privé et de le faire vivre.

Le projet sur github

Comme indiqué en début de cet article, les différents fichiers ont été déposé sur github. Ils ont pour but de vous aider à mettre en place votre automatisation :
https://github.com/Ybbet/mm_config_automate

Attention de ne pas mettre le projet en public si vous l'utiliser sur VOTRE installation. Préservez votre vie... privée.

A lire aussi

MagicMirror², un miroir qui vous veut du bien.
MagicMirror², on recommence depuis le début
MagicMirror², un socle qui lui va comme un gant
MagicMirror², un Raspberry Pi, un écran et cie sont dans un bateau
MagicMirror², ma configuration personnalisée
MagicMirror², configuration scriptée
MagicMirror², configuration scriptée, 2ème partie

MagicMirror², configuration scriptée

Teddy Payet — 2018-07-16T06:00:00Z

Toujours dans l'optique d'améliorer mon installation de MagicMirror², j'ai mis en place une mise en place automatique de mes modules. Prenez un café ou thé et voyons cela en détail.

Pour rappel, MagicMirror² est installé sur un Raspberry Pi 3 avec un Debian 9, Stretch. Cette installation permet donc pas mal de choses très sympathiques dont les crontab, la connection ssh et les scripts bash.

Préambule

Pour des raisons de stabilité, je ne mets pas à jour MagicMirror² avec la dernière version en ligne. De même, les modules tiers ne seront pas mis à jour automatiquement. Je ne désire pas casser mon installation avec des versions que je n'aurais pas testé au préalable. Ces derniers points seront donc mis à jour manuellement pour avoir une meilleure maitrise de "mon" logiciel.

Versionner sa configuration

Comme vous commencez à le savoir, MagicMirror² a besoin d'un fichier config.js dans config/ pour fonctionner correctement et surtout pour avoir votre personnalisation.
Au lieu de faire des copier-coller d'une machine à une autre, j'ai mis en place un dépôt (privé) sur mon compte gitlab.com. J'ai cloné ce dépôt sur mon Raspberry. Puis, j'ai créé un lien symbolique dans /home/pi/MagicMirror/config/ vers /home/pi/magicmirror_config/config.js

De même, pour personnaliser la mise en page sur certains points, j'ai créé un fichier custom.css dans /home/pi/magicmirror_config/. Un lien symbolique dans /home/pi/MagicMirror/css/ est également présent.
Le concept de lien symbolique est mis en place sans difficulté. Voyons maintenant les scripts bash.

Bash, une installation scriptée

Il n'y a rien de crypter, mais tout est scripté, rien de sorcier. :-)

Ma philosophie dans tous mes développements est d'automatiser (scripter) les actions répétitives. Ici vous êtes dans un cas typique d'école : le déploiement de codes.

Je teste sur ma machine locale (mon mac) certains modules tiers (voir des versions de modules que j'aurais fait évoluer).
Dans mon répertoire /home/pi/magicmirror_config/, j'ai créé un fichier bash update_files_config.sh.
Le chemin vers mes répertoires MagicMirror et magicmirror_config change selon la plateforme. Au lieu de changer le chemin vers ces répertoires à chaque fois, je vais créer 2 variables dans mon profil bash :
Sur le Raspberry Pi, dans le fichier ~/.bashrc :

export MM_CFG_HOME=/home/pi/magicmirror_config/ export MM_HOME=/home/pi/MagicMirror/

Sur mon Mac, dans le fichier ~/.bash_profile :

export MM_CFG_HOME=~/Sites/magicmirror_config/ export MM_HOME=~/Sites/MagicMirror/

Ce qui vous permettra d'appeler ces variables dans notre fichier bash sans sourciller :

#!/usr/bin/env bash _MM_CFG_HOME=$MM_CFG_HOME _MM_HOME=$MM_HOME

Un script classique affichera du texte de la couleur par défaut que vous aurez choisit dans votre Terminal. J'ai envie de rendre cela un peu plus lisible. Pour cela, je vais utiliser du texte bold et de la couleur.
Voici ce que cela donne comme variable :

txt_bold=$(tput bold) txt_normal=$(tput sgr0) txt_red='\033[0;31m' txt_green='\033[0;32m' txt_nc='\033[0m' # No Color

Les paramètres de personnalisation "graphique" sont en place. Cool. On les utilisera en temps voulu.

Même si vous avez bien exporté votre variables d'environnement, il est préférable de mettre une petite sécurité (toujours la sécurité !) :

if [ -z ${_MM_CFG_HOME} ]; then _MM_CFG_HOME=/home/pi/magicmirror_config/ fi if [ -z ${_MM_HOME} ]; then _MM_HOME=/home/pi/MagicMirror/ fi

En gros, si votre variable d'environnement est "vide" pour X raisons, le script va leur donner une valeur par défaut.

Bash, liens symboliques, bis

Comme expliqué au début de cet article, MagicMirror a besoin d'un fichier config.js. De ce fait, le script vérifie sa présence dans /home/pi/MagicMirror/config/. Et si il n'existe pas, il crée un lien symbolique vers /home/pi/magicmirror_config/config.js :

if [ ! -f ${_MM_HOME}config/config.js ]; then ln -s ${_MM_CFG_HOME}config.js ${_MM_HOME}config/config.js fi

Dans mon précédent article, j'ai indiqué que j'utilisais le module MMM-AlarmClock avec des fichiers mp3 personnalisés. Pour que le module prenne en compte ces fichiers mp3, ils doivent être présents dans le répertoire /home/pi/MagicMirror/modules/MMM-AlarmClock/sounds.
J'ai une carte SD de 16Go, ce qui assez confortable. Mais je ne veux pas surcharger inutilement la carte mémoire. Pour se faire, les liens symboliques sont également une très bonne solution.

Dans mon dépôt /home/pi/magicmirror_config/, j'ai créé un répertoire sounds/ qui contiendra tous mes fichiers mp3.

Pour mon besoin de fichiers mp3, voici le code présent :

if [ -d ${_MM_HOME}modules/MMM-AlarmClock ]; then #ls ${_MM_CFG_HOME}sounds/ | grep ".mp3" list_mp3=$(ls ${_MM_CFG_HOME}sounds/ | grep ".mp3") for mp3_file in $list_mp3; do if [[ -f ${_MM_HOME}modules/MMM-AlarmClock/sounds/$mp3_file ]]; then echo "Le fichier ${txt_bold}$mp3_file${txt_normal} existe dans ${_MM_HOME}modules/MMM-AlarmClock/sounds"; else echo "Le fichier ${txt_bold}$mp3_file${txt_normal} n'existe pas dans ${_MM_HOME}modules/MMM-AlarmClock/sounds. On crée le lien symbolique."; ln -s ${_MM_CFG_HOME}sounds/$mp3_file ${_MM_HOME}modules/MMM-AlarmClock/sounds/$mp3_file; fi done fi

Bash, des fonctions : importer un module

Le but principal du script update_files_config.sh est d'importer un module qui est nécessaire au fichier config.js pour notre MagicMirror. J'utilise plus d'un module tiers. Certainement, cela sera également votre cas.
Au lieu de répéter X fois le même code, vous allez créer une fonction. Appelons la "import_module" (module au singulier).

import_module () { if [[ ! -z ${1} ]]; then cd ${_MM_HOME}modules/ repository=$(basename -s .git "$1") echo "" printf "${txt_green}${txt_bold}${repository}${txt_normal}${txt_nc}\n" if [[ -d ${_MM_HOME}modules/${repository} ]]; then echo "** ${_MM_HOME}modules/${repository} existe déjà" else echo "** Récupération du répertoire ${1}" git clone ${1} fi cd ${_MM_HOME}modules/${repository} if [[ -f $(ls | grep 'package.json') && ! -d $(ls | grep 'node_modules') ]]; then echo "** Installation des modules npm de ${repository}" npm install npm audit fix else if [[ ! -f $(ls | grep 'package.json') ]]; then echo "** Il n'y a pas de modules npm à installer pour ${txt_bold}${repository}${txt_normal}" else echo "** Les modules npm de ${txt_bold}${repository}${txt_normal} sont déjà installés" fi fi cd ${_MM_HOME}modules/ else printf "\n${txt_red}Vous avez oublié d'indiquer un dépôt git en paramètre${txt_nc}\n" fi }

Cette fonction permet d'importer un module à partir de son url git. Pour cela, vous devez indiquer l'url du git en paramètre de cette façon :

import_module https://github.com/Ybbet/MMM-AlarmClock.git

Si vous ne donnez aucune url, vous aurez un message vous indiquant que l'information est manquante.

Cool… Mais ce n'est pas tout. Un module a souvent besoin d'une installation de modules pour son bon fonctionnement. Pour le savoir, autrement que de lire la documentation, le script vérifie la présence d'un fichier package.json mais également l'absence du répertoire node_modules. En effet, l'absence de ce répertoire indique que l'installation n'a pas encore été réalisée. Le script lancera un npm install && npm audit fix dans son répertoire local.

Pas mal non ? :-)

Bash, des fonctions : effacer les modules inutiles

Vous aurez testé des modules, rejeté des modules et garder des modules. Pour que le script reconnaisse votre choix, il y a une solution très très simple : le fichier config.js
En effet, quand vous utilisez un module, vous indiquez dans votre fichier la mention module: "MMM-AlarmClock" (remplacez "MMM-AlarmClock" par votre nom de module). Ce nom de module correspond au nom du dépôt git désiré et donc du répertoire téléchargé (merci import_module).
Vous l'appellerez "delete_modules" (modules avec un "s" cette fois-ci car on s'occupe de tous les modules sans distinction)

Donc, il suffit de vérifier la présence de cette chaine de caractères dans le fichier :

delete_modules () { # Stocker l'ensemble des répertoires présents /home/pi/MagicMirror/modules/ modules_list=$(ls ${_MM_HOME}/modules/) # Ne pas prendre en compte certains fichiers et répertoires propres à MagicMirror modules_list=${modules_list[@]//default/} modules_list=${modules_list[@]//README.md/} modules_list=${modules_list[@]//node_modules/} # lançons une boucle pour s'occuper de chaque module. for module in ${modules_list[@]} do # Si le module n'est pas utilisé dans config.js if grep -Fq "module: \"${module}\"" ${_MM_HOME}/config/config.js then echo "${module} existe dans config.js" else echo "${module} n'existe pas dans config.js" rm -rf ${_MM_HOME}/modules/${module} fi done }

Bash, oui mais dans l'ordre

Si vous n'avez pas été trop perdu, vous vous rendez compte que je parle de liens symboliques avant même d'avoir installé les modules. :-D
Ben, ouais, c'était un petit piège. Ce n'est pas logique de lancer la création de liens symboliques (cf. MMM-AlarmClock/sounds) dans un répertoire si son installation n'a pas été faite d'abord. Cet ordre est surtout important lorsque vous lancez pour la première fois le script et/ou si vous revenez à plusieurs reprises sur le choix d'un module. J'en ai fait l'expérience avec MMM-AlarmClock. J'ai testé MMM-TTS (pour avoir directement le texte prononcé par la machine sans passer par un fichier mp3, sauf que le français n'est pas pris en compte), créé un module MMM-Google-tts (pas tout à fait convaincant sur le Raspberry Pi). Donc, voici l'ordre dans lequel le code doit être placé (et donc exécuté) :

Bash, une installation scriptée ;
Bash, liens symboliques, bis (la partie config.js uniquement) ;
Bash, des fonctions : importer un module ;
Bash, des fonctions : effacer les modules inutiles ;
Bash, liens symboliques, bis (la partie sounds ici).

En gros, tous vos paramètres d'environnement du fichier bash doivent se trouver en début de script. Puis :

lancer les petites sécurités sur la présence de fichier et répertoire propres à MagicMirror ;
créer les fonctions ;
lancer l'importation des modules, un module par ligne pour faciliter la relecture ;
lancer la suppression des modules inutiles (cf. delete_modules)
lancer vos actions dans les répertoires (liens symboliques par exemple) à la fin du fichier car là, vous serez sûr de la présence de ces modules dans /home/pi/MagicMirror/modules/.

Voilà ! C'est tout pour aujourd'hui. Je laisse un peu pour un nouvel article : la 2ème partie

A lire aussi

Visuel : Photo by Annie Spratt on Unsplash

Des astuces et mémos pour SVN

Teddy Payet — 2018-06-15T09:00:00Z

Je travaille encore très souvent sur des projets sous SVN avec grand plaisir. J'utilise des lignes de commandes pour aller plus vite. Il arrive parfois que je me creuse les méninges pour certaines lignes de commandes. Alors, un petit article mémo ne fera pas de mal.

Lorsqu'on est sous SVN, il est parfois utile de voir la liste des éléments qui ne sont pas encore reconnus dans le dépôt.

svn st | grep ^?

Et si on ne veut pas avoir le " ?" et les espaces entre ce " ?" et le nom des éléments :

svn st | grep ^? | cut -c9-

Pour lister tous les éléments qui ont été modifié :

svn st | grep ^M

Pour lister tous les éléments qui ont été ajouté :

svn st | grep ^A

Pour lister tous les éléments qui sont introuvables :

svn st | grep ^!

Si vous désirez afficher tous les éléments autres que modifiés ou ajoutés :

svn st | grep -v ^[AM]

Afficher tous les fichiers ayant été modifié, ou ajouté ou qui ne sont pas reconnus par svn :

svn st | grep ^[AMD\!?]

Il arrive parfois qu'on ait besoin de déposer des fichiers (exemple : un dump d'une base de données) mais sans vouloir télécharger tout le répertoire cible sur son local. Voici la commande adéquate :

svn co http://example.org/url_depot/bdd_dump/ --depth empty

Cela permettra de faire un checkout sur son local sans télécharger tous les fichiers présents sur le dépôt.

Règle générique

De manière générale, SVN en lignes de commande ajoute 9 caractères avant le nom de l'élément affiché. De ce fait, à chaque fois que vous ne désirez pas voir ces 9 caractères (ou 9 colonnes), il faut mettre à la fin de votre commande | cut -c9-

En bash, si on désire exporter le résultat de notre commande dans un fichier, il faut rajouter à la fin de notre commande " > nom_fichier.txt"
Soit pour exemple, la liste des fichiers autres que modifiés et/ou ajoutés :

svn st | grep -v ^[AM] > files.txt

Ajouter de nouveaux fichiers/répertoires au dépôt

for new_element in $(svn st | grep "^?" | cut -c9-); do svn add ${new_element}; done;

Supprimer des fichiers/répertoires obsolètes au dépôt

for delete_element in $(svn st | grep "^\!" | cut -c9-); do svn delete ${delete_element}; done;

Visuel : Photo by Moja Msanii on Unsplash

MagicMirror², on recommence depuis le début

Teddy Payet — 2018-06-08T05:30:00Z

Récemment, j'ai écrit un article pour installer mon MagicMirror². Ce tutoriel est tout à fait fonctionnel. Malheureusement, pas dans mon cas car j'avais des versions de packages trop anciennes (cf. node.js). Je vais vous expliquer comment j'ai remédié à cela. :-)

J'ai acheté mon Raspberry Pi en juin 2016. J'en avais fait l'acquisition pour tester Gladys. A cette période, la version 2 de Gladys sortait des cartons et avaient peu de plugins pour agrémenter le tout.
Je l'ai donc laissé un peu de côté en attendant le bon moment pour réaliser mon deuxième projet pour ce petit bijoux.

Incompatibilité

J'avais installé toutes les librairies nécessaires pour Gladys et elle-même également. Or, ces versions sont conflictuelles avec ce que MagicMirror² désire. Je vais être honnête, ça me prendrait plus de temps de désinstaller chaque composant plutôt que de refaire la carte SD à partir de l'image de Raspbian fourni par raspberry.org.

Recommençons

Le premier point est de refaire la carte SD avec l'image 2018-04-18-raspbian-stretch issue du site officiel. Cela aura pour effet de repartir de zéro.

Cela fait, on remet la carte SD dans le Raspberry PI pour un redémarrage. Ce dernier point se passe quand même rapidement. Il n'y a pratiquement rien à faire. Les choses sont bien ficelées.

Installation de packages

Il est nécessaire d'installer quelques petits packages pour assurer leur disponibilité au moment voulu :

sudo apt-get install git zip unzip curl wget

Oui, ce n'est pas vraiment nécessaire avec une installation fraîche. Toutefois, cette action permettra de mettre tout le monde au même niveau.

Mise à jour des packages

Comme dans le précédent tutoriel, j'ai mis à jour les packages et le firmware :

sudo apt-get update; sudo apt-get upgrade; sudo apt-get autoremove; sudo rpi-update; sudo apt-get clean

A la fin de cette ligne, je vide le cache puis un redémarrage : sudo reboot

Installation de Node et MagicMirror²

Le redémarrage étant fait, on va maintenant lancer les scripts initiaux :
Node.js

wget -O - https://raw.githubusercontent.com/audstanley/NodeJs-Raspberry-Pi/master/Install-Node.sh | sudo bash node -v

MagicMirror²

bash -c "$(curl -sL https://raw.githubusercontent.com/MichMich/MagicMirror/master/installers/raspberry.sh)"

J'ai vu qu'une branche develop était présente et des commits sur cette branche réglaient quelques bugs. Alors, je passe à cette branche :

cd ~/MagicMirror/ git checkout -b develop git pull

Après cela, on peut lancer l'installation :

npm install

Tout s'est bien passé pour mon installation. Cool.

Installation des modules

Pour mes besoins actuels, j'utilise les modules suivants :

Le principe d'installation est le même pour tous les modules :

cd ~/MagicMirror/modules/ git clone https://github.com/user/mmm-nom-module

Soit :

cd ~/MagicMirror/modules/ git clone https://github.com/tataille/MMM-FreeBox-Monitor.git git clone https://github.com/spectroman/mmm-moon-phases.git git clone https://github.com/edward-shen/MMM-page-indicator.git git clone https://github.com/edward-shen/MMM-pages.git

Pour le reste, la configuration des modules se fait dans le fichier ~/MagicMirror/config/config.js

Configuration du fichier config.js

Comme le demande la documentation de MagicMirror², on doit copier ~/MagicMirror/config/config.js.sample vers ~/MagicMirror/config/config.js
Cela dit… Je ne vais pas faire ça. :-D

En effet, je vais faire en sorte d'avoir une version du fichier config.js qui soit versionnée sur un git.
Comme tout projet git, il n'est pas possible de cibler sur un fichier purement et simplement (comme le ferait svn par exemple). De ce fait, j'ai créé sur Gitlab.com un projet qui sera en mode privé.

On peut nommer ce projet "magicmirror_config" pour faire simple.
Depuis le terminal, je tape les lignes suivantes :

cd ~/ git clone https://gitlab.com/user/magicmirror_config.git

Maintenant, je crée un lien symbolique dans ~/MagicMirror/config/ pointant vers ~/magicmirror_config/config.js

cd ~/MagicMirror/config/ mv config.js config.js.old ln -s ~/magicmirror_config/config.js config.js

Par la même occasion, j'ai fait la même chose avec le fichier ~/MagicMirror/css/custom.css. Pratique pour personnaliser son affichage graphiquement.

cd ~/MagicMirror/css/ mv custom.css custom.css.old ln -s ~/magicmirror_config/custom.css custom.css

Démarrage automatique de MagicMirror²

Comme indiqué dans https://github.com/MichMich/MagicMirror/wiki/Auto-Starting-MagicMirror, il est possible de lancer automatiquement MagicMirror² au démarrage. Pour cela, il est nécessaire d'installer PM2 sur la machine.
Le script d'installation de MagicMirror² le fait. Mais j'ai eu un souci que je ne saurais identifier pour le moment. Je verrai cela plus tard.

Le script a bien installé pm2 mais n'a pas fait les liens symboliques pour ce stretch. Cela se trouve dans /opt/nodejs/bin/.
Sur stretch, on fait un lien vers /etc/alternatives/ puis de là, un lien dans /usr/bin/.
Voici le code à taper dans Terminal :

sudo ln -s /opt/nodejs/bin/pm2 /etc/alternatives/pm2 sudo ln -s /etc/alternatives/pm2 /usr/bin/pm2 sudo ln -s /opt/nodejs/bin/pm2-dev /etc/alternatives/pm2-dev sudo ln -s /etc/alternatives/pm2-dev /usr/bin/pm2-dev sudo ln -s /opt/nodejs/bin/pm2-docker /etc/alternatives/pm2-docker sudo ln -s /etc/alternatives/pm2-docker /usr/bin/pm2-docker sudo ln -s /opt/nodejs/bin/pm2-runtime /etc/alternatives/pm2-runtime sudo ln -s /etc/alternatives/pm2-runtime /usr/bin/pm2-runtime

Créer un fichier de démarrage de MagicMirror²
Pour nous simplifier la tâche, il est conseillé de créer un fichier bash :

cd ~ nano mm.sh

Puis d'ajouter les lignes suivantes :

cd ~/MagicMirror DISPLAY=:0 npm start

On enregistre le tout. Puis on le rend exécutable.

chmod +x mm.sh

Démarrer MagicMirror² avec PM2

C'est vraiment tout simple :

pm2 start mm.sh

Activer le démarrage du script
On doit être sûr que le script soit lancé au démarrage. Pour cela, on sauvegarde les réglages actuels de PM2 :

pm2 save

Contrôler son MagicMirror² via PM2

Avec MagicMirror fonctionnant via PM2, on dispose d'outils pratiques :

Redémarrer MagicMirror

pm2 restart mm

Arrêter MagicMirror

pm2 stop mm

Afficher les logs MagicMirror

pm2 logs mm

Afficher les informations sur le processus MagicMirror

pm2 show mm

A lire aussi

MagicMirror², un miroir qui vous veut du bien.
MagicMirror², on recommence depuis le début
MagicMirror², un socle qui lui va comme un gant
MagicMirror², un Raspberry Pi, un écran et cie sont dans un bateau
MagicMirror², ma configuration personnalisée
MagicMirror², configuration scriptée
MagicMirror², configuration scriptée, 2ème partie

MagicMirror², un miroir qui vous veut du bien.

Teddy Payet — 2018-06-01T15:09:00Z

Le “MagicMirror²” est un projet open source qui a été mis à disposition par son créateur : Michael Teeuw
Présentation : “MagicMirror² est une plate-forme modulaires open source de miroirs intelligents. Avec une liste croissante de modules installables, le MagicMirror² vous permet de convertir votre couloir ou votre miroir de salle de bains en votre assistant personnel. MagicMirror² est construit par le créateur du MagicMirror original avec l'aide incroyable d'une communauté croissante de contributeurs.”

Le matériel

Le matériel nécessaire est le suivant :

Un Raspberry Pi 3 (ne pas oublier une source d'alimentation) ;
Une carte SD de 8Go (minimum) ;
Un clavier ;
Une souris ;
Un câble HDMI ;
Un écran HDMI.

Je vous propose de voir comment installer MagicMirror² (aka MM²) sur votre Raspberry Pi 3. Bien entendu, le moment venu, vous brancherez tous les éléments les uns aux autres lorsque vous devrez vous connecter au Raspberry PI.

Installation du Raspberry Pi
Préparer une carte SD.

Il est nécessaire d'installer Raspbian sur votre carte SD pour optimiser votre utilisation du Raspberry Pi et de MagicMirror². Cette opération doit être réalisée depuis un ordinateur (Windows, Mac, Linux)

Aller sur l'url https://www.raspberrypi.org/downloads/raspbian/

Télécharger la dernière version de Raspbian (en mai 2018, Raspbian Stretch with desktop). Une fois téléchargé sur votre ordinateur, veuillez décompresser le fichier.

Avec le répertoire extrait, vous pouvez préparer la carte SD. Insérez votre carte SD dans votre ordinateur. Ouvrez votre logiciel* de gestion de disques (SD Card Formatter, Win32 Disk Imager, Utilitaire de Disques, etc.). Sélectionnez votre carte SD et lui donner un nom (de préférence sans espace ou accents pour simplifier les lignes de commandes). Référez-vous à la documentation propre à votre logiciel pour toutes ces étapes.

Sélectionnez l'image de Raspbian fraîchement extrait pour l'importer sur la carte SD. Lancez l'écriture de cette image sur la carte.

Cela fait, éjectez la carte SD.

Démarrer et configurer le Raspberry Pi

Maintenant que la carte SD est prête avec Raspbian, il est nécessaire de l'insérer dans le Raspberry Pi.

Connecter le câble HDMI à l'écran puis au Raspberry. Allumez votre écran. Branchez le clavier, la souris au Raspberry. Ne pas oublier maintenant de brancher la source d'alimentation du Raspberry.

Au premier démarrage du Raspberry Pi, cela peut prendre un peu de temps. Vous serez invité à renseigner le mot de passe pour l'utilisateur pi (soit par défaut : raspberry).

Depuis le terminal, entrez sudo raspi-config et validez. Cela lancera la configuration du Raspberry. Choisissez “Expand Filesystem” en tapant sur la touche “Entrée”. On utilisera ainsi tout l'espace de la carte SD.
Cela fait, on sélectionne “Internationalisation Options” pour choisir la langue désirée. Le faire à votre convenance : la langue, le timezone, le format du clavier, le protocole Wifi.

Maintenant, on va choisir “Advanced options”, puis “Hostname”. Par défaut, on a raspberrypi. Mais au vu du projet, on peut appeler ça magicpi. A votre convenance ici :-)

Après cela, revenir sur “Advanced options” et choisir “SSH”. Il sera utile de pouvoir une connexion SSH pour accéder au Raspberry à distance.

On devrait être bon maintenant. Revenir à l'écran principal et utiliser la touche de tabulation pour mettre en surbrillance “Finish” en bas de l'écran et cliquer sur “Entrée”. A la demande de redémarrage, cliquer sur “Yes”.

Configurer le Wifi du Raspberry Pi

Une particularité du Raspberry Pi 3 est d'avoir le wifi nativement. Il va falloir le configurer pour avoir accès à votre réseau internet.

Après le redémarrage, vous aurez un bureau graphique Linux. Lancez le Terminal, vous y configurez le wifi en éditant le fichier wpa_supplicant.conf :

sudo nano /etc/wpa_supplicant/wpa_supplicant.conf

A la fin du fichier, renseignez vos informations de connexion :

network={ ssid="votre_nom_de_reseau" psk="votre_mot_de_passe_reseau" }

Pour enregistrer votre configuration, cliquer sur CTRL-X puis sur Y.

Il faut redémarrer votre raspberry : sudo reboot.

Nettoyer et mettre à jour le système

Bon, tout cela est sympa, mais il va falloir mettre tout ce petit monde à jour et faire maigrir tout ça.

Depuis votre Terminal, taper df -h pour avoir la capacité actuelle de votre Raspberry. Notez l'espace utilisé pour le comparer.

On va supprimer quelques packages inutiles pour le MM² :

sudo apt-get remove --purge idle3 java-common libreoffice* minecraft-pi scratch nuscratch penguinspuzzle python-minecraftpi python3-minecraftpi smartsim sonic-pi wolfram-engine

Puis :

sudo apt-get clean sudo apt-get autoremove

Cela va prendre un petit moment pour que ces opérations se terminent. Soyez patient et pas trop loin de votre écran pour valider certaines opérations. Faites à nouveau df -h dans votre terminal et remarquez le changement.

Continuons. Il est temps de mettre à jour vos packages :

sudo apt-get update ; sudo apt-get upgrade ; sudo rpi-update.

“update” met à jour la liste des packages disponibles et leur version ;
“upgrade” met à jour les packages installées ;
“rpi-update” va quant à lui mettre à jour le firmware du Raspberry Pi.

Respirez à nouveau et tapez sudo reboot

Installation de MagicMirror²

Le Raspberry est prêt. Alors, installons le temps attendu MagicMirror².

Il existe un script qui permettra d'installer MM² comme il se doit. Toutefois, il arrive que l'installation du package “node” pose un problème. Le script installe une version NodeJS 9.x. La version de node testée par MM² est la 5.1.0. Si vous avec une version inférieure, cela bloquera l'installation de composants node qui nécessitent eux un node 4.6.x minimum.
Il faudra faire attention à la version de NodeJS surtout si vous avez depuis un moment votre Raspberry Pi. Ce qui était mon cas. J'avais un node v4.4.2 qui forcément n'était pas au goût de MM².

Installation préalable de NodeJS

Pour y remédier, vous allez installer node en premier. Tapez ceci dans votre Terminal :

wget -O - https://raw.githubusercontent.com/audstanley/NodeJs-Raspberry-Pi/master/Install-Node.sh | sudo bash node -v

Ce script bash installera par défaut la version NodeJS 10.x. Il est possible de changer la version de NodeJS en tapant ceci :

sudo node-install -v 9; # then you will get prompted with which # specific version of 9 you wish to install

Mais on n'en est pas là.

Exécution du script pour MagicMirror²

NodeJS étant installé, vous allez lancer le script d'installation de MagicMirror² :

bash -c "$(curl -sL https://raw.githubusercontent.com/MichMich/MagicMirror/master/installers/raspberry.sh)"

Cela lancera le processus d'installation pour vous. Ne partez pas trop loin du Raspberry car des validations seront à faire au fil de l'eau.

Attention, le script d'installation de MM² s'occupe déjà d'installer un NodeJS (v9.x en mai 2018). Donc, vous pourriez vous passer de l'étape précédente en réalité. Mais si vous désirez tester sur d'autres versions de NodeJS, une installation manuelle, citée précédemment, vous facilitera grandement la tâche.
Si le script de MM² détecte un node existant, il sautera cette étape et vous indiquera qu'il faudra mettre à jour node si votre version est inférieure à la version testée.

Configuration complémentaire

Le script s'est bien déroulé. Vous devez configurer quelques points complémentaires spécifiques à MM². Il faut par exemple indiquer que l'écran est à la verticale. Tapez :

sudo nano /boot/config.txt

Et ajoutez à la fin du fichier les lignes suivantes :

# Rotate display vertically display_rotate=1

Appuyez sur CTRL-X quand vous avez fini puis Y pour sauvegarder vos modifications.
Raspbian lance un écran de veille au bout d'un certain temps. De ce fait, nous allons désactiver ceci en modifiant un fichier :

sudo nano /etc/xdg/lxsession/LXDE-pi/autostart

Ajoutez à la fin du fichier ces lignes :

@xset s noblank @xset s off @xset -dpms

Modifiez le fichier lightdm.conf :

sudo nano /etc/lightdm/lightdm.conf

Recherchez la ligne xserver-command en descendant plus bas. Y renseigner ces valeurs :

xserver-command=X -s 0 -dpms

Enlevez le « # » en début de ligne si besoin. Enregistrez vos modifications CTRL-X puis Y et entrée.

Pour des soucis d'économie d'énergie Raspberry désactive certains composants dont le wifi. En modifiant un paramètre dans /etc/network/interfaces, cette fonctionnalité sera ineffective :

sudo nano /etc/network/interfaces

Cherchez wlan0 et ajoutez, en-dessous, la ligne suivante :

wireless-power off

Sauvegardez vos modifications et redémarrez votre Raspberry Pi :

sudo reboot

A ce stade, vous avez configuré entièrement votre MM². Il vous faudra le personnaliser en éditant le fichier config.js et/ou en ajoutant des modules supplémentaires.

cd ~/MagicMirror/config cp config.js.sample config.js

Et maintenant, vous pouvez l'essayer :

cd ~$HOME/MagicMirror npm start

Enjoy !

Sources :

A lire aussi

MagicMirror², un miroir qui vous veut du bien.
MagicMirror², on recommence depuis le début
MagicMirror², un socle qui lui va comme un gant
MagicMirror², un Raspberry Pi, un écran et cie sont dans un bateau
MagicMirror², ma configuration personnalisée
MagicMirror², configuration scriptée
MagicMirror², configuration scriptée, 2ème partie

Installer Homebrew sur Mac OSX

Teddy Payet — 2016-03-02T08:00:00Z

Il arrive souvent quand on développe qu'il nous soit nécessaire d'installer certains outils pour mieux travailler. Il existe plusieurs solutions pour y arriver :

faire le tout à la main en compilant les sources de l'outil (pas simple pour tout le monde, même pour moi) ;
utiliser MacPorts pour installer les outils (je vous partagerai bientôt un pas à pas pour son installation) ;
utiliser Homebrew pour installer les outils.

Présentation de Homebrew

Homebrew nous permet d'installer des outils qu'Apple n'a pas installé sur MacOS. Généralement ceux sont des utilitaires accessibles par lignes de commande. Donc si vous y êtes allergiques, passez votre chemin.
La communauté autour d'Homebrew est grande et réactive. Ce qui a l'avantage de nous donner accès à un panel très large d'outils. Ces outils sont souvent issus de la communauté Linux (Ubuntu, Debian et cie).
Pour simplifier l'idée, c'est un gestionnaire de packages (cf. nos outils).

Installation

Comme le dit la page d'accueil du site d'Homebrew le moyen le plus simple est de taper cette ligne dans votre Terminal :

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Le script va nous expliquer les actions qu'il va réaliser avant de les lancer. Il nous suffira de valider son message pour que l'installation puisse se lancer. Cela fait, nous pouvons lancer la ligne de commande brew doctor pour savoir si tout est opérationnel pour Homebrew sur notre système d'exploitation. Suivre les indications de cet utilitaire le cas échéant.

Homebrew installe ses packages dans son répertoire (cf. "Cellar") et créera des alias dans le répertoire /usr/local/. C'est un avantage pour reconnaitre ce qui a été installé par Homebrew sans altérer notre OS.

Exemple d'utilisation : GruntJS

Lorsqu'on réalise des sites (ce n'est qu'un exemple), nous réalisons des actions répétitives. Mais voilà… le faire manuellement est chronophage. Pour éviter cela, il existe GruntJS (je vous invite à lire la documentation officielle). Pour installer GruntJS, on a besoin de Node.js et de npm. Et c'est là qu'intervient Homebrew.

Voici le code à exécuter pour installer Node.js et npm :

brew install node npm

Puis

npm install -g grunt-cli

Et voilà, le tour est joué.

Exemple d'installation : wget

Sous MacOS, on a accès à curl en lignes de commande mais pas à wget. Les 2 sont similaires ou du moins peuvent servir aux même tâches. Toutefois pour aspirer un site sur son ordinateur, il est plus aisé d'utiliser la commande wget. Il est très simple d'installer cette commande par l'intermédiaire de Homebrew :

brew install wget

Mettre à jour sa version d'Homebrew et ses packages

Comme indiqué dans la documentation officielle d'Homebrew, si on désire mettre à jour ce dernier, il suffit de saisir la ligne de commande suivante :

brew update

Oui, mais est-ce que nous avons des packages qui ont besoin d'une mise à jour ? Pour le vérifier, taper cette ligne de commande dans votre Terminal :

brew outdated

Homebrew nous indiquera donc la liste des mises à jour disponibles pour nos packages. S'il nous dit que tout est à jour, eh bien, tant mieux ! Sinon, il nous faut saisir cette ligne de commande :

brew update

Et tous nos packages se mettront à jour.

Conclusion

Ce gestionnaire de package n'est pas encore dans une version "1" à l'heure actuelle mais il est déjà suffisamment robuste pour nous permettre de travailler sereinement.
De plus, si nous avons besoin de connaitre la liste des packages disponibles sous Homebrew, il existe un site dédié : ~~http://brewformulas.org/~~ https://formulae.brew.sh
Un formulaire de recherche y est disponible, donc vous n'aurez pas d'excuses pour ne pas trouver le package qui vous va bien.

© Photo par Maciej Korsan
Le visuel de la bière a été choisi en rapport avec l'histoire d'Homebrew. En effet, en anglais, "brew" veut dire "breuvage". Et le créateur de ce projet avait choisi ce nom car il aimait beaucoup tout ce qui touchait à la bière, sans avoir considéré que son projet allait avoir tant d'influence. Quand il l'a réalisé, c'était déjà trop tard.
Référence

Récupérer des fichiers d'un serveur à un autre par SFTP

Teddy Payet — 2015-09-30T08:29:25Z

Lorsqu'on développe des sites, nous avons une version de chaque site selon son statut : production, pré-production, développement, etc. [1]. Il est nécessaire d'avoir les dernières images et médias du site de production sur les autres versions du site pour avoir quelque chose au plus proche de la réalité.
Bien entendu, on prend le contexte ici d'améliorations d'un site, et pas une ré-écriture totale du site.

Préambule

Nous avons prendre en compte 2 types de site : la production et la recette. Nous pouvons accéder à minima le site de production par sftp et le site de recettes par ssh. Ce n'est pas une généralité certes, mais c'est personnellement mon quotidien.
L'arborescence que nous allons décrire est celle d'un site sous SPIP. Mais cela n'empêchera pas l'utilisation de cette mécanique sur des sites gérés par un autre CMS ou un Framework.

Se connecter au serveur de recettes

Pour cela, nous allons ouvrir le Terminal pour entrer les quelques lignes de commandes adéquates. En premier lieu, nous nous connectons au serveur :

> ssh teddy.payet@recettes.example.tld

Nous renseignons le mot de passe à l'invitation du Terminal. Puis nous regardons où nous nous trouvons sur le serveur en tapant :

> pwd
/home/teddy.payet/

Nous allons nous placer dans le répertoire recueillant les médias de notre site internet :

> cd /var/www/IMG/

Bien, cela fait, nous vérifions que nous avons bien sftp accessible en ligne de commande. Pour cela nous saisissons ceci :

> which sftp
/usr/bin/sftp

Parfait si nous avons cela. Sinon, il faut installer « sftp» sur notre serveur.

Récupérer les médias sur le serveur de production

Après les actions précédentes, nous pouvons maintenant se connecter au serveur de production depuis le serveur de recettes. Il nous faut saisir la ligne suivante :

> sftp teddy.payet@example.tld

Nous tapons le mot de passe maintenant. Vérifions où nous nous trouvons sur le serveur de production :

> pwd
/

Et par sécurité, vérifions que le serveur de production et notamment sftp, reconnaît bien notre emplacement sur le serveur de recettes :

> lpwd
/var/www/IMG/

Bien. Nous sommes presque prêts à récupérer les médias. Pour cela, on doit aussi se placer dans le répertoire des médias du site de production :

> cd /var/www/IMG/
> pwd
/var/www/IMG/

Maintenant, récupérons tous les médias de ce répertoire et de ces sous-répertoires :

> get -Pr .

N'oublions pas de mettre le point à la fin de la commande. Le « P » dit à sftp de récupérer tous les fichiers en gardant les propriétés des fichiers. Le « r » indique à sftp de récupérer les fichiers du répertoires courant et de ses sous-répertoires.
Nous verrons alors le terminal afficher chaque action et fichier récupérés, avec le temps de chargement estimé et le poids du fichier.

Et voilà. Rien de plus simple. Il suffit de patienter le temps que le serveur rapatrie tous les médias du site de production vers le site de recettes.

[1] D'ailleurs à ce sujet, je vous invite à lire la documentation du plugin « Info SPIP »

MAMP, PHP-cs-fixer, PHPDoc…

Teddy Payet — 2015-05-06T13:10:36Z

Pour faire suite au précédent article, je vais vous indiquer, très rapidement, l'installation de PHP-cs-fixer et de PHPDoc qui peuvent être à minima complémentaires voir très utiles dans nos développements.

PHP-CS-fixer

Source : https://github.com/FriendsOfPHP/PHP-CS-Fixer
L'outil "PHP Coding Standards Fixer" corrige la plupart des problèmes dans votre code lorsque vous souhaitez suivre les normes de codage PHP définies dans les documents PSR-1 et PSR-2.

Sous Mac, allez dans le Terminal et tapez la ligne suivante :

$ cd /Applications/MAMP/bin/php/php5.5.18/bin/

Puis, comme indiqué sur la page officielle, tapez le curl (le wget ne fonctionnera pas nativement sous MacOSX) :

$ curl http://get.sensiolabs.org/php-cs-fixer.phar -o php-cs-fixer

ET maintenant, on donne les bonnes autorisations d'exécution :

$ sudo chmod a+x php-cs-fixer

Grâce à ces lignes de commande, MAMP saura de quoi on parle quand un IDE en aura besoin… Mais pas encore MacOSX. Rien de plus simple, on fait comme d'habitude :

$ sudo ln -s /Applications/MAMP/bin/php/php5.5.18/bin/php-cs-fixer /usr/bin/php-cs-fixer

On est ok normalement avec PHP-CS-Fixer

PHPDoc

Source : http://www.phpdoc.org/docs/latest/getting-started/installing.html
On ne le présente plus… PHPDocumentor devrait être connu de tous au moins de nom :-)
Pour l'installer en tant qu'extension de PHP, il faut passer par PEAR :

$ pear channel-discover pear.phpdoc.org Adding Channel "pear.phpdoc.org" succeeded
Discovery of channel "pear.phpdoc.org" succeeded

Maintenant, on peut installer phpDocumentor en utilisant la ligne de commande suivante :

$ pear install phpdoc/phpDocumentor downloading phpDocumentor-2.8.2.tgz ...
Starting to download phpDocumentor-2.8.2.tgz (16,246,834 bytes)
............................................................................................................................................................................................................................................................................done: 16,246,834 bytes
install ok: channel://pear.phpdoc.org/phpDocumentor-2.8.2

Et maintenant au tour de Mac OS X de comprendre ce qui se passe :

$ sudo ln -s /Applications/MAMP/bin/php/php5.5.18/bin/phpdoc /usr/bin/phpdoc

Et voilà ! Vous voyez ? C'est rapide !

MAMP, PHP, Pear, PHP Code Sniffer sont dans un même bateau

Teddy Payet — 2015-01-27T17:06:32Z

Cela fait un moment que je n'avais pas écris de billet sur mon blog. Mais ça fait aussi longtemps que je me dis qu'il faut que j'écrive un tutoriel complet sur comment installer PHP Code Sniffer sur un MAMP.

En soit, vous pouvez retrouver toutes ces informations sur le net mais un peu éparpillées… Je dois "à chaque fois" jouer avec google pour retrouver ces différents articles.
De ce fait, je vais les regrouper sur une même page et, dans la mesure du possible, remettre les sources du code que je mettrai.

Besoins

En codant sous Mac OS X (Yosemite, là de suite), on utilise souvent MAMP pour développer nos différents sites en local. Et mine de rien, respecter les normes PHP, ça fait du bien. Et pour cela, on a besoin d'installer PHP Code Sniffer pour que nos IDEs puissent utiliser la norme PSR2 (dans mon cas).
Donc, ma configuration lors de ce pas à pas :

Mac OSX 10.10.1 (dit Yosemite) ;
MAMP 3.0.7.3 ;
PHP 5.5.18 (fournit dans MAMP, et PHP 5.5.14 dans Yosemite).

Configuration de l'installation

Pour que nos lignes de commandes php et pear soient reconnues, il faut dire au système où regarder.
Pour cela, je vous invite à ouvrir le Terminal car c'est quasiment que par lui que nous allons utiliser pour configurer notre Mac.

PHP

Source : http://stackoverflow.com/a/17240373
A partir de là, je vous invite à taper la commande suivante :

# which php

Ce qui devrait vous donner ceci :

/usr/bin/php

Vérifions la version :

# php -v

Cela devrait vous dire que vous avez une version PHP 5.5.14. Ce qui ne correspond pas à notre version fournit avec MAMP. Nous devons alors dire à notre Mac qu'on veut la version de MAMP.
Taper ceci pour faire une sauvegarde de notre version de php en renommant le fichier php en php.bak. :

# sudo mv /usr/bin/php /usr/bin/php.bak

Notre Mac ne reconnaitra plus temporairement les commandes PHP. On crée maintenant un lien symbolique de php vers notre version de MAMP :

# sudo ln -s /Applications/MAMP/bin/php/php5.5.18/bin/php /usr/bin/php

Regarder votre version de PHP maintenant :

# php -v

On est ok normalement avec PHP

PEAR

Cette fois-ci, on va régler PEAR qui va nous permettre d'installer PHP Code Sniffer sur notre installation MAMP. Pour faire simple, on reprend la même démarche que précédemment.

# which pear

Là, si vous n'avez jamais configuré votre Mac, rien ne s'affichera. Vous serez redirigé vers la ligne de saisie de commandes. La commande suivante normalement nous donne le numéro de version de PEAR (attention à la majuscule du "V").

# pear -V

Mais comme dit précédemment, la commande PEAR n'est pas reconnue. On va dire alors à notre Mac qu'il faut qu'il aille voir dans MAMP :

# sudo ln -s /Applications/MAMP/bin/php/php5.5.18/bin/pear /usr/bin/pear

Refaites la commande de version de PEAR. MAMP fournit la version 1.9.5 pour PEAR.
On est ok normalement avec PEAR

PHP Code Sniffer

Source : : https://github.com/Islandora/islandora/wiki/Installing-and-configuring-codesniffer
Pour installer PHP Code Sniffer, il faut passer par PEAR. Comme on l'a déjà installé, il nous suffit de renseigner la commande suivante :

# pear install PHP_CodeSniffer

Je n'ai pas rencontré de problème à ce stade. Si on va dans /Applications/MAMP/bin/php/php5.5.18/bin/ on peut voir un fichier phpcs. Mais dans /usr/bin/, on ne trouve pas de phpcs. Ce qui a pour effet, là de suite, que si on tape une commande phpcs, on aura une erreur. Pour régler ça, rien de miraculeux, une ligne de commande mettra notre Mac dans le droit chemin :

# sudo ln -s /Applications/MAMP/bin/php/php5.5.18/bin/phpcs /usr/bin/phpcs

On vérifie tout ça :

# phpcs --version

Soit pour moi : PHP_CodeSniffer version 2.2.0 (stable) by Squiz (http://www.squiz.net)

PHP Mess Detector

Source : http://pear.phpmd.org/
On installe souvent avec PHPcs la librairie PHP Mess Detector (PHPmd). Pour cela, il faut ajouter un channel spécifique à PEAR.

# pear channel-discover pear.phpmd.org

On regarde les packages disponibles :

# pear remote-list -c phpmd

Soit :

Channel phpmd Available packages:
=================================
Package Version
PHP_PMD 1.5.0

La ligne de commande suivante va poser problème :

# pear install phpmd/PHP_PMD
# Unknown remote channel: pear.pdepend.org
# phpmd/PHP_PMD requires package "channel://pear.pdepend.org/PHP_Depend" (version >= 1.1.1)
# No valid packages found
# install failed

Il faut rajouter le channel pear.pdepend.org :

# pear channel-discover pear.pdepend.org

Et maintenant, on fait ceci :

# pear install --alldeps phpmd/PHP_PMD

L'option --alldeps va installer toutes les dépendances nécessaires pour PHPmd avant d'installer PHPmd.
Ok, on crée les liens symboliques pour notre Mac :

# sudo ln -s /Applications/MAMP/bin/php/php5.5.18/bin/phpmd /usr/bin/phpmd
# sudo ln -s /Applications/MAMP/bin/php/php5.5.18/bin/pdepend /usr/bin/pdepend

Petit test :

# phpmd --version
# pdepend --version

Et voilà ! C'est fini ! Vous pouvez vous amuser maintenant !

Bonus : PHPUnit

Pour PHPcs, on n'a pas besoin de PHPUnit… Qu'on se le dise. Mais, je me dis que cela peut servir à certains. Alors voici la méthode.
Comme on peut le lire sur https://github.com/sebastianbergman..., on ne passe plus par PEAR pour installer PHPUnit mais par un fichier phar.
Sur la doc, on passe par des lignes de commandes aussi pour faire tout cela… Ok… Mais il y a un problème. Sur le Mac, la commande wget ne fonctionnera pas. On va passer par la commande curl pour récupérer le fichier.

D'abord, on va sur le bureau (par exemple)

# cd ~/Desktop/

Et là, on va pouvoir travailler ainsi :

# curl -o phpunit.phar https://phar.phpunit.de/phpunit.phar
# chmod +x phpunit.phar
# sudo mv phpunit.phar /usr/bin/phpunit

Ça vous dit de vérifier ? Simple, même astuce que tout à l'heure :

# phpunit --version
# PHPUnit 4.4.5 by Sebastian Bergmann.

Et voilà ! J'en ai fini avec ce pas à pas. ;-)

Comment mettre un nouveau plugin sur la zone de SPIP

Teddy Payet — 2013-02-16T13:57:40Z

Il y a quelques temps, j'ai écris un petit article sur "Comment faire des commit sur la zone de SPIP". Je vais reprendre un peu le même tutoriel mais mettre en avant la création d'un plugin et non une mise à jour d'un existant.
Il me sert aussi de feuille de route pour l'avenir

Préambule

Le but ici n'est pas de vous expliquer comment réaliser un plugin mais comment déposer le plugin que vous avez créé au préalable.
Je vais prendre pour exemple le plugin "Partenaires" que j'ai créé par plus tard que ce matin.

Mise en place

Il faut d'abord créer un répertoire qui va réceptionner tous nos plugins en devenir. J'ai créer dans mon répertoire "Document" un dossier "svn_repositories" contenant la structure suivante :

_galaxie_
_graphismes_
_plugins_
_squelettes_
_themes_
archivelist

Cela prend dans les grandes lignes la structure des répertoires de la zone à voir ici. Cela permet d'être cohérent et de s'y retrouver plus facilement si on reprend le développement de plugins plusieurs semaines ou mois plus tard.

Étape 1

On va dans panneau de ligne de commande (Terminal sous MacOSX) pour commencer à taper nos commandes svn.
Première chose, se positionner dans le répertoire "Documents/svn_repositories/_plugins_" :

svn cd Documents/svn_repositories/_plugins_

Attention de bien rester dans ce répertoire pour pouvoir faire un "checkout". Cette dernière commande créera le répertoire de plugin venant de la zone…

Étape 2

On crée le répertoire de notre plugin sur la zone :

svn mkdir svn://zone.spip.org/spip-zone/_plugins_/partenaires/ -m "Dépôt initial du plugin Partenaires"

cf. 69939

Étape 03

On lance un checkout pour avoir une bonne version svn de notre répertoire :

svn checkout svn://zone.spip.org/spip-zone/_plugins_/partenaires/

Cela aura créé un répertoire "partenaires". Il faut se positionner depuis le Terminal dans ce répertoire pour en faire les commits plus tard :

cd partenaires

Maintenant, on copie dans notre répertoire local les répertoires et fichiers du plugin que nous avons créé. Pour ma part, avec "Partenaires", j'ai 2 répertoires contenant mes fichiers et sous-répertoires :

branches
trunk

Cela fait, on passe à l'étape 4.

Étape 04

On tape la commande suivante :

svn st

Cela nous indiquera ce qui est ajouté par rapport au répertoire de dépôt. Cela vous donnera quelque chose comme ça :

? branches ? trunk

Le point d'interrogation indique que nous devons indiqué à svn ce que nous devons faire de ces répertoires. Eh bien, on va les ajouter un par un :

svn add branches svn add trunk

Cela fait, on peut enfin passer à l'étape 5, l'étape finale.

Étape 05

On va enfin commiter nos fichiers sur la zone :

svn commit -m "Dépôt complet de plugin Partenaires qui permet de référencer la liste complète de nos partenaires et le type de partenaires (Exemple: officiel, fourniture, alimentaire, etc.) On peut renseigner pour le partenaire les infos suivantes : - Son nom ; - Un descriptif ; - et l'url de son site. Pour le type de partenaires : - Le titre ; - un descriptif. Ces 2 nouveaux objets éditoriaux peuvent avoir un logo. Pour le type de partenaire, en général, le logo n'est pas nécessaire mais je garde pour le moment cette possibilité. La documentation est bientôt à venir sur Contrib."

cf. 69943

ET voilà, c'est fini.

Amusez vous à créer de nouveaux plugins pour la communauté SPIP. On vous sera reconnaissant ! ;-)

Teddy Payet

MagicMirror², configuration scriptée, 2ème partie

Introduction

Liste des scripts

first_install.sh

mm_reset.sh

mm_update.sh

update_files_config.sh

update_files_config.sh : fonction import_module

update_files_config.sh : fonction delete_modules

disk_usage.sh

crontab.txt

Le projet sur github

A lire aussi

MagicMirror², configuration scriptée

Préambule

Versionner sa configuration

Bash, une installation scriptée

Bash, liens symboliques, bis

Bash, des fonctions : importer un module

Bash, des fonctions : effacer les modules inutiles

Bash, oui mais dans l'ordre

A lire aussi

Des astuces et mémos pour SVN

Règle générique

Ajouter de nouveaux fichiers/répertoires au dépôt

Supprimer des fichiers/répertoires obsolètes au dépôt

MagicMirror², on recommence depuis le début

Incompatibilité

Recommençons

Installation de packages

Mise à jour des packages

Installation de Node et MagicMirror²

Installation des modules

Configuration du fichier config.js

Démarrage automatique de MagicMirror²

Démarrer MagicMirror² avec PM2

Contrôler son MagicMirror² via PM2

A lire aussi

MagicMirror², un miroir qui vous veut du bien.

Le matériel

Installation du Raspberry Pi Préparer une carte SD.

Démarrer et configurer le Raspberry Pi

Configurer le Wifi du Raspberry Pi

Nettoyer et mettre à jour le système

Installation de MagicMirror²

Installation préalable de NodeJS

Exécution du script pour MagicMirror²

Configuration complémentaire

Sources :

A lire aussi

Installer Homebrew sur Mac OSX

Présentation de Homebrew

Installation

Exemple d'utilisation : GruntJS

Exemple d'installation : wget

Mettre à jour sa version d'Homebrew et ses packages

Conclusion

Récupérer des fichiers d'un serveur à un autre par SFTP

Préambule

Se connecter au serveur de recettes

Récupérer les médias sur le serveur de production

MAMP, PHP-cs-fixer, PHPDoc…

PHP-CS-fixer

PHPDoc

MAMP, PHP, Pear, PHP Code Sniffer sont dans un même bateau

Besoins

Configuration de l'installation

PHP

PEAR

PHP Code Sniffer

PHP Mess Detector

Bonus : PHPUnit

Comment mettre un nouveau plugin sur la zone de SPIP

Préambule

Mise en place

Étape 1

Étape 2

Étape 03

Étape 04

Installation du Raspberry Pi
Préparer une carte SD.