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