Qualcomm Technologies International, Ltd. / CsrLocation

Dependents:   CsrLocationDemo CsrLocationDemo

Fork of CsrLocation by jie zhao

Embed: (wiki syntax)

« Back to documentation index

CSRLocation Class Reference

CSRLocation Class Reference

CSRLocation class. More...

#include <CsrLocation.h>

Public Member Functions

 CSRLocation (RawSerial &serialLoc, DigitalOut &pinOnoff, DigitalOut &pinReset, DigitalIn &wakeup, Serial *debugP=NULL)
 Constructor: CsrLocation Create the CSRLocation, accept specified configuration.
virtual ~CSRLocation ()
 Destructor: CSRLocation Free allocated resource.
void CsrLocRegOutput (csr_app_output_callback app_output_cb, csr_app_event_callback app_event_cb)
 Register output callback and event callback functions.
virtual void reset (void)
 HW reset to get location chip into hibernation mode.

Detailed Description

CSRLocation class.

A location interface to control location chip and get position and satellite information.

Definition at line 287 of file CsrLocation.h.


Constructor & Destructor Documentation

CSRLocation ( RawSerial &  serialLoc,
DigitalOut &  pinOnoff,
DigitalOut &  pinReset,
DigitalIn &  wakeup,
Serial *  debugP = NULL 
)

Constructor: CsrLocation Create the CSRLocation, accept specified configuration.

Parameters:
[in]pSerialLocserial communication channel between host and GPS controller.
[in]pPinOnoffGPIO pin to control location chip on, a rising edge is used to activate location chip. Please note, before activate chip, reset pin should be pull high.
[in]pPinResetGPIO pin to control location chip reset, low level will keep location chip in hibernation state and high level will permit location chip to be activated.
[in]pWakeupGPIO pin to detect if the chip is still wakeup.
[in]pLocConfigConfiguration including debug serial port, location communication serial port, onoff pin, reset pin
[in]debugPThe debug port for diagnostic messages; can be NULL.

Definition at line 19 of file CsrLocation.cpp.

~CSRLocation ( void   ) [virtual]

Destructor: CSRLocation Free allocated resource.

Definition at line 54 of file CsrLocation.cpp.


Member Function Documentation

void CsrLocRegOutput ( csr_app_output_callback  app_output_cb,
csr_app_event_callback  app_event_cb 
)

Register output callback and event callback functions.

Parameters:
app_output_cbCSRLocation class output the location and satellite information to application
app_event_cbCSRLocation class output the start and stop result to application

Definition at line 66 of file CsrLocation.cpp.

void reset ( void   ) [virtual]

HW reset to get location chip into hibernation mode.

Definition at line 119 of file CsrLocation.cpp.