Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
Go to the source code of this file.
Functions | |
le_msg_ServiceRef_t | taf_locPos_GetServiceRef (void) |
le_msg_SessionRef_t | taf_locPos_GetClientSessionRef (void) |
void | taf_locPos_AdvertiseService (void) |
taf_locPos_MovementHandlerRef_t | taf_locPos_AddMovementHandler (uint32_t horizontalMagnitude, uint32_t verticalMagnitude, taf_locPos_MovementHandlerFunc_t handlerPtr, void *contextPtr) |
void | taf_locPos_RemoveMovementHandler (taf_locPos_MovementHandlerRef_t handlerRef) |
le_result_t | taf_locPos_Get2DLocation (int32_t *latitudePtr, int32_t *longitudePtr, int32_t *hAccuracyPtr) |
le_result_t | taf_locPos_GetDate (uint16_t *yearPtr, uint16_t *monthPtr, uint16_t *dayPtr) |
le_result_t | taf_locPos_GetFixState (taf_locGnss_FixState_t *statePtr) |
le_result_t | taf_locPos_GetMotion (uint32_t *hSpeedPtr, uint32_t *hSpeedAccuracyPtr, int32_t *vSpeedPtr, int32_t *vSpeedAccuracyPtr) |
le_result_t | taf_locPos_GetDirection (uint32_t *directionPtr, uint32_t *directionAccuracyPtr) |
le_result_t | taf_locPos_GetTime (uint16_t *hoursPtr, uint16_t *minutesPtr, uint16_t *secondsPtr, uint16_t *millisecondsPtr) |
le_result_t | taf_locPos_SetAcquisitionRate (uint32_t acquisitionRate) |
uint32_t | taf_locPos_GetAcquisitionRate (void) |
void | taf_locPos_sample_Release (taf_locPos_SampleRef_t positionSampleRef) |
le_result_t | taf_locPos_Get3DLocation (int32_t *latitudePtr, int32_t *longitudePtr, int32_t *hAccuracyPtr, int32_t *altitudePtr, int32_t *vAccuracyPtr) |
le_result_t | taf_locPos_sample_Get2DLocation (taf_locPos_SampleRef_t positionSampleRef, int32_t *latitudePtr, int32_t *longitudePtr, int32_t *horizontalAccuracyPtr) |
le_result_t | taf_locPos_sample_GetAltitude (taf_locPos_SampleRef_t positionSampleRef, int32_t *altitudePtr, int32_t *altitudeAccuracyPtr) |
le_result_t | taf_locPos_sample_GetTime (taf_locPos_SampleRef_t positionSampleRef, uint16_t *hoursPtr, uint16_t *minutesPtr, uint16_t *secondsPtr, uint16_t *millisecondsPtr) |
le_result_t | taf_locPos_sample_GetHorizontalSpeed (taf_locPos_SampleRef_t positionSampleRef, uint32_t *hSpeedPtr, uint32_t *hSpeedAccuracyPtr) |
le_result_t | taf_locPos_sample_GetDirection (taf_locPos_SampleRef_t positionSampleRef, uint32_t *directionPtr, uint32_t *directionAccuracyPtr) |
le_result_t | taf_locPos_sample_GetVerticalSpeed (taf_locPos_SampleRef_t positionSampleRef, int32_t *vspeedPtr, int32_t *vspeedAccuracyPtr) |
le_result_t | taf_locPos_SetDistanceResolution (taf_locPos_Resolution_t resolution) |
le_result_t | taf_locPos_sample_GetFixState (taf_locPos_SampleRef_t positionSampleRef, taf_locGnss_FixState_t *statePtr) |
le_result_t | taf_locPos_sample_GetDate (taf_locPos_SampleRef_t positionSampleRef, uint16_t *yearPtr, uint16_t *monthPtr, uint16_t *dayPtr) |
le_msg_ServiceRef_t taf_locPos_GetServiceRef | ( | void | ) |
Get the server service reference
le_msg_SessionRef_t taf_locPos_GetClientSessionRef | ( | void | ) |
Get the client session reference for the current message
void taf_locPos_AdvertiseService | ( | void | ) |
Initialize the server and advertise the service.
taf_locPos_MovementHandlerRef_t taf_locPos_AddMovementHandler | ( | uint32_t | horizontalMagnitude, |
uint32_t | verticalMagnitude, | ||
taf_locPos_MovementHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Position sample reference type. Handler for movement changes that returns the reference of a reported position sample. Reference type used by Add/Remove functions for EVENT 'taf_locPos_Movement' Resolution values. Add handler function for EVENT 'taf_locPos_Movement'
This event provides information on movement changes.
Add handler function for EVENT 'taf_locPos_Movement'
This event provides information on movement changes.
[in] | horizontalMagnitude | Horizontal magnitude in meters. |
[in] | verticalMagnitude | Vertical magnitude in meters. |
[in] | handlerPtr | |
[in] | contextPtr |
void taf_locPos_RemoveMovementHandler | ( | taf_locPos_MovementHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_locPos_Movement'
[in] | handlerRef |
le_result_t taf_locPos_Get2DLocation | ( | int32_t * | latitudePtr, |
int32_t * | longitudePtr, | ||
int32_t * | hAccuracyPtr | ||
) |
Gets the 2D location data (latitude, longitude, horizontal accuracy).
[out] | latitudePtr | WGS84 latitude in degrees. |
[out] | longitudePtr | WGS84 longitude in degrees. |
[out] | hAccuracyPtr | Horizontal accuracy in meters by default. |
le_result_t taf_locPos_GetDate | ( | uint16_t * | yearPtr, |
uint16_t * | monthPtr, | ||
uint16_t * | dayPtr | ||
) |
Gets the date of the last updated location.
[out] | yearPtr | UTC Year A.D., e.g. 2014. |
[out] | monthPtr | UTC Month into the year; range is 1 to 12. |
[out] | dayPtr | UTC Days into the month; range is 1 to 31. |
le_result_t taf_locPos_GetFixState | ( | taf_locGnss_FixState_t * | statePtr | ) |
Gets the position fix state.
[out] | statePtr | Position fix state. |
le_result_t taf_locPos_GetMotion | ( | uint32_t * | hSpeedPtr, |
uint32_t * | hSpeedAccuracyPtr, | ||
int32_t * | vSpeedPtr, | ||
int32_t * | vSpeedAccuracyPtr | ||
) |
Gets the motion data (horizontal speed, horizontal speed accuracy, vertical speed, and vertical speed accuracy).
[out] | hSpeedPtr | Horizontal speed in m/sec. |
[out] | hSpeedAccuracyPtr | Horizontal speed accuracy in m/sec. |
[out] | vSpeedPtr | Vertical speed in m/sec. |
[out] | vSpeedAccuracyPtr | Vertical speed accuracy in m/sec. |
le_result_t taf_locPos_GetDirection | ( | uint32_t * | directionPtr, |
uint32_t * | directionAccuracyPtr | ||
) |
Gets the position sample's direction. Direction of movement is the direction that the vehicle or person is actually moving.
[out] | directionPtr | Direction indication in degrees; range is 0 to 359. |
[out] | directionAccuracyPtr | Direction's accuracy estimation in degrees. |
le_result_t taf_locPos_GetTime | ( | uint16_t * | hoursPtr, |
uint16_t * | minutesPtr, | ||
uint16_t * | secondsPtr, | ||
uint16_t * | millisecondsPtr | ||
) |
Gets the position sample's time.
[out] | hoursPtr | UTC Hours of the day; range is 0 to 23. |
[out] | minutesPtr | UTC Minutes of the hour; range is 0 to 59. |
[out] | secondsPtr | UTC Seconds of the minute; range is 0 to 59. |
[out] | millisecondsPtr | UTC Milliseconds of the second; range is 0 to 999. |
le_result_t taf_locPos_SetAcquisitionRate | ( | uint32_t | acquisitionRate | ) |
Sets the acquisition rate.
[in] | acquisitionRate | Acquisition Rate in milliseconds. |
uint32_t taf_locPos_GetAcquisitionRate | ( | void | ) |
Retrieves the acquisition rate in milliseconds.
void taf_locPos_sample_Release | ( | taf_locPos_SampleRef_t | positionSampleRef | ) |
Releases the position sample.
[in] | positionSampleRef | Position sample reference. |
le_result_t taf_locPos_Get3DLocation | ( | int32_t * | latitudePtr, |
int32_t * | longitudePtr, | ||
int32_t * | hAccuracyPtr, | ||
int32_t * | altitudePtr, | ||
int32_t * | vAccuracyPtr | ||
) |
Gets the 3D location data (latitude, longitude, altitude, horizontal accuracy, vertical accuracy)
[out] | latitudePtr | WGS84 Latitude in degrees. |
[out] | longitudePtr | WGS84 Longitude in degrees. |
[out] | hAccuracyPtr | Horizontal accuracy in meters by default. |
[out] | altitudePtr | Altitude above mean sea level in meters by default. |
[out] | vAccuracyPtr | Vertical accuracy in meters by default. |
le_result_t taf_locPos_sample_Get2DLocation | ( | taf_locPos_SampleRef_t | positionSampleRef, |
int32_t * | latitudePtr, | ||
int32_t * | longitudePtr, | ||
int32_t * | horizontalAccuracyPtr | ||
) |
Gets the position sample's 2D location (latitude, longitude, horizontal accuracy)
[in] | positionSampleRef | Position sample reference. |
[out] | latitudePtr | WGS84 latitude in degrees. |
[out] | longitudePtr | WGS84 longitude in degrees. |
[out] | horizontalAccuracyPtr | Horizontal accuracy in meters by default. |
le_result_t taf_locPos_sample_GetAltitude | ( | taf_locPos_SampleRef_t | positionSampleRef, |
int32_t * | altitudePtr, | ||
int32_t * | altitudeAccuracyPtr | ||
) |
Gets the position sample's altitude.
[in] | positionSampleRef | Position sample reference. |
[out] | altitudePtr | Altitude above mean sea level in meters by default. |
[out] | altitudeAccuracyPtr | Vertical accuracy in meters by default. |
le_result_t taf_locPos_sample_GetTime | ( | taf_locPos_SampleRef_t | positionSampleRef, |
uint16_t * | hoursPtr, | ||
uint16_t * | minutesPtr, | ||
uint16_t * | secondsPtr, | ||
uint16_t * | millisecondsPtr | ||
) |
Gets the position sample's time.
[in] | positionSampleRef | Position sample reference. |
[out] | hoursPtr | UTC hours of the day; range is 0 to 23. |
[out] | minutesPtr | UTC minutes of the hour; range is 0 to 59. |
[out] | secondsPtr | UTC seconds of the minute; range is 0 to 59. |
[out] | millisecondsPtr | UTC milliseconds of the second; range is 0 to 999. |
le_result_t taf_locPos_sample_GetHorizontalSpeed | ( | taf_locPos_SampleRef_t | positionSampleRef, |
uint32_t * | hSpeedPtr, | ||
uint32_t * | hSpeedAccuracyPtr | ||
) |
Gets the position sample's horizontal speed.
[in] | positionSampleRef | Position sample reference. |
[out] | hSpeedPtr | The horizontal speed in m/sec. |
[out] | hSpeedAccuracyPtr | The horizontal accuracy in m/sec. |
le_result_t taf_locPos_sample_GetDirection | ( | taf_locPos_SampleRef_t | positionSampleRef, |
uint32_t * | directionPtr, | ||
uint32_t * | directionAccuracyPtr | ||
) |
Get the position sample's direction
[in] | positionSampleRef | Position sample reference. |
[out] | directionPtr | Direction indication in degrees. |
[out] | directionAccuracyPtr | Direction's accuracy estimation in degrees. |
le_result_t taf_locPos_sample_GetVerticalSpeed | ( | taf_locPos_SampleRef_t | positionSampleRef, |
int32_t * | vspeedPtr, | ||
int32_t * | vspeedAccuracyPtr | ||
) |
Gets the position sample's vertical speed.
[in] | positionSampleRef | Position sample reference |
[out] | vspeedPtr | The vertical speed in m/sec. |
[out] | vspeedAccuracyPtr | The vertical speed's accuracy in m/sec. |
le_result_t taf_locPos_SetDistanceResolution | ( | taf_locPos_Resolution_t | resolution | ) |
Sets the resolution for the positioning distance values.
[in] | resolution | Resolution. |
le_result_t taf_locPos_sample_GetFixState | ( | taf_locPos_SampleRef_t | positionSampleRef, |
taf_locGnss_FixState_t * | statePtr | ||
) |
Gets the position sample's fix state.
[in] | positionSampleRef | Position sample reference. |
[out] | statePtr | Position fix state. |
le_result_t taf_locPos_sample_GetDate | ( | taf_locPos_SampleRef_t | positionSampleRef, |
uint16_t * | yearPtr, | ||
uint16_t * | monthPtr, | ||
uint16_t * | dayPtr | ||
) |
Gets the position sample date.
[in] | positionSampleRef | Position sample reference. |
[out] | yearPtr | UTC year |
[out] | monthPtr | UTC month of the year; range is 1 to 12. |
[out] | dayPtr | UTC day of the month; range is 1 to 31. |