gammu-smsdrc – man

Posted on by maxime

PRÉNOM

gammu-smsdrc – fichier de configuration gammu-smsd

SYNOPSIS

/etc/gammu-smsdrc

LA DESCRIPTION

gammu-smsd lit la configuration à partir d’un fichier de configuration. Son emplacement peut être spécifié sur la ligne de commande, sinon le chemin par défaut /etc/gammu-smsdrc est utilisé.

Ce fichier utilise la syntaxe de fichier ini, les commentaires étant marqués avec les deux; et #. Les sections du fichier de configuration sont identifiées entre crochets [this]. Toutes les valeurs clés sont insensibles à la casse.

Le fichier de configuration de gammu-smsd comprend au moins deux sections – [gammu] et [smsd].

La section [gammu] est la configuration d’une connexion téléphonique et est identique à celle décrite dans gammurc, à la seule exception que le fichier journal est ignoré et que la consignation courante de la bibliothèque gammu et du démon SMS est utilisée. Cependant, la directive logformat continue de configurer la quantité de messages que gammu émet.

La section [smsd] configure le démon SMS lui-même, décrit dans les sous-sections suivantes. Les premiers paramètres généraux du démon SMS sont répertoriés, puis des paramètres spécifiques pour les systèmes de stockage.

Ensuite, il existe des sections facultatives [include_numbers] et [exclude_numbers], qui contrôlent le filtrage des messages (voir ci-dessous).

Paramètres généraux du démon SMS

Service
Service SMSD à utiliser, un des fichiers FILS, MYSQL, PGSQL, DBI (dépend du support compilé pour le backend).

FICHIERS – stocke les messages dans des fichiers, voir gammu-smsd-files (7) pour plus de détails
MYSQL – stocke les messages dans la base de données MySQL, voir gammu-smsd-mysql (7) pour plus de détails
PGSQL – stocke les messages dans la base de données PostgreSQL, voir gammu-smsd- pgsql (7) pour plus de détails
DBI – stocke les messages dans toutes les bases de données supportées par libdbi, cela inclut les bases de données MSSQL, MySQL, PostgreSQL ou SQLite, voir gammu-smsd-dbi (7) pour plus de détails

PIN
Code PIN pour la carte SIM. Ceci est facultatif, mais vous devez le définir si votre téléphone après la mise sous tension nécessite un code PIN.
NetworkCode
Mot de passe de personnalisation du réseau. Ceci est facultatif, mais certains téléphones en ont besoin après la mise sous tension.
PhoneCode
Mot de passe de verrouillage du téléphone. Ceci est facultatif, mais certains téléphones en ont besoin après la mise sous tension.
LogFile
Fichier dans lequel les actions SMSD sont consignées. Vous pouvez également utiliser une valeur spéciale “syslog” qui enverra tous les messages au démon syslog. Sous Windows, une autre valeur spéciale, “eventlog”, envoie les journaux au journal des événements Windows.

La valeur par défaut est de ne fournir aucune journalisation.

DebugLevel
Niveau de débogage pour SMSD. La valeur entière doit être la somme de tous les indicateurs que vous souhaitez activer.

1 – active les informations de débogage de base
2 – permet la journalisation des requêtes SQL des services rendus
4 – – permet la journalisation des informations de débogage gammu (doit être activé également dans la section gammu)

En règle générale, pour obtenir autant d’informations de débogage que possible, utilisez 255.

La valeur par défaut est 0, ce qui devrait signifier aucune information supplémentaire.

CommTimeout
Combien de secondes SMSD doit-il attendre après chaque boucle de lecture / écriture?

La valeur par défaut est 30.

SendTimeout
Indique le nombre de secondes pendant lesquelles SMSD doit attendre la réponse du réseau lors de l’envoi de SMS. Si rien ne se passe pendant ce temps, les sms seront renvoyés.

La valeur par défaut est 30.

