lriot  2.1.0.0
lr1110_modem_wifi.h
Go to the documentation of this file.
1 
32 #ifndef LR1110_MODEM_WIFI_H
33 #define LR1110_MODEM_WIFI_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 
63 
73 
84 err_t lr1110_modem_wifi_cfg_timestamp_ap_phone( lriot_t *ctx, uint32_t timestamp_in_s );
85 
95 
126  uint8_t max_results, uint8_t nb_scan_per_channel, uint16_t timeout_in_ms,
127  bool abort_on_timeout, lr1110_modem_wifi_result_format_t result_format );
128 
193  uint8_t max_results, uint16_t timeout_per_channel_ms, uint16_t timeout_per_scan_ms,
194  lr1110_modem_wifi_result_format_t result_format );
195 
216  uint8_t nb_max_results, uint8_t nb_scan_per_channel,
217  uint16_t timeout_in_ms, bool abort_on_timeout );
218 
253  uint8_t nb_max_results, uint16_t timeout_per_channel_ms,
254  uint16_t timeout_per_scan_ms );
255 
272 void lr1110_modem_wifi_read_basic_mac_type_channel_results( uint8_t* buffer, uint16_t buffer_len,
274  uint8_t* nb_results );
275 
292 void lr1110_modem_wifi_read_basic_complete_results( uint8_t* buffer, uint16_t buffer_len,
294  uint8_t* nb_results );
295 
309 void lr1110_modem_wifi_read_extended_full_results( uint8_t* buffer, uint16_t buffer_len,
311  uint8_t* nb_results );
312 
321 
330 
331 #ifdef __cplusplus
332 }
333 #endif
334 
335 #endif // LR1110_MODEM_WIFI_H
336 
337 /* --- EOF ------------------------------------------------------------------ */
lr1110_modem_extract_signal_type_from_data_rate_info
err_t lr1110_modem_extract_signal_type_from_data_rate_info(lr1110_modem_wifi_datarate_info_byte_t data_rate_info)
Helper method to retrieve the signal type from data rate info byte.
lr1110_modem_wifi_reset_cumulative_timing
err_t lr1110_modem_wifi_reset_cumulative_timing(lriot_t *ctx)
Reset the internal counters of cumulative timing.
lr1110_modem_wifi_types.h
Wi-Fi passive scan driver types definition for LR1110 modem.
lr1110_modem_wifi_cumulative_timings_t
Cumulative timings.
Definition: lr1110_modem_wifi_types.h:236
lriot_t
LR IoT Click context object.
Definition: lriot.h:259
lr1110_modem_wifi_basic_complete_result_t
Basic complete result structure.
Definition: lr1110_modem_wifi_types.h:259
lr1110_modem_wifi_version_t
Wi-Fi version parameters.
Definition: lr1110_modem_wifi_types.h:316
lr1110_modem_wifi_search_country_code
err_t lr1110_modem_wifi_search_country_code(lriot_t *ctx, lr1110_modem_wifi_channel_mask_t channels_mask, uint8_t nb_max_results, uint8_t nb_scan_per_channel, uint16_t timeout_in_ms, bool abort_on_timeout)
Start a Wi-Fi passive scan for country codes extraction.
lr1110_modem_wifi_read_cumulative_timing
err_t lr1110_modem_wifi_read_cumulative_timing(lriot_t *ctx, lr1110_modem_wifi_cumulative_timings_t *timing)
Read the internal counters of cumulative timing.
lr1110_modem_wifi_result_format_t
lr1110_modem_wifi_result_format_t
Definition: lr1110_modem_wifi_types.h:199
lr1110_modem_wifi_read_extended_full_results
void lr1110_modem_wifi_read_extended_full_results(uint8_t *buffer, uint16_t buffer_len, lr1110_modem_wifi_extended_full_result_t *results, uint8_t *nb_results)
Read extended complete results.
lr1110_modem_wifi_basic_mac_type_channel_result_t
Basic MAC, type, channel result structure.
Definition: lr1110_modem_wifi_types.h:275
lriot.h
This file contains API for LR IoT Click Driver.
lr1110_modem_wifi_channel_mask_t
uint16_t lr1110_modem_wifi_channel_mask_t
Type for channel mask.
Definition: lr1110_modem_wifi_types.h:227
lr1110_modem_wifi_mode_t
lr1110_modem_wifi_mode_t
Wi-Fi capture mode.
Definition: lr1110_modem_wifi_types.h:186
lr1110_modem_wifi_read_version
err_t lr1110_modem_wifi_read_version(lriot_t *ctx, lr1110_modem_wifi_version_t *wifi_version)
Get the internal wifi firmware version.
lr1110_modem_wifi_passive_scan
err_t lr1110_modem_wifi_passive_scan(lriot_t *ctx, lr1110_modem_wifi_signal_type_scan_t signal_type, lr1110_modem_wifi_channel_mask_t channels, lr1110_modem_wifi_mode_t scan_mode, uint8_t max_results, uint8_t nb_scan_per_channel, uint16_t timeout_in_ms, bool abort_on_timeout, lr1110_modem_wifi_result_format_t result_format)
Start a Wi-Fi passive scan operation.
lr1110_modem_wifi_extended_full_result_t
Extended full result structure.
Definition: lr1110_modem_wifi_types.h:288
lr1110_modem_wifi_read_basic_complete_results
void lr1110_modem_wifi_read_basic_complete_results(uint8_t *buffer, uint16_t buffer_len, lr1110_modem_wifi_basic_complete_result_t *results, uint8_t *nb_results)
Read basic complete results.
lr1110_modem_wifi_signal_type_scan_t
lr1110_modem_wifi_signal_type_scan_t
Wi-Fi signal type for passive scanning configuration.
Definition: lr1110_modem_wifi_types.h:144
lr1110_modem_common.h
modem driver common definition for LR1110
lr1110_modem_wifi_datarate_info_byte_t
uint8_t lr1110_modem_wifi_datarate_info_byte_t
Type for datarate info byte.
Definition: lr1110_modem_wifi_types.h:212
lr1110_modem_wifi_search_country_code_time_limit
err_t lr1110_modem_wifi_search_country_code_time_limit(lriot_t *ctx, lr1110_modem_wifi_channel_mask_t channels_mask, uint8_t nb_max_results, uint16_t timeout_per_channel_ms, uint16_t timeout_per_scan_ms)
Start a Wi-Fi passive scan for country codes extraction with duration stop conditions.
lr1110_modem_extract_channel_from_info_byte
err_t lr1110_modem_extract_channel_from_info_byte(lr1110_modem_wifi_channel_info_byte_t info_byte)
Helper method to retrieve channel from channel info byte.
lr1110_modem_wifi_channel_info_byte_t
uint8_t lr1110_modem_wifi_channel_info_byte_t
Type for channel info byte.
Definition: lr1110_modem_wifi_types.h:217
lr1110_modem_wifi_cfg_timestamp_ap_phone
err_t lr1110_modem_wifi_cfg_timestamp_ap_phone(lriot_t *ctx, uint32_t timestamp_in_s)
Configure the timestamp used to discriminate mobile access points from gateways.
lr1110_modem_wifi_read_basic_mac_type_channel_results
void lr1110_modem_wifi_read_basic_mac_type_channel_results(uint8_t *buffer, uint16_t buffer_len, lr1110_modem_wifi_basic_mac_type_channel_result_t *results, uint8_t *nb_results)
Read basic MAC, Wi-Fi type and channel results.
lr1110_modem_wifi_passive_scan_time_limit
err_t lr1110_modem_wifi_passive_scan_time_limit(lriot_t *ctx, lr1110_modem_wifi_signal_type_scan_t signal_type, lr1110_modem_wifi_channel_mask_t channels, lr1110_modem_wifi_mode_t scan_mode, uint8_t max_results, uint16_t timeout_per_channel_ms, uint16_t timeout_per_scan_ms, lr1110_modem_wifi_result_format_t result_format)
Start a Wi-Fi passive scan operation with duration stop conditions.