1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
|
.. _gammu-smsdrc:
SMSD Configuration File
=======================
Description
-----------
gammu-smsd 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, see :ref:`ini`.
Configuration file of gammu-smsd consists of at least two sections -
:config:section:`[gammu]` and :config:section:`[smsd]`. For :ref:`gammu-smsd-sql`
you can also use :config:section:`[sql]`.
The :config:section:`[gammu]` section is configuration of a phone connection
and is same as described in :ref:`gammurc` with the only exception that
:config:option:`LogFile` is ignored and common logging for gammu library and
SMS daemon is used. However the :config:option:`LogFormat` directive still
configures how much messages gammu emits.
.. config:section:: [smsd]
The :config:section:`[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.
.. config:section:: [include_numbers]
List of numbers from which accept messages, see :ref:`message_filtering`.
.. config:section:: [exclude_numbers]
List of numbers from which reject messages, see :ref:`message_filtering`.
.. config:section:: [include_smsc]
List of SMSC numbers from which accept messages, see :ref:`message_filtering`.
.. config:section:: [exclude_smsc]
List of SMSC numbers from which reject messages, see :ref:`message_filtering`.
.. config:section:: [sql]
Configure SQL queries used by :ref:`gammu-smsd-sql`, you usually don't have to modify them.
.. seealso:: :ref:`Configurable queries`
General parameters of SMS daemon
--------------------------------
.. config:option:: Service
SMSD service to use, one of following choices:
``FILES``
stores messages in files, see :ref:`gammu-smsd-files` for details
``NULL``
does not store messages at all, see :ref:`gammu-smsd-null` for details
``SQL``
stores messages in SQL database, see :ref:`gammu-smsd-sql` for details
.. versionadded:: 1.28.93
``MYSQL``
synonym for :config:option:`Service` = ``SQL`` and :config:option:`Driver` = ``native_mysql``
stores messages in MySQL database, see :ref:`gammu-smsd-mysql` for details
.. deprecated:: 1.28.93
``PGSQL``
synonym for :config:option:`Service` = ``SQL`` and :config:option:`Driver` = ``native_mysql``
stores messages in PostgreSQL database, see :ref:`gammu-smsd-pgsql` for details
.. deprecated:: 1.28.93
``DBI``
synonym for :config:option:`Service` = ``SQL`` and :config:option:`Driver` = DBI driver
stores messages in any database supported by libdbi, this includes
MSSQL, MySQL, PostgreSQL or SQLite databases, see :ref:`gammu-smsd-dbi` for
details
.. deprecated:: 1.28.93
.. note::
Availability of backends depends on platform and compile time configuration.
.. config:option:: PIN
PIN for SIM card. This is optional, but you should set it if your phone after
power on requires PIN.
.. config:option:: NetworkCode
Network personalisation password. This is optional, but some phones require it
after power on.
.. config:option:: PhoneCode
Phone lock password. This is optional, but some phones require it after power
on.
.. config:option:: 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.
If you run SMSD as a system daemon (or service), it is recommended to use
absolute path to log file as startup directory might be different than you
expect.
Default is to provide no logging.
.. config:option:: 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
Generally to get as much debug information as possible, use 255.
Default is 0, what should mean no extra information.
.. config:option:: CommTimeout
How many seconds should SMSD wait after there is no message in outbox.
Default is 30.
.. config:option:: 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.
.. config:option:: MaxRetries
How many times will SMSD try to resend message if sending fails.
Default is 1.
.. config:option:: 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
:config:option:`CommTimeout` seconds and after each sent SMS.
Default is 0 (not used).
.. config:option:: StatusFrequency
The number of seconds between refreshing phone status (battery, signal) stored
in shared memory and possibly in service backends. Use 0 to disable.
Default is 15.
.. config:option:: LoopSleep
The number of seconds how long will SMSD sleep before checking for some
activity. Please note that setting this to higher value than 1 will have
effects to other time based configurations, because they will be effectively
rounded to multiply of this value.
Default is 1.
.. config:option:: MultipartTimeout
The number of seconds how long will SMSD wait for all parts of multipart
message. If all parts won't arrive in time, parts will be processed as separate
messages.
Default is 600 (10 minutes).
.. config:option:: CheckSecurity
Whether to check if phone wants to enter PIN.
Default is 1 (enabled).
.. config:option:: CheckBattery
Whether to check phone battery state periodically.
Default is 1 (enabled).
.. config:option:: CheckSignal
Whether to check signal level periodically.
Default is 1 (enabled).
.. config:option:: 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).
.. config:option:: HardResetFrequency
.. versionadded:: 1.28.92
.. warning::
For some phones hard reset means deleting all data in it. Use
:config:option:`ResetFrequency`, unless you know what you are doing.
The number of seconds between performing a preventive hard reset in order to
minimize the cases of hanging phones.
Default is 0 (not used).
.. config:option:: 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``.
.. config:option:: 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).
.. config:option:: 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 with :ref:`gammu-smsd-files`.
.. config:option:: 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.
Gammu SMSD waits for the script to terminate. If you make some time consuming
there, it will make SMSD not receive new messages. However to limit breakage
from this situation, the waiting time is limited to two minutes. After this
time SMSD will continue in normal operation and might execute your script
again.
The process has available lot of information about received message in
environment, check :ref:`smsd_run` for more details.
.. config:option:: RunOnFailure
.. versionadded:: 1.28.93
Executes a program on failure.
This can be used to proactively react on some failures or to interactively
detect failure of sending message.
The program will receive optional parameter, which can currently be either
``INIT`` (meaning failure during phone initialization) or message ID,
which would indicate error while sending the message.
.. note:: The environment with message (as is in :config:option:`RunOnReceive`) is not passed to the command.
.. config:option:: IncludeNumbersFile
File with list of numbers which are accepted by SMSD. The file contains one
number per line, blank lines are ignored. The file is read at startup and is
reread only when configuration is being reread. See Message filtering for
details.
.. config:option:: ExcludeNumbersFile
File with list of numbers which are not accepted by SMSD. The file contains
one number per line, blank lines are ignored. The file is read at startup and
is reread only when configuration is being reread. See Message filtering for
details.
.. config:option:: IncludeSMSCFile
File with list of SMSC numbers which are accepted by SMSD. The file contains
one number per line, blank lines are ignored. The file is read at startup and
is reread only when configuration is being reread. See Message filtering for
details.
.. config:option:: ExcludeSMSCFile
File with list of SMSC numbers which are not accepted by SMSD. The file
contains one number per line, blank lines are ignored. The file is read at
startup and is reread only when configuration is being reread. See Message
filtering for details.
.. config:option:: BackendRetries
How many times will SMSD backend retry operation.
The implementation on different backends is different, for database backends
it generally means how many times it will try to reconnect to the server.
Default is 10.
.. config:option:: Send
Whether to enable sending of messages.
Default is True.
.. config:option:: Receive
Whether to enable receiving of messages.
Default is True.
Database backends options
-------------------------
All DBI, MYSQL and PGSQL backends (see :ref:`gammu-smsd-mysql`,
:ref:`gammu-smsd-pgsql`, :ref:`gammu-smsd-dbi` for their documentation)
supports same options for configuring connection to a database:
.. config:option:: User
User name used for connection to a database.
.. config:option:: Password
Password used for connection to a database.
.. config:option:: Host
Database server address. It can also contain port or socket path after
semicolon, for example ``localhost:/path/to/socket``.
.. versionadded:: 1.28.92
.. config:option:: PC
Synonym for :config:option:`Host`.
.. deprecated:: 1.28.92
.. config:option:: 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.
.. config:option:: 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.
.. config:option:: Driver
SQL driver to use.
Can be either one of native drivers (``native_mysql`` or ``native_pgsql``) or :ref:`gammu-smsd-dbi` driver.
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.
.. config:option:: DriversPath
Path, where DBI drivers are stored, this usually does not have to be set if
you have properly installed drivers.
.. config:option:: 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
:ref:`gammu-smsd-files` for more detailed service backend description. Please note
that all path should contain trailing path separator (/ on Unix systems):
.. config:option:: InboxPath
Where the received SMSes are stored.
Default is current directory.
.. config:option:: OutboxPath
Where SMSes to be sent should be placed.
Default is current directory.
.. config:option:: SentSMSPath
Where the transmitted SMSes are placed, if same as :config:option:`OutboxPath` transmitted
messages are deleted.
Default is to delete transmitted messages.
.. config:option:: ErrorSMSPath
Where SMSes with error in transmission is placed.
Default is same as :config:option:`SentSMSPath`.
.. config:option:: InboxFormat
The format in which the SMS will be stored: ``detail``, ``unicode``, ``standard``.
``detail``
format used for message backup by :ref:`gammu`, see :ref:`gammu-smsbackup`.
``unicode``
message text stored in unicode (UTF-16)
``standard``
message text stored in system charset
The ``standard`` and ``unicode`` settings do not apply for 8-bit messages, which
are always written raw as they are received with extension .bin.
Default is ``unicode``.
.. note::
In ``detail`` format, all message parts are stored into signle file,
for all others each message part is saved separately.
.. config:option:: OutboxFormat
The format in which messages created by :ref:`gammu-smsd-inject` will be stored,
it accepts same values as InboxFormat.
Default is ``detail`` if Gammu is compiled in with backup functions, ``unicode``
otherwise.
.. config:option:: TransmitFormat
The format for transmitting the SMS: ``auto``, ``unicode``, ``7bit``.
Default is ``auto``.
.. _message_filtering:
Message filtering
-----------------
SMSD allows to process only limited subset of incoming messages. You can define
filters for sender number in :config:section:`[include_numbers]` and
:config:section:`[exclude_numbers]` sections or using
:config:option:`IncludeNumbersFile` and :config:option:`ExcludeNumbersFile`
directives.
If :config:section:`[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 :config:section:`[exclude_numbers]` you can
specify numbers which you want to skip.
Lists from both sources are merged together. If there is any number in include
list, only include list is used and only messages in this list are being
accepted. If include list is empty, exclude list can be used to ignore
messages from some numbers. If both lists are empty, all messages are
accepted.
Similar filtering rules can be used for SMSC number filtering, they just use
different set of configuration options - :config:section:`[include_smsc]` and
:config:section:`[exclude_smsc]` sections or :config:option:`IncludeSMSCFile`
and :config:option:`ExcludeSMSCFile` directives.
Examples
--------
There is more complete example available in Gammu documentation. Please note
that for simplicity following examples do not include :config:section:`[gammu]`
section, you can look into :ref:`gammurc` for some examples how it can look like.
SMSD configuration file for FILES backend could look like:
.. code-block:: ini
[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:
.. code-block:: ini
[smsd]
Service = mysql
PIN = 1234
LogFile = syslog
User = smsd
Password = smsd
PC = localhost
Database = smsd
Process only messages from 123456 number:
.. code-block:: ini
[include_numbers]
number1 = 123456
Do not process messages from evil number 666:
.. code-block:: ini
[exclude_numbers]
number1 = 666
Enabling debugging:
.. code-block:: ini
[smsd]
debuglevel = 255
logfile = smsd.log
|