summaryrefslogtreecommitdiff
path: root/docs/manual/python/examples.rst
blob: 586c0e96ae547471429b6fa4e79b88c485bfc505 (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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
.. _python-gammu-examples:

More python-gammu Examples
==========================

Many examples are available in ``examples/`` directory in the python-gammu
sources.

Sending a message
-----------------

.. code-block:: python

    #!/usr/bin/env python
    # Sample script to show how to send SMS

    from __future__ import print_function
    import gammu
    import sys

    # Create object for talking with phone
    state_machine = gammu.StateMachine()

    # Optionally load config file as defined by first parameter
    if len(sys.argv) >= 2:
        # Read the configuration from given file
        state_machine.ReadConfig(Filename=sys.argv[1])
        # Remove file name from args list
        del sys.argv[1]
    else:
        # Read the configuration (~/.gammurc)
        state_machine.ReadConfig()

    # Check parameters
    if len(sys.argv) != 2:
        print('Usage: sendsms.py [configfile] RECIPIENT_NUMBER')
        sys.exit(1)

    # Connect to the phone
    state_machine.Init()

    # Prepare message data
    # We tell that we want to use first SMSC number stored in phone
    message = {
        'Text': 'python-gammu testing message',
        'SMSC': {'Location': 1},
        'Number': sys.argv[1],
    }

    # Actually send the message
    state_machine.SendSMS(message)

Sending a long message
----------------------

.. code-block:: python


    #!/usr/bin/env python
    # Sample script to show how to send long (multipart) SMS

    from __future__ import print_function
    import gammu
    import sys

    # Create object for talking with phone
    state_machine = gammu.StateMachine()

    # Optionally load config file as defined by first parameter
    if len(sys.argv) >= 2:
        # Read the configuration from given file
        state_machine.ReadConfig(Filename=sys.argv[1])
        # Remove file name from args list
        del sys.argv[1]
    else:
        # Read the configuration (~/.gammurc)
        state_machine.ReadConfig()

    # Check parameters
    if len(sys.argv) != 2:
        print('Usage: sendlongsms.py [configfile] RECIPIENT_NUMBER')
        sys.exit(1)

    # Connect to the phone
    state_machine.Init()


    # Create SMS info structure
    smsinfo = {
        'Class': 1,
        'Unicode': False,
        'Entries':  [
            {
                'ID': 'ConcatenatedTextLong',
                'Buffer':
                    'Very long python-gammu testing message '
                    'sent from example python script. '
                    'Very long python-gammu testing message '
                    'sent from example python script. '
                    'Very long python-gammu testing message '
                    'sent from example python script. '
            }
        ]}

    # Encode messages
    encoded = gammu.EncodeSMS(smsinfo)

    # Send messages
    for message in encoded:
        # Fill in numbers
        message['SMSC'] = {'Location': 1}
        message['Number'] = sys.argv[1]

        # Actually send the message
        state_machine.SendSMS(message)

Initiating a voice call
-----------------------

.. code-block:: python

    #!/usr/bin/env python

    from __future__ import print_function
    import gammu
    import sys

    # Create object for talking with phone
    state_machine = gammu.StateMachine()

    # Read the configuration (~/.gammurc or from command line)
    if len(sys.argv) >= 2:
        state_machine.ReadConfig(Filename=sys.argv[1])
        del sys.argv[1]
    else:
        state_machine.ReadConfig()

    # Connect to the phone
    state_machine.Init()

    # Check whether we have a number to dial
    if len(sys.argv) != 2:
        print('Usage: dialvoice.py NUMBER')
        sys.exit(1)

    # Dial a number
    state_machine.DialVoice(sys.argv[1])

Reading calendar from phone
---------------------------

.. code-block:: python

    #!/usr/bin/env python
    # Example for reading calendar from phone

    from __future__ import print_function
    import gammu

    # Create object for talking with phone
    state_machine = gammu.StateMachine()

    # Read the configuration (~/.gammurc)
    state_machine.ReadConfig()

    # Connect to the phone
    state_machine.Init()

    # Get number of calendar entries
    status = state_machine.GetCalendarStatus()

    remain = status['Used']

    start = True

    while remain > 0:
        # Read the entry
        if start:
            entry = state_machine.GetNextCalendar(Start=True)
            start = False
        else:
            entry = state_machine.GetNextCalendar(Location=entry['Location'])
        remain = remain - 1

        # Display it
        print()
        print('%-20s: %d' % ('Location', entry['Location']))
        print('%-20s: %s' % ('Type', entry['Type']))
        for v in entry['Entries']:
            print('%-20s: %s' % (v['Type'], str(v['Value'])))