lriot 2.1.0.0
lr1110_wifi_types.h File Reference

Wi-Fi passive scan driver types for LR1110. More...

#include <stdbool.h>
#include <stdint.h>

Go to the source code of this file.

Data Structures

struct  lr1110_wifi_fcs_info_byte_s
 Wi-Fi FCS info byte. More...
 
struct  lr1110_wifi_cumulative_timings_s
 Cumulative timings. More...
 
struct  lr1110_wifi_basic_complete_result_s
 Basic complete result structure. More...
 
struct  lr1110_wifi_basic_mac_type_channel_result_s
 Basic MAC, type, channel result structure. More...
 
struct  lr1110_wifi_extended_full_result_t
 Extended full result structure. More...
 
struct  lr1110_wifi_country_code_s
 Wi-Fi country code structure. More...
 
struct  lr1110_wifi_version_s
 Wi-Fi firmware version. More...
 

Macros

#define LR1110_WIFI_MAC_ADDRESS_LENGTH   ( 6 )
 
#define LR1110_WIFI_MAX_RESULTS   ( 10 )
 
#define LR1110_WIFI_RESULT_SSID_LENGTH   ( 32 )
 
#define LR1110_WIFI_MAX_COUNTRY_CODE   ( 16 )
 
#define LR1110_WIFI_STR_COUNTRY_CODE_SIZE   ( 2 )
 
#define LR1110_WIFI_CHANNEL_1_POS   ( 0U )
 Channel at frequency 2.412 GHz.
 
#define LR1110_WIFI_CHANNEL_1_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_1_POS )
 
#define LR1110_WIFI_CHANNEL_2_POS   ( 1U )
 Channel at frequency 2.417 GHz.
 
#define LR1110_WIFI_CHANNEL_2_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_2_POS )
 
#define LR1110_WIFI_CHANNEL_3_POS   ( 2U )
 Channel at frequency 2.422 GHz.
 
#define LR1110_WIFI_CHANNEL_3_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_3_POS )
 
#define LR1110_WIFI_CHANNEL_4_POS   ( 3U )
 Channel at frequency 2.427 GHz.
 
#define LR1110_WIFI_CHANNEL_4_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_4_POS )
 
#define LR1110_WIFI_CHANNEL_5_POS   ( 4U )
 Channel at frequency 2.432 GHz.
 
#define LR1110_WIFI_CHANNEL_5_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_5_POS )
 
#define LR1110_WIFI_CHANNEL_6_POS   ( 5U )
 Channel at frequency 2.437 GHz.
 
#define LR1110_WIFI_CHANNEL_6_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_6_POS )
 
#define LR1110_WIFI_CHANNEL_7_POS   ( 6U )
 Channel at frequency 2.442 GHz.
 
#define LR1110_WIFI_CHANNEL_7_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_7_POS )
 
#define LR1110_WIFI_CHANNEL_8_POS   ( 7U )
 Channel at frequency 2.447 GHz.
 
#define LR1110_WIFI_CHANNEL_8_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_8_POS )
 
#define LR1110_WIFI_CHANNEL_9_POS   ( 8U )
 Channel at frequency 2.452 GHz.
 
#define LR1110_WIFI_CHANNEL_9_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_9_POS )
 
#define LR1110_WIFI_CHANNEL_10_POS   ( 9U )
 Channel at frequency 2.457 GHz.
 
#define LR1110_WIFI_CHANNEL_10_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_10_POS )
 
#define LR1110_WIFI_CHANNEL_11_POS   ( 10U )
 Channel at frequency 2.462 GHz.
 
#define LR1110_WIFI_CHANNEL_11_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_11_POS )
 
#define LR1110_WIFI_CHANNEL_12_POS   ( 11U )
 Channel at frequency 2.467 GHz.
 
#define LR1110_WIFI_CHANNEL_12_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_12_POS )
 
#define LR1110_WIFI_CHANNEL_13_POS   ( 12U )
 Channel at frequency 2.472 GHz.
 
#define LR1110_WIFI_CHANNEL_13_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_13_POS )
 
#define LR1110_WIFI_CHANNEL_14_POS   ( 13U )
 Channel at frequency 2.484 GHz.
 
#define LR1110_WIFI_CHANNEL_14_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_14_POS )
 

Typedefs

typedef uint16_t lr1110_wifi_channel_mask_t
 Type to store a Wi-Fi channel mask.
 
