summaryrefslogtreecommitdiff
path: root/docs/manual/utils/gammu-detect.rst
blob: c1616a02913664e10bee45b8727d79ed6f86baa1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
.. _gammu-detect:

gammu-detect
============

.. versionadded:: 1.28.95

.. program:: gammu-detect

Synopsis
--------

.. code-block:: text

    gammu-detect [OPTIONS]

Description
-----------

Script to detect available devices, which might be suitable for :ref:`gammu`.

.. note::

    This program lists all devices, which might be suitable, it does not do
    any probing on devices them self.

Currently it supports following devices:

* USB devices using udev
* Serial ports using udev
* Serial ports on Windows
* Bluetooth devices using Bluez

.. note::

    Supported devices depend on platform you are using and compiled in
    features. You can find out what is actually compiled in by running
    :option:`gammu-detect -v`.

This program follows the usual GNU command line syntax, with long options
starting with two dashes (``-``). A summary of options is included below.

.. option:: -h, --help

    Show summary of options.

.. option:: -d, --debug

    Show debugging output for detecting devices.

.. option:: -v, --version

    Show version information and compiled in features.

.. option:: -u, --no-udev

    Disables scanning of udev.

.. option:: -b, --no-bluez

    Disables scanning using Bluez.

.. option:: -w, --no-win32-serial

    Disables scanning of Windows serial ports.

Output
------

The output of :ref:`gammu-detect` is configuration file for Gammu (see
:ref:`gammurc`) with configuration section for every device which might be
used with :ref:`gammu`.

.. note::

    You can choose which section to use by :option:`gammu -s`.

When invoked as :option:`gammu-detect -d`, also all examined devices are
listed as comments in the output.

Example
-------

.. code-block:: ini

    ; Configuration file generated by gammu-detect.
    ; Please check The Gammu Manual for more information.

    [gammu]
    device = /dev/ttyACM0
    name = Nokia E52
    connection = at

    [gammu1]
    device = /dev/ttyACM1
    name = Nokia E52
    connection = at

    [gammu2]
    device = /dev/ttyS0
    name = Phone on serial port 0
    connection = at

    [gammu3]
    device = /dev/ttyS1
    name = Phone on serial port 1
    connection = at

    [gammu4]
    device = /dev/ttyS2
    name = Phone on serial port 2
    connection = at

    [gammu5]
    device = /dev/ttyS3
    name = Phone on serial port 3
    connection = at

    [gammu6]
    device = 5C:57:C8:BB:BB:BB
    name = Nokia E52
    connection = bluephonet