3 * Copyright (C) 2015 Nicolas JOURDEN
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Nicolas JOURDEN <nicolas.jourden at laposte.net>
30 #include "utils_time.h"
31 #include "configfile.h"
33 #define GPS_DEFAULT_HOST "localhost"
34 #define GPS_DEFAULT_PORT "2947"
35 #define GPS_DEFAULT_TIMEOUT TIME_T_TO_CDTIME_T (15)
36 #define GPS_DEFAULT_PAUSE TIME_T_TO_CDTIME_T (1)
37 #define GPS_MAX_ERROR 100
38 #define GPS_CONFIG "?WATCH={\"enable\":true,\"json\":true,\"nmea\":false}\r\n"
58 static pthread_t connector = (pthread_t) 0;
60 static cgps_config_t config;
62 static cgps_data_t data = {NAN, NAN, NAN, NAN};
63 static pthread_mutex_t data_lock = PTHREAD_MUTEX_INITIALIZER;
66 * Thread reading from gpsd.
68 static void * cgps_thread (void * pData)
70 struct gps_data_t conn;
77 int status = gps_open (config.host, config.port, &conn);
80 WARNING ("gps plugin: Connecting to %s:%s failed: %s",
81 config.host, config.port, gps_errstr (status));
86 gps_stream (&conn, WATCH_ENABLE | WATCH_JSON | WATCH_NEWSTYLE, NULL);
87 gps_send (&conn, GPS_CONFIG);
91 long timeout_ms = CDTIME_T_TO_MS (config.timeout);
92 if (!gps_waiting (&conn, (int) timeout_ms))
94 struct timespec pause_ns;
95 CDTIME_T_TO_TIMESPEC (config.pause, &pause_ns);
96 nanosleep (&pause_ns, NULL);
100 if (gps_read (&conn) == -1)
102 WARNING ("gps plugin: incorrect data! (err_count: %d)", err_count);
105 if (err_count > GPS_MAX_ERROR)
107 // Server is not responding ...
108 if (gps_send (&conn, GPS_CONFIG) == -1)
110 WARNING ("gps plugin: gpsd seems to be done, reconnecting");
113 // Server is responding ...
123 pthread_mutex_lock (&data_lock);
125 // Number of sats in view:
126 data.sats_used = (gauge_t) conn.satellites_used;
127 data.sats_visible = (gauge_t) conn.satellites_visible;
129 // dilution of precision:
130 data.vdop = NAN; data.hdop = NAN;
131 if (data.sats_used > 0)
133 data.hdop = conn.dop.hdop;
134 data.vdop = conn.dop.vdop;
138 DEBUG ("gps plugin: %.0f sats used (of %.0f visible), hdop = %.3f, vdop = %.3f",
139 data.sats_used, data.sats_visible, data.hdop, data.vdop);
141 pthread_mutex_unlock (&data_lock);
145 gps_stream (&conn, WATCH_DISABLE, /* data = */ NULL);
148 pthread_exit ((void *) 0);
152 * Submit a piece of the data.
154 static void cgps_submit (const char *type, gauge_t value, const char *type_instance)
157 value_list_t vl = VALUE_LIST_INIT;
159 values[0].gauge = value;
163 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
164 sstrncpy (vl.plugin, "gps", sizeof (vl.plugin));
165 sstrncpy (vl.type, type, sizeof (vl.type));
166 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
168 plugin_dispatch_values (&vl);
172 * Read the data and submit by piece.
174 static int cgps_read ()
176 cgps_data_t data_copy;
178 pthread_mutex_lock (&data_lock);
180 pthread_mutex_unlock (&data_lock);
182 cgps_submit ("dilution_of_precision", data_copy.hdop, "horizontal");
183 cgps_submit ("dilution_of_precision", data_copy.vdop, "vertical");
184 cgps_submit ("satellites", data_copy.sats_used, "used");
185 cgps_submit ("satellites", data_copy.sats_visible, "visible");
191 * Read configuration.
193 static int cgps_config (oconfig_item_t *ci)
197 for (i = 0; i < ci->children_num; i++)
199 oconfig_item_t *child = ci->children + i;
201 if (strcasecmp ("Host", child->key) == 0)
202 cf_util_get_string (child, &config.host);
203 else if (strcasecmp ("Port", child->key) == 0)
204 cf_util_get_service (child, &config.port);
205 else if (strcasecmp ("Timeout", child->key) == 0)
206 cf_util_get_cdtime (child, &config.timeout);
207 else if (strcasecmp ("Pause", child->key) == 0)
208 cf_util_get_cdtime (child, &config.pause);
210 WARNING ("gps plugin: Ignoring unknown config option \"%s\".", child->key);
219 static int cgps_init (void)
223 DEBUG ("gps plugin: config{host: \"%s\", port: \"%s\", timeout: %.3f, pause: %.3f}",
224 config.host, config.port,
225 CDTIME_T_TO_DOUBLE (config.timeout), CDTIME_T_TO_DOUBLE (config.pause));
227 status = plugin_thread_create (&connector, NULL, cgps_thread, NULL);
230 ERROR ("gps plugin: pthread_create() failed.");
240 static int cgps_shutdown (void)
242 if (connector != ((pthread_t) 0))
244 pthread_kill (connector, SIGTERM);
245 connector = (pthread_t) 0;
255 * Register the module.
257 void module_register (void)
259 config.host = sstrdup (GPS_DEFAULT_HOST);
260 config.port = sstrdup (GPS_DEFAULT_PORT);
261 config.timeout = GPS_DEFAULT_TIMEOUT;
262 config.pause = GPS_DEFAULT_PAUSE;
264 plugin_register_complex_config ("gps", cgps_config);
265 plugin_register_init ("gps", cgps_init);
266 plugin_register_read ("gps", cgps_read);
267 plugin_register_shutdown ("gps", cgps_shutdown);