ST / GPS_Provider

An extension of original API for working with GPS devices.

Dependents:   A_TeseoLocationNEW A_TeseoLocation TeseoLocation

GPS_Provider Library

A controller-neutral API for working with GPS devices.

Overview

This library is an extension of the original API published on os.mbed.com

Besides the basic geo-location functionality, this extended API includes the following features:

  • Geofencing
  • Odometer
  • Datalogging

Getting started

This GPS API is meant to be used for building projects on os.mbed.com

A good starting point is this page:

TeseoLocation

Diff: GPSProvider/GPSDatalog.h

Revision:
3:ccd86d6bd3bc
Parent:
0:0a9c622571d7
--- a/GPSProvider/GPSDatalog.h	Mon Nov 12 12:56:51 2018 +0000
+++ b/GPSProvider/GPSDatalog.h	Thu Feb 14 11:07:42 2019 +0000
@@ -38,6 +38,11 @@
 #ifndef __GPS_DATALOG_H__
 #define __GPS_DATALOG_H__
 
+/**
+ * For more information about DataLogging, please refer to
+ * Teseo LIV-3F UM available at st.com
+ */
+
 class GPSDatalog {
 public:
     
@@ -58,21 +63,46 @@
         _logMask(logMask) {
     }
 
+    /**
+     * Helper method to know if the datalogging subsystem
+     * can raise an alarm in case of buffer full.
+     */
     bool getEnableBufferFullAlarm(void) const {
       return _enableBufferFullAlarm;
     }
+
+    /**
+     * Helper method to know if the datalogging subsystem
+     * supports circular buffer.
+     */
     bool getEnableCircularBuffer(void) const {
       return _enableCircularBuffer;
     }
+
+    /**
+     * Return the rate to record a new entry.
+     */
     unsigned getMinRate(void) const {
       return _minRate;
     }
+
+    /**
+     * Return the speed threshold to log a data.
+     */
     unsigned getMinSpeed(void) const {
       return _minSpeed;
     }
+
+    /**
+     * Return the minimal speed to log a data.
+     */
     unsigned getMinPosition(void) const {
       return _minPosition;
     }
+
+    /**
+     * Return the mask indicating the data to be logged.
+     */
     int getLogMask(void) const {
       return _logMask;
     }