1GAMMURC(5)                           Gammu                          GAMMURC(5)
2
3
4

NAME

6       gammurc - gammu(1) configuration file
7

SYNOPSIS

9       On  Linux, MacOS X, BSD and other Unix-like systems, the config file is
10       searched in following order:
11
12       1. $XDG_CONFIG_HOME/gammu/config
13
14       2. ~/.config/gammu/config
15
16       3. ~/.gammurc
17
18       4. /etc/gammurc
19
20       On Microsoft Windows:
21
22       1. %PROFILE%\Application Data\gammurc
23
24       2. .\gammurc
25

DESCRIPTION

27       Gammu requires configuration to be able to properly talk to your phone.
28       gammu  reads  configuration from a config file. It's location is deter‐
29       mined on runtime, see above for search paths.
30
31       You can use gammu-config or gammu-detect to generate configuration file
32       or start from Fully documented example.
33
34       For hints about configuring your phone, you can check Gammu Phone Data‐
35       base <https://wammu.eu/phones/> to see what user users experienced.
36
37       This file use ini file syntax, see ini.
38
39       Configuration file for gammu can contain several  sections  -  [gammu],
40       [gammu1],  [gammuN],  ...  Each section configures one connection setup
41       and in default mode gammu tries all of them in numerical order. You can
42       also  specify  which configuration section to use by giving it's number
43       ([gammu] has number 0) as a parameter to gammu and  it  will  then  use
44       only this section.
45
46       [gammu]
47
48       This  section  is  read  by default unless you specify other on command
49       line.
50
51   Device connection parameters
52       Connection
53              Protocol which will be used to talk to your phone.
54
55              For Nokia cables you want to use one of following:
56
57              fbus   serial FBUS connection
58
59              dlr3   DLR-3 and compatible cables
60
61              dku2   DKU-2 and compatible cables
62
63              dku5   DKU-5 and compatible cables
64
65              mbus   serial MBUS connection
66
67              If you use some non original cable, you  might  need  to  append
68              -nodtr  (eg.  for  ARK3116  based cables) or -nopower, but Gammu
69              should be able to detect this automatically.
70
71              For non-Nokia phones connected using cable you generally want:
72
73              at     generic AT commands based connection
74
75              You can optionally specify speed of the connection, eg. at19200,
76              but it is not needed for modern USB cables.
77
78              For IrDA connections use one of following:
79
80              irdaphonet
81                     Phonet connection for Nokia phones.
82
83              irdaat AT  commands  connection  for most of phones (this is not
84                     supported on Linux).
85
86              irdaobex
87                     OBEX (IrMC or  file  transfer)  connection  for  most  of
88                     phones.
89
90              irdagnapbus
91                     GNapplet  based  connection for Symbian phones, see gnap‐
92                     plet.
93
94              For Bluetooth connection use one of following:
95
96              bluephonet
97                     Phonet connection for Nokia phones.
98
99              bluefbus
100                     FBUS connection for Nokia phones.
101
102              blueat AT commands connection for most of phones.
103
104              blueobex
105                     OBEX (IrMC or  file  transfer)  connection  for  most  of
106                     phones.
107
108              bluerfgnapbus
109                     GNapplet  based  connection for Symbian phones, see gnap‐
110                     plet.
111
112              blues60
113                     Connection to Series60 applet in S60 phones, see s60.
114
115                     New in version 1.29.90.
116
117
118              New in version 1.36.7: Gammu now supports connecting using proxy
119              command.
120
121
122              You can also proxy the connection using shell command, for exam‐
123              ple to different host. This can be done using proxy connections:
124
125              proxyphonet
126                     Phonet connection for Nokia phones.
127
128              proxyfbus
129                     FBUS connection for Nokia phones.
130
131              proxyat
132                     AT commands connection for most of phones.
133
134              proxyobex
135                     OBEX (IrMC or  file  transfer)  connection  for  most  of
136                     phones.
137
138              proxygnapbus
139                     GNapplet  based  connection for Symbian phones, see gnap‐
140                     plet.
141
142              proxys60
143                     Connection to Series60 applet in S60 phones, see s60.
144
145              SEE ALSO:
146                 faq-config
147
148       Device New in version 1.27.95.
149
150
151              Device node or address of phone. It depends on used connection.
152
153              For cables or emulated serial ports, you enter device name  (for
154              example  /dev/ttyS0, /dev/ttyACM0, /dev/ircomm0, /dev/rfcomm0 on
155              Linux, /dev/cuad0 on FreeBSD or COM1: on Windows).  The  special
156              exception  are  DKU-2  and  DKU-5  cables  on Windows, where the
157              device is automatically detected  from  driver  information  and
158              this parameters is ignored.
159
160              NOTE:
161                 Some  USB  modems  expose  several  interfaces, in such cases
162                 Gammu works best with "User" one, you can find more  informa‐
163                 tion                           on                          <‐
164                 http://www.dd-wrt.com/wiki/index.php/Mobile_Broadband>.
165
166              For USB connections (currently only fbususb and dku2 on  Linux),
167              you  can  specify  to which USB device Gammu should connect. You
168              can either provide vendor/product IDs or device address on USB:
169
170                 Device = 0x1234:0x5678  # Match device by vendor and product id
171                 Device = 0x1234:-1      # Match device by vendor id
172                 Device = 1.10           # Match device by usb bus and device address
173                 Device = 10             # Match device by usb device address
174                 Device = serial:123456  # Match device by serial string
175
176              NOTE:
177                 On Linux systems, you might lack permissions for some  device
178                 nodes.   You  might  need  to  be  member  of some group (eg.
179                 plugdev or dialout) or or add special udev  rules  to  enable
180                 you access these devices as non-root.
181
182                 For  Nokia  phones you can put following file (also available
183                 in    sources    as    contrib/udev/69-gammu-acl.rules)    as
184                 /etc/udev/rules.d/69-gammu-acl.rules:
185
186                     #
187                     # udev rule to give users access to USB device to be used by Gammu
188                     #
189
190                     ACTION!="add|change", GOTO="gammu_acl_rules_end"
191
192                     KERNEL!="ttyACM[0-9]*", GOTO="gammu_acl_rules_end"
193                     SUBSYSTEM!="tty", GOTO="gammu_acl_rules_end"
194
195                     # Nokia devices
196                     ATTRS{manufacturer}=="Nokia", TAG+="uaccess"
197
198                     # Example for Sony Ericsson J108i Cedar
199                     # ATTRS{idVendor}=="0fce", ATTRS{idProduct}=="d14e", TAG+="uaccess"
200
201                     LABEL="gammu_acl_rules_end"
202
203
204              In case your USB device appears as the serial port in the system
205              (eg.  /dev/ttyACM0 on Linux or COM5: on Windows), just use  same
206              setup as with serial port.
207
208              For  Bluetooth connection you have to enter Bluetooth address of
209              your phone (you can list Bluetooth devices  in  range  on  Linux
210              using hcitool scan command). Optionally you can also force Gammu
211              to use specified  channel  by  including  channel  number  after
212              slash.
213
214              Before  using  Gammu, your device should be paired with computer
215              or you should have set up automatic pairing.
216
217              For Proxy connections, you need to specify command which  should
218              be  executed. It is supposed to pass bidirectional communication
219              from Gammu to the device. This can happen for example over  net‐
220              work.
221
222              For IrDA connections, this parameters is not used at all.
223
224              If  IrDA  does not work on Linux, you might need to bring up the
225              interface and enable discovery (you need to run  these  commands
226              as root):
227
228                 ip l s dev irda0 up          # Enables irda0 device
229                 sysctl net.irda.discovery=1  # Enables device discovery on IrDA
230
231              NOTE:
232                 Native IrDA is not supported on Linux, you need to setup vir‐
233                 tual serial port for it (eg. /dev/ircomm0) and  use  it  same
234                 way  as  cable.  This can be usually achieved by loading mod‐
235                 ules ircomm-tty and irtty-sir:
236
237                     modprobe ircomm-tty
238                     modprobe irtty-sir
239
240              SEE ALSO:
241                 faq-config
242
243       Port   Deprecated since version 1.27.95: Please use Device instead.
244
245
246              Alias for Device, kept for backward compatibility.
247
248       Model  Do not use this parameter unless really  needed!  The  only  use
249              case  for this is when Gammu does not know your phone and misde‐
250              tects it's features.
251
252              The only special case for using model is to force  special  type
253              of  OBEX connection instead of letting Gammu try the best suited
254              for selected operation:
255
256              obexfs force using of file browsing service  (file  system  sup‐
257                     port)
258
259              obexirmc
260                     force using of IrMC service (contacts, calendar and notes
261                     support)
262
263              obexnone
264                     none service chosen, this has only limited use for  send‐
265                     ing file (gammu sendfile command)
266
267              mobex  m-obex service for Samsung phones
268
269       Use_Locking
270              On  Posix  systems, you might want to lock serial device when it
271              is being used using UUCP-style lock files. Enabling this  option
272              (setting to yes) will make Gammu honor these locks and create it
273              on startup. On most distributions you need additional privileges
274              to use locking (eg. you need to be member of uucp group).
275
276              This option has no meaning on Windows.
277
278   Connection options
279       SynchronizeTime
280              If  you  want to set time from computer to phone during starting
281              connection.
282
283       StartInfo
284              This option allows one to set, that you want  (setting  yes)  to
285              see message on the phone screen or phone should enable light for
286              a moment during starting connection. Phone will not beep  during
287              starting  connection with this option. This works only with some
288              Nokia phones.
289
290   Debugging options
291       LogFile
292              Path to file  where  information  about  communication  will  be
293              stored.
294
295              NOTE:
296                 For  most  debug  levels  (excluding  errors) the log file is
297                 overwritten on each execution.
298
299       LogFormat
300              Determines what all will be logged to LogFile.  Possible  values
301              are:
302
303              nothing
304                     no debug level
305
306              text   transmission dump in text format
307
308              textall
309                     all possible info in text format
310
311              textalldate
312                     all possible info in text format, with time stamp
313
314              errors errors in text format
315
316              errorsdate
317                     errors in text format, with time stamp
318
319              binary transmission dump in binary format
320
321              For debugging use either textalldate or textall, it contains all
322              needed information to diagnose problems.
323
324       Features
325              Custom features for phone. This can be  used  as  override  when
326              values  coded  in common/gsmphones.c are bad or missing. Consult
327              include/gammu-info.h for possible values (all GSM_Feature values
328              without  leading  F_  prefix).  Please  report correct values to
329              Gammu authors.
330
331   Locales and character set options
332       GammuCoding
333              Forces using specified codepage (for  example  1250  will  force
334              CP-1250  or  utf8  for  UTF-8). This should not be needed, Gammu
335              detects it according to your locales.
336
337       GammuLoc
338              Path to directory with localisation files (the directory  should
339              contain   LANG/LC_MESSAGES/gammu.mo).   If   gammu  is  properly
340              installed it should find these files automatically.
341
342   Advanced options
343       Advanced options are used to alter  default  logic,  when  using  these
344       options  the  user is responsible for ensuring any settings are correct
345       for the target device and that they produce the desired behaviour.
346
347       atgen_setCNMI
348              For configurations using the generic AT command protocol  it  is
349              possible  to override the default indicators used when a new SMS
350              message is received.
351
352              The value for the setting is a comma delimited  list  of  single
353              digits  corresponding  to  the values for the AT+CNMI modem com‐
354              mand. If a digit is not provided, or if the  provided  digit  is
355              outside of the acceptable range for the device the default value
356              is used.
357
358              For example setting atgen_setcnmi =  ,,2  would  set  the  third
359              parameter  of  the CNMI command to the value 2, leaving the rest
360              of the parameters at default, and atgen_setcnmi  =  1,,,1  would
361              set the first and fourth parameters respectively.
362
363   Other options
364       DataPath
365              Additional path where to search for data files. The default path
366              is   configured    on    build    time    (and    defaults    to
367              /usr/share/data/gammu  on  Unix  systems).  Currently it is used
368              only for searching files to upload to phone using gammu install.
369

