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