MaxRetries
Combien de fois SMSD essaiera-t-il de renvoyer un message en cas d’échec de l’envoi?

La valeur par défaut est 1.

ReceiveFrequency
Nombre de secondes entre les tests de SMS reçus, lorsque le téléphone est occupé à envoyer des SMS. Normalement, un test des SMS reçus est effectué toutes les secondes de CommTimeout et après chaque SMS envoyé.

La valeur par défaut est 0 (non utilisé).

CheckSecurity
S’il faut vérifier si le téléphone veut entrer un code PIN.

La valeur par défaut est 1 (activé).

ResetFrequency
Le nombre de secondes entre deux exécutions d’une réinitialisation logicielle préventive afin de minimiser le nombre de cas de téléphones suspendus, par exemple le Nokia 5110 se bloque parfois à un état tel que le téléphone ne redevient opérationnel qu’après le démontage de la batterie.

La valeur par défaut est 0 (non utilisé).

DeliveryReport
Indique si les rapports de livraison doivent être utilisés, l’une des valeurs de «non», «journal», «sms».

log – une entrée de journal de ligne,
sms – stocker dans la boîte de réception en tant que SMS reçu
non – pas de rapports de livraison

La valeur par défaut est “non”.

DeliveryReportDelay
Délai en secondes pendant lequel le rapport de livraison est toujours considéré comme valide. Cela dépend des pannes de votre réseau (le rapport de remise doit avoir le même horodatage que le message envoyé). Augmentez-le si les rapports de remise ne sont pas associés aux messages envoyés.
La valeur par défaut est 600 (10 minutes).
PhoneID
Chaîne d’informations sur le téléphone utilisé pour l’envoi / la réception. Cela peut être utile si vous souhaitez exécuter plusieurs démons SMS.

Lorsque vous définissez PhoneID, tous les messages (y compris ceux injectés) sont marqués par cette chaîne et permettent à davantage de démons SMS de partager une base de données unique. Cette option n’a en réalité aucun effet sur le service d’arrière-plan FILES.

RunOnReceive
Exécute un programme après réception du message. Ce paramètre est exécuté via le shell, vous devrez donc peut-être échapper des caractères spéciaux et inclure un nombre illimité de paramètres. De plus, des paramètres avec les identifiants des messages reçus sont ajoutés à la ligne de commande. Les identifiants dépendent du moteur de service utilisé. Il s’agit généralement de l’ID de la ligne insérée pour les systèmes de base de données ou du nom de fichier pour les systèmes basés sur des fichiers.

Options de base de données

Tous les systèmes DBI, MYSQL et PGSQL (voir gammu–smsd–mysql (7),gammu–smsd–pgsql (7), gammu-smsd–dbi (7)) prennent en charge les mêmes options pour la configuration de la connexion à une base de données:

User
Nom d’utilisateur utilisé pour la connexion à une base de données.
Password
Mot de passe utilisé pour la connexion à une base de données.
PC
Adresse du serveur de base de données. Il peut également contenir un chemin de port ou de socket après un point-virgule, par exemple localhost: /path/to/socket.
Database
Nom de la base de données à utiliser. Veuillez noter que vous devez créer des tables dans cette base de données avant d’utiliser gammu-smsd. Les fichiers SQL permettant de créer les tables nécessaires sont inclus dans la documentation.
SkipSMSCNumber
Lorsque vous envoyez des SMS depuis un centre SMS, vous pouvez avoir des rapports de livraison provenant d’un autre numéro SMSC. Vous pouvez définir ici le numéro de ce SMSC utilisé par vous et Gammu ne vérifiera pas ce numéro lors de l’attribution de rapports aux SMS envoyés.
Dirver
Pilote DBI à utiliser. DBI prend en charge les pilotes DBI que vous avez installés: mysql, freetds (permet d’accéder à MS SQL Server et Sybase), pgsql, sqlite, sqlite3, firebird et ingres, les pilotes msql et oracle sont en cours de développement.
DriversPath
Chemin d’accès, où les pilotes DBI sont stockés, il n’est généralement pas nécessaire de le définir si les pilotes sont correctement installés.
DBDir
Répertoire de base de données pour certains pilotes DBI (actuellement uniquement sqlite). Définissez ici le chemin où sont stockés les fichiers de base de données sqlite.

