Protocols and types related to GNSS locations.
PROTOCOLS
Device
Defined in fuchsia.hardware.gnss/gnss_device.fidl
Device protocol used to connect to a GPS device.
The GNSS (Global Navigation Satellite System) interface provides access to location data obtained from GNSS receivers.
Disable
Disable GNSS device and reset to initial status. Clears any cached fix available Calling this while GNSS device already enabled is a no-op.
Errors
Returns INTERNAL_ERROR incase of any driver issue.
Request
<EMPTY>
Response
| Name | Type |
|---|---|
payload |
Device_Disable_Result
|
Enable
Enable GNSS device and reset to initial status. Calling this while GNSS device already enabled is a no-op.
Errors
Returns MODEM_OFFLINE if modem is offline. Returns INTERNAL_ERROR incase of any other driver issue.
Request
<EMPTY>
Response
| Name | Type |
|---|---|
payload |
Device_Enable_Result
|
GetLastFix
Return location obtained in the most recent successful session.
Errors
Returns GNSS_DISABLED if GNSS is disabled.
Returns NO_FIX_AVAILABLE if no fix is available.
Request
<EMPTY>
Response
| Name | Type |
|---|---|
payload |
Device_GetLastFix_Result
|
GetSingleShotFix
Get a single shot time-limited position fix with a specified accuracy.
Errors
Returns GNSS_DISABLED if GNSS is disabled.
Returns MISSING_PARAMETERS if all required fix parameters
are not provided in the request.
Returns TIMEOUT if time out occurred before obtaining a location
of desired accuracy.
Returns ACTIVE_SESSION_ONGOING if an active session is ongoing.
Returns INTERNAL_ERROR incase of any other driver issue.
Request
| Name | Type |
|---|---|
params |
fuchsia.gnss.types/FixParams
|
Response
| Name | Type |
|---|---|
payload |
Device_GetSingleShotFix_Result
|
STRUCTS
Device_Disable_Response
Defined in fuchsia.hardware.gnss/gnss_device.fidl
<EMPTY>
Device_Enable_Response
Defined in fuchsia.hardware.gnss/gnss_device.fidl
<EMPTY>
Device_GetLastFix_Response
Defined in fuchsia.hardware.gnss/gnss_device.fidl
| Field | Type | Description | Default |
|---|---|---|---|
location |
fuchsia.gnss.types/Location
|
GNSS location |
No default |
Device_GetSingleShotFix_Response
Defined in fuchsia.hardware.gnss/gnss_device.fidl
| Field | Type | Description | Default |
|---|---|---|---|
location |
fuchsia.gnss.types/Location
|
GNSS location |
No default |
ENUMS
Error flexible
Type: uint32
Defined in fuchsia.hardware.gnss/gnss_device.fidl
Errors returned in case of failures.
| Name | Value | Description |
|---|---|---|
MODEM_OFFLINE |
1 |
Modem is offline. |
GNSS_DISABLED |
2 |
GNSS is disabled. |
TIMEOUT |
3 |
Timeout occurred while waiting for an action. |
NO_FIX_AVAILABLE |
4 |
No cached fix available. |
INTERNAL_ERROR |
5 |
Failed due to driver issue, |
ACTIVE_SESSION_ONGOING |
6 |
Active location session is ongoing. |
MISSING_PARAMETERS |
7 |
All required parameters are not available. |
UNIONS
Device_Disable_Result strict
Defined in fuchsia.hardware.gnss/gnss_device.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
Device_Disable_Response
|
|
2 |
err |
Error
|
|
3 |
framework_err |
internal
|
Device_Enable_Result strict
Defined in fuchsia.hardware.gnss/gnss_device.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
Device_Enable_Response
|
|
2 |
err |
Error
|
|
3 |
framework_err |
internal
|
Device_GetLastFix_Result strict
Defined in fuchsia.hardware.gnss/gnss_device.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
Device_GetLastFix_Response
|
|
2 |
err |
Error
|
|
3 |
framework_err |
internal
|
Device_GetSingleShotFix_Result strict
Defined in fuchsia.hardware.gnss/gnss_device.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
Device_GetSingleShotFix_Response
|
|
2 |
err |
Error
|
|
3 |
framework_err |
internal
|
SERVICES
Service
Defined in fuchsia.hardware.gnss/gnss_device.fidl
| Name | Type | Transport |
|---|---|---|
| device |
fuchsia.hardware.gnss/Device
|
Channel |