1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
/**************************************************************************
* @licence app begin@
*
* SPDX-License-Identifier: MPL-2.0
*
* \ingroup GNSSService
* \brief Compliance Level: Abstract Component
* \copyright Copyright (C) 2012, BMW Car IT GmbH, Continental Automotive GmbH, PCA Peugeot Citroën, XS Embedded GmbH
*
* \license
* This Source Code Form is subject to the terms of the
* Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with
* this file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* @licence end@
**************************************************************************/
#ifndef INCLUDE_GENIVI_GNSS_STATUS
#define INCLUDE_GENIVI_GNSS_STATUS
#ifdef __cplusplus
extern "C" {
#endif
/**
* Enumeration to describe the status of the GNSS receiver
*/
typedef enum {
GNSS_STATUS_NOTAVAILABLE = 0, /**< GNSS is not available at all, based on configuration data. */
GNSS_STATUS_INITIALIZING = 1, /**< Initial status when the connection to the GNSS is set up for the first time. */
GNSS_STATUS_AVAILABLE = 2, /**< GNSS is available and running as expected. */
GNSS_STATUS_RESTARTING = 3, /**< GNSS is restarted, i.e. due to communication loss. */
GNSS_STATUS_FAILURE = 4, /**< GNSS is not operating properly. Restarting did not help. */
GNSS_STATUS_OUTOFSERVICE = 5 /**< GNSS is temporarily not available, due to some known external condition, e.g. switch off for antenna supervision. */
} EGNSSStatus;
/**
* TGNSSStatus::validityBits provides information about the currently valid signals of the GNSS status struct.
* It is a or'ed bitmask of the EGNSSStatusValidityBits values.
*/
typedef enum {
GNSSSTATUS_STATUS_VALID = 0x00000001 /**< Validity bit for field TGNSSStatus::status. */
} EGNSSStatusValidityBits;
/**
* Container for GNSS status information
*/
typedef struct {
uint64_t timestamp; /**< Timestamp of the GNSS status transition [ms].
All sensor/GNSS timestamps must be based on the same time source. */
EGNSSStatus status; /**< Status of the GNSS receiver */
uint32_t validityBits; /**< Bit mask indicating the validity of each corresponding value.
[bitwise or'ed @ref EGNSSStatusValidityBits values].
Must be checked before usage. */
} TGNSSStatus;
/**
* Callback type for gnss status.
* Use this type of callback if you want to register for gnss status updates data.
* @param status the gnss status
*/
typedef void (*GNSSStatusCallback)(const TGNSSStatus *status);
/**
* Method to get the gyroscope status at a specific point in time.
* @param status After calling the method the current gyroscope status is written into status
* @return Is true if data can be provided and false otherwise, e.g. missing initialization
*/
bool gnssGetStatus(TGNSSStatus* status);
/**
* Register gnss status callback.
* This is the recommended method for continuously monitoring the gyroscope status.
* The callback will be invoked when new gyroscope status data is available.
* @param callback The callback which should be registered.
* @return True if callback has been registered successfully.
*/
bool gnssRegisterStatusCallback(GNSSStatusCallback callback);
/**
* Deregister gnss status callback.
* After calling this method no new gnss status updates will be delivered to the client.
* @param callback The callback which should be deregistered.
* @return True if callback has been deregistered successfully.
*/
bool gnssDeregisterStatusCallback(GNSSStatusCallback callback);
#ifdef __cplusplus
}
#endif
#endif //#ifndef INCLUDE_GENIVI_GNSS_STATUS
|