typedef uint8_t lr1110_wifi_channel_info_byte_t
 Type to store a Wi-Fi channel info byte.
 
typedef uint8_t lr1110_wifi_datarate_info_byte_t
 Type to store a Wi-Fi datarate info byte.
 
typedef uint8_t lr1110_wifi_frame_type_info_byte_t
 Type to store a Wi-Fi frame type info byte.
 
typedef uint8_t lr1110_wifi_frame_sub_type_t
 Type to store a Wi-Fi frame sub_type.
 
typedef struct lr1110_wifi_fcs_info_byte_s lr1110_wifi_fcs_info_byte_t
 Wi-Fi FCS info byte.
 
typedef uint8_t lr1110_wifi_mac_address_t[LR1110_WIFI_MAC_ADDRESS_LENGTH]
 Type to store a MAC address.
 
typedef struct lr1110_wifi_cumulative_timings_s lr1110_wifi_cumulative_timings_t
 Cumulative timings.
 
typedef struct lr1110_wifi_basic_complete_result_s lr1110_wifi_basic_complete_result_t
 Basic complete result structure.
 
typedef struct lr1110_wifi_basic_mac_type_channel_result_s lr1110_wifi_basic_mac_type_channel_result_t
 Basic MAC, type, channel result structure.
 
typedef struct lr1110_wifi_country_code_s lr1110_wifi_country_code_t
 Wi-Fi country code structure.
 
typedef struct lr1110_wifi_version_s lr1110_wifi_version_t
 Wi-Fi firmware version.
 

Enumerations

enum  lr1110_wifi_channel_t {
  LR1110_WIFI_NO_CHANNEL = 0x00 , LR1110_WIFI_CHANNEL_1 = 0x01 , LR1110_WIFI_CHANNEL_2 = 0x02 , LR1110_WIFI_CHANNEL_3 = 0x03 ,
  LR1110_WIFI_CHANNEL_4 = 0x04 , LR1110_WIFI_CHANNEL_5 = 0x05 , LR1110_WIFI_CHANNEL_6 = 0x06 , LR1110_WIFI_CHANNEL_7 = 0x07 ,
  LR1110_WIFI_CHANNEL_8 = 0x08 , LR1110_WIFI_CHANNEL_9 = 0x09 , LR1110_WIFI_CHANNEL_10 = 0x0A , LR1110_WIFI_CHANNEL_11 = 0x0B ,
  LR1110_WIFI_CHANNEL_12 = 0x0C , LR1110_WIFI_CHANNEL_13 = 0x0D , LR1110_WIFI_CHANNEL_14 = 0x0E , LR1110_WIFI_ALL_CHANNELS = 0x0F
}
 Wi-Fi Channels index. More...
 
enum  lr1110_wifi_datarate_t {
  LR1110_WIFI_DATARATE_1_MBPS = 1 , LR1110_WIFI_DATARATE_2_MBPS = 2 , LR1110_WIFI_DATARATE_6_MBPS = 3 , LR1110_WIFI_DATARATE_9_MBPS = 4 ,
  LR1110_WIFI_DATARATE_12_MBPS = 5 , LR1110_WIFI_DATARATE_18_MBPS = 6 , LR1110_WIFI_DATARATE_24_MBPS = 7 , LR1110_WIFI_DATARATE_36_MBPS = 8 ,
  LR1110_WIFI_DATARATE_48_MBPS = 9 , LR1110_WIFI_DATARATE_54_MBPS = 10 , LR1110_WIFI_DATARATE_6_5_MBPS = 11 , LR1110_WIFI_DATARATE_13_MBPS = 12 ,
  LR1110_WIFI_DATARATE_19_5_MBPS = 13 , LR1110_WIFI_DATARATE_26_MBPS = 14 , LR1110_WIFI_DATARATE_39_MBPS = 15 , LR1110_WIFI_DATARATE_52_MBPS = 16 ,
  LR1110_WIFI_DATARATE_58_MBPS = 17 , LR1110_WIFI_DATARATE_65_MBPS = 18 , LR1110_WIFI_DATARATE_7_2_MBPS = 19 , LR1110_WIFI_DATARATE_14_4_MBPS = 20 ,
  LR1110_WIFI_DATARATE_21_7_MBPS = 21 , LR1110_WIFI_DATARATE_28_9_MBPS = 22 , LR1110_WIFI_DATARATE_43_3_MBPS = 23 , LR1110_WIFI_DATARATE_57_8_MBPS = 24 ,
  LR1110_WIFI_DATARATE_65_2_MBPS = 25 , LR1110_WIFI_DATARATE_72_2_MBPS = 26
}
 WiFi theoretical Datarates. More...
 
