|
Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
|
Header file for extended cellular API of ST87Mxx modems. More...
Go to the source code of this file.
Data Structures | |
| struct | st87mxx_wifiscan_params |
| Parameters for the ST87Mxx WIFI scan operation. More... | |
Macros | |
| #define | APP_MDM_CMD_TIMEOUT K_SECONDS(180) |
| Default timeout for application services sequences. | |
| #define | GNSS_NB_MAX_POSITION 100 |
| Max number of sample positions. | |
| #define | GNSS_CONSTELLATION_ID 0 |
| GNSS constellation selection: 0: GPS 1: GALLILEO 2: GPS+GALLILEO. | |
| #define | GNSS_FORMAT_TYPE 0 |
| GNSS data format selection: 0: ST_AT 1: NMEA. | |
| #define | GNSS_FORMAT_ST_POSITION 1 |
| Parameters used if ST_AT format enabled for GNSS. | |
| #define | GNSS_FORMAT_ST_ACCURACY 0 |
| Accuracy data. | |
| #define | GNSS_FORMAT_ST_SATELLITES 0 |
| Satellites info. | |
| #define | GNSS_FORMAT_ST_ORIENTATION 0 |
| Orientation info. | |
| #define | GNSS_NMEA_GPGGA 1 |
| Parameters used if NMEA format enabled for GNSS. | |
| #define | GNSS_NMEA_GPGSA 0 |
| $GPGSA info | |
| #define | GNSS_NMEA_GPGSV 0 |
| $GPGSV info | |
| #define | GNSS_NMEA_GPGLL 1 |
| $GPGLL info | |
| #define | GNSS_NMEA_GPRMC 0 |
| $GPRMS info | |
| #define | GNSS_NMEA_GPVTG 1 |
| $GPVTG info | |
| #define | URC_MODE 1 |
| To avoid too much data coming again and again on UART, the Host has the possibility to set a filter mode to display only one time the BSSID found during the full time of WIFI scanning. | |
| #define | HOPPING_TIME 1024 |
| Hopping time is the scan duration in ms before swapping to next channel. | |
| #define | ANT_SEL 1 |
| Selects the suitable ST87 input for antenna (GNSS or NB-IOT). | |
Typedefs | |
| typedef void | st87mxx_get_beacon_data_callback_t(char const *const string) |
| Callback that catches the WIFI scan data when it is available. | |
| typedef void | st87mxx_get_pos_callback_t(char const *const string) |
| Callback to retrieve the positions. | |
| typedef void | st87mxx_get_rssi_callback_t(char const *const string) |
| Callback to retrieve the RSSI values. | |
Enumerations | |
| enum | sequence_state { SEQUENCE_NONE = 0 , SEQUENCE_ONGOING = 1 , SEQUENCE_TIMED_OUT = 2 } |
| Application services sequence state. More... | |
Functions | |
| void | st87mxx_app_services_init (void) |
| API to start the application services (GNSS, WSCAN, RSSI capture). | |
| int | st87mxx_gnss_getfix (uint32_t nb_position, st87mxx_get_pos_callback_t *get_pos_callback_func, uint32_t timeout) |
| API to get ST87Mxx GNSS position. | |
| void | st87mxx_gnss_stop (void) |
| API to stop the GNSS feature. | |
| int | st87mxx_wifiscan (st87mxx_wifiscan_params *wscan_params) |
| API to start the WIFI scan (=WSCAN) feature for positioning purpose. | |
| void | st87mxx_wifiscan_stop (void) |
| API to stop the WIFI scan. | |
| int | st87mxx_getrssi (st87mxx_get_rssi_callback_t *get_rssi_callback_func) |
| API to get the RSSI in an asynchronous way. | |
| sequence_state | st87mxx_app_services_getstate (void) |
| API to get the state of the application services sequence. | |
Header file for extended cellular API of ST87Mxx modems.