src/gps.c

   1 /**
   2  * collectd - src/gps.c
   3  * Copyright (C) 2015  Nicolas JOURDEN
   4  *
   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:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  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.
  22  *
  23  * Authors:
  24  *   Nicolas JOURDEN <nicolas.jourden at laposte.net>
  25  **/
  26
  27 #include "collectd.h"
  28 #include "common.h"
  29 #include "plugin.h"
  30 #include "utils_time.h"
  31 #include "configfile.h"
  32
  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"
  39
  40 #include <gps.h>
  41 #include <pthread.h>
  42
  43 typedef struct {
  44   char *host;
  45   char *port;
  46   cdtime_t timeout;
  47   cdtime_t pause;
  48 } cgps_config_t;
  49
  50 typedef struct {
  51   gauge_t sats_used;
  52   gauge_t sats_visible;
  53   gauge_t hdop;
  54   gauge_t vdop;
  55 } cgps_data_t;
  56
  57 // Thread items:
  58 static pthread_t connector = (pthread_t) 0;
  59
  60 static cgps_config_t config;
  61
  62 static cgps_data_t      data = {NAN, NAN, NAN, NAN};
  63 static pthread_mutex_t  data_lock = PTHREAD_MUTEX_INITIALIZER;
  64
  65 /**
  66  * Thread reading from gpsd.
  67  */
  68 static void * cgps_thread (void * pData)
  69 {
  70   struct gps_data_t conn;
  71   int err_count;
  72
  73   while (1)
  74   {
  75     err_count = 0;
  76
  77 #if GPSD_API_MAJOR_VERSION > 4
  78     int status = gps_open (config.host, config.port, &conn);
  79 #else
  80     int status = gps_open_r (config.host, config.port, &conn);
  81 #endif
  82     if (status < 0)
  83     {
  84       WARNING ("gps plugin: Connecting to %s:%s failed: %s",
  85                config.host, config.port, gps_errstr (status));
  86       sleep (60);
  87       continue;
  88     }
  89
  90     gps_stream (&conn, WATCH_ENABLE | WATCH_JSON | WATCH_NEWSTYLE, NULL);
  91     gps_send (&conn, GPS_CONFIG);
  92
  93     while (1)
  94     {
  95 #if GPSD_API_MAJOR_VERSION > 4
  96       long timeout_ms = CDTIME_T_TO_MS (config.timeout);
  97       if (!gps_waiting (&conn, (int) timeout_ms))
  98 #else
  99       if (!gps_waiting (&conn))
 100 #endif
 101       {
 102         struct timespec pause_ns;
 103         CDTIME_T_TO_TIMESPEC (config.pause, &pause_ns);
 104         nanosleep (&pause_ns, NULL);
 105         continue;
 106       }
 107
 108       if (gps_read (&conn) == -1)
 109       {
 110         WARNING ("gps plugin: incorrect data! (err_count: %d)", err_count);
 111         err_count++;
 112
 113         if (err_count > GPS_MAX_ERROR)
 114         {
 115           // Server is not responding ...
 116           if (gps_send (&conn, GPS_CONFIG) == -1)
 117           {
 118             WARNING ("gps plugin: gpsd seems to be done, reconnecting");
 119             break;
 120           }
 121           // Server is responding ...
 122           else
 123           {
 124             err_count = 0;
 125           }
 126         }
 127
 128         continue;
 129       }
 130
 131       pthread_mutex_lock (&data_lock);
 132
 133       // Number of sats in view:
 134       data.sats_used = (gauge_t) conn.satellites_used;
 135       data.sats_visible = (gauge_t) conn.satellites_visible;
 136
 137       // dilution of precision:
 138       data.vdop = NAN; data.hdop = NAN;
 139       if (data.sats_used > 0)
 140       {
 141         data.hdop = conn.dop.hdop;
 142         data.vdop = conn.dop.vdop;
 143       }
 144
 145
 146       DEBUG ("gps plugin: %.0f sats used (of %.0f visible), hdop = %.3f, vdop = %.3f",
 147              data.sats_used, data.sats_visible, data.hdop, data.vdop);
 148
 149       pthread_mutex_unlock (&data_lock);
 150     }
 151   }
 152
 153   gps_stream (&conn, WATCH_DISABLE, /* data = */ NULL);
 154   gps_close (&conn);
 155
 156   pthread_exit ((void *) 0);
 157 }
 158
 159 /**
 160  * Submit a piece of the data.
 161  */
 162 static void cgps_submit (const char *type, gauge_t value, const char *type_instance)
 163 {
 164   value_t values[1];
 165   value_list_t vl = VALUE_LIST_INIT;
 166
 167   values[0].gauge = value;
 168
 169   vl.values = values;
 170   vl.values_len = 1;
 171   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 172   sstrncpy (vl.plugin, "gps", sizeof (vl.plugin));
 173   sstrncpy (vl.type, type, sizeof (vl.type));
 174   sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 175
 176   plugin_dispatch_values (&vl);
 177 }
 178
 179 /**
 180  * Read the data and submit by piece.
 181  */
 182 static int cgps_read ()
 183 {
 184   cgps_data_t data_copy;
 185
 186   pthread_mutex_lock (&data_lock);
 187   data_copy = data;
 188   pthread_mutex_unlock (&data_lock);
 189
 190   cgps_submit ("dilution_of_precision", data_copy.hdop, "horizontal");
 191   cgps_submit ("dilution_of_precision", data_copy.vdop, "vertical");
 192   cgps_submit ("satellites", data_copy.sats_used, "used");
 193   cgps_submit ("satellites", data_copy.sats_visible, "visible");
 194
 195   return (0);
 196 }
 197
 198 /**
 199  * Read configuration.
 200  */
 201 static int cgps_config (oconfig_item_t *ci)
 202 {
 203   int i;
 204
 205   for (i = 0; i < ci->children_num; i++)
 206   {
 207     oconfig_item_t *child = ci->children + i;
 208
 209     if (strcasecmp ("Host", child->key) == 0)
 210       cf_util_get_string (child, &config.host);
 211     else if (strcasecmp ("Port", child->key) == 0)
 212       cf_util_get_service (child, &config.port);
 213     else if (strcasecmp ("Timeout", child->key) == 0)
 214       cf_util_get_cdtime (child, &config.timeout);
 215     else if (strcasecmp ("Pause", child->key) == 0)
 216       cf_util_get_cdtime (child, &config.pause);
 217     else
 218       WARNING ("gps plugin: Ignoring unknown config option \"%s\".", child->key);
 219   }
 220
 221   return 0;
 222 }
 223
 224 /**
 225  * Init.
 226  */
 227 static int cgps_init (void)
 228 {
 229   int status;
 230
 231   DEBUG ("gps plugin: config{host: \"%s\", port: \"%s\", timeout: %.3f, pause: %.3f}",
 232          config.host, config.port,
 233          CDTIME_T_TO_DOUBLE (config.timeout), CDTIME_T_TO_DOUBLE (config.pause));
 234
 235   status = plugin_thread_create (&connector, NULL, cgps_thread, NULL);
 236   if (status != 0)
 237   {
 238     ERROR ("gps plugin: pthread_create() failed.");
 239     return (-1);
 240   }
 241
 242   return (0);
 243 }
 244
 245 /**
 246  * Shutdown.
 247  */
 248 static int cgps_shutdown (void)
 249 {
 250   if (connector != ((pthread_t) 0))
 251   {
 252     pthread_kill (connector, SIGTERM);
 253     connector = (pthread_t) 0;
 254   }
 255
 256   sfree (config.port);
 257   sfree (config.host);
 258
 259   return (0);
 260 }
 261
 262 /**
 263  * Register the module.
 264  */
 265 void module_register (void)
 266 {
 267   config.host = sstrdup (GPS_DEFAULT_HOST);
 268   config.port = sstrdup (GPS_DEFAULT_PORT);
 269   config.timeout = GPS_DEFAULT_TIMEOUT;
 270   config.pause = GPS_DEFAULT_PAUSE;
 271
 272   plugin_register_complex_config ("gps", cgps_config);
 273   plugin_register_init ("gps", cgps_init);
 274   plugin_register_read ("gps", cgps_read);
 275   plugin_register_shutdown ("gps", cgps_shutdown);
 276 }