Firmware SDK
twr_module_gps

Driver for HARDWARIO GPS Module. More...

Typedefs

typedef twr_sam_m8q_time_t twr_module_gps_time_t
 Time data structure.
 
typedef twr_sam_m8q_position_t twr_module_gps_position_t
 Position data structure.
 
typedef twr_sam_m8q_altitude_t twr_module_gps_altitude_t
 Altitude data structure.
 
typedef twr_sam_m8q_quality_t twr_module_gps_quality_t
 Quality data structure.
 
typedef twr_sam_m8q_accuracy_t twr_module_gps_accuracy_t
 Accuracy data structure.
 

Enumerations

enum  twr_module_gps_event_t {
  TWR_MODULE_GPS_EVENT_ERROR = 0,
  TWR_MODULE_GPS_EVENT_START = 1,
  TWR_MODULE_GPS_EVENT_UPDATE = 2,
  TWR_MODULE_GPS_EVENT_STOP = 3
}
 Callback events. More...
 
enum  twr_module_gps_led_t {
  TWR_MODULE_GPS_LED_RED = 0,
  TWR_MODULE_GPS_LED_GREEN = 1
}
 Virtual LED channels. More...
 

Functions

bool twr_module_gps_init (void)
 Initialize HARDWARIO GPS Module. More...
 
void twr_module_gps_set_event_handler (twr_module_gps_event_handler_t event_handler, void *event_param)
 Set callback function. More...
 
void twr_module_gps_start (void)
 Start tracking.
 
void twr_module_gps_stop (void)
 Stop tracking.
 
void twr_module_gps_invalidate (void)
 Invalidate navigation data.
 
bool twr_module_gps_get_time (twr_module_gps_time_t *time)
 Get time. More...
 
bool twr_module_gps_get_position (twr_module_gps_position_t *position)
 Get position. More...
 
bool twr_module_gps_get_altitude (twr_module_gps_altitude_t *altitude)
 Get altitude. More...
 
bool twr_module_gps_get_quality (twr_module_gps_quality_t *quality)
 Get quality. More...
 
bool twr_module_gps_get_accuracy (twr_module_gps_accuracy_t *accuracy)
 Get accuracy. More...
 
const twr_led_driver_ttwr_module_gps_get_led_driver (void)
 Get LED driver. More...
 

Detailed Description

Driver for HARDWARIO GPS Module.

Enumeration Type Documentation

◆ twr_module_gps_event_t

Callback events.

Enumerator
TWR_MODULE_GPS_EVENT_ERROR 

Error event.

TWR_MODULE_GPS_EVENT_START 

Start event.

TWR_MODULE_GPS_EVENT_UPDATE 

Update event.

TWR_MODULE_GPS_EVENT_STOP 

Stop event.

Definition at line 13 of file twr_module_gps.h.

◆ twr_module_gps_led_t

Virtual LED channels.

Enumerator
TWR_MODULE_GPS_LED_RED 

LCD red LED channel.

TWR_MODULE_GPS_LED_GREEN 

LCD green LED channel.

Definition at line 31 of file twr_module_gps.h.

Function Documentation

◆ twr_module_gps_get_accuracy()

bool twr_module_gps_get_accuracy ( twr_module_gps_accuracy_t accuracy)

Get accuracy.

Parameters
[out]accuracyAccuracy data structure
Returns
true On success
false On failure

Definition at line 101 of file twr_module_gps.c.

Here is the call graph for this function:

◆ twr_module_gps_get_altitude()

bool twr_module_gps_get_altitude ( twr_module_gps_altitude_t altitude)

Get altitude.

Parameters
[out]altitudeAltitude data structure
Returns
true On success
false On failure

Definition at line 91 of file twr_module_gps.c.

Here is the call graph for this function:

◆ twr_module_gps_get_led_driver()

const twr_led_driver_t* twr_module_gps_get_led_driver ( void  )

Get LED driver.

Returns
Driver for on-board LED

Definition at line 106 of file twr_module_gps.c.

Here is the call graph for this function:

◆ twr_module_gps_get_position()

bool twr_module_gps_get_position ( twr_module_gps_position_t position)

Get position.

Parameters
[out]positionPosition data structure
Returns
true On success
false On failure

Definition at line 86 of file twr_module_gps.c.

Here is the call graph for this function:

◆ twr_module_gps_get_quality()

bool twr_module_gps_get_quality ( twr_module_gps_quality_t quality)

Get quality.

Parameters
[out]qualityQuality data structure
Returns
true On success
false On failure

Definition at line 96 of file twr_module_gps.c.

Here is the call graph for this function:

◆ twr_module_gps_get_time()

bool twr_module_gps_get_time ( twr_module_gps_time_t time)

Get time.

Parameters
[out]timeTime data structure
Returns
true On success
false On failure

Definition at line 81 of file twr_module_gps.c.

Here is the call graph for this function:

◆ twr_module_gps_init()

bool twr_module_gps_init ( void  )

Initialize HARDWARIO GPS Module.

Returns
true On success
false On failure

Definition at line 27 of file twr_module_gps.c.

Here is the call graph for this function:

◆ twr_module_gps_set_event_handler()

void twr_module_gps_set_event_handler ( twr_module_gps_event_handler_t  event_handler,
void *  event_param 
)

Set callback function.

Parameters
[in]event_handlerFunction address
[in]event_paramOptional event parameter (can be NULL)

Definition at line 60 of file twr_module_gps.c.