1gnokii(1) gnokii gnokii(1)
2
6 gnokii - tool suite for mobile phones
7
9 gnokii [CONFIG OPTIONS] [OPTIONS]
10
12 gnokii is a multiple systems tool suite and driver for mobile phones.
13 gnokii supports the AT protocol defined by the GSM standard (with work‐
15 arounds for some vendor's quirks), some proprietary protocols of Nokia
16 phones (the so called FBUS and FBUS2) and SIM cards in PC/SC compatible
17 Smart Card readers. Limited support for the older and slow Nokia MBUS
18 protocol is also available.
19 You can assume that your phone will work with gnokii when using the AT
21 protocol, however some phones implement only a subset of the protocol
22 and in those cases you will get very limited functionality. The recom‐
23 mended model setting for your config file are:
24 - model = series40, if you have a fairly recent Nokia phone except
25 Symbian phones prior to Series60 3rd Edition
26 - model = gnapplet, if you have a Nokia Symbian Series60 prior to 3rd
27 Edition phone
28 - model = AT, for all other phones of any brand
29 - if you have some older Nokia phone that doesn't work with model =
30 series40 you may try using its brand name, eg. for Nokia 6210 use model
31 = 6210.
32 The recommended connection and port settings for your config file are:
34 - connection = bluetooth and port = phone address, for Bluetooth con‐
35 nections
36 - connection = dku2libusb and port = 1, for most Nokia USB cables
37 - connection = serial and port = /dev/..., for all other cables
38 See also the sample gnokiirc for a description of all configuration
40 parameters and our <http://wiki.gnokii.org/index.php/Config> for con‐
41 figurations known to work.
42 Symbian series60 3rd edition and later (most Nokia N and E series) are
44 not supported by the gnapplet driver due to changes in Symbian API. For
45 now you can get some functionality using the AT driver (with all con‐
46 nection types supported by the phone) or using the series40 driver
47 (only with connection = dku2libusb).
48 Please note that currently there are Nokia models with almost the same
50 names as the old ones, like 6110c vs 6110 or 3110c vs 3110. They are
51 completly incompatible. DO NOT use model = 6110 or model = 3110 setting
52 for them, use model = series40 instead.
53
56 --config filename
57 reads configuration from filename instead of trying default
58 locations. Normally gnokii looks for config file in $XDG_CON‐
59 FIG_HOME/gnokii/config (which is usually $HOME/.con‐
60 fig/gnokii/config), $HOME/.gnokiirc (legacy), $XDG_CON‐
61 FIG_DIRS/gnokii/config (which is usually /etc/xdg/gnokii/config)
62 and /etc/gnokiirc (legacy).
63 --phone name
65 usees parameters from the given phone section of your config
66 file. A phone section named 'foo' starts with [phone_foo] and is
67 used as --phone foo
68
71 The options that are recognized by gnokii can be divided into several
72 different groups.
73 GENERAL
76 --help displays usage information.
77 --version
79 displays version and copyright information.
80 --monitor [delay|once]
82 continually updates phone status to stderr. Optional delay
83 parameter sets the refresh interval to delay seconds. Default is
84 1. once means the output will be printed only once.
85 --shell
87 runs interactive session that will allow to run sequent gnokii
88 commands without a need to reconnect for the sequent commands.
89 DIALING
92 --getspeeddial location
93 reads speed dial from the specified location.
94 --setspeeddial number memory_type location
96 specify speed dial. location number 1 is usually reserved for
97 voice mailbox number and it is unavailable as speed dial.
98 --dialvoice number
100 initiate voice call. On success print the callid identifier to
101 be used with the --hangup command. The --monitor command can be
102 used to show the callid.
103 With model = AT direct dialing from phonebooks is supported with
105 careful use of shell quoting, for example:
106 gnokii --dialvoice ">SM42" # dial the number in location 42
107 of SM memory
108 gnokii --dialvoice '>"Home"' # dial the number if string
109 matches exactly a contact name (note the use of single and dou‐
110 ble quotes)
111 --senddtmf string
113 send DTMF sequence.
114 --answercall callid
116 answer an incoming call. callid is a small integer number used
117 to identify one of the incoming calls. The --monitor command
118 can be used to show the callid.
119 --hangup callid
121 hangup an incoming call or an already established call. callid
122 is a small integer number used to identify one of the incoming
123 calls. If you initiated the call with --dialvoice this is the
124 number printed by that command. The --monitor command can be
125 used to show the callid.
126 --divert {--op|-o} {register|enable|query|disable|erasure} {--type|-t}
128 {all|busy|noans|outofreach|notavail} {--call|-c} {all|voice|fax|data}
129 [{--timeout|-m} time_in_seconds] [{--number|-n} number]
130 Manage call diverting/forwarding.
131 --op specifies one of the operations: register enable query dis‐
133 able erasure
134 --type specifies one of the event types: busy noans outofreach
136 notavail unconditional all
137 --call specifies one of the call types: voice fax data all
139 --timeout is the number of seconds an incoming call will ring
141 before being forwarded to the registered number (use with --type
142 noans)
143 --number is the phone number to which calls are to be forwarded
145 PHONE SETTINGS
148 --getdisplaystatus
149 shows what icons are displayed.
150 --displayoutput
152 show texts displayed in phone's screen.
153 --getprofile [number]
155 show settings for selected(all) profile(s).
156 --setprofile
158 sets settings for selected(all) profile(s).
159 --getactiveprofile
161 reads the active profile.
162 --setactiveprofile profile_no
164 sets active profile to the profile number profile_no.
165 --netmonitor {reset|off|field|devel|next|nr}
167 setting/querying netmonitor mode.
168 --reset [soft|hard]
170 resets the phone. By default a soft reset is performed. Depend‐
171 ing on phone, the hard option also deletes everything in the
172 internal memory and restores the factory settings.
173 TODO
176 --gettodo start_number [end_number|end] [-v|--vCal]
177 get the notes with numbers from start_number to end_number from
178 ToDo list. end is a keyword that denotes 'everything till the
179 end'.
180 -v | --vCal - output in vCalendar 1.0 format
182 --writetodo vcalfile start_number [end_number|end]
184 write the notes with numbers from start_number to end_number
185 from vCalendar file vcalfile to ToDo list. More than one note a
186 time can be saved. end is a keyword that denotes 'everything
187 till the end'.
188 number - location of the note in the vCalendar file
190 --deletealltodos
192 delete all notes from the ToDo list.
193 CALENDAR
196 --getcalendarnote start_number [end_number|end] [-v|--vCal]
197 get the notes with numbers from start_number to end_number from
198 calendar. end is a keyword that denotes 'everything till the
199 end'.
200 -v | --vCal - output in vCalendar 1.0 format
202 --writecalendarnote vcalfile start_number [end_number|end]
204 write the notes with numbers from start_number to end_number
205 from vCalendar file vcalfile to a phone calendar. More than one
206 note a time can be saved. end is a keyword that denotes 'every‐
207 thing till the end'.
208 number - location of the note in the vCalendar file
210 --deletecalendarnote start_number [end_number|end]
212 delete the notes with numbers from start_number to end_number
213 from calendar. end is a keyword that denotes 'everything till
214 the end'.
215 SMS
218 --getsms memory_type start [end] [-f|--file file] [-F|--force-file
219 file] [-a|--append-file file] [-d|--delete]
220 gets SMS messages from specified memory type starting at entry
221 start and ending at end and print them to stdout by default.
222 end can be a number or the string 'end'. If end is not speci‐
223 fied only one location - start is read.
224 For the memory types you usually use IN (Inbox) and OU (Outbox)
226 for Nokias and SM (SIM card) and ME (phone memory) for other
227 brands, except for modern Motorolas that prefer MT (combined SIM
228 and phone memory); in any case the --showsmsfolderstatus command
229 shows the list of memory types available in your phone with
230 their descriptions and message counts (each part of multipart
231 messages is counted separately).
232 -f | --file file - save messages to file in mbox format. If file
234 already exists, user is prompted whether to overwrite it
235 -F | --force-file file - save messages to file in mbox format.
237 If file already exists, it is overwritten without asking
238 -a | --append-file file - save messages to file in mbox format.
240 If file already exists, messages are added to the end
241 -d | --delete - delete message after reading.
243 --deletesms memory_type start [end]
245 deletes SMS messages from specified memory type starting at
246 entry start and ending at end. If end is not specified only one
247 location - start is deleted.
248 --sendsms destination [--smsc message_center_number | --smscno mes‐
250 sage_center_index] [-r|--report] [-8|--8bit] [-C|--class n]
251 [-v|--validity n] [-i|--imelody] [-a|--animation file;file;file;file]
252 [-o|--concat this;total;serial] [-w|--wappush url]
253 sends an SMS message to destination via message_center_number or
254 SMSC number taken from phone memory from address message_cen‐
255 ter_index. If this argument is omitted SMSC number is taken
256 from phone memory from location 1. Message text is taken from
257 STDIN. Meaning of other optional parameters:
258 -r | --report - request for delivery report
260 -8 | --8bit - set 8bit coding
262 -C | --class n - Class Message n, where n can be 0..3
264 -v | --validity n - validity in minutes
266 -i | --imelody - send iMelody within SMS
268 -a | --animation file;file;file;file - send animation message
270 -o | --concat this;total;serial - send this part of all total
272 parts identified by serial
273 -w | --wappush url - send wappush to the given url
275 Sample usage:
277 echo "This is a test message" | gnokii --sendsms +48501123456 -r
278 --savesms [--sender from] [--smsc message_center_number | --smscno mes‐
281 sage_center_index] [--folder folder_id] [--location number] [--sent |
282 --read] [--deliver] [--datetime YYMMDDHHMMSS]
283 saves SMS messages to phone. Messages are read from STDIN. You
284 can specify the following optional arguments:
285 --sender - set the sender number (only --deliver)
287 --smsc message_center_number - set the SMSC number (only
289 --deliver)
290 --smscno message_center_index - SMSC number taken from phone
292 memory from address message_center_index (only --deliver)
293 --folder folder_id - folder ID where to save the SMS to (only
295 valid for newer phones, i.e. 6210/6510 series). For legal values
296 see --getsms.
297 --location number - save the message to location number
299 --sent | --read - mark the message saved/read depending on
301 --deliver
302 --deliver - set the message type to SMS_Deliver
304 --datetime YYMMDDHHMMSS - sets datetime of delivery, i.e.
306 031123185713 would set message delivery time to 23rd November
307 2003, 6:57:13 PM
308 --getsmsc [start_number [end_number]] [-r|--raw]
311 show the SMSC parameters from specified location(s) or for all
312 locations.
313 -r | --raw - output in a format suitable for --setsmsc
315 --setsmsc
318 set SMSC parameters read from STDIN. See --raw output of
319 --getsmsc for syntax.
320 --createsmsfolder name
323 create SMS folder with name name.
324 --deletesmsfolder number
327 delete folder # number of 'My Folders'.
328 --showsmsfolderstatus
331 list SMS folder names with memory types and total number of mes‐
332 sages available.
333 --smsreader
336 keeps reading incoming SMS and saves them into the mailbox.
337 MMS
340 --getmms memory_type start [end] [{--pdu|--raw} file] [-o|--overwrite]
341 gets MMS messages from specified memory type starting at entry
342 start and ending at end. Default output format is human read‐
343 able, alternative output formats are --pdu which is the binary
344 format of MMS as received by the phone from the network and
345 --raw which saves the data as read from the phone.
346 When the -o or --overwrite option is used, existing files are
348 overwritten without asking.
349 --deletemms memory_type start [end]
352 deletes MMS messages from specified memory type starting at
353 entry start and ending at end. If end is not specified only one
354 location - start is deleted.
355 LOGOS
358 --sendlogo {caller|op|picture} destination logofile [network_code]
359 send the logofile to destination as operator or CLI logo.
360 --setlogo op [logofile [network_code]]
362 --setlogo startup [logofile]
364 --setlogo caller [logofile [caller_group_number [group_name]]]
366 set or clear operator, startup or caller logo.
367 --setlogo {dealer|text} [text]
369 set or clear welcome note.
370 --getlogo op [logofile [network_code]]
372 --getlogo startup [logofile [network_code]]
374 --getlogo caller [caller_group_number [logofile [network_code]]]
376 get operator, startup or caller logo.
377 --getlogo {dealer|text}
379 get welcome note.
380 --viewlogo logofile
382 print the logofile as ASCII art. Formats that are automatically
383 detected are: NOL, NGG, NSM, NLM, BMP, I61, GGP, XPM. The OTA
384 format can be used only if the filename ends with the .otb
385 extension.
386 Format of network_code parameter is 3 digits MCC, a space, 2 digits MNC
388 surrounded by single or double quotes, eg. "123 45".
389 RINGTONES
392 --sendringtone destination rtttlfile
393 send the rtttlfile to destination as ringtone.
394 --setringtone rtttlfile
396 set the rtttlfile as ringtone (on 6110).
397 PHONEBOOK
400 --getphonebook memory_type start_number [end_number|end]
401 [[-r|--raw]|[-v|--vcard]|[-l|--ldif]]
402 reads specified memory location from phone. If end_number is
403 not specified only one location - start is read. If instead of
404 end_number the text end is specified then gnokii will read from
405 start_number until it encounters a non-existant location. Valid
406 memory types are ME, SM, FD, ON, EN, DC, RC, MC, LD:
407 ME Internal memory of the mobile equipment
409 SM SIM card memory
411 FD Fixed dial numbers
413 ON Own numbers
415 EN Emergency numbers
417 DC Dialled numbers
419 RC Received calls
421 MC Missed calls
423 LD Last dialed numbers
425 Normally you get human readable output. Please note, that it is not
427 compatible with expected input by --writephonebook. You can use -v or
428 --vcard switch to get output in vCard format or -l or --ldif switch to
429 get output in ldif format or -r or --raw switch to get the raw output
430 which is explained below. You can use it then with --writephonebook.
431 --writephonebook [-o|--overwrite] [-f|--find-free] [-m|--memory-
433 type|--memory memory_type] [-n|--memory-location|--location number]
434 [[-v|--vcard]|[-l|--ldif]]
435 reads data from stdin and writes to phonebook. Uses the format
436 as provided by the output of the getphonebook command using
437 --raw or --vcard or --ldif. Default is raw format (see below
438 for details) and alternate formats are vCard and ldif. Default
439 --getphonebook output format is not compatible with
440 --writephonebook.
441 With --memory-type memory_type and --memory-location number you can set
443 a memory type and a location if the input data doesn't specify them.
444 When the -o or --overwrite option is used, existing entries at a given
446 location are overwritten.
447 When the -f or --find-free option is given, gnokii tries to find a free
449 location. In this case, you can omit the location field in the input
450 data.
451 The raw phonebook format is very simple. Each line represents one
453 entry. Fields are separated by semicolons. Semicolons aren't allowed
454 inside a field. The fields have to be in this order (the subentries
455 are optional, ie. you can repeat all subentry field multiple times, but
456 they have to be alltogether in the given order):
457 name
459 number
461 memory_type
463 entry_location
465 caller_group_number
467 subentry_type
469 subentry_number_type
471 subentry_id
473 subentry_text
475 Possible values of caller_group_number and the corresponding caller
477 groups are (these are defaults, you are able to change these manually
478 in your phone):
479 0 Family
481 1 VIP
483 2 Friends
485 3 Colleagues
487 4 Other
489 5 No group
491 Possible subentry types are described in the gnokii/common.h file:
493 7 subentry is the name
495 8 subentry is the email address
497 9 subentry is the postal address (snail mail)
499 10 subentry is the note (text field)
501 11 subentry is the number
503 12 subentry is the ringtone
505 19 subentry is the date (used for DC, RD, LD)
507 26 subentry is the pointer (pointer to the other memory)
509 27 subentry is the logo (bitmap)
511 28 subentry is the logo switch
513 30 subentry is the group (octect)
515 44 subentry is the URL
517 47 subentry is the location (octect)
519 51 subentry is the image (file id)
521 55 subentry is the ringtoneadv (file id or ringtone)
523 56 subentry is the userid
525 63 subentry is the pttaddress
527 67 subentry is the extgroup
529 69 subentry is the video (file id)
531 70 subentry is the firstname
533 71 subentry is the lastname
535 74 subentry is the postaladdress
537 75 subentry is the extendedaddress
539 76 subentry is the street
541 77 subentry is the city
543 78 subentry is the stateprovince
545 79 subentry is the zipcode
547 50 subentry is the country
549 82 subentry is the formalname
551 84 subentry is the jobtitle
553 85 subentry is the company
555 86 subentry is the nickname
557 87 subentry is the birthday
559 Possible subentry number types are described in the gnokii/common.h
561 file:
562 2 number is the home phone number
564 3 number is the mobile phone number
566 4 number is the fax number
568 6 number is the work phone number
570 10 number is the general number
572 For the subentry types that don't care about number type (as text
574 files) this should be set to 0.
575 --deletephonebook memory_type start_number [end_number|end]
577 delete entries with start_number to end_number from the phone
578 book in memory_type. end is a keyword that denotes 'everything
579 till the end'.
580 WAP
583 --getwapbookmark number
584 reads the specified WAP bookmark from phone
585 --writewapbookmark name URL
587 write WAP bookmark to phone
588 --deletewapbookmark number
590 delete WAP bookmark from phone
591 --getwapsetting number [-r|--raw]
593 read WAP setting from phone
594 --writewapsetting
596 reads data from stdin and writes it to phone. Hint: see syntax
597 from --getwapsetting -r option
598 --activatewapsetting number
600 activate WAP setting number
601 DATE, TIME AND ALARM
605 --setdatetime [YYYY [MM [DD [HH [MM]]]]]
606 set the date and the time of the phone.
607 --getdatetime
609 shows current date and time in the phone.
610 --setalarm HH MM
612 set the alarm of the phone.
613 --getalarm
615 shows current alarm.
616 SECURITY
619 --identify
620 get IMEI, manufacturer, model, product name and revision.
621 --entersecuritycode {PIN|PIN2|PUK|PUK2|SEC}
623 asks for the code and sends it to the phone. Code is read from
624 terminal or from stdin.
625 --getsecuritycode
627 shows the currently set security code.
628 --getsecuritycodestatus
630 show if a security code is needed.
631 --getlocksinfo
633 show information about the (sim)locks of the phone: the lock
634 data, whether a lock is open or closed, whether it is a user or
635 factory lock and the number of unlock attempts.
636 FILE
639 Note that some phones (like Nokia 6610i) support only id based opera‐
640 tions (gnokii options with "byid" suffix). Use gnokiifs for the trans‐
641 parent support.
642 --getfilelist remote_path
644 lists files from the given directory. Use A:\* or B:\* to get
645 the root directory from either phone memory or card memory.
646 --getfiledetailsbyid [id]
648 lists file details or directory contents from the entry identi‐
649 fied by id. If no identifier is given, list the root directory
650 contents.
651 --getfileid remote_filename
653 gets id of the file.
654 --getfile remote_filename [local_filename]
656 gets file identified by name and path from the phone and stores
657 it at the local computer.
658 --getfilebyid id [local_filename]
660 gets file identified by id from the phone and stores it at the
661 local computer.
662 --getallfiles remote_path
664 gets all files from the remote path.
665 --putfile local_filename remote_filename
667 stores the file in the phone memory or on the memory card.
668 --deletefile remote_filename
670 removes the file from the phone.
671 --deletefilebyid id
673 removes the file from the phone.
674 MISC
677 --keysequence
678 emulates pressing keys on phone keyboard. Input is read from
679 stdin.
680 Supported keys (any other char is ignored):
682 M menu
684 N names
686 P power
688 G green phone
690 R red phone
692 U up
694 D down
696 + increase volume
698 - decrease volume
700 0123456789#* as is
702 Example: to increase volume
704 echo "+" | gnokii --keysequence
706 Note: this command isn't supported by all phones/drivers.
708 --enterchar
711 emulates typing a character on phone keyboard. By emulating
712 multiple pressions of keys, it can input all characters sup‐
713 ported by the phone in use, but to input an SMS predictive text
714 should be disabled. Input is read from stdin, with newline
715 interpreted as the "Menu" key and escape interpreted as the
716 "Names" key.
717 Note: this command isn't supported by all phones/drivers.
719 --listnetworks
722 prints a list of cellular network operators with their 3-digits
723 MCC (Mobile country code) and 2-digits MNC (Mobile Network
724 Code).
725 Note: this command doesn't need a valid config or a phone to
727 work.
728 --getnetworkinfo
731 prints information about the network currently in use.
732
735 Various error messages are printed to standard error. The exit code is
736 0 for correct functioning. Errors which appear to be caused by invalid
737 or abused command line parameters cause an exit code of 2, and other
738 errors cause an exit code of 1.
739
742 We write quality software here ;) but see KNOWN_BUGS just in case. If
743 you'd like to send us the bugreport please read the README and Bugs
744 files.
745
748 Hugh Blemings <hugh at blemings dot org>, Pavel Janik ml. <Pavel.Janik
749 at suse dot cz> and Pawel Kot <gnokii at gmail dot com>.
750 Manual page written by Dag Wieers <dag at mind dot be>, Pawel Kot
752 <gnokii at gmail dot com> and Daniele Forsi <daniele at forsi dot it>.
753 See also Docs/CREDITS from gnokii sources.
755
758 This program is distributed under the GNU Public License Version 2, or
759 (at your option) any later version.
760
763 gnokiid, xgnokii, mgnokiidev, ppm2nokia, sendsms, todologo
764Dag Wieers, Pawel Kot Jul 7, 2011 gnokii(1)