Browse Source

README init

leo.viallon 5 years ago
commit
38e506c103
1 changed files with 51 additions and 0 deletions
  1. 51 0
      README.md

+ 51 - 0
README.md

@@ -0,0 +1,51 @@
1
+# Kannad
2
+
3
+Kannad est un logiciel de reception et d'envoi de SMS. Il se compose d'un démon concu pour recevoir les SMS et les traiter et d'un client qui permet de lire les sms reçus, en envoyer, etc.
4
+
5
+## Licence
6
+
7
+La licence est la licence GNU GPL
8
+
9
+Ce programme s'inspire de modèles de la documentation gammu et npyscreen, tous deux sous licence GNU GPL v2
10
+
11
+## Prérequis
12
+Le système utilise python 2 (2.7)
13
+
14
+L'envoi-réception des SMS est basée sur gammu. il faut donc avoir installé gammu sur python2 (packet python-gammu sur debian-based os)
15
+
16
+L'interface du client est basée sur npyscreen (pip install npyscreen)
17
+
18
+## Kannad daemon
19
+
20
+Il se trouve dans daemon/ et se lance par kannad-daemon.py
21
+
22
+### Présentation
23
+Kannad démon est dun démon qui lit les sms à intervalles réguliers et les traite grâce à des modules de traitement. Un module de traitement est simplement un fichier python comprenant une fonction traitement(numero, dateheure, message, \*other).
24
+
25
+Sont déjà proposés l'enregistrement dans uns base de donnée SQLite (qui sert au client), l'envoi par e-mail, et l'affichage à l'écran.
26
+
27
+### Configuration
28
+La configuration des modules d'effectue dans modules/*nomdumodule*config.py
29
+Pour le détail voir la section modules
30
+
31
+Le configuration du démon s'effectue dans **kndconfig.py**, on configure alors :
32
+
33
+* Le fichier de configuration gammu pour la connexion au téléphone (voir http://wammu.eu/docs/manual/config/) : *tel_configfile*
34
+* L'intervalle entre deux tentatives de réception, en secondes : *dtreceive*
35
+* L'ensemble des modules à activer, sous forme d'une liste de noms : *actions*
36
+
37
+## Kannad Client
38
+
39
+Il se trouve dans client/ et se lance par kannad-client.py
40
+
41
+### Présentation
42
+Le client utilise un annuaire pour enregistrer les numéros (base de donnée SQLite), permet de lister les sms recus à partir de a base de donnée du démon et d'envoyer des SMS. D'autres fonctionnalités sont prévues comme la liste des sms envoyés, l'affichage de conversations, etc.
43
+
44
+## Modules
45
+Le module affichage se contente d'afficher le sms à l'écran
46
+
47
+Le module mailer envoie par mail (configuration du smtp à faire) et si *identify\_people* est à True il cherchera également dans la base de donnée du client à attribuer un nom à l'envoyeur.
48
+
49
+Le module tosqlite écrit le sms dans une base de donnée sqlite. C'est la base de donnée utilisée par le client ensuite.
50
+
51
+D'autres modules peuvent être ajoutés dans modules/