le_gnss_interface.h

    1 
    2 
    3 /*
    4  * ====================== WARNING ======================
    5  *
    6  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
    7  * DO NOT MODIFY IN ANY WAY.
    8  *
    9  * ====================== WARNING ======================
   10  */
   11 
   12 /**
   13  * @page c_gnss GNSS
   14  *
   15  * @ref le_gnss_interface.h "API Reference" <br>
   16  * @ref platformConstraintsGnss <br>
   17  * @ref howToGNSS "How To Use GNSS" <br>
   18  * @ref toolsTarget_gnss "GNSS target tool" <br>
   19  *
   20  * <HR>
   21  *
   22  * This API provides access to the GNSS device.
   23  *
   24  * GNSS or Global Navigation Satellite System is a satellite navigation system with global coverage.
   25  *
   26  * This API provides function to configure the GNSS device and retrieve position information.
   27  *
   28  * @section le_gnss_binding IPC interfaces binding
   29  *
   30  * All the functions of this API are provided by the @b positioningService application service.
   31  *
   32  * Here's a code sample binding to Positioning services:
   33  * @verbatim
   34    bindings:
   35    {
   36       clientExe.clientComponent.le_gnss -> positioningService.le_gnss
   37    }
   38    @endverbatim
   39  *
   40  * @section le_gnss_ControlApi GNSS Control API
   41  *
   42  * @subsection le_gnss_EnableDisable Enable/Disable GNSS device
   43  *
   44  * The application can enable/disable the GNSS device with the le_gnss_Enable()
   45  * / le_gnss_Disable() functions.
   46  * By default the GNSS device is enabled for the positioningService application service.
   47  * Also see @ref howToGNSS.
   48  *
   49  * A sample code can be seen in the following page:
   50  * - @subpage c_gnssSampleCodeEnableDisable
   51  *
   52  * @subsection le_gnss_StartStop Start/Stop GNSS device
   53  *
   54  * The application shall start the GNSS device calling le_gnss_Start() function.
   55  * The other starting functions that allow to start or restart the GNSS devices in particular modes
   56  * (see @ref le_gnss_StartingMode) are only used for test purposes and allow start performance
   57  * measurement.
   58  * The application shall stop the GNSS device calling le_gnss_Stop() function.
   59  *
   60  * A diagram of GNSS device state machine showing how to use the different starting fonctions can be
   61  * seen at @ref howToGNSS.
   62  *
   63  * A sample code can be seen in the following page:
   64  * - @subpage c_gnssSampleCodeStartStop
   65  *
   66  * @subsubsection le_gnss_StartingMode Starting mode
   67  *
   68  * Starting modes are used only for test purposes and allow start performance measurement.
   69  * @note For more information about start performances, please refer to your specific
   70  * platform documentation.
   71  *
   72  * @subsubsection le_gnss_startMode Start the GNSS device in the specified starting mode
   73  * The le_gnss_StartMode() function clears the @ref le_gnss_Data according to the starting mode and
   74  * starts the GNSS device.
   75  * In HOT mode, no data are cleared, the GNSS is started with its available data. It is equivalent
   76  * to @ref le_gnss_Start() function. In WARM mode, GNSS is started after the Ephemeris are cleared.
   77  * In COLD mode, GNSS is started after all data are cleared except Almanac and in Factory mode GNSS
   78  * is started after default data are set.
   79  *
   80  * @subsubsection le_gnss_ForceHotRestart Restart the GNSS device in HOT mode
   81  * The le_gnss_ForceHotRestart() function performs a "HOT" restart of the GNSS device. The current
   82  * GNSS session is stopped, then started using the available @ref le_gnss_Data.
   83  * Please refer to @ref le_gnss_APIcallsRequirements. Also see @ref howToGNSS.
   84  *
   85  * @subsubsection le_gnss_ForceWarmRestart Restart the GNSS device in WARM mode
   86  * The le_gnss_ForceWarmRestart() function performs a "WARM" restart of the GNSS device. The current
   87  * GNSS session is stopped, then started using the available @ref le_gnss_Data.
   88  * Please refer to @ref le_gnss_APIcallsRequirements. Also see @ref howToGNSS.
   89  * @Note This API has a platform dependent feature. Please refer to
   90  * @ref platformConstraintsGnss_WarmRestart for further details.
   91  *
   92  * @subsubsection le_gnss_ForceColdRestart Restart the GNSS device in COLD mode
   93  * The le_gnss_ForceColdRestart() function performs a "COLD" restart of the GNSS device. The current
   94  * GNSS session is stopped, then started using the available @ref le_gnss_Data.
   95  * Please refer to @ref le_gnss_APIcallsRequirements. Also see @ref howToGNSS.
   96  *
   97  * @subsubsection le_gnss_ForceFactoryRestart Restart the GNSS device in FACTORY mode
   98  * The le_gnss_ForceFactoryRestart() function performs a "FACTORY" restart of the GNSS device.
   99  * The current GNSS session is stopped, then started using the available @ref le_gnss_Data.
  100  * Please refer to @ref le_gnss_APIcallsRequirements. Also see @ref howToGNSS.
  101  *
  102  * @subsubsection le_gnss_Data GNSS data
  103  * The following table describes the <b>minimum</b> required data for those starting modes:
  104  *
  105  * | GNSS Data / Starting mode  | HOT  | WARM  | COLD  | FACTORY |
  106  *| -----------------------| -----| ------| ----- | ------- |
  107  *| Broadcasted Ephemeris  | Used |  |  |  |
  108  *| Extended Ephemeris     | Used(1) | Used(2) | Used(2) | Removed (3) |
  109  *| Approximate Time and Position  | Used | Used |  |  |
  110  *| Almanac   | Used | Used | Used | Used (Factory) |
  111  *
  112  * For example, a requested HOT start without valid broadcasted ephemeris will be treated
  113  * as a WARM start.
  114  *
  115  * @note (1) Extended Ephemeris can be used if Broadcasted Ephemeris are not valid.
  116  * The Extended Ephemeris could be loaded using the le_gnss_LoadExtendedEphemerisFile()
  117  * function.
  118  * @note (2) Extended Ephemeris is used if the Extended Ephemeris file is loaded and valid.
  119  * @note (3) Extended Ephemeris are removed when a FACTORY start is requested.
  120  * The Extended Ephemeris could be loaded again using the le_gnss_LoadExtendedEphemerisFile()
  121  * function.
  122  *
  123  * @subsubsection SettingConfiguration Setting configuration
  124  *
  125  * @warning The GNSS setting configuration depends on the platform. Please refer to
  126  *          @ref platformConstraintsGnss_SettingConfiguration section for full details.
  127  *
  128  * @subsubsection le_gnss_TTFF Time To First Fix (TTFF)
  129  * The le_gnss_GetTtff() function provides the TTFF (first between 2-Dimensional or 3-Dimensional
  130  * position fix) of the last position fix.
  131  * The GNSS fix position is calculated by the GNSS engine. Its state can be retrieved by
  132  * le_gnss_GetPositionState() function. The GNSS fix position states are given by le_gnss_FixState_t
  133  * enum.
  134  * @note The "estimated" fix is obtained when less than 3 Satellites Vehicle (SV) are used to
  135  * establish the fix. It includes the case when no SVs are used.
  136  *
  137  * Please refer to @ref le_gnss_APIcallsRequirements. Also see @ref howToGNSS.
  138  *
  139  * A sample code can be seen in the following page:
  140  * - @subpage c_gnssSampleCodeReStart
  141  *
  142  * @subsubsection le_gnss_InjectUtcTime Inject UTC time
  143  * The le_gnss_InjectUtcTime() function injects the UTC time into the location engine. Providing an
  144  * accurate UTC time reduces the time to find the first fix.
  145  * @note It is mandatory to enable the 'Extended Ephemeris' file injection into the GNSS device with
  146  * le_gnss_EnableExtendedEphemerisFile() before injecting time with le_gnss_InjectUtcTime API.
  147  * @warning Your GNSS device may require a restart to take into account the enabling of the
  148  * 'Extended Ephemeris' file injection.
  149  * Please refer to your platform documentation @ref platformConstraintsGnss_SettingConfiguration for
  150  * further details.
  151  *
  152  * @subsection le_gnss_AcquisitionRate Acquisition rate
  153  * The GNSS position is computed and delivered each acquisition rate. The acquisition rate defines
  154  * the time interval that must elapse between two final GPS positions calculation and reports.
  155  * Its default value is 1 second.
  156  * The application can configure/retreive the GNSS device acquisition rate with the
  157  * le_gnss_SetAcquisitionRate() / le_gnss_GetAcquisitionRate() functions.
  158  *
  159  * Please refer to @ref le_gnss_APIcallsRequirements.
  160  *
  161  * @subsection le_gnss_EnableDisableExternalLna Control EXT_GPS_LNA_EN signal
  162  * The le_gnss_EnableExternalLna() function enables the EXT_GPS_LNA_EN signal. The pin is set high
  163  * when the GNSS state is active, and set low when the GNSS state is inactive.
  164  *
  165  * The le_gnss_DisableExternalLna() function disables the EXT_GPS_LNA_EN signal. The pin remains off
  166  * regardless of the GNSS state.
  167  *
  168  * The le_gnss_GetExternalLna() function read the EXT_GPS_LNA_EN status.
  169  *
  170  * Please refer to @ref le_gnss_APIcallsRequirements.
  171  *
  172  * A sample code can be seen in the following page:
  173  * - @subpage c_gnssSampleCodeAcquisitionRate
  174  *
  175  * @subsection le_gnss_SetGetConstellation GNSS constellation selection
  176  *
  177  * The le_gnss_SetConstellation() function selects the GNSS constellation(s) used in solution.
  178  * If all GNSS constellations are disabled, the GNSS engine is disabled.
  179  *
  180  * @warning Your GNSS device may require a restart to take into account this change.
  181  * Please refer to your platform documentation @ref platformConstraintsGnss_SettingConfiguration for
  182  * further details.
  183  *
  184  * Combinations of constellation for GPS, GLONASS, BDS, GALILEO and QZSS satellites are currently
  185  * supported. Constellation for SBAS satellites is not supported.
  186  *
  187  * @warning Some constellation types are unsupported depending on the platform. Please refer to
  188  * @ref platformConstraintsGnss_ConstellationType section for full details.
  189  *
  190  * All supported GNSS constellations are enabled by default.
  191  * The le_gnss_GetConstellation() function gets the GNSS constellation(s) enabled to be used
  192  * in solution.
  193  *
  194  * le_gnss_SetConstellationArea sets the area for a GNSS constellation. le_gnss_GetConstellationArea
  195  * gets the area for a GNSS constellation.
  196  *
  197  * A sample code can be seen in the following page:
  198  * - @subpage c_gnssSampleCodeConstellation
  199  *
  200  * The le_gnss_GetSupportedConstellations() function gets a bit mask of the constellations
  201  * supported on the platform.
  202  *
  203  * @subsection le_gnss_SetGetMinElevation GNSS minimum elevation selection
  204  *
  205  * The le_gnss_SetMinElevation() function sets the GNSS minimum elevation.
  206  * Satellites with elevation lower than the minimum elevation will be ignored.
  207  *
  208  * The le_gnss_GetMinElevation() function gets the GNSS minimum elevation.
  209  *
  210  * A sample code can be seen in the following page:
  211  * - @subpage c_gnssSampleCodeMinElevation
  212  *
  213  * @subsection le_gnss_NmeaSentences NMEA sentences selection
  214  *
  215  * The le_gnss_SetNmeaSentences() function selects the enabled NMEA sentences in the
  216  * @ref le_gnss_NMEA with a bit mask. The supported values are listed in @ref le_gnss_NmeaBitMask_t.
  217  *
  218  * @note This function may be subject to limitations depending on the platform. Please refer to the
  219  * @ref platformConstraintsGnss page.
  220  *
  221  * @warning Your GNSS device may require a restart to take into account this change.
  222  * Please refer to your platform documentation @ref platformConstraintsGnss_SettingConfiguration for
  223  * further details.
  224  *
  225  * @warning Some NMEA sentences are unsupported depending on the platform. Please refer to
  226  * @ref platformConstraintsGnss_nmeaMask section for full details.
  227  *
  228  * @note All supported NMEA sentences are enabled by default.
  229  *
  230  * The le_gnss_GetNmeaSentences() function gets the bit mask of the enabled NMEA sentences in the
  231  * @ref le_gnss_NMEA.
  232  *
  233  * The le_gnss_GetSupportedNmeaSentences() function gets a bit mask of the NMEA sentences supported
  234  * on the platform.
  235  *
  236  * Please refer to @ref le_gnss_APIcallsRequirements.
  237  *
  238  * A sample code can be seen in the following page:
  239  * - @subpage c_gnssSampleCodeNmeaSentences
  240  *
  241  * @subsection le_gnss_GetMinMaxNmeaRate Get the supported NMEA rates
  242  * The le_gnss_GetMinNmeaRate() function gets the minimum NMEA rate supported on the platform
  243  * in milliseconds.
  244  *
  245  * The le_gnss_GetMaxNmeaRate() function gets the maximum NMEA rate supported on the platform
  246  * in milliseconds.
  247  *
  248  * @subsection le_gnss_APIcallsRequirements API calls Requirements
  249  * The following table shows the pre-requisites when using the GNSS service API function set.
  250  * ''LE_OK or error code'' means the function is authorized in the corresponding state, the request
  251  * is performed and the result is returned; otherwise the returned error is indicated for each state
  252  *.
  253  * | Function / GNSS state  | UNINITIALIZED  | READY  | ACTIVE  | DISABLED |
  254  *| ----------------------------- | --------------------------- | -----------------------------| --------------------------- | --------------------------- |
  255  *| le_gnss_Start() | LE_NOT_PERMITTED | LE_OK or error code | LE_DUPLICATE | LE_NOT_PERMITTED |
  256  *| le_gnss_Stop() | LE_NOT_PERMITTED | LE_DUPLICATE | LE_OK or error code | LE_NOT_PERMITTED |
  257  *| le_gnss_ForceHotRestart() | LE_NOT_PERMITTED | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED |
  258  *| le_gnss_ForceWarmRestart() | LE_NOT_PERMITTED | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED |
  259  *| le_gnss_ForceColdRestart() | LE_NOT_PERMITTED | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED |
  260  *| le_gnss_ForceFactoryRestart() | LE_NOT_PERMITTED | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED |
  261  *| le_gnss_Disable() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_DUPLICATE |
  262  *| le_gnss_Enable() | LE_NOT_PERMITTED | LE_DUPLICATE | LE_DUPLICATE | LE_OK or error code |
  263  *| le_gnss_SetConstellation() | LE_NOT_PERMITTED |  LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |
  264  *| le_gnss_GetConstellation() | LE_NOT_PERMITTED |  LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |
  265  *| le_gnss_SetConstellationArea() | LE_NOT_PERMITTED |  LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |
  266  *| le_gnss_GetConstellationArea() | LE_NOT_PERMITTED |  LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |
  267  *| le_gnss_GetTtff() | LE_NOT_PERMITTED |  LE_OK or error code | LE_OK or error code | LE_NOT_PERMITTED |
  268  *| le_gnss_SetAcquisitionRate() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |
  269  *| le_gnss_GetAcquisitionRate() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |
  270  *| le_gnss_SetNmeaSentences() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |
  271  *| le_gnss_GetNmeaSentences() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |
  272  *| le_gnss_EnableExternalLna() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |
  273  *| le_gnss_DisableExternalLna() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |
  274  *| le_gnss_GetExternalLna() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |
  275  *
  276  * Also see @ref howToGNSS.
  277  *
  278  * @section le_gnss_Information GNSS position information
  279  * @ref le_gnss_NMEA
  280  *
  281  * @ref le_gnss_GetInfo
  282  *
  283  * @ref le_gnss_GetLeapSeconds
  284  *
  285  * @subsection le_gnss_NMEA NMEA Flow
  286  * The National Marine Electronics Association (NMEA) standard defines an electrical interface
  287  * and data protocol for communications between marine instrumentation.
  288  *
  289  * The NMEA-0183, scope of this document, defines a set of frame prefixed by
  290  * $GP (concerning Global Positioning System),
  291  * $GL (concerning GLONASS)
  292  * and $GN (concerning combination of navigation systems).
  293  * For more details about NMEA standards, please refer to http://www.nmea.org/.
  294  *
  295  * That NMEA frames flow can be retrieved from the "/dev/nmea" device folder, using for example
  296  * the shell command $<EM> cat /dev/nmea | grep '$G'</EM>
  297  *
  298  * @subsection le_gnss_GetInfo Get position information
  299  * The position information is referenced to a position sample object.
  300  *
  301  * An application can register a handler to be notified of the
  302  * updated position each @ref le_gnss_AcquisitionRate, returning a position sample object.
  303  *
  304  * The GNSS information commonly used such as
  305  * device state, position, time and date, satellites information and accuracy
  306  * can be queried using the following functions:
  307  * - le_gnss_GetState()
  308  * - le_gnss_GetPositionState()
  309  * - le_gnss_GetLocation()
  310  * - le_gnss_GetAltitude()
  311  * - le_gnss_GetDate()
  312  * - le_gnss_GetTime()
  313  * - le_gnss_GetGpsTime()
  314  * - le_gnss_GetGpsLeapSeconds()
  315  * - le_gnss_GetEpochTime()
  316  * - le_gnss_GetTimeAccuracy()
  317  * - le_gnss_GetHorizontalSpeed()
  318  * - le_gnss_GetVerticalSpeed()
  319  * - le_gnss_GetDirection()
  320  * - le_gnss_GetSatellitesInfo()
  321  * - le_gnss_GetSbasConstellationCategory()
  322  * - le_gnss_GetSatellitesStatus()
  323  * - le_gnss_GetDilutionOfPrecision()
  324  * - le_gnss_GetAltitudeOnWgs84()
  325  * - le_gnss_GetMagneticDeviation()
  326  *
  327  * le_gnss_SetDataResolution() function can be called to configure the resolution of position data
  328  * type per client session. Currently, three data types are supported:
  329  * - Vertical position accuracy provided by le_gnss_GetAltitude().
  330  * - Vertical speed accuracy provided by le_gnss_GetVerticalSpeed().
  331  * - Horizontal speed accuracy provided by le_gnss_GetHorizontalSpeed().
  332  * Each data type can be set with a resolution from 0 to 3 decimal place.
  333  *
  334  * For example, to get the vertical position accuracy with a resolution of 2 decimal places,
  335  * le_gnss_SetDataResolution() function is called with vertical position accuracy set as data type
  336  * and 2 decimal place is set as resolution, then le_gnss_GetAltitude() function is called.
  337  *
  338  * @note If le_gnss_SetDataResolution() function is not called, the position data types are received
  339  * in their default accuracies.
  340  *
  341  * le_gnss_ConvertDataCoordinateSystem() function can be called to convert a location data value
  342  * from a coordinate system to another. Currently it is possible to convert the following data
  343  * types:
  344  * - Latitude
  345  * - Longitude
  346  * - Altitude
  347  *
  348  * System coordinates source and destination are currently:
  349  * - Coordinate system WGS84
  350  * - Coordinate system PZ90
  351  *
  352  * @note Only conversion from WGS84 coordinate system to PZ90 coordinate system is currently
  353  * supported.
  354  * @note The altitude in coordinate system WGS84 is obtained by le_gnss_GetAltitudeOnWgs84()
  355  * function.
  356  *
  357  * A sample code using le_gnss_ConvertDataCoordinate() function can be seen in the following page:
  358  * - @subpage c_gnssSampleCodePosition
  359  *
  360  * le_gnss_GetDilutionOfPrecision() gets the DOP parameters (Dilution Of Precision) with a
  361  * resolution of 3 decimal places by default. This resolution can be modified by calling the
  362  * @c le_gnss_SetDopResolution() function first.
  363  *
  364  * As @c le_gnss_SetDopResolution() sets the resolution per client session,
  365  * @c le_gnss_SetDopResolution() and @c le_gnss_GetDilutionOfPrecision() functions should be called
  366  * in the same thread or client session.
  367  *
  368  * A sample code can be seen in the following page:
  369  * - @subpage c_gnssSampleCodePosition
  370  *
  371  * The handler can be managed using le_gnss_AddPositionHandler()
  372  * and le_gnss_RemovePositionHandler().
  373  * When a position is computed, the handler is called.
  374  *
  375  * The application has to release each position sample object received by the handler,
  376  * using the le_gnss_ReleaseSampleRef().
  377  *
  378  * A sample code can be seen in the following page:
  379  * - @subpage c_gnssSampleCodePosition
  380  *
  381  * @subsection le_gnss_GetLeapSeconds Get leap seconds event information
  382  * The leap seconds event information is retrieved by calling le_gnss_GetLeapSeconds() API.
  383  * The result includes current GPS time, current leap seconds, next leap second event time,
  384  * and next leap seconds.
  385  *
  386  * Insertion of each UTC leap second is usually decided about six months in advance by the
  387  * International Earth Rotation and Reference Systems Service (IERS).
  388  *
  389  * @section le_gnss_Assisted_GNSS Assisted GNSS
  390  *
  391  * @ref le_gnss_Assisted_GNSS_EE
  392  * @ref le_gnss_Assisted_GNSS_UP
  393  *
  394  * @subsection le_gnss_Assisted_GNSS_EE Server based Extended Ephemeris
  395  *
  396  * @todo Add detailed documentation.
  397  *
  398  * With le_gnss_LoadExtendedEphemerisFile() , you can load an 'Extended Ephemeris' file into
  399  * the GNSS device from the filesystem.
  400  * You have to download the file before loading it.
  401  * @warning Ensure to check that the downloaded file is supported for your specific platform.
  402  *
  403  * With le_gnss_GetExtendedEphemerisValidity(), you will to get the validity of the last injected
  404  * Extended Ephemeris.
  405  *
  406  * You can enable/disable the use of the 'Extended Ephemeris' file into the GNSS device with
  407  * le_gnss_EnableExtendedEphemerisFile() / le_gnss_DisableExtendedEphemerisFile() functions.
  408  * @warning Ensure to check configuration capabilities for your specific platform.
  409  * A reboot must be required if your platform doesn't allow run-time configuration.
  410  *
  411  * A sample code can be seen in the following page:
  412  * - @subpage c_gnssSampleCodeXtra
  413  *
  414  * @subsection le_gnss_Assisted_GNSS_UP 3GPP User Plane (OMA SUPL)
  415  *
  416  * That 3GPP User Plane A-GNSS (Assisted GNSS) protocol is defined by two different standardization
  417  * bodies, 3GPP and Open Mobile Alliance (OMA). For more information, please refer to the standard.
  418  *
  419  * Both MS-Assisted and MS-Based position determination methods are supported in the User Plane.
  420  *
  421  * In MS-Assisted mode, the MS (Mobile Station) measures the signals from the GNSS satellites
  422  *, then returns the retrieved GNSS data to the SUPL (Secure User Plan Location) server, where the
  423  * position calculation is performed.
  424  *
  425  * In MS-Based mode, the MS gets the assistance data from the SUPL (Secure User Plan Location)
  426  * server. The MS measures the signals from the GNSS satellites and makes the position calculation.
  427  *
  428  * The data transport over User Plan is done using the TCP/IP protocol.
  429  *
  430  * The Assisted-GNSS mode can be configured thru the le_gnss_SetSuplAssistedMode() function.
  431  *
  432  * The supported modes are the following:
  433  * - Standalone mode: That 3GPP User Plane A-GNSS feature is deactivated.
  434  * - MS-Based mode
  435  * - MS-Assisted mode
  436  *
  437  * Moreover, the le_gnss_GetSuplAssistedMode() function reads the configured Assisted-GNSS mode.
  438  *
  439  * The SUPL server is configured using the le_gnss_SetSuplServerUrl() function. That function sets
  440  * the SUPL server URL and optionally the port number.
  441  *
  442  * The SUPL certificate to be used in A-GNSS sessions is injected through the
  443  * le_gnss_InjectSuplCertificate() function and deleted through the le_gnss_DeleteSuplCertificate()
  444  * function.
  445  * The SUPL certificate lenght given as parameter to le_gnss_InjectSuplCertificate() must be less
  446  * than LE_GNSS_SUPL_CERTIFICATE_MAX_LEN.
  447  *
  448  * <HR>
  449  *
  450  * Copyright (C) Sierra Wireless Inc.
  451  */
  452 /**
  453  * @page c_gnssSampleCode Sample code for GNSS device
  454  *
  455  * @include "apps/test/positioning/gnssTest/gnssTest/gnssTest.c"
  456  */
  457 /**
  458  * @page c_gnssSampleCodeEnableDisable Sample code for Enable/Disable GNSS device
  459  *
  460  * @snippet "apps/test/positioning/gnssTest/gnssTest/gnssTest.c" GnssEnable
  461  */
  462 /**
  463  * @page c_gnssSampleCodeStartStop Sample code for Start/Stop GNSS device
  464  *
  465  * @snippet "apps/test/positioning/gnssTest/gnssTest/gnssTest.c" GnssControl
  466  */
  467 /**
  468  * @page c_gnssSampleCodeReStart Sample code for restart GNSS device and get TTFF
  469  *
  470  * @snippet "apps/test/positioning/gnssTest/gnssTest/gnssTest.c" GnssReStart
  471  */
  472 /**
  473  * @page c_gnssSampleCodeAcquisitionRate Sample code for GNSS acquisition rate configuration
  474  *
  475  * @snippet "apps/test/positioning/gnssTest/gnssTest/gnssTest.c" GnssControl
  476  */
  477 /**
  478  * @page c_gnssSampleCodeConstellation Sample code for GNSS constellation selection
  479  *
  480  * @snippet "apps/test/positioning/gnssTest/gnssTest/gnssTest.c" GnssControl
  481  */
  482 /**
  483  * @page c_gnssSampleCodeMinElevation Sample code for GNSS minimum elevation
  484  *
  485  * @snippet "apps/test/positioning/gnssTest/gnssTest/gnssTest.c" GnssControl
  486  */
  487 /**
  488  * @page c_gnssSampleCodeNmeaSentences Sample code for GNSS NMEA sentences selection
  489  *
  490  * @snippet "apps/test/positioning/gnssTest/gnssTest/gnssTest.c" GnssControl
  491  */
  492 /**
  493  * @page c_gnssSampleCodePosition Sample code for GNSS position information
  494  *
  495  * @snippet "apps/test/positioning/gnssTest/gnssTest/gnssTest.c" GnssPosition
  496  */
  497 /**
  498  * @page c_gnssSampleCodeXtra Sample code for GNSS Server based Extended Ephemeris
  499  *
  500  * @include "apps/test/positioning/gnssXtraTest/gnssXtraTest/xtraTest.c"
  501  */
  502 /**
  503  * @file le_gnss_interface.h
  504  *
  505  * Legato @ref c_gnss include file.
  506  *
  507  * Copyright (C) Sierra Wireless Inc.
  508  */
  509 
  510 #ifndef LE_GNSS_INTERFACE_H_INCLUDE_GUARD
  511 #define LE_GNSS_INTERFACE_H_INCLUDE_GUARD
  512 
  513 
  514 #include "legato.h"
  515 
  516 // Internal includes for this interface
  517 #include "le_gnss_common.h"
  518 /** @addtogroup le_gnss le_gnss API Reference
  519  * @{
  520  * @file le_gnss_common.h
  521  * @file le_gnss_interface.h **/
  522 //--------------------------------------------------------------------------------------------------
  523 /**
  524  * Type for handler called when a server disconnects.
  525  */
  526 //--------------------------------------------------------------------------------------------------
  527 typedef void (*le_gnss_DisconnectHandler_t)(void *);
  528 
  529 //--------------------------------------------------------------------------------------------------
  530 /**
  531  *
  532  * Connect the current client thread to the service providing this API. Block until the service is
  533  * available.
  534  *
  535  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
  536  * called before any other functions in this API.  Normally, ConnectService is automatically called
  537  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
  538  *
  539  * This function is created automatically.
  540  */
  541 //--------------------------------------------------------------------------------------------------
  542 void le_gnss_ConnectService
  543 (
  544     void
  545 );
  546 
  547 //--------------------------------------------------------------------------------------------------
  548 /**
  549  *
  550  * Try to connect the current client thread to the service providing this API. Return with an error
  551  * if the service is not available.
  552  *
  553  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
  554  * called before any other functions in this API.  Normally, ConnectService is automatically called
  555  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
  556  *
  557  * This function is created automatically.
  558  *
  559  * @return
  560  *  - LE_OK if the client connected successfully to the service.
  561  *  - LE_UNAVAILABLE if the server is not currently offering the service to which the client is
  562  *    bound.
  563  *  - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
  564  *  - LE_COMM_ERROR if the Service Directory cannot be reached.
  565  */
  566 //--------------------------------------------------------------------------------------------------
  567 le_result_t le_gnss_TryConnectService
  568 (
  569     void
  570 );
  571 
  572 //--------------------------------------------------------------------------------------------------
  573 /**
  574  * Set handler called when server disconnection is detected.
  575  *
  576  * When a server connection is lost, call this handler then exit with LE_FATAL.  If a program wants
  577  * to continue without exiting, it should call longjmp() from inside the handler.
  578  */
  579 //--------------------------------------------------------------------------------------------------
  580 LE_FULL_API void le_gnss_SetServerDisconnectHandler
  581 (
  582     le_gnss_DisconnectHandler_t disconnectHandler,
  583     void *contextPtr
  584 );
  585 
  586 //--------------------------------------------------------------------------------------------------
  587 /**
  588  *
  589  * Disconnect the current client thread from the service providing this API.
  590  *
  591  * Normally, this function doesn't need to be called. After this function is called, there's no
  592  * longer a connection to the service, and the functions in this API can't be used. For details, see
  593  * @ref apiFilesC_client.
  594  *
  595  * This function is created automatically.
  596  */
  597 //--------------------------------------------------------------------------------------------------
  598 void le_gnss_DisconnectService
  599 (
  600     void
  601 );
  602 
  603 
  604 //--------------------------------------------------------------------------------------------------
  605 /**
  606  *  Reference type for dealing with GNSS position samples.
  607  */
  608 //--------------------------------------------------------------------------------------------------
  609 
  610 
  611 //--------------------------------------------------------------------------------------------------
  612 /**
  613  * Enumeration for GNSS device state
  614  */
  615 //--------------------------------------------------------------------------------------------------
  616 
  617 
  618 //--------------------------------------------------------------------------------------------------
  619 /**
  620  *  GNSS fix position states.
  621  */
  622 //--------------------------------------------------------------------------------------------------
  623 
  624 
  625 //--------------------------------------------------------------------------------------------------
  626 /**
  627  *  Resolutions values.
  628  */
  629 //--------------------------------------------------------------------------------------------------
  630 
  631 
  632 //--------------------------------------------------------------------------------------------------
  633 /**
  634  **  Data types.
  635  */
  636 //--------------------------------------------------------------------------------------------------
  637 
  638 
  639 //--------------------------------------------------------------------------------------------------
  640 /**
  641  *  SBAS constellation category
  642  */
  643 //--------------------------------------------------------------------------------------------------
  644 
  645 
  646 //--------------------------------------------------------------------------------------------------
  647 /**
  648  *  GNSS constellation type.
  649  */
  650 //--------------------------------------------------------------------------------------------------
  651 
  652 
  653 //--------------------------------------------------------------------------------------------------
  654 /**
  655  * Assisted-GNSS mode
  656  */
  657 //--------------------------------------------------------------------------------------------------
  658 
  659 
  660 //--------------------------------------------------------------------------------------------------
  661 /**
  662  * Dilution of precision type
  663  */
  664 //--------------------------------------------------------------------------------------------------
  665 
  666 
  667 //--------------------------------------------------------------------------------------------------
  668 /**
  669  * GNSS constellation area type
  670  */
  671 //--------------------------------------------------------------------------------------------------
  672 
  673 
  674 //--------------------------------------------------------------------------------------------------
  675 /**
  676  * GNSS constellation Bit Mask (8 bits) indicating the GNSS constellation(s)
  677  * used in solution.
  678  *
  679  */
  680 //--------------------------------------------------------------------------------------------------
  681 
  682 
  683 //--------------------------------------------------------------------------------------------------
  684 /**
  685  * NMEA sentences Bit Mask indicating the NMEA sentences enabled in the NMEA flow.
  686  *
  687  * @warning The supported NMEA sentences depend on the platform. Please refer to your platform
  688  * documentation for further details.
  689  *
  690  * @note The bit mask values should be coherent with @ref LE_GNSS_NMEA_SENTENCES_MAX
  691  */
  692 //--------------------------------------------------------------------------------------------------
  693 
  694 
  695 //--------------------------------------------------------------------------------------------------
  696 /**
  697  *  Coordinate system
  698  */
  699 //--------------------------------------------------------------------------------------------------
  700 
  701 
  702 //--------------------------------------------------------------------------------------------------
  703 /**
  704  **  Location data types
  705  */
  706 //--------------------------------------------------------------------------------------------------
  707 
  708 
  709 //--------------------------------------------------------------------------------------------------
  710 /**
  711  * Type of GNSS start.
  712  */
  713 //--------------------------------------------------------------------------------------------------
  714 
  715 
  716 //--------------------------------------------------------------------------------------------------
  717 /**
  718  * Handler for position information.
  719  *
  720  */
  721 //--------------------------------------------------------------------------------------------------
  722 
  723 
  724 //--------------------------------------------------------------------------------------------------
  725 /**
  726  * Reference type used by Add/Remove functions for EVENT 'le_gnss_Position'
  727  */
  728 //--------------------------------------------------------------------------------------------------
  729 
  730 
  731 //--------------------------------------------------------------------------------------------------
  732 /**
  733  * Set the GNSS constellation bit mask
  734  *
  735  * @return
  736  *  - LE_FAULT         The function failed.
  737  *  - LE_UNSUPPORTED   If the request is not supported.
  738  *  - LE_NOT_PERMITTED If the GNSS device is not initialized, disabled or active.
  739  *  - LE_OK            The function succeeded.
  740  *
  741  * @warning Some constellation types are unsupported depending on the platform. Please refer to
  742  *          @ref platformConstraintsGnss_ConstellationType section for full details.
  743  *
  744  * @warning The settings are platform dependent. Please refer to
  745  *          @ref platformConstraintsGnss_SettingConfiguration section for full details.
  746  */
  747 //--------------------------------------------------------------------------------------------------
  748 le_result_t le_gnss_SetConstellation
  749 (
  750     le_gnss_ConstellationBitMask_t constellationMask
  751         ///< [IN] GNSS constellation used in solution.
  752 );
  753 
  754 //--------------------------------------------------------------------------------------------------
  755 /**
  756  * Get the GNSS constellation bit mask
  757  *
  758  * @return
  759  *  - LE_OK on success
  760  *  - LE_FAULT on failure
  761  *
  762  * @note If the caller is passing a null pointer into this function, it is a fatal error, the
  763  *       function will not return.
  764  */
  765 //--------------------------------------------------------------------------------------------------
  766 le_result_t le_gnss_GetConstellation
  767 (
  768     le_gnss_ConstellationBitMask_t* constellationMaskPtr
  769         ///< [OUT] GNSS constellation used in solution.
  770 );
  771 
  772 //--------------------------------------------------------------------------------------------------
  773 /**
  774  * Set the area for the GNSS constellation
  775  *
  776  * @return
  777  *  - LE_OK            The function succeeded.
  778  *  - LE_FAULT         The function failed.
  779  *  - LE_UNSUPPORTED   If the request is not supported.
  780  *  - LE_NOT_PERMITTED If the GNSS device is not initialized, disabled or active.
  781  *  - LE_BAD_PARAMETER Invalid constellation area.
  782  *
  783  * @warning The settings are platform dependent. Please refer to
  784  *          @ref platformConstraintsGnss_SettingConfiguration section for full details.
  785  */
  786 //--------------------------------------------------------------------------------------------------
  787 le_result_t le_gnss_SetConstellationArea
  788 (
  789     le_gnss_Constellation_t satConstellation,
  790         ///< [IN] GNSS constellation type.
  791     le_gnss_ConstellationArea_t constellationArea
  792         ///< [IN] GNSS constellation area.
  793 );
  794 
  795 //--------------------------------------------------------------------------------------------------
  796 /**
  797  * Get the area for the GNSS constellation
  798  *
  799  * @return
  800  *  - LE_OK            On success
  801  *  - LE_FAULT         On failure
  802  *  - LE_UNSUPPORTED   Request not supported
  803  *  - LE_NOT_PERMITTED If the GNSS device is not initialized, disabled or active.
  804  *
  805  * @note If the caller is passing a null pointer into this function, it is a fatal error, the
  806  *       function will not return.
  807  */
  808 //--------------------------------------------------------------------------------------------------
  809 le_result_t le_gnss_GetConstellationArea
  810 (
  811     le_gnss_Constellation_t satConstellation,
  812         ///< [IN] GNSS constellation type.
  813     le_gnss_ConstellationArea_t* constellationAreaPtr
  814         ///< [OUT] GNSS constellation area.
  815 );
  816 
  817 //--------------------------------------------------------------------------------------------------
  818 /**
  819  * This function enables the use of the 'Extended Ephemeris' file into the GNSS device.
  820  *
  821  * @return
  822  *  - LE_FAULT         The function failed.
  823  *  - LE_OK            The function succeeded.
  824  *
  825  * @warning The settings are platform dependent. Please refer to
  826  *          @ref platformConstraintsGnss_SettingConfiguration section for full details.
  827  */
  828 //--------------------------------------------------------------------------------------------------
  829 le_result_t le_gnss_EnableExtendedEphemerisFile
  830 (
  831     void
  832 );
  833 
  834 //--------------------------------------------------------------------------------------------------
  835 /**
  836  * This function disables the use of the 'Extended Ephemeris' file into the GNSS device.
  837  *
  838  * @return
  839  *  - LE_FAULT         The function failed.
  840  *  - LE_OK            The function succeeded.
  841  *
  842  * @warning The settings are platform dependent. Please refer to
  843  *          @ref platformConstraintsGnss_SettingConfiguration section for full details.
  844  */
  845 //--------------------------------------------------------------------------------------------------
  846 le_result_t le_gnss_DisableExtendedEphemerisFile
  847 (
  848     void
  849 );
  850 
  851 //--------------------------------------------------------------------------------------------------
  852 /**
  853  * This function must be called to load an 'Extended Ephemeris' file into the GNSS device.
  854  *
  855  * @return
  856  *  - LE_FAULT         The function failed to inject the 'Extended Ephemeris' file.
  857  *  - LE_TIMEOUT       A time-out occurred.
  858  *  - LE_FORMAT_ERROR  'Extended Ephemeris' file format error.
  859  *  - LE_OK            The function succeeded.
  860  *
  861  */
  862 //--------------------------------------------------------------------------------------------------
  863 le_result_t le_gnss_LoadExtendedEphemerisFile
  864 (
  865     int fd
  866         ///< [IN] Extended ephemeris file descriptor
  867 );
  868 
  869 //--------------------------------------------------------------------------------------------------
  870 /**
  871  * This function must be called to get the validity of the last injected Extended Ephemeris.
  872  *
  873  * @return
  874  *  - LE_FAULT         The function failed to get the validity
  875  *  - LE_OK            The function succeeded.
  876  *
  877  * @note If the caller is passing an invalid Position sample reference or null pointers into this
  878  *       function, it is a fatal error, the function will not return.
  879  */
  880 //--------------------------------------------------------------------------------------------------
  881 le_result_t le_gnss_GetExtendedEphemerisValidity
  882 (
  883     uint64_t* startTimePtr,
  884         ///< [OUT] Start time in seconds (since Jan. 1, 1970)
  885     uint64_t* stopTimePtr
  886         ///< [OUT] Stop time in seconds (since Jan. 1, 1970)
  887 );
  888 
  889 //--------------------------------------------------------------------------------------------------
  890 /**
  891  * This function must be called to inject the UTC time into the GNSS device.
  892  *
  893  * @return
  894  *  - LE_OK            The function succeeded.
  895  *  - LE_FAULT         The function failed to inject the UTC time.
  896  *  - LE_TIMEOUT       A time-out occurred.
  897  *
  898  * @note It is mandatory to enable the 'Extended Ephemeris' file injection into the GNSS device with
  899  * le_gnss_EnableExtendedEphemerisFile() before injecting time with this API.
  900  */
  901 //--------------------------------------------------------------------------------------------------
  902 le_result_t le_gnss_InjectUtcTime
  903 (
  904     uint64_t timeUtc,
  905         ///< [IN] [IN] UTC time since Jan. 1, 1970 in milliseconds
  906     uint32_t timeUnc
  907         ///< [IN] [IN] Time uncertainty in milliseconds
  908 );
  909 
  910 //--------------------------------------------------------------------------------------------------
  911 /**
  912  * This function starts the GNSS device.
  913  *
  914  * @return
  915  *  - LE_FAULT         The function failed.
  916  *  - LE_DUPLICATE     If the GNSS device is already started.
  917  *  - LE_NOT_PERMITTED If the GNSS device is not initialized or disabled.
  918  *  - LE_OK            The function succeeded.
  919  *
  920  */
  921 //--------------------------------------------------------------------------------------------------
  922 le_result_t le_gnss_Start
  923 (
  924     void
  925 );
  926 
  927 //--------------------------------------------------------------------------------------------------
  928 /**
  929  * This function starts the GNSS device in the specified start mode.
  930  *
  931  * @return
  932  *  - LE_OK              The function succeeded.
  933  *  - LE_BAD_PARAMETER   Invalid start mode
  934  *  - LE_FAULT           The function failed.
  935  *  - LE_DUPLICATE       If the GNSS device is already started.
  936  *  - LE_NOT_PERMITTED   If the GNSS device is not initialized or disabled.
  937  *
  938  * @warning This function may be subject to limitations depending on the platform. Please refer to
  939  *          the @ref platformConstraintsGnss page.
  940  */
  941 //--------------------------------------------------------------------------------------------------
  942 le_result_t le_gnss_StartMode
  943 (
  944     le_gnss_StartMode_t mode
  945         ///< [IN] [IN] Start mode
  946 );
  947 
  948 //--------------------------------------------------------------------------------------------------
  949 /**
  950  * This function stops the GNSS device.
  951  *
  952  * @return
  953  *  - LE_FAULT         The function failed.
  954  *  - LE_DUPLICATE     If the GNSS device is already stopped.
  955  *  - LE_NOT_PERMITTED If the GNSS device is not initialized or disabled.
  956  *  - LE_OK            The function succeeded.
  957  *
  958  */
  959 //--------------------------------------------------------------------------------------------------
  960 le_result_t le_gnss_Stop
  961 (
  962     void
  963 );
  964 
  965 //--------------------------------------------------------------------------------------------------
  966 /**
  967  * This function performs a "HOT" restart of the GNSS device.
  968  *
  969  * @return
  970  *  - LE_FAULT         The function failed.
  971  *  - LE_NOT_PERMITTED If the GNSS device is not enabled or not started.
  972  *  - LE_OK            The function succeeded.
  973  *
  974  * @Note This API can be used to restart the GNSS device. It is equivalent calling le_gnss_Stop()
  975  *       and le_gnss_Start().
  976  */
  977 //--------------------------------------------------------------------------------------------------
  978 le_result_t le_gnss_ForceHotRestart
  979 (
  980     void
  981 );
  982 
  983 //--------------------------------------------------------------------------------------------------
  984 /**
  985  * This function performs a "WARM" restart of the GNSS device.
  986  *
  987  * @return
  988  *  - LE_FAULT         The function failed.
  989  *  - LE_NOT_PERMITTED If the GNSS device is not enabled or not started.
  990  *  - LE_OK            The function succeeded.
  991  *
  992  * @Note This API has a platform dependent feature. Please refer to
  993  * @ref platformConstraintsGnss_WarmRestart for further details.
  994  */
  995 //--------------------------------------------------------------------------------------------------
  996 le_result_t le_gnss_ForceWarmRestart
  997 (
  998     void
  999 );
 1000 
 1001 //--------------------------------------------------------------------------------------------------
 1002 /**
 1003  * This function performs a "COLD" restart of the GNSS device.
 1004  *
 1005  * @return
 1006  *  - LE_FAULT         The function failed.
 1007  *  - LE_NOT_PERMITTED If the GNSS device is not enabled or not started.
 1008  *  - LE_OK            The function succeeded.
 1009  *
 1010  */
 1011 //--------------------------------------------------------------------------------------------------
 1012 le_result_t le_gnss_ForceColdRestart
 1013 (
 1014     void
 1015 );
 1016 
 1017 //--------------------------------------------------------------------------------------------------
 1018 /**
 1019  * This function performs a "FACTORY" restart of the GNSS device.
 1020  *
 1021  * @return
 1022  *  - LE_FAULT         The function failed.
 1023  *  - LE_NOT_PERMITTED If the GNSS device is not enabled or not started.
 1024  *  - LE_OK            The function succeeded.
 1025  *
 1026  */
 1027 //--------------------------------------------------------------------------------------------------
 1028 le_result_t le_gnss_ForceFactoryRestart
 1029 (
 1030     void
 1031 );
 1032 
 1033 //--------------------------------------------------------------------------------------------------
 1034 /**
 1035  * Get the TTFF in milliseconds
 1036  *
 1037  * @return
 1038  *  - LE_BUSY          The position is not fixed and TTFF can't be measured.
 1039  *  - LE_NOT_PERMITTED If the GNSS device is not enabled or not started.
 1040  *  - LE_OK            Function succeeded.
 1041  *  - LE_FAULT         If there are some other errors.
 1042  *
 1043  * @note If the caller is passing a null pointer into this function, it is a fatal error, the
 1044  *       function will not return.
 1045  */
 1046 //--------------------------------------------------------------------------------------------------
 1047 le_result_t le_gnss_GetTtff
 1048 (
 1049     uint32_t* ttffPtr
 1050         ///< [OUT] TTFF in milliseconds
 1051 );
 1052 
 1053 //--------------------------------------------------------------------------------------------------
 1054 /**
 1055  * This function enables the GNSS device.
 1056  *
 1057  * @return
 1058  *  - LE_FAULT         The function failed.
 1059  *  - LE_DUPLICATE     If the GNSS device is already enabled.
 1060  *  - LE_NOT_PERMITTED If the GNSS device is not initialized.
 1061  *  - LE_OK            The function succeeded.
 1062  *
 1063  * @warning The settings are platform dependent. Please refer to
 1064  *          @ref platformConstraintsGnss_SettingConfiguration section for full details.
 1065  */
 1066 //--------------------------------------------------------------------------------------------------
 1067 le_result_t le_gnss_Enable
 1068 (
 1069     void
 1070 );
 1071 
 1072 //--------------------------------------------------------------------------------------------------
 1073 /**
 1074  * This function disables the GNSS device.
 1075  *
 1076  * @return
 1077  *  - LE_FAULT         The function failed.
 1078  *  - LE_DUPLICATE     If the GNSS device is already disabled.
 1079  *  - LE_NOT_PERMITTED If the GNSS device is not initialized or started.
 1080  *  - LE_OK            The function succeeded.
 1081  *
 1082  * @warning The settings are platform dependent. Please refer to
 1083  *          @ref platformConstraintsGnss_SettingConfiguration section for full details.
 1084  */
 1085 //--------------------------------------------------------------------------------------------------
 1086 le_result_t le_gnss_Disable
 1087 (
 1088     void
 1089 );
 1090 
 1091 //--------------------------------------------------------------------------------------------------
 1092 /**
 1093  * This function sets the GNSS device acquisition rate.
 1094  *
 1095  * @return
 1096  *  - LE_OK on success
 1097  *  - LE_FAULT on failure
 1098  *  - LE_UNSUPPORTED request not supported
 1099  *  - LE_TIMEOUT a time-out occurred
 1100  *  - LE_NOT_PERMITTED If the GNSS device is not in "ready" state.
 1101  *  - LE_OUT_OF_RANGE  if acquisition rate value is equal to zero
 1102  *
 1103  * @warning This function may be subject to limitations depending on the platform. Please refer to
 1104  *          the @ref platformConstraintsGnss page.
 1105  *
 1106  * @warning The settings are platform dependent. Please refer to
 1107  *          @ref platformConstraintsGnss_SettingConfiguration section for full details.
 1108  */
 1109 //--------------------------------------------------------------------------------------------------
 1110 le_result_t le_gnss_SetAcquisitionRate
 1111 (
 1112     uint32_t rate
 1113         ///< [IN] Acquisition rate in milliseconds.
 1114 );
 1115 
 1116 //--------------------------------------------------------------------------------------------------
 1117 /**
 1118  * This function gets the GNSS device acquisition rate.
 1119  *
 1120  * @return
 1121  *  - LE_OK on success
 1122  *  - LE_FAULT on failure
 1123  *  - LE_NOT_PERMITTED If the GNSS device is not in "ready" state.
 1124  *
 1125  * @note If the caller is passing a null pointer into this function, it is a fatal error, the
 1126  *       function will not return.
 1127  */
 1128 //--------------------------------------------------------------------------------------------------
 1129 le_result_t le_gnss_GetAcquisitionRate
 1130 (
 1131     uint32_t* ratePtr
 1132         ///< [OUT] Acquisition rate in milliseconds.
 1133 );
 1134 
 1135 //--------------------------------------------------------------------------------------------------
 1136 /**
 1137  * Add handler function for EVENT 'le_gnss_Position'
 1138  *
 1139  * This event provides information on position.
 1140  *
 1141  *  - A handler reference, which is only needed for later removal of the handler.
 1142  *
 1143  * @note Doesn't return on failure, so there's no need to check the return value for errors.
 1144  */
 1145 //--------------------------------------------------------------------------------------------------
 1146 le_gnss_PositionHandlerRef_t le_gnss_AddPositionHandler
 1147 (
 1148     le_gnss_PositionHandlerFunc_t handlerPtr,
 1149         ///< [IN]
 1150     void* contextPtr
 1151         ///< [IN]
 1152 );
 1153 
 1154 //--------------------------------------------------------------------------------------------------
 1155 /**
 1156  * Remove handler function for EVENT 'le_gnss_Position'
 1157  */
 1158 //--------------------------------------------------------------------------------------------------
 1159 void le_gnss_RemovePositionHandler
 1160 (
 1161     le_gnss_PositionHandlerRef_t handlerRef
 1162         ///< [IN]
 1163 );
 1164 
 1165 //--------------------------------------------------------------------------------------------------
 1166 /**
 1167  * This function gets the position sample's fix state
 1168  *
 1169  *  - LE_OK on success
 1170  *  - LE_FAULT on failure
 1171  *
 1172  * @note If the caller is passing an invalid Position sample reference or a null pointer into this
 1173  *       function, it is a fatal error, the function will not return.
 1174  */
 1175 //--------------------------------------------------------------------------------------------------
 1176 le_result_t le_gnss_GetPositionState
 1177 (
 1178     le_gnss_SampleRef_t positionSampleRef,
 1179         ///< [IN] Position sample's reference.
 1180     le_gnss_FixState_t* statePtr
 1181         ///< [OUT] Position fix state.
 1182 );
 1183 
 1184 //--------------------------------------------------------------------------------------------------
 1185 /**
 1186  * Get the location's data (Latitude, Longitude, Horizontal accuracy).
 1187  *
 1188  * @return
 1189  *  - LE_FAULT         Function failed to get the location's data
 1190  *  - LE_OUT_OF_RANGE  At least one of the retrieved parameters is invalid (set to INT32_MAX).
 1191  *  - LE_OK            Function succeeded.
 1192  *
 1193  * @note latitudePtr, longitudePtr and hAccuracyPtr can be set to NULL if not needed.
 1194  *
 1195  * @note The latitude and longitude values are based on the WGS84 standard coordinate system.
 1196  *
 1197  * @note The latitude and longitude values are given in degrees with 6 decimal places like:
 1198  *       Latitude +48858300 = 48.858300 degrees North
 1199  *       Longitude +2294400 = 2.294400 degrees East
 1200  *       (The latitude and longitude values are given in degrees, minutes, seconds in NMEA frame)
 1201  *
 1202  * @note In case the function returns LE_OUT_OF_RANGE, some of the retrieved parameters may be
 1203  *       valid. Please compare them with INT32_MAX.
 1204  *
 1205  * @note If the caller is passing an invalid Position sample reference into this function,
 1206  *       it is a fatal error, the function will not return.
 1207  */
 1208 //--------------------------------------------------------------------------------------------------
 1209 le_result_t le_gnss_GetLocation
 1210 (
 1211     le_gnss_SampleRef_t positionSampleRef,
 1212         ///< [IN] Position sample's reference.
 1213     int32_t* latitudePtr,
 1214         ///< [OUT] WGS84 Latitude in degrees, positive North [resolution 1e-6].
 1215     int32_t* longitudePtr,
 1216         ///< [OUT] WGS84 Longitude in degrees, positive East [resolution 1e-6].
 1217     int32_t* hAccuracyPtr
 1218         ///< [OUT] Horizontal position's accuracy in meters [resolution 1e-2].
 1219 );
 1220 
 1221 //--------------------------------------------------------------------------------------------------
 1222 /**
 1223  * Get the position sample's altitude.
 1224  *
 1225  * @return
 1226  *  - LE_FAULT         Function failed to get the altitude. Invalid Position reference provided.
 1227  *  - LE_OUT_OF_RANGE  At least one of the retrieved parameters is invalid (set to INT32_MAX).
 1228  *  - LE_OK            Function succeeded.
 1229  *
 1230  * @note Altitude is in meters, above Mean Sea Level, with 3 decimal places (3047 = 3.047 meters).
 1231  *
 1232  * @note For a 2D position fix, the altitude will be indicated as invalid and set to INT32_MAX
 1233  *
 1234  * @note Vertical position accuracy is default set to meters with 1 decimal place (3047 = 3.0
 1235  *       meters). To change its accuracy, call the @c le_gnss_SetDataResolution() function. Vertical
 1236  *       position accuracy is set as data type and accuracy from 0 to 3 decimal place is set as
 1237  *       resolution.
 1238  *
 1239  * @note In case the function returns LE_OUT_OF_RANGE, some of the retrieved parameters may be
 1240  *       valid. Please compare them with INT32_MAX.
 1241  *
 1242  * @note If the caller is passing an invalid Position reference into this function,
 1243  *       it is a fatal error, the function will not return.
 1244  *
 1245  * @note altitudePtr, altitudeAccuracyPtr can be set to NULL if not needed.
 1246  */
 1247 //--------------------------------------------------------------------------------------------------
 1248 le_result_t le_gnss_GetAltitude
 1249 (
 1250     le_gnss_SampleRef_t positionSampleRef,
 1251         ///< [IN] Position sample's reference.
 1252     int32_t* altitudePtr,
 1253         ///< [OUT] Altitude in meters, above Mean Sea Level [resolution 1e-3].
 1254     int32_t* vAccuracyPtr
 1255         ///< [OUT] Vertical position's accuracy in meters.
 1256 );
 1257 
 1258 //--------------------------------------------------------------------------------------------------
 1259 /**
 1260  * Get the position sample's time.
 1261  *
 1262  * @return
 1263  *  - LE_FAULT         Function failed to get the time.
 1264  *  - LE_OUT_OF_RANGE  The retrieved time is invalid (all fields are set to 0).
 1265  *  - LE_OK            Function succeeded.
 1266  *
 1267  * @note If the caller is passing an invalid Position sample reference or null pointers into this
 1268  *       function, it is a fatal error, the function will not return.
 1269  *
 1270  */
 1271 //--------------------------------------------------------------------------------------------------
 1272 le_result_t le_gnss_GetTime
 1273 (
 1274     le_gnss_SampleRef_t positionSampleRef,
 1275         ///< [IN] Position sample's reference.
 1276     uint16_t* hoursPtr,
 1277         ///< [OUT] UTC Hours into the day [range 0..23].
 1278     uint16_t* minutesPtr,
 1279         ///< [OUT] UTC Minutes into the hour [range 0..59].
 1280     uint16_t* secondsPtr,
 1281         ///< [OUT] UTC Seconds into the minute [range 0..59].
 1282     uint16_t* millisecondsPtr
 1283         ///< [OUT] UTC Milliseconds into the second [range 0..999].
 1284 );
 1285 
 1286 //--------------------------------------------------------------------------------------------------
 1287 /**
 1288  * Get the position sample's GPS time.
 1289  *
 1290  * @return
 1291  *  - LE_FAULT         Function failed to get the time.
 1292  *  - LE_OUT_OF_RANGE  The retrieved time is invalid (all fields are set to 0).
 1293  *  - LE_OK            Function succeeded.
 1294  *
 1295  * @note If the caller is passing an invalid Position sample reference or null pointers into this
 1296  *       function, it is a fatal error, the function will not return.
 1297  */
 1298 //--------------------------------------------------------------------------------------------------
 1299 le_result_t le_gnss_GetGpsTime
 1300 (
 1301     le_gnss_SampleRef_t positionSampleRef,
 1302         ///< [IN] Position sample's reference.
 1303     uint32_t* gpsWeekPtr,
 1304         ///< [OUT] GPS week number from midnight, Jan. 6, 1980.
 1305     uint32_t* gpsTimeOfWeekPtr
 1306         ///< [OUT] Amount of time in milliseconds into the GPS week.
 1307 );
 1308 
 1309 //--------------------------------------------------------------------------------------------------
 1310 /**
 1311  *  Get the position sample's epoch time.
 1312  *
 1313  * @return
 1314  *  - LE_FAULT         Function failed to acquire the epoch time.
 1315  *  - LE_OK            Function succeeded.
 1316  *  - LE_OUT_OF_RANGE  The retrieved time is invalid (all fields are set to 0).
 1317  *
 1318  * @note The epoch time is the number of seconds elapsed since January 1, 1970
 1319  *       (midnight UTC/GMT), not counting leaps seconds.
 1320  *
 1321  * @note If the caller is passing an invalid position sample reference or a null pointer into this
 1322  *       function, it is a fatal error, the function will not return.
 1323  */
 1324 //--------------------------------------------------------------------------------------------------
 1325 le_result_t le_gnss_GetEpochTime
 1326 (
 1327     le_gnss_SampleRef_t positionSampleRef,
 1328         ///< [IN] Position sample's reference.
 1329     uint64_t* millisecondsPtr
 1330         ///< [OUT] Milliseconds since Jan. 1, 1970.
 1331 );
 1332 
 1333 //--------------------------------------------------------------------------------------------------
 1334 /**
 1335  * Get the position sample's time accurary.
 1336  *
 1337  * @return
 1338  *  - LE_FAULT         Function failed to get the time.
 1339  *  - LE_OUT_OF_RANGE  The retrieved time accuracy is invalid (set to UINT16_MAX).
 1340  *  - LE_OK            Function succeeded.
 1341  *
 1342  * @note If the caller is passing an invalid position sample reference or a null pointer into this
 1343  *       function, it is a fatal error, the function will not return.
 1344  */
 1345 //--------------------------------------------------------------------------------------------------
 1346 le_result_t le_gnss_GetTimeAccuracy
 1347 (
 1348     le_gnss_SampleRef_t positionSampleRef,
 1349         ///< [IN] Position sample's reference.
 1350     uint32_t* timeAccuracyPtr
 1351         ///< [OUT] Estimated time accuracy in nanoseconds
 1352 );
 1353 
 1354 //--------------------------------------------------------------------------------------------------
 1355 /**
 1356  * Get the position sample's UTC leap seconds in advance
 1357  *
 1358  * @return
 1359  *  - LE_FAULT         Function failed to get the leap seconds.
 1360  *  - LE_OUT_OF_RANGE  The retrieved time accuracy is invalid (set to UINT8_MAX).
 1361  *  - LE_OK            Function succeeded.
 1362  *
 1363  * @note The leap seconds in advance is the accumulated time in seconds since the start of GPS Epoch
 1364  * time (Jan 6, 1980). This value has to be added to the UTC time (since Jan. 1, 1970)
 1365  *
 1366  * @note Insertion of each UTC leap second is usually decided about six months in advance by the
 1367  * International Earth Rotation and Reference Systems Service (IERS).
 1368  *
 1369  * @note If the caller is passing an invalid position sample reference or a null pointer into this
 1370  *       function, it is a fatal error, the function will not return.
 1371  *
 1372  * @deprecated This function is deprecated, le_gnss_GetLeapSeconds should be used instead.
 1373  */
 1374 //--------------------------------------------------------------------------------------------------
 1375 le_result_t le_gnss_GetGpsLeapSeconds
 1376 (
 1377     le_gnss_SampleRef_t positionSampleRef,
 1378         ///< [IN] Position sample's reference.
 1379     uint8_t* leapSecondsPtr
 1380         ///< [OUT] UTC leap seconds in advance in seconds
 1381 );
 1382 
 1383 //--------------------------------------------------------------------------------------------------
 1384 /**
 1385  * Get leap seconds information.
 1386  *
 1387  * @return
 1388  *  - LE_OK            Function succeeded.
 1389  *  - LE_FAULT         Function failed to get the data.
 1390  *  - LE_TIMEOUT       Timeout occured.
 1391  *  - LE_UNSUPPORTED   Not supported on this platform.
 1392  *
 1393  * @note Insertion of each UTC leap second is usually decided about six months in advance by the
 1394  * International Earth Rotation and Reference Systems Service (IERS).
 1395  *
 1396  * @note If the caller is passing a null pointer into this function, it is considered a fatal
 1397  * error and the function will not return.
 1398  *
 1399  * @note If the return value of a parameter is INT32_MAX/UINT64_MAX, the parameter is not valid.
 1400  */
 1401 //--------------------------------------------------------------------------------------------------
 1402 le_result_t le_gnss_GetLeapSeconds
 1403 (
 1404     uint64_t* gpsTimePtr,
 1405         ///< [OUT] The number of milliseconds of GPS time since midnight,
 1406         ///< Jan. 6, 1980.
 1407     int32_t* currentLeapSecondsPtr,
 1408         ///< [OUT] Current UTC leap seconds value in milliseconds.
 1409     uint64_t* changeEventTimePtr,
 1410         ///< [OUT] The number of milliseconds since midnight, Jan. 6, 1980
 1411         ///< to the next leap seconds change event.
 1412     int32_t* nextLeapSecondsPtr
 1413         ///< [OUT] UTC leap seconds value to be applied at the change
 1414         ///< event time in milliseconds.
 1415 );
 1416 
 1417 //--------------------------------------------------------------------------------------------------
 1418 /**
 1419  * Get the position sample's date.
 1420  *
 1421  * @return
 1422  *  - LE_FAULT         Function failed to get the date.
 1423  *  - LE_OUT_OF_RANGE  The retrieved date is invalid (all fields are set to 0).
 1424  *  - LE_OK            Function succeeded.
 1425  *
 1426  * @note If the caller is passing an invalid Position sample reference or null pointers into this
 1427  *       function, it is a fatal error, the function will not return.
 1428  */
 1429 //--------------------------------------------------------------------------------------------------
 1430 le_result_t le_gnss_GetDate
 1431 (
 1432     le_gnss_SampleRef_t positionSampleRef,
 1433         ///< [IN] Position sample's reference.
 1434     uint16_t* yearPtr,
 1435         ///< [OUT] UTC Year A.D. [e.g. 2014].
 1436     uint16_t* monthPtr,
 1437         ///< [OUT] UTC Month into the year [range 1...12].
 1438     uint16_t* dayPtr
 1439         ///< [OUT] UTC Days into the month [range 1...31].
 1440 );
 1441 
 1442 //--------------------------------------------------------------------------------------------------
 1443 /**
 1444  * Get the position sample's horizontal speed.
 1445  *
 1446  *  - LE_FAULT         Function failed to find the positionSample.
 1447  *  - LE_OUT_OF_RANGE  At least one of the retrieved parameters is invalid (set to UINT32_MAX).
 1448  *  - LE_OK            Function succeeded.
 1449  *
 1450  * @note hSpeedPtr, hSpeedAccuracyPtr can be set to NULL if not needed.
 1451  *
 1452  * @note Horizontal speed is in meters/second with 2 decimal places (3047 = 30.47 meters/second).
 1453  *
 1454  * @note Horizontal speed accuracy estimate is default set to meters/second with 1 decimal place
 1455  *       (304 = 30.4 meters/second). To change its accuracy, call the @c le_gnss_SetDataResolution()
 1456  *       function. Horizontal speed accuracy estimate is set as data type and accuracy from 0 to 3
 1457  *       decimal place is set as resolution.
 1458  *
 1459  * @note In case the function returns LE_OUT_OF_RANGE, some of the retrieved parameters may be
 1460  *       valid. Please compare them with UINT32_MAX.
 1461  *
 1462  * @note If the caller is passing an invalid Position sample reference into this function,
 1463  *       it is a fatal error, the function will not return.
 1464  *
 1465  * @warning The Horizontal speed accuracy is platform dependent. Please refer to
 1466  *          @ref platformConstraintsGnss_speedAccuracies section for full details.
 1467  */
 1468 //--------------------------------------------------------------------------------------------------
 1469 le_result_t le_gnss_GetHorizontalSpeed
 1470 (
 1471     le_gnss_SampleRef_t positionSampleRef,
 1472         ///< [IN] Position sample's reference.
 1473     uint32_t* hspeedPtr,
 1474         ///< [OUT] Horizontal speed in meters/second [resolution 1e-2].
 1475     uint32_t* hspeedAccuracyPtr
 1476         ///< [OUT] Horizontal speed's accuracy estimate in meters/second.
 1477 );
 1478 
 1479 //--------------------------------------------------------------------------------------------------
 1480 /**
 1481  * Get the position sample's vertical speed.
 1482  *
 1483  * @return
 1484  *  - LE_FAULT         The function failed to find the positionSample.
 1485  *  - LE_OUT_OF_RANGE  At least one of the retrieved parameters is not valid (set to INT32_MAX).
 1486  *  - LE_OK            The function succeeded.
 1487  *
 1488  * @note vSpeedPtr, vSpeedAccuracyPtr can be set to NULL if not needed.
 1489  *
 1490  * @note For a 2D position Fix, the vertical speed will be indicated as invalid
 1491  * and set to INT32_MAX.
 1492  *
 1493  * @note Vertical speed accuracy estimate is default set to meters/second with 1 decimal place
 1494  *       (304 = 30.4 meters/second). To change its accuracy, call the @c le_gnss_SetDataResolution()
 1495  *       function. Vertical speed accuracy estimate is set as data type and accuracy from 0 to 3
 1496  *       decimal place is set as resolution.
 1497  *
 1498  * @note In case the function returns LE_OUT_OF_RANGE, some of the retrieved parameters may be
 1499  *       valid. Please compare them with INT32_MAX.
 1500  *
 1501  * @note If the caller is passing an invalid Position sample reference into this function,
 1502  *       it is a fatal error, the function will not return.
 1503  *
 1504  * @warning The Vertical speed accuracy is platform dependent. Please refer to
 1505  *          @ref platformConstraintsGnss_speedAccuracies section for full details.
 1506  */
 1507 //--------------------------------------------------------------------------------------------------
 1508 le_result_t le_gnss_GetVerticalSpeed
 1509 (
 1510     le_gnss_SampleRef_t positionSampleRef,
 1511         ///< [IN] Position sample's reference.
 1512     int32_t* vspeedPtr,
 1513         ///< [OUT] Vertical speed in meters/second [resolution 1e-2],
 1514         ///< positive up.
 1515     int32_t* vspeedAccuracyPtr
 1516         ///< [OUT] Vertical speed's accuracy estimate in meters/second.
 1517 );
 1518 
 1519 //--------------------------------------------------------------------------------------------------
 1520 /**
 1521  * Get the position sample's direction. Direction of movement is the direction that the vehicle or
 1522  * person is actually moving.
 1523  *
 1524  * @return
 1525  *  - LE_FAULT         Function failed to find the positionSample.
 1526  *  - LE_OUT_OF_RANGE  At least one of the retrieved parameters is invalid (set to UINT32_MAX).
 1527  *  - LE_OK            Function succeeded.
 1528  *
 1529  * @note Direction and direction accuracy are given in degrees with 1 decimal place: 1755 = 175.5
 1530  *       degrees.
 1531  *       Direction ranges from 0 to 359.9 degrees, where 0 is True North.
 1532  *
 1533  * @note In case the function returns LE_OUT_OF_RANGE, some of the retrieved parameters may be
 1534  *       valid. Please compare them with UINT32_MAX.
 1535  *
 1536  * @note directionPtr, directionAccuracyPtr can be set to NULL if not needed.
 1537  *
 1538  * @note If the caller is passing an invalid Position sample reference into this function,
 1539  *       it is a fatal error, the function will not return.
 1540  */
 1541 //--------------------------------------------------------------------------------------------------
 1542 le_result_t le_gnss_GetDirection
 1543 (
 1544     le_gnss_SampleRef_t positionSampleRef,
 1545         ///< [IN] Position sample's reference.
 1546     uint32_t* directionPtr,
 1547         ///< [OUT] Direction in degrees [resolution 1e-1].
 1548         ///< Range: 0 to 359.9, where 0 is True North
 1549     uint32_t* directionAccuracyPtr
 1550         ///< [OUT] Direction's accuracy estimate
 1551         ///< in degrees [resolution 1e-1].
 1552 );
 1553 
 1554 //--------------------------------------------------------------------------------------------------
 1555 /**
 1556  * Get the Satellites Vehicle information.
 1557  *
 1558  * @return
 1559  *  - LE_FAULT         Function failed to find the positionSample.
 1560  *  - LE_OUT_OF_RANGE  At least one of the retrieved parameters is invalid.
 1561  *  - LE_OK            Function succeeded.
 1562  *
 1563  * @note satId[] can be set to 0 if that information list index is not configured, so
 1564  * all satellite parameters (satConst[], satSnr[],satAzim[], satElev[]) are fixed to 0.
 1565  *
 1566  * @note For LE_OUT_OF_RANGE returned code, invalid value depends on field type:
 1567  * UINT16_MAX for satId, LE_GNSS_SV_CONSTELLATION_UNDEFINED for satConst, false for satUsed,
 1568  * UINT8_MAX for satSnr, UINT16_MAX for satAzim, UINT8_MAX for satElev.
 1569  *
 1570  * @note In case the function returns LE_OUT_OF_RANGE, some of the retrieved parameters may be
 1571  *       valid.
 1572  *
 1573  * @note If the caller is passing an invalid Position sample reference into this function,
 1574  *       it is a fatal error, the function will not return.
 1575  */
 1576 //--------------------------------------------------------------------------------------------------
 1577 le_result_t le_gnss_GetSatellitesInfo
 1578 (
 1579     le_gnss_SampleRef_t positionSampleRef,
 1580         ///< [IN] Position sample's reference.
 1581     uint16_t* satIdPtr,
 1582         ///< [OUT] Satellites in View ID number, referring
 1583         ///< to NMEA standard.
 1584     size_t* satIdSizePtr,
 1585         ///< [INOUT]
 1586     le_gnss_Constellation_t* satConstPtr,
 1587         ///< [OUT] GNSS constellation type.
 1588     size_t* satConstSizePtr,
 1589         ///< [INOUT]
 1590     bool* satUsedPtr,
 1591         ///< [OUT] TRUE if satellite in View Used
 1592         ///< for Navigation.
 1593     size_t* satUsedSizePtr,
 1594         ///< [INOUT]
 1595     uint8_t* satSnrPtr,
 1596         ///< [OUT] Satellites in View Signal To
 1597         ///< Noise Ratio (C/No) [dBHz].
 1598     size_t* satSnrSizePtr,
 1599         ///< [INOUT]
 1600     uint16_t* satAzimPtr,
 1601         ///< [OUT] Satellites in View Azimuth [degrees].
 1602         ///< Range: 0 to 360
 1603         ///< If Azimuth angle is currently unknown,
 1604         ///< the value is set to UINT16_MAX.
 1605     size_t* satAzimSizePtr,
 1606         ///< [INOUT]
 1607     uint8_t* satElevPtr,
 1608         ///< [OUT] Satellites in View Elevation [degrees].
 1609         ///< Range: 0 to 90
 1610         ///< If Elevation angle is currently unknown,
 1611         ///< the value is set to UINT8_MAX.
 1612     size_t* satElevSizePtr
 1613         ///< [INOUT]
 1614 );
 1615 
 1616 //--------------------------------------------------------------------------------------------------
 1617 /**
 1618  * Get the SBAS constellation category given the SBAS satellite number ID.
 1619  *
 1620  */
 1621 //--------------------------------------------------------------------------------------------------
 1622 le_gnss_SbasConstellationCategory_t le_gnss_GetSbasConstellationCategory
 1623 (
 1624     uint16_t satId
 1625         ///< [IN] SBAS satellite number ID, referring to NMEA standard.
 1626 );
 1627 
 1628 //--------------------------------------------------------------------------------------------------
 1629 /**
 1630  * Get the Satellites Vehicle status.
 1631  *
 1632  * @return
 1633  *  - LE_FAULT         Function failed to find the positionSample.
 1634  *  - LE_OUT_OF_RANGE  At least one of the retrieved parameters is invalid (set to UINT8_MAX).
 1635  *  - LE_OK            Function succeeded.
 1636  *
 1637  * @note In case the function returns LE_OUT_OF_RANGE, some of the retrieved parameters may be
 1638  *       valid. Please compare them with UINT8_MAX.
 1639  *
 1640  * @note If the caller is passing an invalid Position sample reference into this function,
 1641  *       it is a fatal error, the function will not return.
 1642  */
 1643 //--------------------------------------------------------------------------------------------------
 1644 le_result_t le_gnss_GetSatellitesStatus
 1645 (
 1646     le_gnss_SampleRef_t positionSampleRef,
 1647         ///< [IN] Position sample's reference.
 1648     uint8_t* satsInViewCountPtr,
 1649         ///< [OUT] Number of satellites expected to be in view.
 1650     uint8_t* satsTrackingCountPtr,
 1651         ///< [OUT] Number of satellites in view, when tracking.
 1652     uint8_t* satsUsedCountPtr
 1653         ///< [OUT] Number of satellites in view used for Navigation.
 1654 );
 1655 
 1656 //--------------------------------------------------------------------------------------------------
 1657 /**
 1658  * Get the DOP parameter (Dilution Of Precision) for the fixed position.
 1659  *
 1660  * @return
 1661  *  - LE_FAULT         Function failed to find the DOP value.
 1662  *  - LE_OUT_OF_RANGE  The retrieved parameter is invalid (set to UINT16_MAX).
 1663  *  - LE_OK            Function succeeded.
 1664  *
 1665  * @note The DOP value is given with 3 decimal places by default like: DOP value 2200 = 2.200
 1666  *       The resolution can be modified by calling the @c le_gnss_SetDopResolution() function.
 1667  *
 1668  * @note If the caller is passing an invalid Position sample reference into this function,
 1669  *       it is a fatal error, the function will not return.
 1670  */
 1671 //--------------------------------------------------------------------------------------------------
 1672 le_result_t le_gnss_GetDilutionOfPrecision
 1673 (
 1674     le_gnss_SampleRef_t positionSampleRef,
 1675         ///< [IN] Position sample's reference.
 1676     le_gnss_DopType_t dopType,
 1677         ///< [IN] Dilution of Precision type [range 0..5].
 1678     uint16_t* dopPtr
 1679         ///< [OUT] Dilution of Precision corresponding to the dopType
 1680 );
 1681 
 1682 //--------------------------------------------------------------------------------------------------
 1683 /**
 1684  * Get the position sample's altitude with respect to the WGS-84 ellipsoid
 1685  *
 1686  * @return
 1687  *  - LE_FAULT         Function failed to get the altitude.
 1688  *  - LE_OUT_OF_RANGE  The altitudeOnWgs84 is invalid (set to INT32_MAX).
 1689  *  - LE_OK            Function succeeded.
 1690  *
 1691  * @note altitudeOnWgs84 is in meters, with respect to the WGS-84 ellipsoid with 3 decimal
 1692  *       places (3047 = 3.047 meters).
 1693  *
 1694  * @note For a 2D position fix, the altitude with respect to the WGS-84 ellipsoid will be indicated
 1695  *       as invalid and set to INT32_MAX.
 1696  *
 1697  * @note If the caller is passing an invalid Position reference or a null pointer into this
 1698  *       function, it is a fatal error, the function will not return.
 1699  */
 1700 //--------------------------------------------------------------------------------------------------
 1701 le_result_t le_gnss_GetAltitudeOnWgs84
 1702 (
 1703     le_gnss_SampleRef_t positionSampleRef,
 1704         ///< [IN] Position sample's reference.
 1705     int32_t* altitudeOnWgs84Ptr
 1706         ///< [OUT] Altitude in meters, between WGS-84 earth ellipsoid
 1707         ///< and mean sea level [resolution 1e-3].
 1708 );
 1709 
 1710 //--------------------------------------------------------------------------------------------------
 1711 /**
 1712  * Get the position sample's magnetic deviation. It is the difference between the bearing to
 1713  * true north and the bearing shown on a magnetic compass. The deviation is positive when the
 1714  * magnetic north is east of true north.
 1715  *
 1716  * @return
 1717  *  - LE_FAULT         Function failed to find the positionSample.
 1718  *  - LE_OUT_OF_RANGE  The magneticDeviation is invalid (set to INT32_MAX).
 1719  *  - LE_OK            Function succeeded.
 1720  *
 1721  * @note magneticDeviation is in degrees, with 1 decimal places (47 = 4.7 degree).
 1722  *
 1723  * @note If the caller is passing an invalid Position sample reference into this function,
 1724  *       it is a fatal error, the function will not return.
 1725  */
 1726 //--------------------------------------------------------------------------------------------------
 1727 le_result_t le_gnss_GetMagneticDeviation
 1728 (
 1729     le_gnss_SampleRef_t positionSampleRef,
 1730         ///< [IN] Position sample's reference.
 1731     int32_t* magneticDeviationPtr
 1732         ///< [OUT] MagneticDeviation in degrees [resolution 1e-1].
 1733 );
 1734 
 1735 //--------------------------------------------------------------------------------------------------
 1736 /**
 1737  * This function gets the last updated position sample object reference.
 1738  *
 1739  * @return A reference to last Position's sample.
 1740  *
 1741  * @note
 1742  *      On failure, the process exits, so you don't have to worry about checking the returned
 1743  *      reference for validity.
 1744  */
 1745 //--------------------------------------------------------------------------------------------------
 1746 le_gnss_SampleRef_t le_gnss_GetLastSampleRef
 1747 (
 1748     void
 1749 );
 1750 
 1751 //--------------------------------------------------------------------------------------------------
 1752 /**
 1753  * This function must be called to release the position sample.
 1754  *
 1755  * @note If the caller is passing an invalid Position sample reference into this function,
 1756  *       it is a fatal error, the function will not return.
 1757  */
 1758 //--------------------------------------------------------------------------------------------------
 1759 void le_gnss_ReleaseSampleRef
 1760 (
 1761     le_gnss_SampleRef_t positionSampleRef
 1762         ///< [IN] Position sample's reference.
 1763 );
 1764 
 1765 //--------------------------------------------------------------------------------------------------
 1766 /**
 1767  * This function sets the SUPL Assisted-GNSS mode.
 1768  *
 1769  * @return
 1770  *  - LE_OK on success
 1771  *  - LE_FAULT on failure
 1772  *  - LE_UNSUPPORTED request not supported
 1773  *  - LE_TIMEOUT a time-out occurred
 1774  *
 1775  * @warning The settings are platform dependent. Please refer to
 1776  *          @ref platformConstraintsGnss_SettingConfiguration section for full details.
 1777  */
 1778 //--------------------------------------------------------------------------------------------------
 1779 le_result_t le_gnss_SetSuplAssistedMode
 1780 (
 1781     le_gnss_AssistedMode_t assistedMode
 1782         ///< [IN] Assisted-GNSS mode.
 1783 );
 1784 
 1785 //--------------------------------------------------------------------------------------------------
 1786 /**
 1787  * This function gets the SUPL Assisted-GNSS mode.
 1788  *
 1789  * @return
 1790  *  - LE_OK on success
 1791  *  - LE_FAULT on failure
 1792  *
 1793  * @note If the caller is passing a null pointer into this function, it is a fatal error, the
 1794  *       function will not return.
 1795  */
 1796 //--------------------------------------------------------------------------------------------------
 1797 le_result_t le_gnss_GetSuplAssistedMode
 1798 (
 1799     le_gnss_AssistedMode_t* assistedModePtr
 1800         ///< [OUT] Assisted-GNSS mode.
 1801 );
 1802 
 1803 //--------------------------------------------------------------------------------------------------
 1804 /**
 1805  * This function sets the SUPL server URL.
 1806  * That server URL is a NULL-terminated string with a maximum string length (including NULL
 1807  * terminator) equal to 256. Optionally the port number is specified after a colon.
 1808  *
 1809  * @return
 1810  *  - LE_OK on success
 1811  *  - LE_FAULT on failure
 1812  *  - LE_BUSY service is busy
 1813  *  - LE_TIMEOUT a time-out occurred
 1814  *
 1815  * @note If the SUPL server URL size is bigger than the maximum string length (including NULL
 1816  * terminator) size, it is a fatal error, the function will not return.
 1817  *
 1818  * @warning The settings are platform dependent. Please refer to
 1819  *          @ref platformConstraintsGnss_SettingConfiguration section for full details.
 1820  */
 1821 //--------------------------------------------------------------------------------------------------
 1822 le_result_t le_gnss_SetSuplServerUrl
 1823 (
 1824     const char* LE_NONNULL suplServerUrl
 1825         ///< [IN] SUPL server URL.
 1826 );
 1827 
 1828 //--------------------------------------------------------------------------------------------------
 1829 /**
 1830  * This function injects the SUPL certificate to be used in A-GNSS sessions. Certificates must
 1831  * be encoded in DER. Other certificate encryptions (e.g., PEM, CER and CRT)
 1832  * aren't supported.
 1833  *
 1834  * @return
 1835  *  - LE_OK on success
 1836  *  - LE_BAD_PARAMETER on invalid parameter
 1837  *  - LE_FAULT on failure
 1838  *  - LE_BUSY service is busy
 1839  *  - LE_TIMEOUT a time-out occurred
 1840  *
 1841  * @note If the SUPL certificate size is bigger than the Maximum SUPL certificate size,
 1842  * it is a fatal error, the function will not return.
 1843  */
 1844 //--------------------------------------------------------------------------------------------------
 1845 le_result_t le_gnss_InjectSuplCertificate
 1846 (
 1847     uint8_t suplCertificateId,
 1848         ///< [IN] ID of the SUPL certificate.
 1849         ///< Certificate ID range is 0 to 9
 1850     uint16_t suplCertificateLen,
 1851         ///< [IN] SUPL certificate size in Bytes.
 1852     const char* LE_NONNULL suplCertificate
 1853         ///< [IN] SUPL certificate contents.
 1854 );
 1855 
 1856 //--------------------------------------------------------------------------------------------------
 1857 /**
 1858  * This function deletes the SUPL certificate.
 1859  *
 1860  * @return
 1861  *  - LE_OK on success
 1862  *  - LE_BAD_PARAMETER on invalid parameter
 1863  *  - LE_FAULT on failure
 1864  *  - LE_BUSY service is busy
 1865  *  - LE_TIMEOUT a time-out occurred
 1866  */
 1867 //--------------------------------------------------------------------------------------------------
 1868 le_result_t le_gnss_DeleteSuplCertificate
 1869 (
 1870     uint8_t suplCertificateId
 1871         ///< [IN] ID of the SUPL certificate.
 1872         ///< Certificate ID range is 0 to 9
 1873 );
 1874 
 1875 //--------------------------------------------------------------------------------------------------
 1876 /**
 1877  * This function sets the enabled NMEA sentences using a bit mask.
 1878  *
 1879  * @return
 1880  *  - LE_OK             Success
 1881  *  - LE_BAD_PARAMETER  Bit mask exceeds the maximal value
 1882  *  - LE_FAULT          Failure
 1883  *  - LE_BUSY           Service is busy
 1884  *  - LE_TIMEOUT        Timeout occurred
 1885  *  - LE_NOT_PERMITTED  GNSS device is not in "ready" state
 1886  *
 1887  * @warning This function may be subject to limitations depending on the platform. Please refer to
 1888  *          the @ref platformConstraintsGnss page.
 1889  *
 1890  * @note Some NMEA sentences are unsupported depending on the platform. Please refer to
 1891  *       @ref platformConstraintsGnss_nmeaMask section for full details. Setting an unsuported NMEA
 1892  *       sentence won't report an error.
 1893  *
 1894  * @warning The settings are platform dependent. Please refer to
 1895  *          @ref platformConstraintsGnss_SettingConfiguration section for full details.
 1896  */
 1897 //--------------------------------------------------------------------------------------------------
 1898 le_result_t le_gnss_SetNmeaSentences
 1899 (
 1900     le_gnss_NmeaBitMask_t nmeaMask
 1901         ///< [IN] Bit mask for enabled NMEA sentences.
 1902 );
 1903 
 1904 //--------------------------------------------------------------------------------------------------
 1905 /**
 1906  * This function gets the bit mask for the enabled NMEA sentences.
 1907  *
 1908  * @return
 1909  *  - LE_OK             Success
 1910  *  - LE_FAULT          Failure
 1911  *  - LE_BUSY           Service is busy
 1912  *  - LE_TIMEOUT        Timeout occurred
 1913  *  - LE_NOT_PERMITTED  GNSS device is not in "ready" state
 1914  *
 1915  * @note If the caller is passing a null pointer to this function, it is a fatal error, the
 1916  *       function will not return.
 1917  *
 1918  * @note Some NMEA sentences are unsupported depending on the platform. Please refer to
 1919  *       @ref platformConstraintsGnss_nmeaMask section for full details. The bit mask for an unset
 1920  *       or unsupported NMEA sentence is zero.
 1921  */
 1922 //--------------------------------------------------------------------------------------------------
 1923 le_result_t le_gnss_GetNmeaSentences
 1924 (
 1925     le_gnss_NmeaBitMask_t* nmeaMaskPtrPtr
 1926         ///< [OUT] Bit mask for enabled NMEA sentences.
 1927 );
 1928 
 1929 //--------------------------------------------------------------------------------------------------
 1930 /**
 1931  * This function returns the status of the GNSS device.
 1932  *
 1933  */
 1934 //--------------------------------------------------------------------------------------------------
 1935 le_gnss_State_t le_gnss_GetState
 1936 (
 1937     void
 1938 );
 1939 
 1940 //--------------------------------------------------------------------------------------------------
 1941 /**
 1942  * This function sets the GNSS minimum elevation.
 1943  *
 1944  * @return
 1945  *  - LE_OK on success
 1946  *  - LE_FAULT on failure
 1947  *  - LE_OUT_OF_RANGE if the minimum elevation is above range
 1948  *  - LE_UNSUPPORTED request not supported
 1949  *
 1950  * @warning The settings are platform dependent. Please refer to
 1951  *          @ref platformConstraintsGnss_SettingConfiguration section for full details.
 1952  */
 1953 //--------------------------------------------------------------------------------------------------
 1954 le_result_t le_gnss_SetMinElevation
 1955 (
 1956     uint8_t minElevation
 1957         ///< [IN] Minimum elevation in degrees [range 0..90].
 1958 );
 1959 
 1960 //--------------------------------------------------------------------------------------------------
 1961 /**
 1962  * This function gets the GNSS minimum elevation.
 1963  *
 1964  * @return
 1965  *  - LE_OK on success
 1966  *  - LE_FAULT on failure
 1967  *  - LE_UNSUPPORTED request not supported
 1968  *
 1969  * @note If the caller is passing n null pointer to this function, it is a fatal error, the
 1970  *       function will not return.
 1971  */
 1972 //--------------------------------------------------------------------------------------------------
 1973 le_result_t le_gnss_GetMinElevation
 1974 (
 1975     uint8_t* minElevationPtrPtr
 1976         ///< [OUT] Minimum elevation in degrees [range 0..90].
 1977 );
 1978 
 1979 //--------------------------------------------------------------------------------------------------
 1980 /**
 1981  * Set the resolution for the DOP parameters
 1982  *
 1983  * @return LE_OK               Function succeeded.
 1984  * @return LE_BAD_PARAMETER    Invalid parameter provided.
 1985  * @return LE_FAULT            Function failed.
 1986  *
 1987  * @note The function sets the same resolution to all DOP values returned by
 1988  *       le_gnss_GetDilutionOfPrecision() API. The resolution setting takes effect immediately.
 1989  *
 1990  * @note The resolution setting is done per client session.
 1991  */
 1992 //--------------------------------------------------------------------------------------------------
 1993 le_result_t le_gnss_SetDopResolution
 1994 (
 1995     le_gnss_Resolution_t resolution
 1996         ///< [IN] Resolution.
 1997 );
 1998 
 1999 //--------------------------------------------------------------------------------------------------
 2000 /**
 2001  * Set the resolution for the specific type of data
 2002  *
 2003  * @return LE_OK               Function succeeded.
 2004  * @return LE_BAD_PARAMETER    Invalid parameter provided.
 2005  * @return LE_FAULT            Function failed.
 2006  *
 2007  * @note The resolution setting takes effect immediately and is not persistent to reset.
 2008  *
 2009  * @note The resolution setting is done per client session.
 2010  */
 2011 //--------------------------------------------------------------------------------------------------
 2012 le_result_t le_gnss_SetDataResolution
 2013 (
 2014     le_gnss_DataType_t dataType,
 2015         ///< [IN] Data type.
 2016     le_gnss_Resolution_t resolution
 2017         ///< [IN] Resolution.
 2018 );
 2019 
 2020 //--------------------------------------------------------------------------------------------------
 2021 /**
 2022  * This function converts a location data parameter from/to multi-coordinate system
 2023  *
 2024  * @return
 2025  *  - LE_OK on success
 2026  *  - LE_FAULT on failure
 2027  *  - LE_BAD_PARAMETER Invalid parameter provided.
 2028  *  - LE_UNSUPPORTED request not supported
 2029  *
 2030  * @note The resolution of location data parameter remains unchanged after the conversion.
 2031  */
 2032 //--------------------------------------------------------------------------------------------------
 2033 le_result_t le_gnss_ConvertDataCoordinateSystem
 2034 (
 2035     le_gnss_CoordinateSystem_t coordinateSrc,
 2036         ///< [IN] Coordinate system to convert from.
 2037     le_gnss_CoordinateSystem_t coordinateDst,
 2038         ///< [IN] Coordinate system to convert to.
 2039     le_gnss_LocationDataType_t locationDataType,
 2040         ///< [IN] Type of location data to convert.
 2041     int64_t locationDataSrc,
 2042         ///< [IN] Data to convert.
 2043     int64_t* locationDataDstPtr
 2044         ///< [OUT] Converted Data.
 2045 );
 2046 
 2047 //--------------------------------------------------------------------------------------------------
 2048 /**
 2049  * Enables the EXT_GPS_LNA_EN signal
 2050  *
 2051  * @return LE_OK               Function succeeded.
 2052  * @return LE_NOT_PERMITTED    GNSS is not in the ready state
 2053  * @return LE_UNSUPPORTED      Function not supported on this platform
 2054  *
 2055  * @note The EXT_GPS_LNA_EN signal will be set high when the GNSS state is active
 2056  */
 2057 //--------------------------------------------------------------------------------------------------
 2058 le_result_t le_gnss_EnableExternalLna
 2059 (
 2060     void
 2061 );
 2062 
 2063 //--------------------------------------------------------------------------------------------------
 2064 /**
 2065  * Disables the EXT_GPS_LNA_EN signal
 2066  *
 2067  * @return LE_OK               Function succeeded.
 2068  * @return LE_NOT_PERMITTED    GNSS is not in the ready state
 2069  * @return LE_UNSUPPORTED      Function not supported on this platform
 2070  *
 2071  */
 2072 //--------------------------------------------------------------------------------------------------
 2073 le_result_t le_gnss_DisableExternalLna
 2074 (
 2075     void
 2076 );
 2077 
 2078 //--------------------------------------------------------------------------------------------------
 2079 /**
 2080  * Read the EXT_GPS_LNA_EN status
 2081  *
 2082  * @return LE_OK               Function succeeded.
 2083  * @return LE_NOT_PERMITTED    GNSS is not in the ready state
 2084  * @return LE_UNSUPPORTED      Function not supported on this platform
 2085  *
 2086  */
 2087 //--------------------------------------------------------------------------------------------------
 2088 le_result_t le_gnss_GetExternalLna
 2089 (
 2090     uint8_t* lnaStatusPtr
 2091         ///< [OUT] GNSS LNA Status
 2092 );
 2093 
 2094 //--------------------------------------------------------------------------------------------------
 2095 /**
 2096  * Returns a bitmask containing all NMEA sentences supported on this platform
 2097  *
 2098  * @return LE_OK               Function succeeded.
 2099  * @return LE_UNSUPPORTED      Function not supported on this platform.
 2100  */
 2101 //--------------------------------------------------------------------------------------------------
 2102 le_result_t le_gnss_GetSupportedNmeaSentences
 2103 (
 2104     le_gnss_NmeaBitMask_t* NmeaMaskPtr
 2105         ///< [OUT] Supported NMEA sentences
 2106 );
 2107 
 2108 //--------------------------------------------------------------------------------------------------
 2109 /**
 2110  * Returns a bitmask containing all satellite constellations supported on this platform
 2111  *
 2112  * @return LE_OK               Function succeeded.
 2113  * @return LE_UNSUPPORTED      Function not supported on this platform.
 2114  */
 2115 //--------------------------------------------------------------------------------------------------
 2116 le_result_t le_gnss_GetSupportedConstellations
 2117 (
 2118     le_gnss_ConstellationBitMask_t* constellationMaskPtr
 2119         ///< [OUT] Supported GNSS constellations
 2120 );
 2121 
 2122 //--------------------------------------------------------------------------------------------------
 2123 /**
 2124  * Get the minimum NMEA rate supported on this platform
 2125  *
 2126  * @return LE_OK               Function succeeded.
 2127  * @return LE_UNSUPPORTED      Function not supported on this platform
 2128  */
 2129 //--------------------------------------------------------------------------------------------------
 2130 le_result_t le_gnss_GetMinNmeaRate
 2131 (
 2132     uint32_t* minNmeaRatePtr
 2133         ///< [OUT] Minimum NMEA rate in milliseconds.
 2134 );
 2135 
 2136 //--------------------------------------------------------------------------------------------------
 2137 /**
 2138  * Get the maximum NMEA rate supported on this platform
 2139  *
 2140  * @return LE_OK               Function succeeded.
 2141  * @return LE_UNSUPPORTED      Function not supported on this platform
 2142  */
 2143 //--------------------------------------------------------------------------------------------------
 2144 le_result_t le_gnss_GetMaxNmeaRate
 2145 (
 2146     uint32_t* maxNmeaRatePtr
 2147         ///< [OUT] Maximum NMEA rate in milliseconds.
 2148 );
 2149 
 2150 /** @} **/
 2151 
 2152 #endif // LE_GNSS_INTERFACE_H_INCLUDE_GUARD