Fichiers backend options

Le serveur de fichiers accepte les options de configuration suivantes. Voir gammu-smsd-files (7) pour une description plus détaillée du service. Veuillez noter que tous les chemins doivent contenir un séparateur de chemin de fin (/ sur les systèmes Unix):

InboxPath
Où les SMS reçus sont stockés.

La valeur par défaut est le répertoire actuel.

OutboxPath
Les SMS à envoyer doivent être placés.

La valeur par défaut est le répertoire actuel.

SentSMSPath
Où les SMS transmis sont placés, si identique à OutBoxPath, les messages transmis sont supprimés.

La valeur par défaut est de supprimer les messages transmis.

ErrorSMSPath
Où les SMS avec erreur dans la transmission sont placés.

La valeur par défaut est identique à SentSMSPath.

InboxFormat
Le format dans lequel les SMS seront stockés: ‘détail’, ‘unicode’, ‘standard’.

detail – format utilisé pour la sauvegarde des messages par gammu (1)
unicode – texte du message stocké au
standard unicode (UTF-16) – texte du message stocké dans le jeu de caractères système

La valeur par défaut est “Unicode”.

TransmitFormat
Le format de transmission du SMS: ‘auto’, ‘unicode’, ‘7bit’.

La valeur par défaut est “auto”.

Filtrage des messages

SMSD permet de traiter uniquement un sous-ensemble limité de messages entrants. Vous pouvez définir des filtres dans les sections [include_numbers] et [exclude_numbers]. Si la section [include_numbers] existe, toutes les valeurs (les clés sont ignorées) sont utilisées comme numéros de téléphone autorisés et aucun autre message n’est traité. De l’autre côté, dans [exclude_numbers], vous pouvez spécifier les nombres que vous voulez ignorer.

EXEMPLE

Des exemples plus complets sont disponibles dans la documentation Gammu. Veuillez noter que pour simplifier, les exemples suivants n’incluent pas la section [gammu], vous pouvez consulter gammurc (5) pour quelques exemples.

Le fichier de configuration SMSD pour le backend FILES pourrait ressembler à ceci:

[smsd]
Service = files
PIN = 1234
LogFile = syslog
InboxPath = /var/spool/sms/inbox/
OutboPpath = /var/spool/sms/outbox/
SentSMSPath = /var/spool/sms/sent/
ErrorSMSPath = /var/spool/sms/error/







Si vous voulez utiliser le backend MYSQL, vous aurez besoin de quelque chose comme ceci:






 
 
 
[smsd]
Service = mysql
PIN = 1234
LogFile = syslog
User = smsd
Password = smsd
PC = localhost
Database = smsd
 








Traiter uniquement les messages du numéro 123456:






 
 
 
[include_numbers]
number1 = 123456
 








Ne traitez pas les messages du numéro 666:






 
 
 
[exclude_numbers]
number1 = 666
 








VOIR ÉGALEMENT


gammu-smsd, gammu, gammurc


gammu-smsd-files, gammu-smsd-mysql, gammu-smsd-pgsql, gammu-smsd-dbi, gammu-smsd-tables


RAPPORTS BUGS


Avant de signaler un bogue, veuillez activer la journalisation détaillée dans la configuration de SMSD:


 
 
 
    [gammu] 
    logformat = textall


    [smsd] 
    debuglevel = 255 
    logfile = smsd.log
 


et inclure ce journal détaillé dans le rapport de bogue.






Version Originale


NAME


gammu-smsdrc – gammu-smsd(1) configuration file


SYNOPSIS


