Showing 1 changed files with 11 additions and 2 deletions
+11 -2
README.md
... ...
@@ -52,8 +52,8 @@ Les vieux scripts oubliés, mal écrits (enfin à mon goût plus mal écrits que
52 52
     1. `/usr/local/share/${basename}`
53 53
    * Les fonctions ne commençant pas par un caractère alphabétique sont ignorées, et toutes celles commençant par un caractère alphanumérique sont exécutées les unes après les autres, sans ordre défini. Pour exécuter les fontions dans un ordre précis il suffit de les préfixer par *underscore* et de les lister dans une fonction qui sera exécutée.  
54 54
    * fonctions prédéfinies:
55
-    * \_turns <modulo> : permet de ne lancer la fonction que tous les *modulo* tours
56
-    * \_load <fichier> [fichier [fichier...]] : permet de sourcer de la configuration supplémentaire
55
+    * `_turns <modulo>` : permet de ne lancer la fonction que tous les *modulo* tours
56
+    * `_load fichier [fichier [fichier...]]` : permet de sourcer de la configuration supplémentaire
57 57
    * Le code de sortie est ignoré, seule la sortie standard de chaque fonction exécutée est prise en compte (via `echo` ou `printf` par exemple).  
58 58
    * Les messages collectés sont rassemblés en un message unique hiérarchisé qui reprend les informations sur les fichiers sourcés, la fonction qui génère le message reporté, et le message lui-même, formatté pour un envoi par SMS (cf. smsapi).  
59 59
    * Si aucun message n'est apparu depuis 24h après le dernier envoi d'alerte le plus ancien alors rien n'est envoyé, mais il est possible d'obtenir toutes les alertes actuelles sur la sortie standard (sans formattage SMS).
... ...
@@ -66,3 +66,12 @@ Les vieux scripts oubliés, mal écrits (enfin à mon goût plus mal écrits que
66 66
    * date sous la forme **yyyy-mm-dd**, si aucune date n'est fournie prend la date du jour
67 67
    * chaque nom de paquet est préfixé par ` -> `
68 68
    * ne gère pas encore correctement la suppression de résidus de configuration (perçue comme une erreur)
69
+
70
+## smsapi
71
+    * ne fonctionne qu'avec Freebox (et Freemobile ?)
72
+    * la configuration tient dans un fichier sourcé par le script, au format bash:
73
+     * `ID=` identifiant
74
+     * `PASS=` mot de passe (foruni par la console de gestion du compte freebox
75
+     * `HSUP=` nombre compris entre 1 et 23 définissant l'heure au-delà de laquelle l'envoi sera reporté à HINF.
76
+     l'envoi ne se fera pas exactement à partir de $HINF, mais selon un algorithme qui permet de répartir sur plusieurs minutes les éventuels multiples envois pour ne pas se faire bloquer par l'API de Free
77
+     * `HINF=` nombre compris entre 0 et 22 définissant l'heure à partir de laquelle l'envoi est immédiat