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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GypsyDevice</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="Gypsy Reference Manual">
<link rel="up" href="ch03.html" title="GPS Data Objects">
<link rel="prev" href="ch03.html" title="GPS Data Objects">
<link rel="next" href="GypsyAccuracy.html" title="GypsyAccuracy">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="reference" href="rn01.html" title="Gypsy Overview">
<link rel="reference" href="rn02.html" title="Tutorials">
<link rel="chapter" href="ch01.html" title="Programming Gypsy With Python">
<link rel="reference" href="gypsy-server-interfaces.html" title="Gypsy Server Interface">
<link rel="reference" href="gypsy-client-interfaces.html" title="Gypsy Client Interface">
<link rel="reference" href="rn05.html" title="LibGypsy API Reference">
<link rel="chapter" href="ch02.html" title="Gypsy-Daemon Control">
<link rel="chapter" href="ch03.html" title="GPS Data Objects">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Gypsy Reference Manual</th>
<td><a accesskey="n" href="GypsyAccuracy.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2577719" class="shortcut">Top</a>
 | 
<a href="#id2565912" class="shortcut">Description</a>
 | 
<a href="#id2587120" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2587144" class="shortcut">Properties</a>
 | 
<a href="#id2565880" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GypsyDevice"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2577719"></a><span class="refentrytitle">GypsyDevice</span>
</h2>
<p>GypsyDevice — Object for obtaining device information</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="GypsyDevice.html#GypsyDevice-struct">GypsyDevice</a>;
#define <a href="GypsyDevice.html#GYPSY-DEVICE-DBUS-SERVICE:CAPS">GYPSY_DEVICE_DBUS_SERVICE</a>
#define <a href="GypsyDevice.html#GYPSY-DEVICE-DBUS-INTERFACE:CAPS">GYPSY_DEVICE_DBUS_INTERFACE</a>
enum <a href="GypsyDevice.html#GypsyDeviceFixStatus">GypsyDeviceFixStatus</a>;
<a href="GypsyDevice.html" title="GypsyDevice">GypsyDevice</a>* <a href="GypsyDevice.html#gypsy-device-new">gypsy_device_new</a> (const char *object_path);
gboolean <a href="GypsyDevice.html#gypsy-device-get-connection-status">gypsy_device_get_connection_status</a> (<a href="GypsyDevice.html" title="GypsyDevice">GypsyDevice</a> *device,
GError **error);
<a href="GypsyDevice.html#GypsyDeviceFixStatus">GypsyDeviceFixStatus</a> <a href="GypsyDevice.html#gypsy-device-get-fix-status">gypsy_device_get_fix_status</a> (<a href="GypsyDevice.html" title="GypsyDevice">GypsyDevice</a> *device,
GError **error);
gboolean <a href="GypsyDevice.html#gypsy-device-start">gypsy_device_start</a> (<a href="GypsyDevice.html" title="GypsyDevice">GypsyDevice</a> *device,
GError **error);
gboolean <a href="GypsyDevice.html#gypsy-device-stop">gypsy_device_stop</a> (<a href="GypsyDevice.html" title="GypsyDevice">GypsyDevice</a> *device,
GError **error);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2587120"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GypsyDevice
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2587144"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GypsyDevice.html#GypsyDevice--object-path">object-path</a>" gchararray : Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2565880"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GypsyDevice.html#GypsyDevice-connection-changed">connection-changed</a>" : Run First / No Recursion
"<a href="GypsyDevice.html#GypsyDevice-fix-status-changed">fix-status-changed</a>" : Run First / No Recursion
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2565912"></a><h2>Description</h2>
<p>
<a href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> is used whenever the client program wishes to know about
changes in the device's status. It has signals for connection status and
fix status. It can also be used to tell gypsy-daemon to start or stop parsing
sentences from the GPS device.
</p>
<p>
A <a href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> object is created using <a href="GypsyDevice.html#gypsy-device-new"><code class="function">gypsy_device_new()</code></a> using the D-Bus path of
the GPS device. This path is returned from the <a href="GypsyControl.html#gypsy-control-create"><code class="function">gypsy_control_create()</code></a>
function. The client can start the GPS data stream with <a href="GypsyDevice.html#gypsy-device-start"><code class="function">gypsy_device_start()</code></a>,
stop it with <a href="GypsyDevice.html#gypsy-device-stop"><code class="function">gypsy_device_stop()</code></a>, or find out about the status with
<a href="GypsyDevice.html#gypsy-device-get-fix-status"><code class="function">gypsy_device_get_fix_status()</code></a> and <a href="GypsyDevice.html#gypsy-device-get-connection-status"><code class="function">gypsy_device_get_connection_status()</code></a>.
</p>
<p>
As the fix status and connection status change, <a href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> will emit the
<a href="GypsyDevice.html#GypsyDevice-fix-status-changed"><span class="type">GypsyDevice::fix-status-changed</span></a> and <a href="GypsyDevice.html#GypsyDevice-connection-changed"><span class="type">GypsyDevice::connection-changed</span></a> signals
respectively.
</p>
<p>
</p>
<div class="informalexample"><pre class="programlisting">
GypsyDevice *device;
GError *error = NULL;
. . .
/* path comes from the <a href="GypsyControl.html#gypsy-control-create">gypsy_control_create</a>() function */
device = <a href="GypsyDevice.html#gypsy-device-new">gypsy_device_new</a> (path);
g_signal_connect (device, "connection-changed", G_CALLBACK (connection_changed), NULL);
<a href="GypsyDevice.html#gypsy-device-start">gypsy_device_start</a> (device, &error);
if (error != NULL) {
  g_warning ("Error starting GPS: %s", error->message);
  g_error_free (error);
}
. . .
static void connection_changed (GypsyDevice *device, gboolean connected, gpointer data)
{
  g_print ("Connection status: %s\n", connected ? "Connected" : "Disconnected");
}
</pre></div>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2599578"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2599589"></a><h3>
<a name="GypsyDevice-struct"></a>GypsyDevice</h3>
<a class="indexterm" name="id2599601"></a><pre class="programlisting">typedef struct _GypsyDevice GypsyDevice;</pre>
<p>
There are no public fields in <a href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a>.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2599628"></a><h3>
<a name="GYPSY-DEVICE-DBUS-SERVICE:CAPS"></a>GYPSY_DEVICE_DBUS_SERVICE</h3>
<a class="indexterm" name="id2599641"></a><pre class="programlisting">#define GYPSY_DEVICE_DBUS_SERVICE "org.freedesktop.Gypsy"
</pre>
<p>
A define containing the name of the Device service</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2599661"></a><h3>
<a name="GYPSY-DEVICE-DBUS-INTERFACE:CAPS"></a>GYPSY_DEVICE_DBUS_INTERFACE</h3>
<a class="indexterm" name="id2599674"></a><pre class="programlisting">#define GYPSY_DEVICE_DBUS_INTERFACE "org.freedesktop.Gypsy.Device"
</pre>
<p>
A define containing the name of the Device interface</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2599695"></a><h3>
<a name="GypsyDeviceFixStatus"></a>enum GypsyDeviceFixStatus</h3>
<a class="indexterm" name="id2599706"></a><pre class="programlisting">typedef enum {
GYPSY_DEVICE_FIX_STATUS_INVALID = 0,
GYPSY_DEVICE_FIX_STATUS_NONE,
GYPSY_DEVICE_FIX_STATUS_2D,
GYPSY_DEVICE_FIX_STATUS_3D
} GypsyDeviceFixStatus;
</pre>
<p>
An enumeration representing the various fix states that a GPS device can be in.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="GYPSY-DEVICE-FIX-STATUS-INVALID:CAPS"></a><code class="literal">GYPSY_DEVICE_FIX_STATUS_INVALID</code></span></td>
<td> The fix is invalid
</td>
</tr>
<tr>
<td><span class="term"><a name="GYPSY-DEVICE-FIX-STATUS-NONE:CAPS"></a><code class="literal">GYPSY_DEVICE_FIX_STATUS_NONE</code></span></td>
<td> A fix has not yet been obtained
</td>
</tr>
<tr>
<td><span class="term"><a name="GYPSY-DEVICE-FIX-STATUS-2D:CAPS"></a><code class="literal">GYPSY_DEVICE_FIX_STATUS_2D</code></span></td>
<td> A fix with latitude and longitude has been obtained
</td>
</tr>
<tr>
<td><span class="term"><a name="GYPSY-DEVICE-FIX-STATUS-3D:CAPS"></a><code class="literal">GYPSY_DEVICE_FIX_STATUS_3D</code></span></td>
<td> A fix with latitude, longitude and altitude has been obtained
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2585544"></a><h3>
<a name="gypsy-device-new"></a>gypsy_device_new ()</h3>
<a class="indexterm" name="id2585556"></a><pre class="programlisting"><a href="GypsyDevice.html" title="GypsyDevice">GypsyDevice</a>* gypsy_device_new (const char *object_path);</pre>
<p>
Creates a new <a href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a> that points to <em class="parameter"><code>object_path</code></em></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>object_path</code></em> :</span></td>
<td> Object path to the device
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A pointer to a <a href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2585636"></a><h3>
<a name="gypsy-device-get-connection-status"></a>gypsy_device_get_connection_status ()</h3>
<a class="indexterm" name="id2585648"></a><pre class="programlisting">gboolean gypsy_device_get_connection_status (<a href="GypsyDevice.html" title="GypsyDevice">GypsyDevice</a> *device,
GError **error);</pre>
<p>
Obtains the connection status of <em class="parameter"><code>device</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>device</code></em> :</span></td>
<td> A <a href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> A pointer to a <span class="type">GError</span> to return an error in.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <span class="type">TRUE</span> if the device is connected, <span class="type">FALSE</span> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601970"></a><h3>
<a name="gypsy-device-get-fix-status"></a>gypsy_device_get_fix_status ()</h3>
<a class="indexterm" name="id2601981"></a><pre class="programlisting"><a href="GypsyDevice.html#GypsyDeviceFixStatus">GypsyDeviceFixStatus</a> gypsy_device_get_fix_status (<a href="GypsyDevice.html" title="GypsyDevice">GypsyDevice</a> *device,
GError **error);</pre>
<p>
Obtains the current fix status of <em class="parameter"><code>device</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>device</code></em> :</span></td>
<td> A <a href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> A pointer to a <span class="type">GError</span> to return a error in.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A <a href="GypsyDevice.html#GypsyDeviceFixStatus"><span class="type">GypsyDeviceFixStatus</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602078"></a><h3>
<a name="gypsy-device-start"></a>gypsy_device_start ()</h3>
<a class="indexterm" name="id2602089"></a><pre class="programlisting">gboolean gypsy_device_start (<a href="GypsyDevice.html" title="GypsyDevice">GypsyDevice</a> *device,
GError **error);</pre>
<p>
Starts the connection to the physical device pointed to by <em class="parameter"><code>device</code></em>, and
listens for incoming messages.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>device</code></em> :</span></td>
<td> A <a href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> A pointer to a <span class="type">GError</span> to return the error in
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <span class="type">TRUE</span> on success, <span class="type">FALSE</span> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602205"></a><h3>
<a name="gypsy-device-stop"></a>gypsy_device_stop ()</h3>
<a class="indexterm" name="id2602217"></a><pre class="programlisting">gboolean gypsy_device_stop (<a href="GypsyDevice.html" title="GypsyDevice">GypsyDevice</a> *device,
GError **error);</pre>
<p>
Stops the physical device pointed to by <em class="parameter"><code>device</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>device</code></em> :</span></td>
<td> A <a href="GypsyDevice.html" title="GypsyDevice"><span class="type">GypsyDevice</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> A pointer to a <span class="type">GError</span> to return the error in
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <span class="type">TRUE</span> on success, <span class="type">FALSE</span> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2602335"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2602345"></a><h3>
<a name="GypsyDevice--object-path"></a>The "<code class="literal">object-path</code>" property</h3>
<a class="indexterm" name="id2602359"></a><pre class="programlisting"> "object-path" gchararray : Write / Construct Only</pre>
<p>
The path of the Gypsy GPS object</p>
<p>
</p>
<p>Default value: ""</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2602391"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2602402"></a><h3>
<a name="GypsyDevice-connection-changed"></a>The "connection-changed" signal</h3>
<a class="indexterm" name="id2602411"></a><pre class="programlisting">void user_function (<a href="GypsyDevice.html" title="GypsyDevice">GypsyDevice</a> *connected,
gboolean arg1,
gpointer user_data) : Run First / No Recursion</pre>
<p>
The ::connection-changed signal is emitted whenever the device
connection changes.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>connected</code></em> :</span></td>
<td> Whether or not the device is connected
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602492"></a><h3>
<a name="GypsyDevice-fix-status-changed"></a>The "fix-status-changed" signal</h3>
<a class="indexterm" name="id2602501"></a><pre class="programlisting">void user_function (<a href="GypsyDevice.html" title="GypsyDevice">GypsyDevice</a> *fix_status,
gint arg1,
gpointer user_data) : Run First / No Recursion</pre>
<p>
The ::fix-status-changed signal is emitted whenever the GPS device
reports that its fix status has changed. <em class="parameter"><code>fix_status</code></em> is a
<a href="GypsyDevice.html#GypsyDeviceFixStatus"><span class="type">GypsyDeviceFixStatus</span></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>fix_status</code></em> :</span></td>
<td> The new fix status
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|
