Menu:
All global settings (in alphabetic order):
All modem settings:
The config file is /etc/smsd.conf. You may specify another file using the option -c. During installation an easy example file will be copied to smstools3/examples directory.
The config file has the following structure:
|
some global settings [first modem name] ... [second modem name] ... [third modem name] ... and so on |
Configuring the provider-sorting is shown in different document.
In case of yes/no settings, you can use the following keywords:
After version >= 3.1 also "no" values should be typed correctly, "no" is no more a default.
In case of lists, you need to use the comma character to separate items. Example: modem1, modem2, modem3
After version >= 3.1 multiple different values can be defined for each setting.
If smsd is started with command line argument -a (ask), settings with multiple choices are prompted and
suitable value can be selected for a run. For example:
After version >= 3.1.5 only whole line comments are allowed. For example:
# This comment line is valid.
devices = GSM1 # This kind of comment is invalid.
After version >= 3.1.5 default settings for all modems can be defined in the [default] section. If setup has large count of similar modems, almost all settings can be defined once in [default] section and only device depended settings like device are required to define in the modem sections. In the future versions this will replace all modem settings which are now defined in the global part of configuration.
As "default" is now reserved name, it cannot be used as a modem name.
The global part begins at the top of the config file.
adminmessage_device = name
Default value: first available modem.
Available from version >= 3.1.5.
Defines which modem is used to send administrative messages from the mainspooler.
This feature uses shared memory and works only if libmm is installed and statistics functionality is enabled.
admin_to = phone number
Default value: not in use.
Available from version >= 3.1. Specifies a destination number for administrative messages created by smsd.
Messages are sent without using the filesystem.
alarmhandler = filename
Default value: not in use.
You can specify here an external program that is started whenever an alarm occurs.
After version >= 3.1 a value can be defined as a word, like LOG_INFO, INFO or info.
alarmlevel = number
Default value: LOG_WARNING.
Specifies what levels start an alarmhandler. You can use value between 2 and 7.
autosplit = number
Default value: 3.
Controls if and how the program splits large text messages.
The program does not split text messages with UDH.
If splitting is disabled, binary messages requiring more than one part are not sent.
| 0 | disabled |
| 1 | enabled, no part-number |
| 2 | enabled, text numbers |
| 3 | enabled, concatenated format (not supported by some phones) |
blacklist = filename
Default value: not in use.
Name of the blacklist file.
blockafter = number
Default value: 3.
Available from version >= 3.0.9.
A modem is blocked after n number of errors while sending messages.
A successfull sending will reset this counter.
blocktime = number
Default value: 3600.
A modem is not used so many seconds when it seems to be out of order.
checked = directory
Default value: /var/spool/sms/checked.
Path of the default Queue directory in case you do not use provider-sorting.
checkhandler = filename
Default value: not in use.
External program that checks if a message file is valid.
(This script can also be used to convert message file from UTF-8 to ISO format, which is internal format used in smsd.
See scripts/checkhandler-utf-8 for sample code.)
After version >= 3.0.9 the smsd converts messages automatically from UTF-8 to ISO, if it is necessary.
If the checkhandler return a non-zero (other than 2) exitcode the message will not be sent.
With the smsd version >= 3.1 the checkhandler can also modify a message file.
Exitcode 2 means that the checkhandler has moved a message to the spooler by itself.
date_filename = number
Default value: 0.
Available from version >= 3.1.
Defines if date is included to the filename of incoming message.
With value 1 like 2007-09-02.GSM1.xxxxxx and with value 2 like GSM1.2007-09-02.xxxxxx.
date_filename_format = format string
Default value: compatible with previous versions.
Available from version >= 3.1.7. Specifies a format for date string in filenames.
See man strftime for usage details.
datetime_format = format string
Default value: compatible with previous versions.
Available from version >= 3.1. Specifies a format for timestamps.
See man strftime for usage details.
Before the version 3.1.7 a name for this setting was datetime. The old name can still be used because of backward compatibility.
decode_unicode_text = yes/no
Default value: no.
Available from version >= 3.0. Controls when the incoming Unicode text is decoded internally.
delaytime = number
Default value: 10.
Smsd sleep so many seconds when it has nothing to do.
delaytime_mainprocess = number
Default value: not in use.
Available after >= 3.1.4.
If this value is not set, delaytime setting is used in the main process.
With this setting outgoing messages can be checked more frequently than incoming messages.
devices = names
Default value: empty.
List of names of your modems, maximum 64 devices. This limit is changeable.
After version >= 3.1.12 this setting can be given in shortened form:
devices = GSM* 101-164
"GSM" defines a prefix, "101" is the number of first modem and "164" is the number of last modem.
The example is extracted to: devices = GSM101,GSM102,GSM103 etc...
errorsleeptime = number
Default value: 10.
A modem sleeps so many seconds when it answers a command with ERROR.
eventhandler = filename
Default value: not in use.
Specifies an external program or script that will execute whenever a message was sent, received or failed.
(If your locale is UTF-8, you can use this script to convert received messages from smsd's internal format (ISO) to UTF-8.
See scripts/eventhandler-utf-8 for code sample.)
After version >= 3.0.9 there is incoming_utf8 = yes setting available.
Using this setting the external conversion is not required.
executable_check = yes/no
Default value: yes.
Available from version >= 3.1.1.
This setting defines if all executables are checked during the startup check.
Usually eventhanler, alarmhandler etc. are shell scripts or some other single files which can be executed and therefore checked simply.
If using a settings like eventhandler = /usr/local/bin/php -f /usr/local/bin/smsd_eventhandler.php,
the check will fail and smsd will not start unless executable_check = no is defined.
failed = directory
Default value: not in use.
Path of the Failed Folder. Delete this line if you do not want to keep failed files.
filename_preview = number
Default value: not in use.
Available from version >= 3.1. Defines how many characters of message text is concatenated to the name of a messsage file.
Characters used are a...z, A...Z, 0...9, - and period.
All other characters are replaced with _'s.
hangup_incoming_call = yes/no
Default value: no.
Available from version >= 3.1.5.
If set to yes and detected unexpected input contains "RING", incoming call is ended.
Use modem setting voicecall_hangup_ath to define if "ATH" is used to make hangup instead of "AT+CHUP".
ic_purge_hours = number
Default value: 24.
ic_purge_minutes = number
Default value: 0.
ic_purge_read = yes/no
Default value: yes.
ic_purge_interval = number
Default value: 30.
Available from version >= 3.1.5.
These settings defines how concatenation storage is purged when internal_combine is used
and messages with missing parts are received.
Storage is checked every ic_purge_interval minutes.
If there are message parts older than defined with ic_purge_hours and/or ic_purge_minutes settings,
message parts are deleted. If ic_purge_read is yes, message is stored to the incoming folder.
In this case there will be only one part in the file and a header Incomplete: yes indicates that message is broken.
Value 0 for both ic_purge_hours and ic_purge_minutes disables this feature.
ignore_exec_output = yes/no
Default value: no.
Available from version >= 3.1.7.
Defines if an unexpected output from eventhanders is ignored.
Usually eventhandlers should not output anything.
If there is some output, it usually means that some error has occurred.
These errors are often problematic, because that output cannot be seen and error is therefore not notified.
Smsd will print any output from the evenhandlers to the log file.
This output can also be used for debugging purposes, but usually debugging should be done by running eventhandler manually.
ignore_outgoing_priority = yes/no
Default value: no.
Available from version >= 3.1.5.
With this setting Priority: high header is not checked.
This speeds up spooling on systems where priorizing is not required and there are lot of files in the spooler directory.
incoming = directory
Default value: /var/spool/sms/incoming.
Path of the Incoming Folder.
incoming_utf8 = yes/no
Default value: no.
Available from version >= 3.0.9. With this setting messages using ISO or GSM alphabet are stored using UTF-8 character set.
internal_combine = yes/no
Default value: yes.
Available from version >= 3.0. Controls when the incoming multipart message is combined internally.
internal_combine_binary = no
Default value: internal_combine.
Available from version >= 3.1.5. Controls when the incoming multipart binary message is not combined internally.
international_prefixes = list of numbers
Default value: not in use.
Available from version >= 3.1.5.
See SMS file (Using Type Of Address selection) for details.
keep_filename = yes/no
Default value: yes.
Available from version >= 3.1. If this is set to no, an unique filename is created each time
when a message file is moved from directory to another directory. This ensures that any previously sent message file
is not overwritten, even if the original filename was the same. Also if an user has created filename with space
character, this creates a new name without spaces and therefore spaces can't effect to operation of an eventhandler.
keep_messages = yes/no
Default value: no.
Available from version >= 3.1.5.
This is for testing purposes. Smsd runs as usual but messages are not removed from the modem.
After all messages are read, smsd will stop. Use this with one modem only.
language_file = filename
Default value: not in use.
Available from version >= 3.1.
Message files can be written using localized headers.
See the localizing for details.
log_charconv = yes/no
Default value: no.
Available from version >= 3.0.9.
With this setting a details of character set conversions (outgoing UTF-8 to ISO conversion and incoming GSM/ISO to
UTF-8 conversion) is printed to the log.
If smsd is compiled using DEBUGMSG definition, details are also printed to the console.
Logging feature can be useful if you have some troubles with characters and like to know what exactly happens inside the smsd.
logfile = filename
Default value: empty.
Name of the log file. Delete this line, if you want to use the syslog for logging.
You can use "1" to write to the console (stdout).
This setting can be overridden by the -l (ell) command line argument.
loglevel = number/word
Default value: 4 for logfile, 7 for syslog.
Sets the verbosity of a log file.
This affects also syslog. If you want all messages in syslog, you need to set it to "7" (or higher) here and "*" in the config file of syslog. If you want less messages, you can reduce it here or in the config file of syslog, both will work.
| debug | 7 | All AT-Commands and modem answers and other detailed informations useful for debugging |
| info | 6 | Information what is going on at the moment. Not detailled enough for debugging but maybe interesting. |
| notice | 5 | Information when a message was received or sent and when something not normal happens but program still works fine (for example wrong destination number in SMS file). |
| warning | 4 | Warning when the program has a problem sending a single short message. |
| error | 3 | Error message when the program has temporary problem (for example modem answered with ERROR during initialization or a file can not be accessed). |
| critical | 2 | Error message when the program has a permament problem (for example sending failed many times or wrong permissions to a queue). |
After version >= 3.1 a value can be defined as a word, like LOG_INFO, INFO or info.
log_read_from_modem = yes/no
Default value: no.
Available from version >= 3.1.9.
In some cases, when resolving troubles with a modem, it's useful to see exact data which is received from the modem.
This setting is similar than log_unmodified, but displays the data as a hexadecimal dump.
log_single_lines = yes/no
Default value: yes.
Available from version >= 3.1.
Defines if linefeeds are removed from the modem response.
logtime_format = format string
Default value: compatible with previous versions.
Available from version >= 3.1.7. Specifies a format for date string logging.
See man strftime for usage details.
After version >= 3.1.14 this setting can have special keywords included: timeus or timems. Keywords are replaced with a current value of microseconds or milliseconds.
logtime_ms = yes/no
Default value: no.
logtime_us = yes/no
Default value: no.
Available from version >= 3.1.14.
With these settings the timestamp in the log file can have microseconds or milliseconds shown.
These settings can be used when a default format for timestamp is in use.
Value is shown after seconds and is delimited with a dot.
If logtime_format is defined, these settings have no effect. Milliseconds or microseconds can be included in customized logtime_format using keywords timeus or timems.
log_unmodified = yes/no
Default value: no.
Available from version >= 3.1.7.
In some cases, when resolving troubles with a modem, it's useful to see what kind of line ends were received from the modem.
With this setting spaces and line ends are not removed from the string which is logged.
This setting overrides the setting log_single_lines.
max_continuous_sending = number
Default value: 300 (5 min).
Available from version >= 3.1.5.
This setting is in seconds and defines how long modem can send messages without doing anything else.
After max_continuous_sending time is reached, received messages are checked and other tasks are run.
national_prefixes = list of numbers
Default value: not in use.
Available from version >= 3.1.5.
See SMS file (Using Type Of Address selection) for details.
os_cygwin = yes/no
Default value: no.
Available from version >= 3.0.10.
Defines if smsd is running on Cygwin environment.
This is needed if outgoing file permissions should be checked and changed by the smsd.
outgoing = directory
Default value: /var/spool/sms/outgoing.
Path of the Outgoing Queue folder.
phonecalls = directory
Default value: empty, incoming directory is used.
Available from version >= 3.1. Defines where phonecalls data is stored.
priviledged_numbers = list of numbers
Default value: not in use.
Available from version >= 3.1.5.
This list can be used with check_memory_method values 31, 41, and 5.
Global list is default for each modem.
List can be comma separated list of numbers or their parts starting from the left.
Maximum 25 priviledged numbers can be defined.
When messages are received, messages from priviledged numbers are handled first.
First number in the list has highest priority.
receive_before_send = yes/no
Default value: no.
Forces smsd to empty the first SIM card memory before sending SM.
This is a workaround for modems that cannot send SM with a full SIM card.
regular_run = filename
Default value: not in use.
regular_run_interval = number
Default value: 300.
Available from version >= 3.1. A regular_run is an external script or program which is run regularly while the smsd is running.
A value regular_run_interval describes number of seconds between each run.
See Running for more information and sample usage.
report = directory
Default value: not in use.
Available from version >= 3.1.
Path of the Report Folder.
Without this setting status report messages are stored to the Incoming Folder.
saved = directory
Default value: not in use.
Available from version >= 3.1. Path of the Saved Folder.
If defined, smsd will store concatenation storage's to this directory (otherwise incoming directory is used).
At startup check existing concatenation storages are moved from incoming directory to saved directory.
Zero sized files are ignored.
If both directories has a storage file with data, fatal error is produced and the smsd does not start.
sent = directory
Default value: not in use.
Path of the Sent Folder. Delete this line, if you do not want to keep copies of each sent message file.
shell = filename
Default value: /bin/sh
Available from version >= 3.1.5.
Defines which shell is used to run eventhandler and other external scripts.
shell_test = yes/no
Default value: yes
Available from version >= 3.1.14.
When executable_check is enabled, testing of the shell can be omitted with this setting.
smart_logging = yes/no.
Default value: no.
Available from version >= 3.1.5.
This feature is available when file based logging is used.
If loglevel is less than 7 (for example "notice" is a good choise with smart_logging),
trouble log (with loglevel 7) about whole communication is written to different file if there has been any errors.
"Whole communication" means sending single SMS, receiving single SMS, and other things what smsd will do after idle time is spent. When communication starts, all possible log lines are collected to internal buffer and only loglevel lines are written to the logfile. If during communication there are any errors, all collected lines are printed to trouble log when communication reaches it's end.
This feature was made because with loglevel 7 logfile grows very much and fast, and debug level is not usually needed when there was no any errors. In case of errors it's important to see whole communication, not just a single line which says that "error happened".
File name is created with the rule: if lenght of logfile setting is more than 4 characters and setting ends with ".log", trouble log filename will end with "_trouble.log". If length is less than 4 or setting does not end with ".log", trouble log filename is logfile appended with ".trouble". In usual cases logfile is /var/log/smsd.log and trouble log filename will be /var/log/smsd_trouble.log, or in some (Debian, Ubuntu, ...) distributions: /var/log/smstools/smsd.log and /var/log/smstools/smsd_trouble.log.
spool_directory_order = yes/no
Default value: no.
Available from version >= 3.1.9.
With this setting files are handled in the order they are on disk.
This disables priorizing and also the age of files are not checked.
stats = directory
Default value: not in use.
Specifies the directory where smsd stores statistic files.
The directoy must exist before you start smsd.
If not given, then the program does not write statistic files.
After version >= 3.1.1 message counter files are stored to this directory even if smsd is compiled without statistics enabled.
stats_interval = number
Default value: 3600.
Smsd writes statistics files every n seconds.
Value 0 disables statistics but counters are still updated if stats directory is defined.
stats_no_zeroes = yes/no
Default value: no.
Smsd does not write statistic files when no message was sent or received (Zero-Counters) if this is set to yes.
status_include_counters = yes/no
Default value: yes.
status_signal_quality = yes/no
Default value: yes.
Available from version >= 3.1.5.
These settings define if message counters and explained signal quality is included in the line of status file.
status_interval = number.
Default value: 1.
Available from version >= 3.1.5.
If statistics function is enabled and stats directory is defined, smsd writes file named status into this directory.
The file contains status of all modems in the first line using Status: header (this is similar than smsd -s outputs to console) and
explained status in the next lines using modem's name as a header.
Smsd writes status file every status_interval seconds if a status has changed. Value 0 disables this feature.
For example, the output is like:
Status: 09-05-27 20:46:17, irir------------ SONERA: 09-05-27 20:46:09, Idle, 123, 0, 321, ssi: -63 dBm, ber: < 0.2 % ELISA: 09-05-27 20:46:12, Receiving, 234, 0, 432, ssi: -73 dBm, ber: < 0.2 % DNA: 09-05-27 20:46:06, Idle, 456, 0, 543, ssi: -77 dBm, ber: < 0.2 % SAUNALAHTI: 09-05-27 20:46:14, Receiving, 678, 0, 654, ssi: -69 dBm, ber: < 0.2 %Timestamp value tells when status is created or modem initialization was last started.
Status can be: (s) Sending, (r) Receiving, (i) Idle, (b) Blocked, (t) Trouble, (-) Unknown. Trouble -status means that something abnormal has happened and if smart_logging is in use, trouble log will be written.
Counters are: sent, failed, received. Sent counter is the value from stats/<modemname>.counter file. Smsd does not clear this value. Failed and received counters are from original statistics data and they are cleared each time when stats are stored (stats_interval), or smsd is restarted.
store_original_filename = yes/no
Default value: yes.
Available from version >= 3.1. Together with keep_filename this controls when the original
filename is stored to message file when it's moved from outgoing directory to the spool.
store_received_pdu = number
Default value: 1.
Available from version >= 3.0. Controls when the incoming PDU string(s) is stored to message file.
| 0 | no PDU's are stored |
| 1 | unsupported PDU's are stored |
| 2 | unsupported and PDU's with 8bit binary data or Unicode text are stored |
| 3 | all PDU's are stored |
store_sent_pdu = number
Default value: 1.
Available from version >= 3.0.9. Controls when the outgoing PDU string(s) is stored to message file.
| 0 | no PDU's are stored |
| 1 | failed (to send) PDU's are stored |
| 2 | failed and PDU's with 8bit binary data or Unicode text are stored |
| 3 | all PDU's are stored |
suspend = filename
Default value: not in use.
Available from version >= 3.1.7.
With this file, any modem process can be suspended.
When a process is suspended, the modem port is closed and modem process does not do anything.
The file is checked before smsd starts sending or receiving. If a name of the device is found from the file, suspend will start. The format of a line in file is: <devicename>: <reason>. Colon is needed, but the <reason> is optional. It is printed to the log. A special line ALL: <reason> can also be used, and this affects for all modem processes.
When a process is suspended, the file is checked every ten seconds, or more frequently if the delaytime value is smaller.
When a process is suspended, it listens a signal SIGUSR2. If this signal is received, modem process will send and receive messages once.
terminal = yes/no
Default value: no.
Available from version >= 3.1. Enables terminal mode like command line argument -t.
trim_text = yes/no
Default value: yes.
Available from version >= 3.1.7.
With this setting trailing whitespaces are removed from the outgoing message.
Does not effect with messages written using Unicode or GSM alphabet.
After version >= 3.1.9, if the message is going blank, the removal is not done. This is because some people, really, need to send a message which contains only single space character.
trust_outgoing = yes/no
Default value: no.
Available from version >= 3.1.5.
This setting can be used to speed up spooling, but only if it is completely sure that files are created by rename and permissions are correct.
umask = value
Default value: empty.
Available from version >= 3.1.7.
Effective umask for smsd can be set in the configuration file.
Value can be hexadecimal, decimal or octal format.
Next four settings are available from version >= 3.0.2:
user = username
Default value: not in use.
group = groupname
Default value: not in use.
If the smsd is started by the root, these two settings can be used to switch smsd to run as an unpriviledged user.
As of version >= 3.0.9, if user is set but group is unset, that user's normal groups (e.g. from
/etc/groups) are used.
This means you can allow other users on the system access to write messages to the outgoing spool without giving them
direct access to the serial port.
infofile = filename
Default value: /var/run/smsd.working.
pidfile = filename
Default value: /var/run/smsd.pid.
Location of infofile and pidfile can be changed with these settings.
This is usually necessary if the smsd is running as an unpriviledged user.
If a sms3 script is used to start and stop the smsd, these settings should be defined in the script.
These four settings can be overridden by the command line argument(s):
validity = number
Default value: 255.
Available from version >= 3.0. See SMS file for details of possible values.
voicecall_hangup_ath = yes/no
Default value: no.
Available from version >= 3.1.5.
Defines if ATH is used to hangup call instead of AT+CHUP.
whitelist = filename
Default value: not in use.
Name of the whitelist file. The black list takes precedence before the white list.
See Blacklist and Whitelist for more details and sample usage.
[modem name]
Begin of a modem settings block. The modem name must be the same as in the devices= line in the global part.
NOTE for Cygwin users: Do not use a device name, like COM1, as a modem name.
While a message is received, a file starting with this name is created and Windows handles it as a device.
This will cause a modem process to be freezed.
After version >= 3.1.12 it is no more mandatory that the modem settings block exists for all modems. When using large number of similar modems, it is often enough that [default] block exists.
adminmessage_limit = number
Default value: not in use.
adminmessage_count_clear = number
Default value: not in use.
Available from version >= 3.1.5.
Adminmessage_limit specifies the maximum number of administrative messages to send.
After this limit is reached, no more administrative messages will be sent until the smsd is restarted or message counter
is cleared by the adminmessage_count_clear setting. The value of this setting is minutes.
admin_to = phone number
Default value: not in use.
Available from version >= 3.1. Specifies a destination number for administrative messages created by smsd.
This setting overrides the setting in the global part.
baudrate = number
Default value: 115200.
Specifies the speed of the serial communication in bits per second.
Most modems including old devices work well with 115200.
If this speed is not supported by the system, 19200 is used.
Some very old devices may need lower speed like 9600 baud.
check_memory_method = number
Default value: 1.
Available from version >= 3.1.5.
Defines how incoming messages are checked:
| 0 | CPMS is not supported. Default values are used for used_memory and max_memory. |
| 1 | CPMS is supported and must work. In case of failure incoming messages are not read. |
| 2 | CMGD is used to check messages. Some devices does not support this.
To see if this is supported, check the answer for AT+CMGD=? command. Answers like: |
| 3 | CMGL is used to check messages. Message is deleted after it is read. |
| 4 | CMGL is used to check messages. Messages are deleted after all messages are read. |
| 31 | CMGL is used to check messages. Message is deleted after it is read. CMGL data is checked and PDU is taken directly from the list. |
| 41 | CMGL is used to check messages. Messages are deleted after all messages are read. CMGL data is checked and PDU is taken directly from the list. |
| 5 | CMGL is used to check messages. Messages are deleted after all messages are read. CMGL data is checked and PDU is taken directly from the list. Multipart message is handled after all of it's parts are available. After multipart message is handled, only the first part is deleted by the smsd. The modem will delete rest of parts by itself. This is SIMCOM SIM600 compatible. |
NOTE: Some devices are incompatible with CMGL method.
NOTE: With values 31, 41 and 5 priviledged_numbers sorting can be used.
check_network = value
Default value: 1.
Available from version >= 3.1, enhanced in version 3.1.5.
Defines how network registration is checked:
| 0 no | Network registration is not checked. |
| 1 yes | Network registration is always checked |
| 2 | Network registration is checked only when preparing to send messages. |
If a modem does not support network checking, checking is automatically ignored.
With value 2 incoming messages are processed faster.
cmgl_value = string
Default value: 4.
Available from version >= 3.1.5.
If check_memory_method = 3, 4, 31, 41 or 5 is used, correct value for AT+CMGL= command must be defined. This value depends on the modem.
communication_delay = number
Default value: 0.
Available from version >= 3.1.5.
Only some very problematic modems may need this setting.
Defines minimum time in milliseconds between latest answer from modem and next command which will be sent to modem.
cs_convert = yes/no
Default value: yes.
The program converts normal text messages into GSM character set. You need this to display
german umlauts and control characters correctly.
decode_unicode_text = yes/no
Default value: use the global part setting.
Available from version >= 3.0. Specifies an internal Unicode decoding like in the global part.
detect_message_routing = yes/no
Default value: yes.
Available from version >= 3.1.5.
By default smsd tries to detect if a modem is in message routing mode.
Before sending a command smsd listens if some data with routed message is available.
Also, after a command is sent, smsd checks the answer.
In both cases, if there is one or more routed message coming, a notification is written to the log and alarmhandler is called.
Routed messages are saved and handled later when smsd can do it.
NOTE: This checking is done to avoid errors and loss of messages. Routing mode SHOULD NOT BE USED in normal operation. With routing mode it is NOT quaranteed that all messages are delivered. Some devices are in routing mode by default and this feature helps to detect it. Use init = AT+CNMI=... with suitable values to disable routing mode. Values depend on modem, see the manual of a modem for details. All received messages must be stored to the message store which is usually "SM" (SIM card memory).
detect_unexpected_input = yes/no
Default value: yes.
Available from version >= 3.1.5.
Before any command is sent to the modem, smsd checks if there is some unexpected input.
For example some modem may send new message identification (CMTI) if settings are incorrect.
Any unexpected input will be logged.
device = name of serial port / definition of internet host
Default value: empty.
Specifies the device name of the serial port or internet host to the modem.
GNU/Linux example: /dev/ttyS0. Windows example: /dev/com1 or /dev/ttyS0. Solaris example: /dev/cuaa. Network modem example: @10.1.1.1:5000.
After version >= 3.1.7 this setting can define a socket if starting with character @. Format for the internet host is: @<host_or_ip>:<port>. Host definition can be name or IP address.
After version >= 3.1.12 this setting can contain a special word "modemname" (without quotation marks).
For example:
device_open_alarm_after = number
Default value: 0.
Available from version >= 3.1.7.
After defined number of retries, an alarmhandler is called.
Smsd still continues trying, if device_open_retries value is bigger.
device_open_retries = number
Default value: 1.
Available from version >= 3.1.7.
Defines how many times smsd will retry when cannot open a device.
When maximum number of retries is reached, modem process will call alarmhandler and stop.
With value -1 smsd will retry forever.
eventhandler = filename
Default value: empty.
Specifies an eventhandler script like in the global part.
If you use this variable, then this modem will use its own individual eventhandler instead of the global one.
eventhandler_ussd = filename
Default value: not in use.
Available from version >= 3.1.7.
This setting defines an eventhandler to use with USSD messages.
It is possible to use the same script or program which is used as eventhandler,
but it's not a default because basically those scripts are not compatible without modifications.
After an USSD message is received, and probably ussd_convert is done, eventhandler_ussd is called.
Smsd checks what is the current character set of a modem and creates a temporary file which contains the USSD answer.
Arguments for the eventhandler_ussd are:
| $1 | "USSD" keyword. |
| $2 | Filename (which contains the answer). |
| $3 | Devicename. |
| $4 | Character set. |
| $5 | Command what was used to get the USSD answer. |
Eventhandler_ussd can do whatever is needed with the USSD answer. It can also modify the answer, or delete the file. After eventhandler_ussd returns, smsd will check if the file still exists. If it exists, it's first line is taken as a new answer. Modified answer is then logged and probably printed to the regular_run_statfile.
hangup_incoming_call = yes/no
Default value: no.
Available from version >= 3.1.5.
If set to yes and detected unexpected input contains "RING", incoming call is ended.
Use modem setting voicecall_hangup_ath to define if "ATH" is used to make hangup instead of "AT+CHUP".
This setting overrides global setting.
incoming = no/yes/high or 0/1/2
Default value: no.
Specifies if the program should read incoming SM from this modem.
"Yes" or "1" means that smsd receives with less priority.
The value "high" or "2" means that smsd receives with high priority.
"No" or "0" means that smsd does not receive messages.
init = modem command
Default value: not in use.
Specifies a modem initialisation command. Most modems do not need any init string.
See the manual of your modem for more details of modem commands.
init2 = modem command
Default value: not in use.
Specifies a second modem initialisation command. Most users do not need this.
internal_combine = yes/no
Default value: use the global part setting.
Available from version >= 3.0. Specifies an internal multipart message combining like in the global part.
internal_combine_binary = no
Default value: use the global part setting.
Available from version >= 3.1.5. Specifies an internal multipart binary message combining like in the global part.
keep_messages = yes/no
Default value: no.
Available from version >= 3.1.7.
Defines if messages are not deleted from the device.
Unlike a global setting keep_messages, smsd continues running.
keep_open = yes/no
Default value: yes.
Available from version >= 3.1.
If this is changed to no, a modem is closed while it's not used.
logfile = filename
Default value: empty, using a global log file.
Available from version >= 3.1.
Defines a log file if a global log is not used.
After version >= 3.1.12 this setting can contain a special word "modemname" (without quotation marks).
For example:
logfile = /var/log/smstools/modemname.log
When a device is GSM1, the setting is extracted as /var/log/smstools/GSM1.log.
loglevel = number/word
Default value: same as in the global setting.
Available from version >= 3.1.
Sets the verbosity of a log file.
See more details in the global part.
loglevel_lac_ci = number/word
Default value: LOG_INFO.
Available from version >= 3.1.14.
Sets the verbosity of logging the Location area code and Cell ID and their changes.
This requires that AT+CREG? returns location information.
It is automatically enabled by pre_init using a command CREG=2.
After the Location are code or Cell ID changes, quality of signal is also logged.
This feature can be disabled with the setting which is more than current loglevel, for example 8.
log_not_registered_after = number
Default value: 0.
Available from version >= 3.1.14.
If it's known that the modem gives "not registered" after a message is sent or received,
with this setting number of log messages can be avoided.
max_continuous_sending = number
Default value: 300 (5 min).
Available from version >= 3.1.5.
This setting is in seconds and defines how long modem can send messages without doing anything else.
After max_continuous_sending time is reached, received messages are checked and other tasks are run.
This setting overrides global setting.
memory_start = number
Default value: 1.
Tells the first memory space number for received messages.
This is normally 1, Vodafone Mobile Connect Card starts with 0.
messageids = number
Default value: 2.
Available from version >= 3.1.1.
Defines how message id's are stored: 1 = first, 2 = last, 3 = all.
When all id's are stored, numbers are delimited whith space and there is one space and dot in the end of string.
message_limit = number
Default value: not in use.
message_count_clear = number
Default value: not in use.
Available from version >= 3.1. Message_limit specifies the maximum number of messages to send.
After this limit is reached, no more messages will be sent until the smsd is restarted or message counter
is cleared by the message_count_clear setting. The value of this setting is minutes.
If admin_to is specified, an administrative message is sent when the limit is reached.
mode = old/new
Default value: new.
Specifies version of modem command set.
Almost everybody needs to use this as a "new".
From version >= 3.0.9 this effects mainly to the sending side. In the receiving side the incoming PDU is checked, and if it does not match to the selected mode, another mode is tried automatically.
| old | For Falcom A1 and maybe some other old modems of GSM phase 1 (1990-1995). In the receiving side this mode does not have SCA information in the begin of PDU. |
| new | For nearly all mobile phones and modems. In the receiving side this mode has SCA information in the begin of PDU. |
modem_disabled = yes/no
Default value: no.
Available from version >= 3.0.9. This is for testing purposes too.
Whole messaging system including eventhandlers etc. can be tested without any working
modem existing. Sending of messages is simulated in the similar way than with sending_disabled setting.
Incoming messages are taken only from the file, if pdu_from_file is defined.
No any communication is made between smsd and modem, but a device setting should still exist because smsd wants to
open and close a device.
If in you testing environment you do not have a priviledges to the usual modem device,
like /dev/ttyS0, you can use a definition like device = /tmp/modemfile.
If this file exists and is writable for the process owner, it's enough for smsd.
ms_purge_hours = number
Default value: 6.
ms_purge_minutes = number
Default value: 0.
ms_purge_read = yes/no
Default value: yes.
Available from version >= 3.1.5.
These settings are used only with SIM600 (or compatible) modems (check_memory_method 5).
If multipart message is received with one or more parts missing, incomplete message is removed from the message storage after time defined.
Time is calculated from the timestamp of the first available part.
Value 0 for both settings disables this feature.
Setting ms_purge_read defines if parts are read before they are deleted.
If internal_combine setting is used, parts are stored to the concatenation storage.
If missing part(s) are later received, there will be similar timeout before parts are purged.
After this the messsage is complete and is stored to the incoming folder.
See also global settings ic_purge_*.
needs_wakeup_at = yes/no
Default value: no.
Available from version >= 3.1.7.
After being idle, some modems do not answer to the first AT command.
For example with BenQ M32, there can be OK answer, but in many times there is not.
To avoid error messages, smsd first send AT and read the answer if it's available.
smsc = number
Default value: not in use.
Specifies the SMSC number that this modem should use to send SM.
You need this setting only if the default of the SIM card is bad.
Write the phone number of the SMSC in international format without the starting "+".
outgoing = yes/no
Default value: yes.
Available from version >= 3.0.9.
Specifies if a modem is used to handle and send outgoing messages.
pdu_from_file = filename / directoryname/
Default value: not in use.
Available from version >= 3.0. This is for testing purposes.
You can test you eventhandler and some other things without actually receiving a message from the modem/phone.
This is especially important when it's not possible to receive the same message again because the sender cannot be reached.
You may have the original PDU string stored to the incoming messsage file, or you may see it in log file (depending of the loglevel).
This PDU string can be stored to the pdu_from_file named file, and when this file exists the smsd will read the PDU from there.
Rest processing will be done similarry than with normally received messsages and you can then debug possible problems
and see when they are fixed.
This file can contain empty lines and comment lines starting with # character.
Actual data can be stored as one line containing the PDU string, or two lines containing (first) the modem answer
and (second) the PDU string.
For example:
#2006-09-13 13:12:10,7, GSM1: <-
+CMGR: 0,,40
0791531811111111240C9153183254769800F1609031314174211854747A0E4ACF416110BD3CA783DAE5F93C7C2EBB14
or simply one line only:
079153181111111106BC0C91531832547698609031314174216090313141842100
NOTE: After this file is processed, it is removed.
After >= 3.0.9 the setting can be a directory.
If this setting ends with a slash and a directory with that name exists,
file(s) are read from this directory (and deleted after processing).
All files found from the given directory are processed one by one, expect hidden files (name begins with a dot).
When this setting points to the directory, no dot's are allowed in any position of a path.
Be very careful with this setting while it will delete the content of a whole directory.
After >= 3.0.9: while reading a PDU from file, a first line starting with PDU: and space is taken if any exists.
After >= 3.1.5: this can be used only with check_memory_method values 0 or 1.
phonecalls = yes/no/clip
Default value: no.
Available from version >= 3.1.
Specifies if missed phonecalls are reported.
After version >= 3.1.7 a value clip, or 2 can be used.
This value could be used with modems which do not support reading of phonebook,
or phobebook cannot be used because entries cannot be deleted.
Phocecall is detected using the +CLIP Calling line identification report from a modem.
When phonecalls = clip is used, a setting hangup_incoming_call is automaticatty set to yes. This is because smsd must hangup a call before it's handled.
phonecalls_purge = yes/no/command
Default value: no.
Available from version >= 3.1.7.
Specifies if missed phonecalls are removed using a purge command.
Value yes specifies that AT^SPBD="MC" command is used, this works with some Siemens based devices.
Other command can be given as a value.
pin = 4 digit number
Default value: not in use.
Specifies the PIN number of the SIM card inside the modem.
See also pinsleeptime.
Note after version >= 3.1.1: Even if a PIN is not defined, it's still checked if a PIN is needed.
Some phones may give an incorrect answer for the check when a pin is not needed, like SIM PIN2 or SIM PUK2 instead of READY.
In this case define pin = ignore to skip the whole PIN handling procedure.
pinsleeptime = number
Default value: 0.
Available from version >= 3.0.9. Specifies how many seconds the program will sleep after a PIN is entered.
Some modems do not work without some delay.
phonecalls_error_max = number
Default value: 3.
Available from version >= 3.1.7.
Specifies the maximum number of errors before phonecalls are ignored.
pre_init = yes/no
Default value: yes.
Available from version >= 3.0.8. Specifies is an "echo off" and "CMEE=1" commands are sent to the modem
before anything else is done.
primary_memory = memory name
Default value: not in use.
secondary_memory = memory name
Default value: not in use.
secondary_memory_max = number
Default value: accept what device returns.
These three settings are used to control dual-memory handler, available from version >= 3.0.
If your modem/phone receives messages to the Mobile Equipment (ME) memory after the SIM memory (SM) has been filled up,
with dual-memory handler messages can be read from the Mobile Equipment memory too.
Defining secondary_memory_max is needed, if your device does not tell how much there is space in the Mobile Equipment memory.
For example the Nokia 6210 does not tell (it returns 0 as max value) and with this device 150 is reasonable value.
From version >= 3.1, multiple parameters can be defined for memories, like SM,SM,SM.
Double-quotation marks are not necessary to use in the string.
priviledged_numbers = list of numbers
Default value: not in use.
Available from version >= 3.1.5.
This setting overrides the setting in the global part.
See the global part for details.
queues = list of queue names
Default value: not in use.
Specifies the Provider Queues that this modem shall serve.
Use the same provider names as in [queues] and [providers].
If you do not use the provider-sorting feature, then leave this line out.
After version >= 3.1.5 special keyword modemname can be used, it's replaced with a name of modem.
read_timeout = number
Default value: 5.
Available from version >= 3.1.5.
When smsd reads data from a modem, timeout will occur after read_timeout seconds if an acceptable answer is not received.
Some very slow devices might need greater value than 5 seconds.
regular_run = filename
Default value: not in use.
Regular_run for a modem is available from version >= 3.1:
This setting defines an external script or program to execute.
A modem can be used as it's closed by the smsd.
regular_run_cmd = string
Default value: empty.
Like regular_run_cmdfile, this string can be used to define modem commands.
This setting can be used more than once to define multiple commands.
regular_run_cmdfile = filename
Default value: not in use.
This file can contain command lines which smsd will write to the modem.
Modem result of each line is logged and written to the regular_run_statfile (if defined).
After a file is processed, it is removed.
If you need to use permanent commands on each run, use regular_run script to create this file or
define commands using regular_run_cmd settings.
After version >= 3.1.12 the expected answer can be defined. By default smsd will expect "OK" or "ERROR" from the modem. Any other answer will cause timeout. Line can start with opening square bracket, and the expected answer can be given between square brackets. The expected answer must be a valid regular expression (see man regcomp for details).
Example:
regular_run_interval = number
Default value: 300.
Describes number of seconds between each run.
Value 0 disables this feature.
regular_run_logfile = filename
Default value: not in use.
Defines a log file for regular_run. Syslog cannot be used for this.
If a log file is not defined, smsd's main log is used.
regular_run_loglevel = number
Default value: LOG_NOTICE.
Defines a level of logging.
regular_run_post_run = filename
Default value: not in use.
Available from version >= 3.1.7.
This setting can define the second script or program which is executed regularly.
The same script with regular_run can be used.
The script gets an argument $1 which is PRE_RUN for regular_run and POST_RUN for regular_run_post_run.
There is also the second argument $2, which includes a definition of regular_run_statfile.
This is how the regular_run for a modem currently works:
regular_run_statfile = filename
Default value: not in use.
If defined, results of commands are written to this file.
Old file is cleared before each run.
report = yes/no
Default value: no.
If you enable this, the program requests a status report SM from the SMSC for each sent message.
This does not work on many mobile phones and on some modems.
report_device_details = yes/no
Default value: no/yes.
Available from version >= 3.1.7.
Defines if a details from device are printed to the log when modem process is starting.
With beta versions of smsd this setting defaults to yes, otherwise it defaults to no.
routed_status_report_cnma = yes/no
Default value: yes.
Available from version >= 3.1.7.
Defines if +CNMA acknowledgement is needed to send after routed status report was received.
rtscts = yes/no
Default value: yes.
You can disable usage of hardware handshake wires by setting this option to "no".
Please don't use this feature in commercial applications because
the hardware handshake wires ensure proper communications timing between the
computer and the modem.
send_delay = number
Default value: 1.
If your modem does not support hardware handshake you should use the lowest possible baudrate to ensure that the
program does not run faster than the modem can do. However, if the lowest possible baudrate is still too fast, then you
can use this parameter to make it even slower.
A value of 300 means that the program waits 300 milliseconds between sending each single character to the modem
which makes the program very slow.
From version >= 3.1.5, value 0 means that whole string is sent at once without any delays.
This resolves slow communication with LAN based multiport servers, like Digi Portserver II.
If, for some reason, "tcdrain" is still needed after sending, use value -1.
send_handshake_select = yes/no
Default value: yes.
Available from version >= 3.1.9.
Instead of checking the flag TIOCM_CTS, select() function is used when the serial transmitted is busy.
If because of some reason the old style should be used, this setting allows it.
sending_disabled = yes/no
Default value: no.
Available from version >= 3.0. This is for testing purposes.
You can test your eventhandler and whole system around the smsd without sending any messages to the GSM network.
All other functionality is working as usual, so this is some kind of "mute" to the modem.
However the modem should be connected and working.
This does not have an effect to the incoming messsages.
signal_quality_ber_ignore = yes/no
Default value: no.
Available from version >= 3.1.14.
Some devices do not support Bit Error Rate when signal quality is asked, and this always provides
"Bit Error Rate: not known or not detectable" to the log line and to the status file.
With this setting ber can be ignored.
smsc_pdu = yes/no
Default value: no.
Available from version >= 3.1.12.
If the number of SMSC is set in the configuration, or in the message file, the number is included in the PDU instead of changing SMSC with a command AT+CSCA.
The number can be presented in international format, or in national format starting with 0.
socket_connection_alarm_after = number
Default value: 0.
Available from version >= 3.1.7.
After defined number of retries, an alarmhandler is called.
Smsd still continues trying, if socket_connection_retries value is bigger.
socket_connection_errorsleeptime = number
Default value: 5.
Available from version >= 3.1.7.
Defines how many seconds the smsd will sleep after an error with socket connection.
socket_connection_retries = number
Default value: 11.
Available from version >= 3.1.7.
Defines how many times smsd will retry when a socket connection fails.
When maximum number of retries is reached, modem process will call alarmhandler and stop.
With value -1 smsd will retry forever.
start = modem command
Default value: not in use.
startsleeptime = number
Default value: 3
stop = modem command
Default value: not in use
Available from version >= 3.1.7.
If defined, start command is sent to the modem when a modem process starts.
After a command is sent, startsleeptime is spent.
When a modem process is stopping, stop command is sent to the modem.
status_include_counters = yes/no
Default value: yes.
status_signal_quality = yes/no
Default value: yes.
Available from version >= 3.1.5.
These settings define if message counters and explained signal quality is included in the line of status file.
Modem setting overrides global setting.
telnet_login = string
Default value: empty.
Available from version >= 3.1.12.
If a network modem requires telnet login, it can be defined with this setting.
telnet_login_prompt = string
Default value: login:.
Available from version >= 3.1.12.
If telnet_login is used, this setting can be used to change the login prompt.
telnet_login_prompt_ignore = string
Default value: Last login:.
Available from version >= 3.1.12.
If telnet_login is used and after successful login motd contains a string which is the same as telnet_login_prompt,
this setting can be used to define which kind of a string is ignored.
For example, telnet_login_prompt can be login: and telnet_login_prompt_ignore could be Last login:.
telnet_password = string
Default value: empty.
Available from version >= 3.1.12.
If telnet_login is used and device requires password, it can be defined with this setting.
telnet_password_prompt = string
Default value: Password:.
Available from version >= 3.1.12.
If telnet_password is used, this setting can be defined to change the prompt for password.
trust_spool = yes/no
Default value: yes.
Available from version >= 3.1.9.
When a modem process is searching for a file from the spooler, it assumes that the file is complete when it exists and it's not locked.
This will speed up sending, because one second delay is avoided.
If some other process or checkhandler is creating files directly to the spooler, it may be necessary to set this to no.
unexpected_input_is_trouble = yes/no
Default value: yes.
Available from version >= 3.1.5.
With smart_logging, this setting defines if unexpected input activates trouble log.
using_routed_status_report = yes/no
Default value: no.
Available from version >= 3.1.7.
Smsd can detect routed status reports, but usually it's not recommended to use them.
Modems should store status reports as an ordinary messages, which can be read when smsd will need them.
However, some modem cannot store status reports, and therefore routing is the only way to get them.
With this setting smsd will change some severity and text of a logging.
ussd_convert = number
Default value: 0.
Available from version >= 3.1.7.
Defines if a text part from incoming USSD message is decoded.
Possible values are:
| 1 | Unicode format is converted to UTF-8. This requires that USE_ICONV is defined. |
| 2 | GSM 7bit packed format is converted to ISO or UTF-8. |
| 4 | Hexadecimal dump is converted to ASCII. (Available from version >= 3.1.11.) |
Decoded text is appended to the original answer with two slashes and one space character.
verify_pdu = yes/no
Default value: no.
Available from version >= 3.1.14.
This setting is for testing purposes.
When trying to send SMS and modem does not accept the PDU, there may be a communication problem which breaks the sent PDU.
With this setting smsd changes "echo on", and verifies the string which is echoed back after the PDU was sent.
In case of mismatch "Verify PDU: ERROR" is printed to the log and also both sent and received strings are logged.
In case of success "Verify PDU: OK" is printed to the log.
After the verification is done, "echo" is changed back to "off".
voicecall_clcc = yes/no
Default value: no.
Available from version >= 3.1.12.
Defines if AT+CLCC is used to detect when a call is answered.
This is required if modem returns OK immediately after the call and voicecall_cpas cannot be used.
voicecall_cpas = yes/no
Default value: no.
Available from version >= 3.1.7.
Defines if AT+CPAS is used to detect when a call is answered.
This is required if modem returns OK immediately after the call.
voicecall_hangup_ath = yes/no
Default value: no.
Available from version >= 3.1.5.
Defines if ATH is used to hangup call instead of AT+CHUP.
This setting overrides the setting in the global part.
voicecall_ignore_modem_response = yes/no
Default value: no.
Available from version >= 3.1.5.
When a voicecall is ringing, some devices give OK answer after couple of seconds even if a call is not yet answered.
With this kind of device DTMF tones cannot be sent.
If a ringing time is defined in the message file (using TIME: n), the waiting loop is breaked too soon.
To avoid this, use voicecall_ignore_modem_response = yes in the modem settings.
With this setting call rings n seconds (if not answered) and after this voicecall is over.
voicecall_vts_list = yes/no
Default value: no.
Available from version >= 3.1.3.
Defines how VTS command is used to create DTMF tones:
yes = AT+VTS=1,2,3,4,5 (list is used), no = each tone is created with single command like AT+VTS="1";+VTS="2" etc.
voicecall_vts_quotation_marks = yes/no
Default value: no.
Available from version >= 3.1.7.
Defines if quotation marks are used when sending VTS command to the modem.
NOTE: previously quotation marks were used, now this setting default to no.