/etc/gammu-smsdrc


DESCRIPTION


gammu-smsd(1) reads configuration from a config file. It’s location can be specified on command line, otherwise default path /etc/gammu-smsdrc is used.




This file use ini file syntax, with comments being marked with both ; and #. Sections of config file are identified in square brackets line [this]. All key values are case insensitive.


Configuration file of gammu-smsd consists of at least two sections – [gammu] and [smsd].


The [gammu] section is configuration of a phone connection and is same as described in gammurc(5) with the only exception that logfile is ignored and common logging for gammu library and SMS daemon is used. However the logformat directive still configures how much messages gammu emits.


The [smsd] section configures SMS daemon itself, which are described in following subsections. First general parameters of SMS daemon are listed and then specific parameters for storage backends.


Then there are optional sections [include_numbers] and [exclude_numbers], which control message filtering (see bellow).




General parameters of SMS daemon




Service


SMSD service to use, one of FILES, MYSQL, PGSQL, DBI (depends on compiled in support for backends).


FILES – stores messages in files, see gammu-smsd-files(7) for details

MYSQL – stores messages in MySQL database, see gammu-smsd-mysql(7) for details

PGSQL – stores messages in PostgreSQL database, see gammu-smsd-pgsql(7) for details

DBI – stores messages in any database supported by libdbi, this includes MSSQL, MySQL, PostgreSQL or SQLite databases, see gammu-smsd-dbi(7) for details


PIN


PIN for SIM card. This is optional, but you should set it if your phone after power on requires PIN.


NetworkCode


Network personalisation password. This is optional, but some phones require it after power on.


PhoneCode


Phone lock password. This is optional, but some phones require it after power on.


LogFile


File where SMSD actions are being logged. You can also use special value “syslog” which will send all messages to syslog daemon. On Windows another special value “eventlog” exists, which will send logs to Windows Event Log.


Default is to provide no logging.


DebugLevel


Debug level for SMSD. The integer value should be sum of all flags you want to enable.


1 – enables basic debugging information

2 – enables logging of SQL queries of service backends

4 – enables logging of gammu debug information (has to be enabled also in gammu section)


Generally to get as much debug information as possible, use 255.


Default is 0, what should mean no extra information.


CommTimeout


How many seconds should SMSD wait after each read/write loop.


Default is 30.


SendTimeout


Shows how many seconds SMSD should wait for network answer during sending sms. If nothing happen during this time, sms will be resent.


Default is 30.


MaxRetries


How many times will SMSD try to resend message if sending fails.


Default is 1.


ReceiveFrequency


The number of seconds between testing for received SMSes, when the phone is busy sending SMSes. Normally a test for received SMSes is done every CommTimeout seconds and after each sent SMS.


Default is 0 (not used).


CheckSecurity


Whether to check if phone wants to enter PIN.


Default is 1 (enabled).


ResetFrequency


The number of seconds between performing a preventive soft reset in order to minimize the cases of hanging phones e.g. Nokia 5110 will sometimes freeze to a state when only after unmounting the battery the phone will be functional again.


Default is 0 (not used).


DeliveryReport


Whether delivery reports should be used, one of ‘no’, ‘log’, ‘sms’.


log – one line log entry,

sms – store in inbox as a received SMS

no – no delivery reports


Default is ‘no’.


DeliveryReportDelay


Delay in seconds how long is still delivery report considered valid. This depends on brokeness of your network (delivery report should have same timestamp as sent message). Increase this if delivery reports are not paired with sent messages.

Default is 600 (10 minutes).


PhoneID


String with info about phone used for sending/receiving. This can be useful if you want to run several SMS daemons.


When you set PhoneID, all messages (including injected ones) will be marked by this string and it allow more SMS daemons to share single database. This option has actually no effect of FILES backend service.


RunOnReceive


