Pileus Git - aweather/blob - src/plugins/gps-plugin.c

   1 /*
   2  * Copyright (C) 2012 Adam Boggs <boggs@aircrafter.org>
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /* TODO:
  19  *    If gpsd connection fails, try to connect again periodically.
  20  *    If gps stops sending data there should be an indication that it's stale.
  21  */
  22
  23 #define _XOPEN_SOURCE
  24 #include <config.h>
  25
  26 #include <stdio.h>
  27 #include <fcntl.h>
  28 #include <errno.h>
  29 #include <time.h>
  30 #include <string.h>
  31 #include <glib/gstdio.h>
  32 #include <gtk/gtk.h>
  33 #include <gio/gio.h>
  34 #include <math.h>
  35
  36 #include <grits.h>
  37 #include <gps.h>
  38
  39 #include "gps-plugin.h"
  40 #include "level2.h"
  41 #include "../aweather-location.h"
  42
  43 /* interval to update map with new gps data in seconds. */
  44 #define GPS_UPDATE_INTERVAL     (2)
  45
  46 /* Filename and search path to use for gps marker, should be configurable */
  47 #define GPS_MARKER_ICON_PATH    ".:" PKGDATADIR
  48 #define GPS_MARKER_ICON         "arrow.png"
  49
  50 /* number of track points per group and number of groups to maintain */
  51 #define GPS_TRACK_POINTS        (256)
  52 #define GPS_TRACK_GROUPS        (16)
  53 #define GPS_TRACK_POINTS_FACTOR (1.5)
  54
  55 /* interval to update log file in seconds (default value for slider) */
  56 #define GPS_LOG_DEFAULT_UPDATE_INTERVAL (30)
  57 #define GPS_LOG_EXT             "csv"
  58
  59 /* For updating the status bar conveniently */
  60 #define GPS_STATUSBAR_CONTEXT   "GPS"
  61
  62 #if 0
  63 #define GPS_STATUS(gps, format, args...) \
  64         do { \
  65                 gchar *buf = g_strdup_printf(format, ##args); \
  66                 gtk_statusbar_push(GTK_STATUSBAR(gps->status_bar), \
  67                     gtk_statusbar_get_context_id( \
  68                       GTK_STATUSBAR(gps->status_bar), \
  69                       GPS_STATUSBAR_CONTEXT), \
  70                 buf); \
  71         } while (0)
  72 #endif
  73
  74 #define GPS_STATUS(gps, format, args...) \
  75         do { \
  76                 gchar *buf = g_strdup_printf(format, ##args); \
  77                 g_debug("STATUS: %s", buf); \
  78         } while (0)
  79
  80
  81 /********************
  82  * Helper functions *
  83  ********************/
  84
  85 /* Find a readable file in a colon delimeted path */
  86 static gchar *find_path(const gchar *path, const gchar *filename)
  87 {
  88         gchar *end_ptr, *fullpath;
  89
  90         end_ptr = (gchar *)path;
  91
  92         /* find first : */
  93         while (*end_ptr != ':' && *end_ptr != '\0')
  94                 end_ptr++;
  95         fullpath = g_strdup_printf("%.*s/%s", (int)(end_ptr-path), path,
  96                                filename);
  97         g_debug("GritsPluginGps: find_path - searching %s", fullpath);
  98         if (access(fullpath, R_OK) == 0) {
  99                 g_debug("GritsPluginGps: find_path - found %s", fullpath);
 100                 return fullpath;        /* caller frees */
 101         }
 102
 103         g_free(fullpath);
 104         /* recurse */
 105         if (*end_ptr == '\0') {
 106                 return NULL;
 107         } else {
 108                 return find_path(end_ptr + 1, filename);
 109         }
 110 }
 111
 112
 113 /********************
 114  * GPS Status Table *
 115  ********************/
 116
 117 static gchar *gps_get_status(struct gps_data_t *gps_data)
 118 {
 119         gchar *status_color;
 120         gchar *status_text;
 121
 122         switch (gps_data->fix.mode) {
 123         case MODE_NOT_SEEN:
 124                 status_color = "red";
 125                 status_text = "No Signal";
 126                 break;
 127         case MODE_NO_FIX:
 128                 status_color = "red";
 129                 status_text = "No Fix";
 130                 break;
 131         case MODE_2D:
 132                 status_color = "yellow";
 133                 status_text = "2D Mode";
 134                 break;
 135         case MODE_3D:
 136                 status_color = "green";
 137                 status_text = "3D Mode";
 138                 break;
 139         default:
 140                 status_color = "black";
 141                 status_text = "Unknown";
 142                 break;
 143         }
 144         return g_strdup_printf("<span foreground=\"%s\">%s</span>",
 145                                 status_color, status_text);
 146 }
 147
 148 #if 0
 149 static gchar *gps_get_online(struct gps_data_t *gps_data)
 150 {
 151         gchar *status_str;
 152         gchar *online_str;
 153
 154         if (gps_data->online == -1.0) {
 155                 online_str = "Offline";
 156         } else {
 157                 online_str = "Online";
 158         }
 159
 160         switch (gps_data->status) {
 161         case 0:
 162                 status_str = "No Fix";
 163                 break;
 164         case 1:
 165                 status_str = "Fix Acquired";
 166                 break;
 167         case 2:
 168                 status_str = "DGPS Fix";
 169                 break;
 170         default:
 171                 status_str = "Unknown Status";
 172                 break;
 173         }
 174
 175         return g_strdup_printf("%lf,%s,%s", gps_data->online, online_str, status_str);
 176 }
 177 #endif
 178
 179 static gchar *gps_get_latitude(struct gps_data_t *gps_data)
 180 {
 181         return g_strdup_printf("%3.4f", gps_data->fix.latitude);
 182 }
 183
 184 static gchar *gps_get_longitude(struct gps_data_t *gps_data)
 185 {
 186         return g_strdup_printf("%3.4f", gps_data->fix.longitude);
 187 }
 188
 189 static gchar *gps_get_elevation(struct gps_data_t *gps_data)
 190 {
 191         /* XXX Make units (m/ft) settable */
 192         return g_strdup_printf("%.1lf %s",
 193                     (gps_data->fix.altitude * METERS_TO_FEET), "ft");
 194 }
 195
 196 static gchar *gps_get_heading(struct gps_data_t *gps_data)
 197 {
 198         /* XXX Make units (m/ft) settable */
 199         return g_strdup_printf("%03.0lf", gps_data->fix.track);
 200 }
 201
 202 static gchar *gps_get_speed(struct gps_data_t *gps_data)
 203 {
 204         /* XXX Make units (m/ft) settable */
 205         return g_strdup_printf("%1.1f %s",
 206                 (gps_data->fix.speed*3600.0*METERS_TO_FEET/5280.0), "mph");
 207 }
 208
 209 struct {
 210         const gchar *label;
 211         const gchar *initial_val;
 212         gchar     *(*get_data)(struct gps_data_t *);
 213         guint        font_size;
 214         GtkWidget   *label_widget;
 215         GtkWidget   *value_widget;
 216 } gps_table[] = {
 217         {"Status:",    "No Data", gps_get_status,    14, NULL, NULL},
 218 //      {"Online:",    "No Data", gps_get_online,    14, NULL, NULL},
 219         {"Latitude:",  "No Data", gps_get_latitude,  14, NULL, NULL},
 220         {"Longitude:", "No Data", gps_get_longitude, 14, NULL, NULL},
 221         {"Elevation:", "No Data", gps_get_elevation, 14, NULL, NULL},
 222         {"Heading:",   "No Data", gps_get_heading,   14, NULL, NULL},
 223         {"Speed:",     "No Data", gps_get_speed,     14, NULL, NULL},
 224 };
 225
 226
 227 /******************
 228  * Track handling *
 229  ******************/
 230
 231 static void gps_track_init(GpsTrack *track)
 232 {
 233         /* Save a spot at the end for the NULL termination */
 234         track->points = (gpointer)g_new0(double*, GPS_TRACK_GROUPS + 1);
 235         track->cur_point  = 0;
 236         track->cur_group  = 0;
 237         track->num_points = 1;  /* starts at 1 so realloc logic works */
 238         track->line = NULL;
 239 }
 240
 241 static void gps_track_clear(GpsTrack *track)
 242 {
 243         gint pi;
 244         for (pi = 0; pi < GPS_TRACK_GROUPS; pi++) {
 245                 if (track->points[pi] != NULL) {
 246                         g_free(track->points[pi]);
 247                         track->points[pi] = NULL;
 248                 }
 249         }
 250         track->cur_point  = 0;
 251         track->cur_group  = 0;
 252         track->num_points = 1;  /* starts at 1 so realloc logic works */
 253 }
 254
 255 static void gps_track_free(GpsTrack *track)
 256 {
 257         gps_track_clear(track);
 258         g_free(track->points);
 259 }
 260
 261 /* add a new track group (points in a track group are connected, and
 262  * separated from points in other track groups).  */
 263 static void gps_track_group_incr(GpsTrack *track)
 264 {
 265         gdouble (**points)[3] = track->points; /* for simplicity */
 266
 267         /* Just return if they increment it again before any points have
 268          * been added.
 269          */
 270         if (points[track->cur_group] == NULL) {
 271                 return;
 272         }
 273
 274         g_debug("GritsPluginGps: track_group_incr - track group %u->%u.",
 275                 track->cur_group, track->cur_group + 1);
 276
 277         track->cur_group++;
 278         track->cur_point  = 0;
 279         track->num_points = 1;  /* starts at 1 so realloc logic works */
 280
 281         if (track->cur_group >= GPS_TRACK_GROUPS) {
 282                 g_debug("GritsPluginGps: track_group_incr - track group %u "
 283                         "is at max %u, shifting groups",
 284                         track->cur_group, GPS_TRACK_GROUPS);
 285
 286                 /* Free the oldest one which falls off the end */
 287                 g_free(points[0]);
 288
 289                 /* shift the rest down, last one should be NULL already */
 290                 /* note we alloc GPS_TRACK_GROUPS+1 */
 291                 for (int pi = 0; pi < GPS_TRACK_GROUPS; pi++) {
 292                         points[pi] = points[pi+1];
 293                 }
 294
 295                 /* always write into the last group */
 296                 track->cur_group = GPS_TRACK_GROUPS - 1;
 297         }
 298 }
 299
 300 static void gps_track_add_point(GpsTrack *track,
 301     gdouble lat, gdouble lon, gdouble elevation)
 302 {
 303         gdouble (**points)[3] = track->points; /* for simplicity */
 304
 305         g_debug("GritsPluginGps: track_add_point");
 306
 307         g_assert(track->cur_group < GPS_TRACK_GROUPS &&
 308                 (track->cur_point <= track->num_points));
 309
 310         /* resize/allocate the point group if the current one is full */
 311         if (track->cur_point >= track->num_points - 1) {
 312                 guint new_size = track->num_points == 1 ?
 313                             GPS_TRACK_POINTS :
 314                             track->num_points * GPS_TRACK_POINTS_FACTOR;
 315                 g_debug("GritsPluginGps: track_add_point - reallocating points "
 316                         "array from %u points to %u points.\n",
 317                         track->num_points, new_size);
 318                 points[track->cur_group] = (gpointer)g_renew(gdouble,
 319                             points[track->cur_group], 3*(new_size+1));
 320                 track->num_points = new_size;
 321         }
 322
 323         g_assert(points[track->cur_group] != NULL);
 324
 325         /* Add the coordinate */
 326         lle2xyz(lat, lon, elevation,
 327             &points[track->cur_group][track->cur_point][0],
 328             &points[track->cur_group][track->cur_point][1],
 329             &points[track->cur_group][track->cur_point][2]);
 330
 331         track->cur_point++;
 332
 333         /* make sure last point is always 0s so the line drawing stops. */
 334         points[track->cur_group][track->cur_point][0] = 0.0;
 335         points[track->cur_group][track->cur_point][1] = 0.0;
 336         points[track->cur_group][track->cur_point][2] = 0.0;
 337 }
 338
 339
 340 /*****************
 341  * Track Logging *
 342  *****************/
 343
 344 static gchar *gps_get_date_string(double gps_time)
 345 {
 346         static gchar    buf[256];
 347         time_t int_time = (time_t)gps_time;
 348         struct tm       tm_time;
 349
 350         gmtime_r(&int_time, &tm_time);
 351
 352         snprintf(buf, sizeof(buf), "%04d-%02d-%02d",
 353                  tm_time.tm_year+1900, tm_time.tm_mon+1, tm_time.tm_mday);
 354
 355         return buf;
 356 }
 357
 358 static gchar *gps_get_time_string(time_t gps_time)
 359 {
 360         static gchar buf[256];
 361         time_t int_time = (time_t)gps_time;
 362         struct tm tm_time;
 363
 364         gmtime_r(&int_time, &tm_time);
 365
 366         snprintf(buf, sizeof(buf), "%02d:%02d:%02dZ",
 367                  tm_time.tm_hour, tm_time.tm_min, tm_time.tm_sec);
 368
 369         return buf;
 370 }
 371
 372 static gboolean gps_write_log(gpointer data)
 373 {
 374         GritsPluginGps *gps = (GritsPluginGps *)data;
 375         struct gps_data_t *gps_data = &gps->gps_data;
 376         gchar buf[256];
 377         gchar filename[256];
 378         gint fd;
 379         gboolean new_file = FALSE;
 380
 381         if (gps_data == NULL) {
 382                 g_warning("Skipped write to GPS log file: "
 383                           "can not get GPS coordinates.");
 384                 GPS_STATUS(gps, "Skipped write to GPS log file: "
 385                           "can not get GPS coordinates.");
 386                 return TRUE;
 387         }
 388
 389         /* get filename from text entry box.  If empty, generate a name from
 390          * the date and time and set it. */
 391         if (strlen(gtk_entry_get_text(
 392                       GTK_ENTRY(gps->ui.gps_log_filename_entry))) == 0) {
 393                 snprintf(filename, sizeof(filename),
 394                             "%sT%s.%s",
 395                             gps_get_date_string(gps->gps_data.fix.time),
 396                             gps_get_time_string(gps->gps_data.fix.time),
 397                             GPS_LOG_EXT);
 398                 gtk_entry_set_text(GTK_ENTRY(gps->ui.gps_log_filename_entry),
 399                             filename);
 400         }
 401
 402         strncpy(filename,
 403             gtk_entry_get_text(GTK_ENTRY(gps->ui.gps_log_filename_entry)),
 404             sizeof(filename));
 405
 406         if (!g_file_test(filename, G_FILE_TEST_EXISTS)) {
 407                 new_file = TRUE;
 408         }
 409
 410         if ((fd = open(filename, O_CREAT|O_APPEND|O_WRONLY, 0644)) == -1) {
 411                 g_warning("Error opening log file %s: %s",
 412                                 filename, strerror(errno));
 413                 return FALSE;
 414         }
 415
 416         if (new_file) {
 417                 /* write header and reset record counter */
 418                 snprintf(buf, sizeof(buf),
 419                         "No,Date,Time,Lat,Lon,Ele,Head,Speed,RTR\n");
 420                 if (write(fd, buf, strlen(buf)) == -1) {
 421                     g_warning("Error writing header to log file %s: %s",
 422                                     filename, strerror(errno));
 423                 }
 424                 gps->ui.gps_log_number = 1;
 425         }
 426
 427         /* Write log entry.  Make sure this matches the header */
 428         /* "No,Date,Time,Lat,Lon,Ele,Head,Speed,Fix,RTR\n" */
 429         /* RTR values: T=time, B=button push, S=speed, D=distance */
 430         snprintf(buf, sizeof(buf), "%d,%s,%s,%lf,%lf,%lf,%lf,%lf,%c\n",
 431                         gps->ui.gps_log_number++,
 432                         gps_get_date_string(gps->gps_data.fix.time),
 433                         gps_get_time_string(gps->gps_data.fix.time),
 434                         //gps_data->fix.time,
 435                         gps_data->fix.latitude,
 436                         gps_data->fix.longitude,
 437                         gps_data->fix.altitude * METERS_TO_FEET,
 438                         gps_data->fix.track,
 439                         gps_data->fix.speed * METERS_TO_FEET,
 440                         'T'); /* position due to timer expired  */
 441
 442         if (write(fd, buf, strlen(buf)) == -1) {
 443                 g_warning("Could not write log number %d to log file %s: %s",
 444                                 gps->ui.gps_log_number-1, filename, strerror(errno));
 445         }
 446         close(fd);
 447
 448         GPS_STATUS(gps, "Updated GPS log file %s.", filename);
 449
 450         /* reschedule */
 451         return TRUE;
 452 }
 453
 454
 455 /****************
 456  * Main drawing *
 457  ****************/
 458
 459 static gboolean gps_data_is_valid(struct gps_data_t *gps_data)
 460 {
 461         if (gps_data != NULL && gps_data->online != -1.0 &&
 462                 gps_data->fix.mode >= MODE_2D &&
 463                 gps_data->status > STATUS_NO_FIX) {
 464                 return TRUE;
 465         }
 466
 467         return FALSE;
 468 }
 469
 470 static void gps_update_status(GritsPluginGps *gps)
 471 {
 472         struct gps_data_t *gps_data = &gps->gps_data;
 473
 474         /* gps table update */
 475         gint i;
 476         gchar *str;
 477         for (i = 0; i < G_N_ELEMENTS(gps_table); i++) {
 478                 gtk_label_set_markup(GTK_LABEL(gps_table[i].value_widget),
 479                             (str = gps_table[i].get_data(gps_data)));
 480                 g_free(str);
 481         }
 482 }
 483
 484 /* external interface to update UI from latest GPS data. */
 485 gboolean gps_redraw_all(gpointer data)
 486 {
 487         GritsPluginGps *gps = (GritsPluginGps *)data;
 488         g_assert(gps);
 489
 490         struct gps_data_t *gps_data = &gps->gps_data;
 491
 492         g_debug("GritsPluginGps: redraw_all");
 493
 494         g_assert(gps_data);
 495         if (!gps_data_is_valid(gps_data)) {
 496                 g_debug("GritsPluginGps: redraw_all - gps_data is not valid.");
 497                 /* XXX Change marker to indicate data is not valid */
 498                 return TRUE;
 499         }
 500
 501         /* update position labels */
 502         gps_update_status(gps);
 503
 504         /* Update track and marker position */
 505         if (gps_data_is_valid(gps_data) && gps->track.active) {
 506                 g_debug("GritsPluginGps: redraw_all - updating track group %u "
 507                         "point %u at lat = %f, long = %f, track = %f",
 508                         gps->track.cur_group,
 509                         gps->track.cur_point,
 510                         gps_data->fix.latitude,
 511                         gps_data->fix.longitude,
 512                         gps_data->fix.track);
 513
 514                 gps_track_add_point(&gps->track,
 515                           gps_data->fix.latitude, gps_data->fix.longitude, 0.0);
 516
 517                 if (gps->track.line) {
 518                         grits_viewer_remove(gps->viewer,
 519                             GRITS_OBJECT(gps->track.line));
 520                         gps->track.line = NULL;
 521                 }
 522
 523                 gps->track.line = grits_line_new(gps->track.points);
 524                 gps->track.line->color[0]  = 1.0;
 525                 gps->track.line->color[1]  = 0;
 526                 gps->track.line->color[2]  = 0.1;
 527                 gps->track.line->color[3]  = 1.0;
 528                 gps->track.line->width     = 3;
 529
 530                 grits_viewer_add(gps->viewer, GRITS_OBJECT(gps->track.line),
 531                             GRITS_LEVEL_OVERLAY, FALSE);
 532                 grits_object_queue_draw(GRITS_OBJECT(gps->track.line));
 533         }
 534
 535         if (gps_data_is_valid(gps_data)) {
 536                 if (gps->marker) {
 537                         grits_viewer_remove(gps->viewer,
 538                             GRITS_OBJECT(gps->marker));
 539                         gps->marker = NULL;
 540                 }
 541
 542                 gchar *path = find_path(GPS_MARKER_ICON_PATH, GPS_MARKER_ICON);
 543                 if (path) {
 544                         gps->marker = grits_marker_icon_new("GPS", path,
 545                                       gps_data->fix.track, TRUE, GRITS_MARKER_DMASK_ICON);
 546                         g_free(path);
 547                 } else {
 548                         /* if icon not found just use a point */
 549                         g_warning("Could not find GPS marker icon %s in path %s.",
 550                                   GPS_MARKER_ICON, GPS_MARKER_ICON_PATH);
 551                         gps->marker = grits_marker_icon_new("GPS", NULL,
 552                                       gps_data->fix.track, FALSE,
 553                                       GRITS_MARKER_DMASK_POINT |
 554                                       GRITS_MARKER_DMASK_LABEL);
 555                 }
 556
 557                 GRITS_OBJECT(gps->marker)->center.lat  = gps_data->fix.latitude;
 558                 GRITS_OBJECT(gps->marker)->center.lon  = gps_data->fix.longitude;
 559                 GRITS_OBJECT(gps->marker)->center.elev = 0.0;
 560                 GRITS_OBJECT(gps->marker)->lod         = EARTH_R * 5;
 561                 GRITS_MARKER(gps->marker)->ortho       = FALSE;
 562
 563                 grits_viewer_add(gps->viewer, GRITS_OBJECT(gps->marker),
 564                         GRITS_LEVEL_OVERLAY+1, FALSE);
 565                 grits_object_queue_draw(GRITS_OBJECT(gps->marker));
 566         }
 567
 568         if (gps->follow_gps && gps_data_is_valid(gps_data)) {
 569                 /* Center map at current GPS position. */
 570                 g_debug("GritsPluginGps: redraw_all - centering map at "
 571                         "lat = %f, long = %f, track = %f",
 572                             gps_data->fix.latitude,
 573                             gps_data->fix.longitude,
 574                             gps_data->fix.track);
 575
 576                 double lat, lon, elev;
 577                 grits_viewer_get_location(gps->viewer, &lat, &lon, &elev);
 578                 grits_viewer_set_location(gps->viewer, gps_data->fix.latitude,
 579                                           gps_data->fix.longitude, elev);
 580                 //grits_viewer_set_rotation(gps->viewer, 0, 0, 0);
 581         }
 582
 583         /* reschedule */
 584         return TRUE;
 585 }
 586
 587
 588 /***************
 589  * Config Area *
 590  ***************/
 591
 592 /* GPS Data Frame */
 593 static void gps_init_status_info(GritsPluginGps *gps, GtkWidget *gbox)
 594 {
 595         gps->ui.gps_status_frame = gtk_frame_new("<b>GPS Data</b>");
 596         GtkWidget *label = gtk_frame_get_label_widget(
 597                            GTK_FRAME(gps->ui.gps_status_frame));
 598         gtk_label_set_use_markup(GTK_LABEL(label), TRUE);
 599         gtk_frame_set_shadow_type(GTK_FRAME(gps->ui.gps_status_frame),
 600                            GTK_SHADOW_NONE);
 601         gps->ui.gps_status_table = gtk_table_new(5, 2, TRUE);
 602         gtk_container_add(GTK_CONTAINER(gps->ui.gps_status_frame),
 603                    gps->ui.gps_status_table);
 604
 605         /* gps data table setup */
 606         gint i;
 607         for (i = 0; i < G_N_ELEMENTS(gps_table); i++) {
 608                 gps_table[i].label_widget = gtk_label_new(gps_table[i].label);
 609                 gtk_label_set_justify(GTK_LABEL(gps_table[i].label_widget),
 610                                       GTK_JUSTIFY_LEFT);
 611                 gtk_table_attach(GTK_TABLE(gps->ui.gps_status_table),
 612                                            gps_table[i].label_widget,
 613                                            0, 1, i, i+1, 0, 0, 0, 0);
 614                 gps_table[i].value_widget = gtk_label_new(gps_table[i].initial_val);
 615                 gtk_table_attach( GTK_TABLE(gps->ui.gps_status_table),
 616                                 gps_table[i].value_widget, 1, 2, i, i+1, 0, 0, 0, 0);
 617
 618                 PangoFontDescription *font_desc = pango_font_description_new();
 619                 pango_font_description_set_size(font_desc,
 620                                 gps_table[i].font_size*PANGO_SCALE);
 621                 gtk_widget_modify_font(gps_table[i].label_widget, font_desc);
 622                 gtk_widget_modify_font(gps_table[i].value_widget, font_desc);
 623                 pango_font_description_free(font_desc);
 624         }
 625         gtk_box_pack_start(GTK_BOX(gbox), gps->ui.gps_status_frame,
 626                             TRUE, FALSE, 0);
 627
 628         /* Start UI refresh task, which will reschedule itgps. */
 629         gps_redraw_all(gps);
 630         gps->gps_update_timeout_id = g_timeout_add(
 631                     GPS_UPDATE_INTERVAL*1000,
 632                     gps_redraw_all, gps);
 633
 634 }
 635
 636 /* GPS Control Frame */
 637 static gboolean on_gps_follow_clicked_event(GtkWidget *widget, gpointer user_data)
 638 {
 639         GritsPluginGps *gps = (GritsPluginGps *)user_data;
 640
 641         g_debug("GritsPluginGps: follow_clicked_event - button status %d",
 642                 gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (widget)));
 643         if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (widget))) {
 644                 gps->follow_gps = TRUE;
 645         } else {
 646                 gps->follow_gps = FALSE;
 647         }
 648
 649         return FALSE;
 650 }
 651
 652 static gboolean on_gps_track_enable_clicked_event(GtkWidget *widget, gpointer user_data)
 653 {
 654         GritsPluginGps *gps = (GritsPluginGps *)user_data;
 655
 656         g_debug("GritsPluginGps: track_enable_clicked_event");
 657
 658         if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (widget))) {
 659                 /* start logging trip history */
 660                 GPS_STATUS(gps, "Enabled GPS track.");
 661                 gps->track.active = TRUE;
 662         } else {
 663                 /* stop logging trip history */
 664                 GPS_STATUS(gps, "Disabled GPS track.");
 665                 gps->track.active = FALSE;
 666                 /* advance to the next track group, moving everything down if
 667                  * it's full. */
 668                 gps_track_group_incr(&gps->track);
 669         }
 670
 671         return FALSE;
 672 }
 673
 674 static gboolean on_gps_track_clear_clicked_event(GtkWidget *widget, gpointer user_data)
 675 {
 676         GritsPluginGps *gps = (GritsPluginGps *)user_data;
 677
 678         g_debug("GritsPluginGps: track_clear_clicked_event");
 679         GPS_STATUS(gps, "Cleared GPS track.");
 680         gps_track_clear(&gps->track);
 681
 682         return FALSE;
 683 }
 684
 685 static void gps_init_control_frame(GritsPluginGps *gps, GtkWidget *gbox)
 686 {
 687         /* Control checkboxes */
 688         GtkWidget *gps_control_frame = gtk_frame_new("<b>GPS Control</b>");
 689         GtkWidget *label = gtk_frame_get_label_widget(
 690                            GTK_FRAME(gps_control_frame));
 691         gtk_label_set_use_markup(GTK_LABEL(label), TRUE);
 692         gtk_frame_set_shadow_type(GTK_FRAME(gps_control_frame),
 693                            GTK_SHADOW_NONE);
 694         GtkWidget *cbox = gtk_vbox_new(FALSE, 2);
 695         gtk_container_add(GTK_CONTAINER(gps_control_frame), cbox);
 696         gtk_box_pack_start(GTK_BOX(gbox), gps_control_frame, FALSE, FALSE, 0);
 697
 698         gps->ui.gps_follow_checkbox =
 699                       gtk_check_button_new_with_label("Follow GPS");
 700         g_signal_connect(G_OBJECT(gps->ui.gps_follow_checkbox), "clicked",
 701                       G_CALLBACK(on_gps_follow_clicked_event),
 702                       (gpointer)gps);
 703         gtk_box_pack_start(GTK_BOX(cbox), gps->ui.gps_follow_checkbox,
 704                        FALSE, FALSE, 0);
 705
 706         gps->ui.gps_track_checkbox =
 707                        gtk_check_button_new_with_label("Record Track");
 708         g_signal_connect(G_OBJECT(gps->ui.gps_track_checkbox), "clicked",
 709                        G_CALLBACK(on_gps_track_enable_clicked_event),
 710                        (gpointer)gps);
 711         gtk_box_pack_start(GTK_BOX(cbox), gps->ui.gps_track_checkbox,
 712                        FALSE, FALSE, 0);
 713
 714         gps->ui.gps_clear_button = gtk_button_new_with_label("Clear Track");
 715         g_signal_connect(G_OBJECT(gps->ui.gps_clear_button), "clicked",
 716                       G_CALLBACK(on_gps_track_clear_clicked_event),
 717                       (gpointer)gps);
 718         gtk_box_pack_start(GTK_BOX(cbox), gps->ui.gps_clear_button,
 719                        FALSE, FALSE, 0);
 720 }
 721
 722 /* Track Log Frame */
 723 static gboolean on_gps_log_clicked_event(GtkWidget *widget, gpointer user_data)
 724 {
 725         GritsPluginGps *gps = (GritsPluginGps *)user_data;
 726
 727         g_debug("GritsPluginGps: log_clicked_event");
 728
 729         if (gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON (widget)))  {
 730                 gps_write_log(gps);
 731
 732                 /* Schedule log file write */
 733                 gps->ui.gps_log_timeout_id = g_timeout_add(
 734                       gtk_range_get_value(
 735                         GTK_RANGE(gps->ui.gps_log_interval_slider))*1000,
 736                         gps_write_log, gps);
 737         } else {
 738                 /* button unchecked */
 739                 g_source_remove(gps->ui.gps_log_timeout_id);
 740                 gps->ui.gps_log_timeout_id = 0;
 741                 g_debug("GritsPluginGps: log_clicked_event - closed log file.");
 742         }
 743
 744         return FALSE;
 745 }
 746
 747 static gboolean on_gps_log_interval_changed_event(GtkWidget *widget, gpointer user_data)
 748 {
 749         GritsPluginGps *gps = (GritsPluginGps *)user_data;
 750
 751         g_assert(gps);
 752
 753         g_debug("GritsPluginGps: log_interval_changed_event - value = %f",
 754         gtk_range_get_value(GTK_RANGE(widget)));
 755
 756         if (gtk_toggle_button_get_active(
 757                         GTK_TOGGLE_BUTTON(gps->ui.gps_log_checkbox))) {
 758                 g_assert(gps->ui.gps_log_timeout_id != 0);
 759
 760                 /* disable old timeout */
 761                 g_source_remove(gps->ui.gps_log_timeout_id);
 762                 gps->ui.gps_log_timeout_id = 0;
 763
 764                 /* Schedule new log file write */
 765                 gps->ui.gps_log_timeout_id = g_timeout_add(
 766                          gtk_range_get_value(GTK_RANGE(widget))*1000,
 767                          gps_write_log, gps);
 768                 gps_write_log(gps);
 769         }
 770
 771         return FALSE;
 772 }
 773
 774 static void gps_init_track_log_frame(GritsPluginGps *gps, GtkWidget *gbox)
 775 {
 776         /* Track log box with enable checkbox and filename entry */
 777         GtkWidget *gps_log_frame = gtk_frame_new("<b>Track Log</b>");
 778         GtkWidget *label = gtk_frame_get_label_widget(GTK_FRAME(gps_log_frame));
 779         gtk_label_set_use_markup(GTK_LABEL(label), TRUE);
 780         gtk_frame_set_shadow_type(GTK_FRAME(gps_log_frame), GTK_SHADOW_NONE);
 781         GtkWidget *lbox = gtk_vbox_new(FALSE, 2);
 782         gtk_container_add(GTK_CONTAINER(gps_log_frame), lbox);
 783         gtk_box_pack_start(GTK_BOX(gbox), gps_log_frame,
 784                         FALSE, FALSE, 0);
 785
 786         gps->ui.gps_log_checkbox =
 787                gtk_check_button_new_with_label("Log Position to File");
 788         g_signal_connect(G_OBJECT(gps->ui.gps_log_checkbox), "clicked",
 789                G_CALLBACK(on_gps_log_clicked_event),
 790                (gpointer)gps);
 791         gtk_box_pack_start(GTK_BOX(lbox), gps->ui.gps_log_checkbox,
 792                FALSE, FALSE, 0);
 793
 794         /* Set up filename entry box */
 795         GtkWidget *fbox = gtk_hbox_new(FALSE, 2);
 796         GtkWidget *filename_label = gtk_label_new("Filename:");
 797         gtk_box_pack_start(GTK_BOX(fbox), filename_label, FALSE, FALSE, 0);
 798         gps->ui.gps_log_filename_entry = gtk_entry_new();
 799         gtk_box_pack_start(GTK_BOX(fbox), gps->ui.gps_log_filename_entry,
 800                TRUE, TRUE, 0);
 801         gtk_box_pack_start(GTK_BOX(lbox), fbox, FALSE, FALSE, 0);
 802
 803         /* set up gps log interval slider */
 804         GtkWidget *ubox = gtk_hbox_new(FALSE, 4);
 805         GtkWidget *interval_label = gtk_label_new("Update Interval:");
 806         gtk_box_pack_start(GTK_BOX(ubox), interval_label, FALSE, FALSE, 0);
 807         gps->ui.gps_log_interval_slider =
 808                     gtk_hscale_new_with_range(1.0, 600.0, 30.0);
 809         gtk_range_set_value(GTK_RANGE(gps->ui.gps_log_interval_slider),
 810                     GPS_LOG_DEFAULT_UPDATE_INTERVAL);
 811         g_signal_connect(G_OBJECT(gps->ui.gps_log_interval_slider),
 812                     "value-changed",
 813                     G_CALLBACK(on_gps_log_interval_changed_event),
 814                     (gpointer)gps);
 815         gtk_range_set_increments(
 816                     GTK_RANGE(gps->ui.gps_log_interval_slider),
 817                     10.0 /* step */, 30.0 /* page up/down */);
 818         gtk_range_set_update_policy(
 819                     GTK_RANGE(gps->ui.gps_log_interval_slider),
 820                     GTK_UPDATE_DELAYED);
 821         gtk_box_pack_start(GTK_BOX(ubox), gps->ui.gps_log_interval_slider,
 822                     TRUE, TRUE, 0);
 823         gtk_box_pack_start(GTK_BOX(lbox), ubox, FALSE, FALSE, 0);
 824 }
 825
 826
 827 /*******************
 828  * GPSD interfaces *
 829  *******************/
 830
 831 static void process_gps(gpointer data, gint source, GdkInputCondition condition)
 832 {
 833         struct gps_data_t *gps_data = (struct gps_data_t *)data;
 834
 835         g_debug("GritsPluginGps: process_gps");
 836
 837         /* Process any data from the gps and call the hook function */
 838         if (gps_data != NULL) {
 839                 gint result = gps_read(gps_data);
 840                 g_debug("GritsPluginGps: process_gps - gps_read returned %d, "
 841                         "position %f, %f.", result,
 842                         gps_data->fix.latitude, gps_data->fix.longitude);
 843         } else {
 844                 g_warning("GritsPluginGps: process_gps - gps_data == NULL.");
 845         }
 846 }
 847
 848 static gint initialize_gpsd(char *server, gchar *port, struct gps_data_t *gps_data)
 849 {
 850 #if GPSD_API_MAJOR_VERSION < 5
 851 #error "GPSD protocol version 5 or greater required."
 852 #endif
 853         gint result;
 854
 855         if ((result = gps_open(server, port, gps_data)) != 0) {
 856                 g_warning("Unable to open gpsd connection to %s:%s: %d, %d, %s",
 857                 server, port, result, errno, gps_errstr(errno));
 858         } else {
 859                 (void)gps_stream(gps_data, WATCH_ENABLE|WATCH_JSON, NULL);
 860                 g_debug("GritsPluginGps: initialize_gpsd - gpsd fd %u.",
 861                         gps_data->gps_fd);
 862                 gdk_input_add(gps_data->gps_fd, GDK_INPUT_READ, process_gps, gps_data);
 863         }
 864
 865         return result;
 866 }
 867
 868
 869 /**********************
 870  * GPS Plugin Methods *
 871  **********************/
 872
 873 /* Methods */
 874 GritsPluginGps *grits_plugin_gps_new(GritsViewer *viewer, GritsPrefs *prefs)
 875 {
 876         /* TODO: move to constructor if possible */
 877         g_debug("GritsPluginGps: new");
 878         GritsPluginGps *gps = g_object_new(GRITS_TYPE_PLUGIN_GPS, NULL);
 879         gps->viewer = viewer;
 880         gps->prefs  = prefs;
 881
 882         initialize_gpsd("localhost", DEFAULT_GPSD_PORT, &gps->gps_data);
 883         gps->follow_gps = FALSE;
 884
 885         gps_track_init(&gps->track);
 886         gps_init_status_info(gps, gps->config);
 887         gps_init_control_frame(gps, gps->config);
 888         gps_init_track_log_frame(gps, gps->config);
 889
 890         return gps;
 891 }
 892
 893 static GtkWidget *grits_plugin_gps_get_config(GritsPlugin *_gps)
 894 {
 895         GritsPluginGps *gps = GRITS_PLUGIN_GPS(_gps);
 896         return gps->config;
 897 }
 898
 899 /* GObject code */
 900 static void grits_plugin_gps_plugin_init(GritsPluginInterface *iface);
 901 G_DEFINE_TYPE_WITH_CODE(GritsPluginGps, grits_plugin_gps, G_TYPE_OBJECT,
 902                 G_IMPLEMENT_INTERFACE(GRITS_TYPE_PLUGIN,
 903                         grits_plugin_gps_plugin_init));
 904
 905 static void grits_plugin_gps_plugin_init(GritsPluginInterface *iface)
 906 {
 907         g_debug("GritsPluginGps: plugin_init");
 908         /* Add methods to the interface */
 909         iface->get_config = grits_plugin_gps_get_config;
 910 }
 911
 912 static void grits_plugin_gps_init(GritsPluginGps *gps)
 913 {
 914         g_debug("GritsPluginGps: gps_init");
 915
 916         gps->config     = gtk_hbox_new(FALSE, 15);
 917 }
 918
 919 static void grits_plugin_gps_dispose(GObject *gobject)
 920 {
 921         GritsPluginGps *gps = GRITS_PLUGIN_GPS(gobject);
 922
 923         g_debug("GritsPluginGps: dispose");
 924
 925         if (gps->viewer) {
 926                 if (gps->marker) {
 927                         grits_viewer_remove(gps->viewer,
 928                                GRITS_OBJECT(gps->marker));
 929                 }
 930                 g_object_unref(gps->viewer);
 931                 gps->viewer = NULL;
 932         }
 933
 934         gps_track_free(&gps->track);
 935
 936         /* Drop references */
 937         G_OBJECT_CLASS(grits_plugin_gps_parent_class)->dispose(gobject);
 938 }
 939
 940 static void grits_plugin_gps_finalize(GObject *gobject)
 941 {
 942         GritsPluginGps *gps = GRITS_PLUGIN_GPS(gobject);
 943
 944         g_debug("GritsPluginGps: finalize");
 945
 946         /* Free data */
 947         gtk_widget_destroy(gps->config);
 948         G_OBJECT_CLASS(grits_plugin_gps_parent_class)->finalize(gobject);
 949 }
 950
 951 static void grits_plugin_gps_class_init(GritsPluginGpsClass *klass)
 952 {
 953         g_debug("GritsPluginGps: class_init");
 954         GObjectClass *gobject_class = (GObjectClass*)klass;
 955         gobject_class->dispose  = grits_plugin_gps_dispose;
 956         gobject_class->finalize = grits_plugin_gps_finalize;
 957 }