EXAMPLES

371       There is more complete example available in  Gammu  documentation,  see
372       gammu.
373
374   Connection examples
375       Gammu configuration for Nokia phone using DLR-3 cable:
376
377          [gammu]
378          device = /dev/ttyACM0
379          connection = dlr3
380
381       Gammu configuration for Sony-Ericsson phone (or any other AT compatible
382       phone) connected using USB cable:
383
384          [gammu]
385          device = /dev/ttyACM0
386          connection = at
387
388       Gammu configuration for  Sony-Ericsson  (or  any  other  AT  compatible
389       phone) connected using bluetooth:
390
391          [gammu]
392          device = B0:0B:00:00:FA:CE
393          connection = blueat
394
395       Gammu  configuration for phone which needs to manually adjust Bluetooth
396       channel to use channel 42:
397
398          [gammu]
399          device = B0:0B:00:00:FA:CE/42
400          connection = blueat
401
402   Working with multiple phones
403       Gammu can be configured for multiple phones (however only  one  connec‐
404       tion is used at one time, you can choose which one to use with gammu -s
405       parameter). Configuration for phones on three serial ports  would  look
406       like following:
407
408          [gammu]
409          device = /dev/ttyS0
410          connection = at
411
412          [gammmu1]
413          device = /dev/ttyS1
414          connection = at
415
416          [gammmu2]
417          device = /dev/ttyS2
418          connection = at
419
420   Connecting to remote phone
421       New in version 1.36.7.
422
423
424       You  can  connect  using Gammu to phone running on different host. This
425       can be achieved using proxy connection, which executes command to  for‐
426       ward bi-directional communication with the phone.
427
428          [gammu]
429          device = ssh root@my.router /usr/local/bin/myscript /dev/ttyUSB0
430          connection = proxyat
431
432       You can find sample script which can be used on the remote side in con‐
433       trib/proxy/gammu-backend.
434
435   Fully documented example
436       You can find this sample file as docs/config/gammurc in Gammu sources.
437
438          ; This is a sample ~/.gammurc file.
439          ; In Unix/Linux  copy it into your home directory and name it .gammurc
440          ;                or into /etc and name it gammurc
441          ; In Win32       copy it into directory with Gammu.exe and name gammurc
442          ; More about parameters later
443          ; Anything behind ; or # is comment.
444          ; -----------------------------------------------------------------------------
445
446          [gammu]
447
448          device = com8:
449          connection = irdaphonet
450          ; Do not use model configuration unless you really need it
451          ;model = 6110
452          ;synchronizetime = yes
453          ;logfile = gammulog
454          ;logformat = textall
455          ;use_locking = yes
456          ;gammuloc = locfile
457          ;startinfo = yes
458          ;gammucoding = utf8
459          ;usephonedb = yes
460
461          [gammu1]
462
463          device = com8:
464          ;model = 6110
465          connection = fbusblue
466          ;synchronizetime = yes
467          ;logfile = gammulog
468          ;logformat = textall
469          ;use_locking = yes
470          ;gammuloc = locfile
471          ;startinfo = yes
472          ;gammucoding = utf8
473
474          ; Step 1. Please find required Connection parameter and look into assigned
475          ; with it device type. With some Connection you must set concrete model
476
477          ; ================================================================ cables =====
478          ; New Nokia protocol for FBUS/DAU9P
479          ;    Connection "fbus", device type serial
480          ; New Nokia protocol for DLR3/DLR3P
481          ;    Connection "fbusdlr3"/"dlr3", device type serial
482          ; New Nokia protocol for DKU2 (and phone with USB converter on phone mainboard
483          ;                              like 6230)
484          ;    Connection "dku2phonet"/"dku2", device type dku2 on Windows
485          ;    Connection "fbususb" on Linux
486          ; New Nokia protocol for DKU5 (and phone without USB converter on phone
487          ;                              mainboard like 5100)
488          ;    Connection "dku5fbus"/"dku5", device type dku5
489          ; New Nokia protocol for PL2303 USB cable (and phone without USB converter
490          ;                                          on phone mainboard like 5100)
491          ;    Connection "fbuspl2303", device type usb
492          ; Old Nokia protocol for MBUS/DAU9P
493          ;    Connection "mbus", device type serial
494          ; Variants:
495          ; You can modify a bit behaviour of connection using additional flags
496          ; specified just after connection name like connection-variant.
497          ; If you're using ARK3116 cable (or any other which does not like dtr
498          ; handling), you might need -nodtr variant of connection, eg. dlr3-nodtr.
499          ; If cable you use is not powered over DTR/RTS, try using -nopower variant of
500          ; connection, eg. fbus-nopower.
501          ; -----------------------------------------------------------------------------
502          ; AT commands for DLR3, DKU5 or other AT compatible cable (8 bits, None
503          ; parity, no flow control, 1 stop bit). Used with Nokia, Alcatel, Siemens, etc.
504          ;    Connection "at19200"/"at115200"/.., device type serial
505          ; AT commands for DKU2 cable
506          ;    Connection "dku2at", device type dku2
507          ; ============================================================== infrared =====
508          ; Nokia protocol for infrared with Nokia 6110/6130/6150
509          ;    Connection "fbusirda"/"infrared", device type serial
510          ; Nokia protocol for infrared with other Nokia models
511          ;    Connection "irdaphonet"/"irda", device type irda
512          ; -----------------------------------------------------------------------------
513          ; AT commands for infrared. Used with Nokia, Alcatel, Siemens, etc.
514          ;    Connection "irdaat", device type irda
515          ; -----------------------------------------------------------------------------
516          ; OBEX for infrared
517          ;    Connection "irdaobex", device type irda.
518          ; ============================================================= Bluetooth =====
519          ; Nokia protocol with serial device set in BT stack (WidComm, other) from
520          ; adequate service and Nokia 6210
521          ;    Connection "fbusblue", device type serial
522          ; Nokia protocol with serial device set in BT stack (WidComm, other) from
523          ; adequate service and other Nokia models
524          ;    Connection "phonetblue", device type serial
525          ; -----------------------------------------------------------------------------
526          ; Nokia protocol for Bluetooth stack with Nokia 6210
527          ;    Connection "bluerffbus", device type BT
528          ; Nokia protocol for Bluetooth stack with DCT4 Nokia models, which don't inform
529          ; about services correctly (6310, 6310i with firmware lower than 5.50, 8910,..)
530          ;    Connection "bluerfphonet", device type BT
531          ; Nokia protocol for Bluetooth stack with other DCT4 Nokia models
532          ;    Connection "bluephonet", device type BT
533          ; -----------------------------------------------------------------------------
534          ; AT commands for Bluetooth stack and 6210 / DCT4 Nokia models, which don't
535          ; inform about BT services correctly (6310, 6310i with firmware lower
536          ; than 5.50, 8910,..)
537          ;    Connection "bluerfat", device type BT
538          ; AT commands for Bluetooth stack with other phones (Siemens, other Nokia,etc.)
539          ;    Connection "blueat", device type BT
540          ; -----------------------------------------------------------------------------
541          ; OBEX for Bluetooth stack with DCT4 Nokia models, which don't inform about
542          ; BT services correctly (6310, 6310i with firmware lower than 5.50, 8910,...)
543          ;    Connection "bluerfobex", device type BT
544          ; OBEX for Bluetooth stack with other phones (Siemens, other Nokia, etc.)
545          ;    Connection "blueobex", device type BT.
546          ; -----------------------------------------------------------------------------
547          ;    Connection "bluerfgnapbus", device type BT, model "gnap"
548          ;    Connection "irdagnapbus", device type irda, model "gnap"
549
550          ; Step2. According to device type from Step1 and used OS set Port parameter
551
552          ; -----------------------------------------------------------------------------
553          ; Port type | "Port" parameter in Windows/DOS | "Port" parameter in Linux/Unix
554          ; ----------|---------------------------------|--------------------------------
555          ; serial    | "com*:"                         | "/dev/ttyS*"
556          ;           | (example "com1:")               | (example "/dev/ttyS1")
557          ;           |                                 | or "/dev/tts/**" (with DevFS)
558          ;           |                                 | virtual serial ports like
559          ;           |                                 | "/dev/ircomm*" or "/dev/rfcomm*"
560          ; ----------|---------------------------------|--------------------------------
561          ; irda      | ignored (can be empty)          | ignored (can be empty)
562          ; ----------|---------------------------------|--------------------------------
563          ; BT        | Bluetooth device address (example "00:11:22:33:44:55").
564          ;           | Optionally you can also include channel after slash
565          ;           | (example "00:11:22:33:44:55/12"). Can be also empty.
566          ; ----------|---------------------------------|--------------------------------
567          ; dku2      | ignored (can be empty)          | /dev/ttyUSB* or /dev/ttyACM*
568          ; ----------|---------------------------------|--------------------------------
569          ; dku5      | ignored (can be empty)          | connection with it not possible
570          ; ----------|---------------------------------|--------------------------------
571          ; usb       | connection with it not possible | "/dev/ttyUSB*"
572
573          ; Step3. Set other config parameters
574
575          ; -----------------------------------------------------------------------------
576          ; Parameter name  | Description
577          ; ----------------|------------------------------------------------------------
578          ; Model           | Should not be used unless you have a good reason to do so.
579          ;                 | If Gammu doesn't recognize your phone model, put it here.
580          ;                 | Example values: "6110", "6150", "6210", "8210"
581          ; SynchronizeTime | if you want to set time from computer to phone during
582          ;                 | starting connection. Do not rather use this option when
583          ;                 | when to reset phone during connection (in some phones need
584          ;                 | to set time again after restart)
585          ; GammuLoc        | name of localisation file
586          ; StartInfo       | this option allows one to set, that you want (setting "yes")
587          ;                 | to see message on the phone screen or phone should enable
588          ;                 | light for a moment during starting connection. Phone
589          ;                 | WON'T beep during starting connection with this option.
590          ; GammuCoding     | forces using specified codepage (in win32 - for example
591          ;                 | "1250" will force CP1250) or UTF8 (in Linux - "utf8")
592          ; ----------------|------------------------------------------------------------
593          ; Logfile         | Use, when want to have logfile from communication.
594          ; Logformat       | What debug info and format should be used:
595          ;                 |   "nothing" - no debug level (default)
596          ;                 |   "text"    - transmission dump in text format
597          ;                 |   "textall" - all possible info in text format
598          ;                 |   "errors"  - errors in text format
599          ;                 |   "binary"  - transmission dump in binary format
600          ; ----------------|------------------------------------------------------------
601          ; Features        | Custom features for phone. This can be used as override
602          ;                 | when values coded in common/gsmphones.c are bad or
603          ;                 | missing. Consult include/gammu-info.h for possible values
604          ;                 | (all Feature values without leading F_ prefix).
605          ;                 | Please report correct values to Gammu authors.
606          ; ----------------|------------------------------------------------------------
607          ; Use_Locking     | under Unix/Linux use "yes", if want to lock used device
608          ;                 | to prevent using it by other applications. In win32 ignored
609
610          ; vim: et ts=4 sw=4 sts=4 tw=78 spell spelllang=en_us
611
612

AUTHOR

614       Michal Čihař <michal@cihar.com>
615
617       2009-2015, Michal Čihař <michal@cihar.com>
618
619
620
621
6221.42.0                           Oct 03, 2020                       GAMMURC(5)
Impressum