le_gnss_GetConstellation
le_result_t le_gnss_GetConstellation(le_gnss_ConstellationBitMask_t *constellationMaskPtr)
le_gnss_FixState_t
le_gnss_FixState_t
Definition: le_gnss_common.h:155
le_gnss_Enable
le_result_t le_gnss_Enable(void)
le_gnss_GetExternalLna
le_result_t le_gnss_GetExternalLna(uint8_t *lnaStatusPtr)
le_gnss_ForceHotRestart
le_result_t le_gnss_ForceHotRestart(void)
le_gnss_SetAcquisitionRate
le_result_t le_gnss_SetAcquisitionRate(uint32_t rate)
le_gnss_GetEpochTime
le_result_t le_gnss_GetEpochTime(le_gnss_SampleRef_t positionSampleRef, uint64_t *millisecondsPtr)
le_gnss_GetSuplAssistedMode
le_result_t le_gnss_GetSuplAssistedMode(le_gnss_AssistedMode_t *assistedModePtr)
le_gnss_RemovePositionHandler
void le_gnss_RemovePositionHandler(le_gnss_PositionHandlerRef_t handlerRef)
le_result_t
le_result_t
Definition: le_basics.h:46
le_gnss_GetExtendedEphemerisValidity
le_result_t le_gnss_GetExtendedEphemerisValidity(uint64_t *startTimePtr, uint64_t *stopTimePtr)
le_gnss_GetTtff
le_result_t le_gnss_GetTtff(uint32_t *ttffPtr)
le_gnss_ForceColdRestart
le_result_t le_gnss_ForceColdRestart(void)
le_gnss_GetAltitude
le_result_t le_gnss_GetAltitude(le_gnss_SampleRef_t positionSampleRef, int32_t *altitudePtr, int32_t *vAccuracyPtr)
le_gnss_SetSuplServerUrl
le_result_t le_gnss_SetSuplServerUrl(const char *LE_NONNULL suplServerUrl)
le_gnss_GetMinElevation
le_result_t le_gnss_GetMinElevation(uint8_t *minElevationPtrPtr)
le_gnss_ForceWarmRestart
le_result_t le_gnss_ForceWarmRestart(void)
le_gnss_GetPositionState
le_result_t le_gnss_GetPositionState(le_gnss_SampleRef_t positionSampleRef, le_gnss_FixState_t *statePtr)
le_gnss_EnableExtendedEphemerisFile
le_result_t le_gnss_EnableExtendedEphemerisFile(void)
le_gnss_Constellation_t
le_gnss_Constellation_t
Definition: le_gnss_common.h:243
le_gnss_common.h
le_gnss_DopType_t
le_gnss_DopType_t
Definition: le_gnss_common.h:293
le_gnss_GetState
le_gnss_State_t le_gnss_GetState(void)
le_gnss_SetConstellation
le_result_t le_gnss_SetConstellation(le_gnss_ConstellationBitMask_t constellationMask)
le_gnss_GetSatellitesInfo
le_result_t le_gnss_GetSatellitesInfo(le_gnss_SampleRef_t positionSampleRef, uint16_t *satIdPtr, size_t *satIdSizePtr, le_gnss_Constellation_t *satConstPtr, size_t *satConstSizePtr, bool *satUsedPtr, size_t *satUsedSizePtr, uint8_t *satSnrPtr, size_t *satSnrSizePtr, uint16_t *satAzimPtr, size_t *satAzimSizePtr, uint8_t *satElevPtr, size_t *satElevSizePtr)
le_gnss_StartMode
le_result_t le_gnss_StartMode(le_gnss_StartMode_t mode)
le_gnss_ConnectService
void le_gnss_ConnectService(void)
le_gnss_SetNmeaSentences
le_result_t le_gnss_SetNmeaSentences(le_gnss_NmeaBitMask_t nmeaMask)
le_gnss_CoordinateSystem_t
le_gnss_CoordinateSystem_t
Definition: le_gnss_common.h:391
le_gnss_DisconnectService
void le_gnss_DisconnectService(void)
le_gnss_DisableExternalLna
le_result_t le_gnss_DisableExternalLna(void)
le_gnss_GetNmeaSentences
le_result_t le_gnss_GetNmeaSentences(le_gnss_NmeaBitMask_t *nmeaMaskPtrPtr)
le_gnss_SetMinElevation
le_result_t le_gnss_SetMinElevation(uint8_t minElevation)
le_gnss_StartMode_t
le_gnss_StartMode_t
Definition: le_gnss_common.h:427
le_gnss_SbasConstellationCategory_t
le_gnss_SbasConstellationCategory_t
Definition: le_gnss_common.h:214
le_gnss_GetSbasConstellationCategory
le_gnss_SbasConstellationCategory_t le_gnss_GetSbasConstellationCategory(uint16_t satId)
le_gnss_GetSatellitesStatus
le_result_t le_gnss_GetSatellitesStatus(le_gnss_SampleRef_t positionSampleRef, uint8_t *satsInViewCountPtr, uint8_t *satsTrackingCountPtr, uint8_t *satsUsedCountPtr)
le_gnss_SetConstellationArea
le_result_t le_gnss_SetConstellationArea(le_gnss_Constellation_t satConstellation, le_gnss_ConstellationArea_t constellationArea)
le_gnss_TryConnectService
le_result_t le_gnss_TryConnectService(void)
le_gnss_InjectSuplCertificate
le_result_t le_gnss_InjectSuplCertificate(uint8_t suplCertificateId, uint16_t suplCertificateLen, const char *LE_NONNULL suplCertificate)
le_gnss_ConstellationArea_t
le_gnss_ConstellationArea_t
Definition: le_gnss_common.h:316
le_gnss_GetMagneticDeviation
le_result_t le_gnss_GetMagneticDeviation(le_gnss_SampleRef_t positionSampleRef, int32_t *magneticDeviationPtr)
le_gnss_ConvertDataCoordinateSystem
le_result_t le_gnss_ConvertDataCoordinateSystem(le_gnss_CoordinateSystem_t coordinateSrc, le_gnss_CoordinateSystem_t coordinateDst, le_gnss_LocationDataType_t locationDataType, int64_t locationDataSrc, int64_t *locationDataDstPtr)
le_gnss_GetSupportedNmeaSentences
le_result_t le_gnss_GetSupportedNmeaSentences(le_gnss_NmeaBitMask_t *NmeaMaskPtr)
le_gnss_GetSupportedConstellations
le_result_t le_gnss_GetSupportedConstellations(le_gnss_ConstellationBitMask_t *constellationMaskPtr)
le_gnss_GetMinNmeaRate
le_result_t le_gnss_GetMinNmeaRate(uint32_t *minNmeaRatePtr)
le_gnss_GetTime
le_result_t le_gnss_GetTime(le_gnss_SampleRef_t positionSampleRef, uint16_t *hoursPtr, uint16_t *minutesPtr, uint16_t *secondsPtr, uint16_t *millisecondsPtr)
le_gnss_GetLocation
le_result_t le_gnss_GetLocation(le_gnss_SampleRef_t positionSampleRef, int32_t *latitudePtr, int32_t *longitudePtr, int32_t *hAccuracyPtr)
le_gnss_GetAltitudeOnWgs84
le_result_t le_gnss_GetAltitudeOnWgs84(le_gnss_SampleRef_t positionSampleRef, int32_t *altitudeOnWgs84Ptr)
le_gnss_Stop
le_result_t le_gnss_Stop(void)
le_gnss_LocationDataType_t
le_gnss_LocationDataType_t
Definition: le_gnss_common.h:408
le_gnss_GetAcquisitionRate
le_result_t le_gnss_GetAcquisitionRate(uint32_t *ratePtr)
le_gnss_PositionHandlerFunc_t
void(* le_gnss_PositionHandlerFunc_t)(le_gnss_SampleRef_t positionSampleRef, void *contextPtr)
Definition: le_gnss_common.h:458
le_gnss_DataType_t
le_gnss_DataType_t
Definition: le_gnss_common.h:195
le_gnss_GetMaxNmeaRate
le_result_t le_gnss_GetMaxNmeaRate(uint32_t *maxNmeaRatePtr)
LE_FULL_API
#define LE_FULL_API
Definition: le_apiFeatures.h:40
le_gnss_GetVerticalSpeed
le_result_t le_gnss_GetVerticalSpeed(le_gnss_SampleRef_t positionSampleRef, int32_t *vspeedPtr, int32_t *vspeedAccuracyPtr)
le_gnss_SetServerDisconnectHandler
LE_FULL_API void le_gnss_SetServerDisconnectHandler(le_gnss_DisconnectHandler_t disconnectHandler, void *contextPtr)
legato.h
le_gnss_GetGpsLeapSeconds
le_result_t le_gnss_GetGpsLeapSeconds(le_gnss_SampleRef_t positionSampleRef, uint8_t *leapSecondsPtr)
le_gnss_Disable
le_result_t le_gnss_Disable(void)
le_gnss_ReleaseSampleRef
void le_gnss_ReleaseSampleRef(le_gnss_SampleRef_t positionSampleRef)
le_gnss_DisconnectHandler_t
void(* le_gnss_DisconnectHandler_t)(void *)
Definition: le_gnss_interface.h:527
le_gnss_GetHorizontalSpeed
le_result_t le_gnss_GetHorizontalSpeed(le_gnss_SampleRef_t positionSampleRef, uint32_t *hspeedPtr, uint32_t *hspeedAccuracyPtr)
le_gnss_PositionHandlerRef_t
struct le_gnss_PositionHandler * le_gnss_PositionHandlerRef_t
Definition: le_gnss_common.h:448
le_gnss_InjectUtcTime
le_result_t le_gnss_InjectUtcTime(uint64_t timeUtc, uint32_t timeUnc)
le_gnss_GetLastSampleRef
le_gnss_SampleRef_t le_gnss_GetLastSampleRef(void)
le_gnss_GetGpsTime
le_result_t le_gnss_GetGpsTime(le_gnss_SampleRef_t positionSampleRef, uint32_t *gpsWeekPtr, uint32_t *gpsTimeOfWeekPtr)
le_gnss_DeleteSuplCertificate
le_result_t le_gnss_DeleteSuplCertificate(uint8_t suplCertificateId)
le_gnss_LoadExtendedEphemerisFile
le_result_t le_gnss_LoadExtendedEphemerisFile(int fd)
le_gnss_AssistedMode_t
le_gnss_AssistedMode_t
Definition: le_gnss_common.h:276
le_gnss_SetDopResolution
le_result_t le_gnss_SetDopResolution(le_gnss_Resolution_t resolution)
le_gnss_SetDataResolution
le_result_t le_gnss_SetDataResolution(le_gnss_DataType_t dataType, le_gnss_Resolution_t resolution)
le_gnss_SampleRef_t
struct le_gnss_Sample * le_gnss_SampleRef_t
Definition: le_gnss_common.h:126
le_gnss_Resolution_t
le_gnss_Resolution_t
Definition: le_gnss_common.h:174
le_gnss_AddPositionHandler
le_gnss_PositionHandlerRef_t le_gnss_AddPositionHandler(le_gnss_PositionHandlerFunc_t handlerPtr, void *contextPtr)
le_gnss_Start
le_result_t le_gnss_Start(void)
le_gnss_EnableExternalLna
le_result_t le_gnss_EnableExternalLna(void)
le_gnss_GetDate
le_result_t le_gnss_GetDate(le_gnss_SampleRef_t positionSampleRef, uint16_t *yearPtr, uint16_t *monthPtr, uint16_t *dayPtr)
le_gnss_DisableExtendedEphemerisFile
le_result_t le_gnss_DisableExtendedEphemerisFile(void)
le_gnss_State_t
le_gnss_State_t
Definition: le_gnss_common.h:134
le_gnss_GetDirection
le_result_t le_gnss_GetDirection(le_gnss_SampleRef_t positionSampleRef, uint32_t *directionPtr, uint32_t *directionAccuracyPtr)
le_gnss_ForceFactoryRestart
le_result_t le_gnss_ForceFactoryRestart(void)
le_gnss_SetSuplAssistedMode
le_result_t le_gnss_SetSuplAssistedMode(le_gnss_AssistedMode_t assistedMode)
le_gnss_GetLeapSeconds
le_result_t le_gnss_GetLeapSeconds(uint64_t *gpsTimePtr, int32_t *currentLeapSecondsPtr, uint64_t *changeEventTimePtr, int32_t *nextLeapSecondsPtr)
le_gnss_GetDilutionOfPrecision
le_result_t le_gnss_GetDilutionOfPrecision(le_gnss_SampleRef_t positionSampleRef, le_gnss_DopType_t dopType, uint16_t *dopPtr)
le_gnss_GetTimeAccuracy
le_result_t le_gnss_GetTimeAccuracy(le_gnss_SampleRef_t positionSampleRef, uint32_t *timeAccuracyPtr)
le_gnss_GetConstellationArea
le_result_t le_gnss_GetConstellationArea(le_gnss_Constellation_t satConstellation, le_gnss_ConstellationArea_t *constellationAreaPtr)