gpsserial2.h

/*
    This file is part of Kismet

    Kismet is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    Kismet is distributed in the hope that it will be useful,
      but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Kismet; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef __GPSSERIAL_V2_H__
#define __GPSSERIAL_V2_H__

#include "config.h"

#include "kis_gps.h"
#include "timetracker.h"
#include "buffer_handler.h"
#include "ringbuf2.h"
#include "globalregistry.h"
#include "serialclient2.h"
#include "pollabletracker.h"

// New serial GPS code
//
// This code replaces gpsserial with a new gps driver based on
// a ringbuffer interface, serialclientv2, and new kis_gps interface.

class GPSSerialV2 : public KisGps, public BufferInterface {
public:
    GPSSerialV2(GlobalRegistry *in_globalreg, SharedGpsBuilder in_builder);
    virtual ~GPSSerialV2();

    // BufferInterface API
    virtual void BufferAvailable(size_t in_amt);
    virtual void BufferError(string error);

    virtual bool open_gps(string in_opts);

    virtual bool get_location_valid();

    virtual bool get_device_connected();

protected:
    time_t error_reconnect_timer;

    shared_ptr<PollableTracker> pollabletracker;
    
    shared_ptr<SerialClientV2> serialclient;
    BufferHandler<RingbufV2> *serialhandler;

    // Device
    string serial_device;
    unsigned int baud;

    // Have we ever seen data from the device?
    bool ever_seen_gps;

    // Last time we calculated the heading, don't do it more than once every 
    // few seconds or we get nasty noise
    time_t last_heading_time;

    // Decaying reconnection algorithm
    int reconnect_tid;
    int num_reconnects;
    static int time_event_reconnect(TIMEEVENT_PARMS);
};

class GPSSerialV2Builder : public KisGpsBuilder {
public:
    GPSSerialV2Builder(GlobalRegistry *in_globalreg) : 
        KisGpsBuilder(in_globalreg, 0) { 
        initialize();
    }

    virtual void initialize() {
        set_int_gps_class("serial");
        set_int_gps_class_description("serial-attached NMEA gps (includes USB GPS)");
        set_int_gps_priority(-1000);
        set_int_default_name("serial");
        set_int_singleton(false);
    }

    virtual SharedGps build_gps(SharedGpsBuilder in_builder) {
        return SharedGps(new GPSSerialV2(globalreg, in_builder));
    }
};


#endif