Executes a program after receiving message. This parameter is executed through shell, so you might need to escape some special characters and you can include any number of parameters. Additionally parameters with identifiers of received messages are appended to the command line. The identifiers depend on used service backend, typically it is ID of inserted row for database backends or file name for file based backends.




Database backends options


All DBI, MYSQL and PGSQL backends (see gammu-smsd-mysql, gammu-smsd-pgsql, gammu-smsd-dbi) for their documentation) supports same options for configuring connection to a database:




User


User name used for connection to a database.


Password


Password used for connection to a database.


PC


Database server address. It can also contain port or socket path after semicolon, for example localhost:/path/to/socket.


Database


Name of database to use. Please note that you should create tables in this database before using gammu-smsd. SQL files for creating needed tables are included in documentation.


SkipSMSCNumber


When you send sms from some SMS centere you can have delivery reports from other SMSC number. You can set here number of this SMSC used by you and Gammu will not check it’s number during assigning reports to sent SMS.


Driver


DBI driver to use. Depends on what DBI drivers you have installed, DBI supports: mysql, freetds (provides access to MS SQL Server and Sybase), pgsql, sqlite, sqlite3, firebird and ingres, msql and oracle drivers are under development.


DriversPath


Path, where DBI drivers are stored, this usually does not have to be set if you have properly installed drivers.


DBDir


Database directory for some (currently only sqlite) DBI drivers. Set here path where sqlite database files are stored.




Files backend options


The FILES backend accepts following configuration options. See gammu-smsd-files for more detailed service backend description. Please note that all path should contain trailing path separator (/ on Unix systems):




InboxPath


Where the received SMSes are stored.


Default is current directory.


OutboxPath


Where SMSes to be sent should be placed.


Default is current directory.


SentSMSPath


Where the transmitted SMSes are placed, if same as OutBoxPath transmitted messages are deleted.


Default is to delete transmitted messages.


ErrorSMSPath


Where SMSes with error in transmission is placed.


Default is same as SentSMSPath.


InboxFormat


The format in which the SMS will be stored: ‘detail’, ‘unicode’, ‘standard’.


detail – format used for message backup by gammu

unicode – message text stored in unicode (UTF-16)

standard – message text stored in system charset


Default is ‘unicode’.


TransmitFormat


The format for transmitting the SMS: ‘auto’, ‘unicode’, ‘7bit’.


Default is ‘auto’.




Message filtering


SMSD allows to process only limited subset of incoming messages. You can define filters in [include_numbers] and [exclude_numbers] sections. If [include_numbers] section exists, all values (keys are ignored) from it are used as allowed phone numbers and no other message is processed. On the other side, in [exclude_numbers] you can specify numbers which you want to skip.


EXAMPLE


There is more complete example available in Gammu documentation. Please note that for simplicity following examples do not include [gammu] section, you can look into gammurc for some examples how it can look like.


SMSD configuration file for FILES backend could look like:








[smsd]
Service = files
PIN = 1234
LogFile = syslog
InboxPath = /var/spool/sms/inbox/
OutboPpath = /var/spool/sms/outbox/
SentSMSPath = /var/spool/sms/sent/
ErrorSMSPath = /var/spool/sms/error/







If you want to use MYSQL backend, you will need something like this:








[smsd]
Service = mysql
PIN = 1234
LogFile = syslog
User = smsd
Password = smsd
PC = localhost
Database = smsd







Process only messages from 123456 number:








[include_numbers]
number1 = 123456







Do not process messages from evil number 666:








[exclude_numbers]
number1 = 666







SEE ALSO


gammu-smsd, gammu, gammurc


gammu-smsd-files, gammu-smsd-mysql, gammu-smsd-pgsql, gammu-smsd-dbi, gammu-smsd-tables


REPORTING BUGS


 


Before reporting a bug, please enable verbose logging in SMSD configuration:


[gammu]

logformat = textall


[smsd]

debuglevel = 255

logfile = smsd.log


and include this verbose log within bug report.


 


Source