enum  lr1110_wifi_frame_type_t { LR1110_WIFI_FRAME_TYPE_MANAGEMENT = 0x00 , LR1110_WIFI_FRAME_TYPE_CONTROL = 0x01 , LR1110_WIFI_FRAME_TYPE_DATA = 0x02 }
 WiFi Frame Types. More...
 
enum  lr1110_wifi_mac_origin_t { LR1110_WIFI_ORIGIN_BEACON_FIX_AP = 1 , LR1110_WIFI_ORIGIN_BEACON_MOBILE_AP = 2 , LR1110_WIFI_ORIGIN_UNKNOWN = 3 }
 The WiFi MAC address origin. More...
 
enum  lr1110_wifi_signal_type_scan_t { LR1110_WIFI_TYPE_SCAN_B = 0x01 , LR1110_WIFI_TYPE_SCAN_G = 0x02 , LR1110_WIFI_TYPE_SCAN_N = 0x03 , LR1110_WIFI_TYPE_SCAN_B_G_N = 0x04 }
 Wi-Fi signal type for passive scanning configuration. More...
 
enum  lr1110_wifi_signal_type_result_t { LR1110_WIFI_TYPE_RESULT_B = 0x01 , LR1110_WIFI_TYPE_RESULT_G = 0x02 , LR1110_WIFI_TYPE_RESULT_N = 0x03 }
 Wi-Fi signal type for passive scan results. More...
 
enum  lr1110_wifi_mode_t { LR1110_WIFI_SCAN_MODE_BEACON , LR1110_WIFI_SCAN_MODE_BEACON_AND_PKT , LR1110_WIFI_SCAN_MODE_FULL_BEACON , LR1110_WIFI_SCAN_MODE_UNTIL_SSID = 5 }
 Wi-Fi capture mode. More...
 
enum  lr1110_wifi_result_format_t { LR1110_WIFI_RESULT_FORMAT_BASIC_COMPLETE , LR1110_WIFI_RESULT_FORMAT_BASIC_MAC_TYPE_CHANNEL , LR1110_WIFI_RESULT_FORMAT_EXTENDED_FULL }
 Wi-Fi scan result formats. More...
 

Detailed Description

Wi-Fi passive scan driver types for LR1110.

The Clear BSD License Copyright Semtech Corporation 2021. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of the Semtech corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SEMTECH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

◆ LR1110_WIFI_CHANNEL_10_MASK

#define LR1110_WIFI_CHANNEL_10_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_10_POS )

◆ LR1110_WIFI_CHANNEL_10_POS

#define LR1110_WIFI_CHANNEL_10_POS   ( 9U )

Channel at frequency 2.457 GHz.

◆ LR1110_WIFI_CHANNEL_11_MASK

#define LR1110_WIFI_CHANNEL_11_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_11_POS )

◆ LR1110_WIFI_CHANNEL_11_POS

#define LR1110_WIFI_CHANNEL_11_POS   ( 10U )

Channel at frequency 2.462 GHz.

◆ LR1110_WIFI_CHANNEL_12_MASK

#define LR1110_WIFI_CHANNEL_12_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_12_POS )

◆ LR1110_WIFI_CHANNEL_12_POS

#define LR1110_WIFI_CHANNEL_12_POS   ( 11U )

Channel at frequency 2.467 GHz.

◆ LR1110_WIFI_CHANNEL_13_MASK

#define LR1110_WIFI_CHANNEL_13_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_13_POS )

◆ LR1110_WIFI_CHANNEL_13_POS

#define LR1110_WIFI_CHANNEL_13_POS   ( 12U )

Channel at frequency 2.472 GHz.

◆ LR1110_WIFI_CHANNEL_14_MASK

#define LR1110_WIFI_CHANNEL_14_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_14_POS )

◆ LR1110_WIFI_CHANNEL_14_POS

#define LR1110_WIFI_CHANNEL_14_POS   ( 13U )

Channel at frequency 2.484 GHz.

◆ LR1110_WIFI_CHANNEL_1_MASK

#define LR1110_WIFI_CHANNEL_1_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_1_POS )

◆ LR1110_WIFI_CHANNEL_1_POS

