lriot  2.1.0.0
lr1110_modem_gnss.h
Go to the documentation of this file.
1 
32 #ifndef LR1110_MODEM_GNSS_H
33 #define LR1110_MODEM_GNSS_H
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 /*
40  * -----------------------------------------------------------------------------
41  * --- DEPENDENCIES ------------------------------------------------------------
42  */
43 
44 #include <stdbool.h>
45 #include <stdint.h>
48 #include "lriot.h"
49 
50 /*
51  * -----------------------------------------------------------------------------
52  * --- PUBLIC FUNCTIONS PROTOTYPES ---------------------------------------------
53  */
54 
67 
80 
91 
102 
115 
128 
138 
149 
163 
180 
191 
205 
214 err_t lr1110_modem_gnss_set_xtal_error( lriot_t *ctx, float xtal_error_in_ppm );
215 
224 err_t lr1110_modem_gnss_read_xtal_error( lriot_t *ctx, float* xtal_error_in_ppm );
225 
235 
244 err_t lr1110_modem_gnss_get_nb_detected_satellites( lriot_t *ctx, uint8_t* nb_detected_satellites );
245 
258 err_t lr1110_modem_gnss_get_detected_satellites( lriot_t *ctx, uint8_t nb_detected_satellites,
259  lr1110_modem_gnss_detected_satellite_t* detected_satellite_id_snr );
260 
272 
284 err_t lr1110_modem_gnss_almanac_read_by_index( lriot_t *ctx, uint8_t sv_id, uint8_t nb_sv,
285  uint8_t* almanac_read, uint8_t buffer_len );
286 
301  uint8_t gnss_result_mask, uint8_t nb_sat );
302 
315  uint8_t gnss_result_mask, uint8_t nb_sat );
316 
326 err_t lr1110_modem_gnss_push_solver_msg( lriot_t *ctx, uint8_t* payload, uint16_t payload_size );
327 
328 #ifdef __cplusplus
329 }
330 #endif
331 
332 #endif // LR1110_MODEM_GNSS_H
333 
334 /* --- EOF ------------------------------------------------------------------ */
lr1110_modem_gnss_types.h
GNSS scan driver types definition for LR1110 modem.
lr1110_modem_gnss_read_firmware_version
err_t lr1110_modem_gnss_read_firmware_version(lriot_t *ctx, lr1110_modem_gnss_version_t *version)
Function to read the GNSS firmware version.
lr1110_modem_gnss_almanac_full_update_bytestream_t
uint8_t lr1110_modem_gnss_almanac_full_update_bytestream_t[LR1110_MODEM_GNSS_FULL_ALMANAC_WRITE_BUFFER_SIZE]
Buffer that holds data for all almanacs full update.
Definition: lr1110_modem_gnss_types.h:206
lr1110_modem_gnss_push_solver_msg
err_t lr1110_modem_gnss_push_solver_msg(lriot_t *ctx, uint8_t *payload, uint16_t payload_size)
Push data received from solver to LR1110 modem.
lr1110_modem_gnss_detected_satellite_t
Detected satellite structure.
Definition: lr1110_modem_gnss_types.h:226
lr1110_modem_gnss_context_t
Status message struct in case of operation code = 0x18 (Status Message)
Definition: lr1110_modem_gnss_types.h:253
lriot_t
LR IoT Click context object.
Definition: lriot.h:259
lr1110_modem_gnss_read_almanac_update
err_t lr1110_modem_gnss_read_almanac_update(lriot_t *ctx, lr1110_modem_gnss_constellation_mask_t *constellations_to_update)
Function to read the almanac update configuration.
lr1110_modem_gnss_scan_assisted
err_t lr1110_modem_gnss_scan_assisted(lriot_t *ctx, lr1110_modem_gnss_search_mode_t effort_mode, uint8_t gnss_result_mask, uint8_t nb_sat)
GNSS scan with assisted parameters.
lr1110_modem_gnss_read_frequency_search
err_t lr1110_modem_gnss_read_frequency_search(lriot_t *ctx, lr1110_modem_gnss_frequency_search_space_mask_t *frequency_search_space)
Read constellation used by the GNSS scanner from the almanac update configuration.
lr1110_modem_gnss_read_used_constellations
err_t lr1110_modem_gnss_read_used_constellations(lriot_t *ctx, lr1110_modem_gnss_constellation_mask_t *constellations_used)
Read constellation used by the GNSS scanner from the almanac update configuration.
lr1110_modem_gnss_solver_assistance_position_t
Assistance position.
Definition: lr1110_modem_gnss_types.h:217
lr1110_modem_gnss_frequency_search_space_mask_t
uint8_t lr1110_modem_gnss_frequency_search_space_mask_t
Bit mask of frequency search space configurations.
Definition: lr1110_modem_gnss_types.h:201
lriot.h
This file contains API for LR IoT Click Driver.
lr1110_modem_gnss_almanac_one_chunk_bytestream_t
uint8_t lr1110_modem_gnss_almanac_one_chunk_bytestream_t[LR1110_MODEM_GNSS_SINGLE_ALMANAC_WRITE_SIZE]
Buffer that hold one chunk of almanac for update.
Definition: lr1110_modem_gnss_types.h:211
lr1110_modem_gnss_set_constellations_to_use
err_t lr1110_modem_gnss_set_constellations_to_use(lriot_t *ctx, lr1110_modem_gnss_constellation_mask_t constellation_to_use)
Activate the GNSS scan constellation.
lr1110_modem_gnss_set_assistance_position
err_t lr1110_modem_gnss_set_assistance_position(lriot_t *ctx, lr1110_modem_gnss_solver_assistance_position_t *assistance_position)
Function to set the assistance position.
lr1110_modem_gnss_almanac_full_update
err_t lr1110_modem_gnss_almanac_full_update(lriot_t *ctx, lr1110_modem_gnss_almanac_full_update_bytestream_t almanac_bytestream)
Update full almanac for all satellites.
lr1110_modem_gnss_one_chunk_almanac_update
err_t lr1110_modem_gnss_one_chunk_almanac_update(lriot_t *ctx, lr1110_modem_gnss_almanac_one_chunk_bytestream_t almanac_one_chunk_bytestream)
One chunk almanac update.
lr1110_modem_gnss_get_timings
err_t lr1110_modem_gnss_get_timings(lriot_t *ctx, lr1110_modem_gnss_timings_t *timings)
Get the timings spent in signal acquisition and signal analyzis.
lr1110_modem_gnss_set_xtal_error
err_t lr1110_modem_gnss_set_xtal_error(lriot_t *ctx, float xtal_error_in_ppm)
Function to set the Xtal error.
lr1110_modem_gnss_read_supported_constellations
err_t lr1110_modem_gnss_read_supported_constellations(lriot_t *ctx, lr1110_modem_gnss_constellation_mask_t *supported_constellations)
Function to read the supported constellation, GPS or BEIDOU other constellations.
lr1110_modem_gnss_scan_autonomous
err_t lr1110_modem_gnss_scan_autonomous(lriot_t *ctx, lr1110_modem_gnss_search_mode_t effort_mode, uint8_t gnss_result_mask, uint8_t nb_sat)
GNSS scan with no assisted parameters needed.
lr1110_modem_gnss_get_detected_satellites
err_t lr1110_modem_gnss_get_detected_satellites(lriot_t *ctx, uint8_t nb_detected_satellites, lr1110_modem_gnss_detected_satellite_t *detected_satellite_id_snr)
Get the satellites detected on last scan with their IDs and C/N (aka. CNR)
lr1110_modem_gnss_read_assistance_position
err_t lr1110_modem_gnss_read_assistance_position(lriot_t *ctx, lr1110_modem_gnss_solver_assistance_position_t *assistance_position)
Function to read the assistance position.
lr1110_modem_gnss_almanac_read_by_index
err_t lr1110_modem_gnss_almanac_read_by_index(lriot_t *ctx, uint8_t sv_id, uint8_t nb_sv, uint8_t *almanac_read, uint8_t buffer_len)
Read at maximum 11 sv’s Almanac, starting from sv id.
lr1110_modem_common.h
modem driver common definition for LR1110
lr1110_modem_gnss_get_nb_detected_satellites
err_t lr1110_modem_gnss_get_nb_detected_satellites(lriot_t *ctx, uint8_t *nb_detected_satellites)
Get the number of detected satellites during last scan.
lr1110_modem_gnss_set_almanac_update
err_t lr1110_modem_gnss_set_almanac_update(lriot_t *ctx, lr1110_modem_gnss_constellation_mask_t constellations_to_update)
Activate the almanac update.
lr1110_modem_gnss_read_xtal_error
err_t lr1110_modem_gnss_read_xtal_error(lriot_t *ctx, float *xtal_error_in_ppm)
Function to read the Xtal error.
lr1110_modem_gnss_search_mode_t
lr1110_modem_gnss_search_mode_t
Search mode for GNSS scan.
Definition: lr1110_modem_gnss_types.h:126
lr1110_modem_gnss_timings_t
GNSS timings of the LR1110 modem.
Definition: lr1110_modem_gnss_types.h:235
lr1110_modem_gnss_version_t
Version structure of the LR1110 GNSS firmware.
Definition: lr1110_modem_gnss_types.h:244
lr1110_modem_gnss_get_context
err_t lr1110_modem_gnss_get_context(lriot_t *ctx, lr1110_modem_gnss_context_t *gnss_context)
Function to read context status.
lr1110_modem_gnss_set_frequency_search
err_t lr1110_modem_gnss_set_frequency_search(lriot_t *ctx, lr1110_modem_gnss_frequency_search_space_mask_t frequency_search_space)
Set the GNSS frequency search.
lr1110_modem_gnss_constellation_mask_t
uint8_t lr1110_modem_gnss_constellation_mask_t
Bit mask of constellation configurations.
Definition: lr1110_modem_gnss_types.h:194