IPC Module - Location Service

This page contains documentation of the Location API.

Messages

message location_request_req
Parameters:

user (string) – User identifier, max 15 characters long.

Return message:

location_request_rsp

Request the location service to be on.

It is on if one or more users requests it. user is the requesters system wide unique name.

message location_request_rsp
Parameters:

result (enum location_result) – Result of the operation

Location request response.

message location_release_req_norsp
Parameters:

user (string) – User identifier, max 15 characters long.

Release any requested location service for given user user.

message location_publish_ind
Parameters:

  • latitude (int32) – Latitude in degrees * 10^6. Example 1: 59293555 => 59.293555 degrees Example 2: -22973457 => -22.973457 degrees

  • longitude (int32) – Longitude in degrees * 10^6. Example 1: 18083011 => 18.083011 degrees Example 2: -43185185 => -43.185185 degrees

  • altitude (int32) – Altitude in decimeter.

  • bearing (int32) – Track angle in degrees * 10. This is the “Track angle in degrees” field in the NMEA 0183 RMC sentence. Example: 844 => 84.4 degrees

  • time (uint32) – Time in seconds since Epoch (January 1, 1970).

This message contains the latest known location data.

It is published periodically if any user has requested the location service. It is also possible to get the raw NMEA sentences by connecting to IP: 198.18.2.1, tcp-port: 1001. The NMEA stream can be used as input for gpsd.

message location_subscribe_req

Subscribe to location_publish_ind messages

message location_subscribe_rsp
Parameters:

result (enum ipc_subscribe_result)

Result from location_subscribe_req

message location_unsubscribe_req_norsp

Unsubscribe from location_publish_ind messages

message location_trigger_gnss_cold_start_req
Return message:

location_trigger_gnss_cold_start_rsp

Trigger gnss cold start request.

Stops gnss engine, clears gnss data and restarts gnss engine if location is requested

message location_trigger_gnss_cold_start_rsp
Parameters:

result (enum location_result) – Result of the operation

Trigger gnss cold start response.

Enums

enum location_result

Location result

Constant

Value

Description

OK

0

OK

ERROR

1

Error

ERROR_NAD_IS_BOOTING

2

Deprecated - can’t occur