#define LR1110_WIFI_CHANNEL_1_POS   ( 0U )

Channel at frequency 2.412 GHz.

◆ LR1110_WIFI_CHANNEL_2_MASK

#define LR1110_WIFI_CHANNEL_2_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_2_POS )

◆ LR1110_WIFI_CHANNEL_2_POS

#define LR1110_WIFI_CHANNEL_2_POS   ( 1U )

Channel at frequency 2.417 GHz.

◆ LR1110_WIFI_CHANNEL_3_MASK

#define LR1110_WIFI_CHANNEL_3_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_3_POS )

◆ LR1110_WIFI_CHANNEL_3_POS

#define LR1110_WIFI_CHANNEL_3_POS   ( 2U )

Channel at frequency 2.422 GHz.

◆ LR1110_WIFI_CHANNEL_4_MASK

#define LR1110_WIFI_CHANNEL_4_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_4_POS )

◆ LR1110_WIFI_CHANNEL_4_POS

#define LR1110_WIFI_CHANNEL_4_POS   ( 3U )

Channel at frequency 2.427 GHz.

◆ LR1110_WIFI_CHANNEL_5_MASK

#define LR1110_WIFI_CHANNEL_5_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_5_POS )

◆ LR1110_WIFI_CHANNEL_5_POS

#define LR1110_WIFI_CHANNEL_5_POS   ( 4U )

Channel at frequency 2.432 GHz.

◆ LR1110_WIFI_CHANNEL_6_MASK

#define LR1110_WIFI_CHANNEL_6_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_6_POS )

◆ LR1110_WIFI_CHANNEL_6_POS

#define LR1110_WIFI_CHANNEL_6_POS   ( 5U )

Channel at frequency 2.437 GHz.

◆ LR1110_WIFI_CHANNEL_7_MASK

#define LR1110_WIFI_CHANNEL_7_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_7_POS )

◆ LR1110_WIFI_CHANNEL_7_POS

#define LR1110_WIFI_CHANNEL_7_POS   ( 6U )

Channel at frequency 2.442 GHz.

◆ LR1110_WIFI_CHANNEL_8_MASK

#define LR1110_WIFI_CHANNEL_8_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_8_POS )

◆ LR1110_WIFI_CHANNEL_8_POS

#define LR1110_WIFI_CHANNEL_8_POS   ( 7U )

Channel at frequency 2.447 GHz.

◆ LR1110_WIFI_CHANNEL_9_MASK

#define LR1110_WIFI_CHANNEL_9_MASK   ( 0x01UL << LR1110_WIFI_CHANNEL_9_POS )

◆ LR1110_WIFI_CHANNEL_9_POS

#define LR1110_WIFI_CHANNEL_9_POS   ( 8U )

Channel at frequency 2.452 GHz.

◆ LR1110_WIFI_MAC_ADDRESS_LENGTH

#define LR1110_WIFI_MAC_ADDRESS_LENGTH   ( 6 )

◆ LR1110_WIFI_MAX_COUNTRY_CODE

#define LR1110_WIFI_MAX_COUNTRY_CODE   ( 16 )

◆ LR1110_WIFI_MAX_RESULTS

#define LR1110_WIFI_MAX_RESULTS   ( 10 )

◆ LR1110_WIFI_RESULT_SSID_LENGTH

#define LR1110_WIFI_RESULT_SSID_LENGTH   ( 32 )

◆ LR1110_WIFI_STR_COUNTRY_CODE_SIZE

#define LR1110_WIFI_STR_COUNTRY_CODE_SIZE   ( 2 )

Typedef Documentation

◆ lr1110_wifi_basic_complete_result_t

Basic complete result structure.

The beacon period is expressed in TU (Time Unit). 1 TU is 1024 microseconds.

◆ lr1110_wifi_basic_mac_type_channel_result_t

Basic MAC, type, channel result structure.

◆ lr1110_wifi_channel_info_byte_t

Type to store a Wi-Fi channel info byte.

◆ lr1110_wifi_channel_mask_t

typedef uint16_t lr1110_wifi_channel_mask_t

Type to store a Wi-Fi channel mask.

◆ lr1110_wifi_country_code_t

Wi-Fi country code structure.

◆ lr1110_wifi_cumulative_timings_t

Cumulative timings.

This structure is representing the cumulative time spent in the different modes of Wi-Fi passive scanning procedure. All timings are provided in [us].

◆ lr1110_wifi_datarate_info_byte_t

Type to store a Wi-Fi datarate info byte.

◆ lr1110_wifi_fcs_info_byte_t

Wi-Fi FCS info byte.

◆ lr1110_wifi_frame_sub_type_t

Type to store a Wi-Fi frame sub_type.

◆ lr1110_wifi_frame_type_info_byte_t

Type to store a Wi-Fi frame type info byte.

◆ lr1110_wifi_mac_address_t

typedef uint8_t lr1110_wifi_mac_address_t[LR1110_WIFI_MAC_ADDRESS_LENGTH]

Type to store a MAC address.

◆ lr1110_wifi_version_t

Wi-Fi firmware version.

Enumeration Type Documentation

◆ lr1110_wifi_channel_t

Wi-Fi Channels index.

Enumerator
LR1110_WIFI_NO_CHANNEL 
LR1110_WIFI_CHANNEL_1 

Channel at frequency 2.412 GHz.

LR1110_WIFI_CHANNEL_2 

Channel at frequency 2.417 GHz.

LR1110_WIFI_CHANNEL_3 

Channel at frequency 2.422 GHz.

LR1110_WIFI_CHANNEL_4 

Channel at frequency 2.427 GHz.

LR1110_WIFI_CHANNEL_5 

Channel at frequency 2.432 GHz.

LR1110_WIFI_CHANNEL_6 

Channel at frequency 2.437 GHz.

LR1110_WIFI_CHANNEL_7 

Channel at frequency 2.442 GHz.

LR1110_WIFI_CHANNEL_8 

Channel at frequency 2.447 GHz.

LR1110_WIFI_CHANNEL_9 

Channel at frequency 2.452 GHz.

LR1110_WIFI_CHANNEL_10 

Channel at frequency 2.457 GHz.

LR1110_WIFI_CHANNEL_11 

Channel at frequency 2.462 GHz.

LR1110_WIFI_CHANNEL_12 

Channel at frequency 2.467 GHz.

LR1110_WIFI_CHANNEL_13 

Channel at frequency 2.472 GHz.

LR1110_WIFI_CHANNEL_14 

Channel at frequency 2.484 GHz.

LR1110_WIFI_ALL_CHANNELS 

◆ lr1110_wifi_datarate_t

WiFi theoretical Datarates.

Enumerator
LR1110_WIFI_DATARATE_1_MBPS 
LR1110_WIFI_DATARATE_2_MBPS 
LR1110_WIFI_DATARATE_6_MBPS 
LR1110_WIFI_DATARATE_9_MBPS 
LR1110_WIFI_DATARATE_12_MBPS 
LR1110_WIFI_DATARATE_18_MBPS 
LR1110_WIFI_DATARATE_24_MBPS 
LR1110_WIFI_DATARATE_36_MBPS 
LR1110_WIFI_DATARATE_48_MBPS 
LR1110_WIFI_DATARATE_54_MBPS 
LR1110_WIFI_DATARATE_6_5_MBPS 
LR1110_WIFI_DATARATE_13_MBPS 
LR1110_WIFI_DATARATE_19_5_MBPS 
LR1110_WIFI_DATARATE_26_MBPS 
LR1110_WIFI_DATARATE_39_MBPS 
LR1110_WIFI_DATARATE_52_MBPS 
LR1110_WIFI_DATARATE_58_MBPS 
LR1110_WIFI_DATARATE_65_MBPS 
LR1110_WIFI_DATARATE_7_2_MBPS 
LR1110_WIFI_DATARATE_14_4_MBPS 
LR1110_WIFI_DATARATE_21_7_MBPS 
LR1110_WIFI_DATARATE_28_9_MBPS 
LR1110_WIFI_DATARATE_43_3_MBPS 
LR1110_WIFI_DATARATE_57_8_MBPS 
LR1110_WIFI_DATARATE_65_2_MBPS 
LR1110_WIFI_DATARATE_72_2_MBPS 

◆ lr1110_wifi_frame_type_t

WiFi Frame Types.

Enumerator
LR1110_WIFI_FRAME_TYPE_MANAGEMENT 
LR1110_WIFI_FRAME_TYPE_CONTROL 
LR1110_WIFI_FRAME_TYPE_DATA 

◆ lr1110_wifi_mac_origin_t

The WiFi MAC address origin.

See also
lr1110_wifi_parse_channel_info for details about the MAC address origin estimation of the LR1110
Enumerator
LR1110_WIFI_ORIGIN_BEACON_FIX_AP 

MAC address extracted from a packet coming from a fix Access Point.

LR1110_WIFI_ORIGIN_BEACON_MOBILE_AP 

MAC address extracted from a packet coming from a mobile Access Point.

LR1110_WIFI_ORIGIN_UNKNOWN 

Impossible to determine the origin of the packet the MAC is extracted from.

◆ lr1110_wifi_mode_t

Wi-Fi capture mode.

The result type available depends on the Wi-Fi capture mode selected when calling the Wi-Fi scan API as follows:

Scan Mode Type/Sub-type selected Corresponding read result function
LR1110_WIFI_SCAN_MODE_BEACON Management/Beacon and Management/Probe Response lr1110_wifi_read_basic_complete_results, lr1110_wifi_read_basic_mac_type_channel_results
LR1110_WIFI_SCAN_MODE_BEACON_AND_PKT Some from Management, Control and Data Types
LR1110_WIFI_SCAN_MODE_FULL_BEACON Management/Beacon and Management/Probe Response lr1110_wifi_read_extended_full_results LR1110_WIFI_SCAN_MODE_UNTIL_SSID Management/Beacon and Management/Probe Response - until SSID field lr1110_wifi_read_extended_full_results

When the LR1110 receives a Wi-Fi frame, it starts demodulating it. Depending on the scan mode selected, only some Wi-Fi frame type/sub-types are to be kept. The demodulation step is stopped as soon as the LR1110 detects the current Wi-Fi frame is not of the required type/sub-types. This saves scan time and consumption.

A Wi-Fi frame is never completely demodulated. The LR1110_WIFI_SCAN_MODE_FULL_BEACON uses a special configuration allowing to demodulate more fields (until Frame Check Sequence field), at a price of higher scan duration and higher consumption.

Enumerator
LR1110_WIFI_SCAN_MODE_BEACON 

Exposes Beacons and Probe Responses Access Points frames until Period Beacon field (Basic result)

LR1110_WIFI_SCAN_MODE_BEACON_AND_PKT 

Exposes some Management Access Points frames until Period Beacon field, and some other packets frame until third Mac Address field (Basic result)

LR1110_WIFI_SCAN_MODE_FULL_BEACON 

Exposes Beacons and Probes Responses Access Points frames until Frame Check Sequence (FCS) field (Extended result). In this mode, only signal type LR1110_WIFI_TYPE_SCAN_B is executed and other signal types are silently discarded.

LR1110_WIFI_SCAN_MODE_UNTIL_SSID 

of SSID field (Extended result) - available since firmware 0x0306

Exposes Beacons and Probes Responses Access Points frames until the end

◆ lr1110_wifi_result_format_t

Wi-Fi scan result formats.

Enumerator
LR1110_WIFI_RESULT_FORMAT_BASIC_COMPLETE 
LR1110_WIFI_RESULT_FORMAT_BASIC_MAC_TYPE_CHANNEL 
LR1110_WIFI_RESULT_FORMAT_EXTENDED_FULL 

◆ lr1110_wifi_signal_type_result_t

Wi-Fi signal type for passive scan results.

Note that the Wi-Fi N detected is Wi-Fi N Mixed mode, and not GreenField.

Enumerator
LR1110_WIFI_TYPE_RESULT_B 

WiFi B.

LR1110_WIFI_TYPE_RESULT_G 

WiFi G.

LR1110_WIFI_TYPE_RESULT_N 

WiFi N.

◆ lr1110_wifi_signal_type_scan_t

Wi-Fi signal type for passive scanning configuration.

Note it is not possible to configure the WiFi passive scanning to search Wi-Fi type N GreenField. Only Wi-Fi type N Mixed Mode can be scanned by LR1110.

Warning
LR1110_WIFI_TYPE_SCAN_G and LR1110_WIFI_TYPE_SCAN_N configurations are implemented the same way, and both will scan Wi-Fi type G AND Wi-Fi type N.
Enumerator
LR1110_WIFI_TYPE_SCAN_B 

Wi-Fi B.

LR1110_WIFI_TYPE_SCAN_G 

Wi-Fi G.

LR1110_WIFI_TYPE_SCAN_N 

Wi-Fi N.

LR1110_WIFI_TYPE_SCAN_B_G_N 

Wi-Fi B and Wi-Fi G/N.