2. Silicon Labs
  3. RS9113 WiSeConnect Host API

Silicon Labs RS9113 WiSeConnect Host API Reference guide

  • Hello! I am an AI chatbot trained to assist you with the Silicon Labs RS9113 WiSeConnect Host API Reference guide. I’ve already reviewed the document and can help you find the information you need or explain it in simple terms. Just ask your questions, and providing more details will help me assist you more effectively!
silabs.com | Building a more connected world.
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
May 2020
silabs.com | Building a more connected world. Page 3
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
Table Of Contents
1 Overview .................................................................................................................. 7
2 Host API Architecture ............................................................................................... 8
3 File Organization .................................................................................................... 10
4 Porting Steps .......................................................................................................... 11
5 WLAN API Library ................................................................................................... 12
5.1.1 rsi_oper_mode ................................................................................................................ 12
5.1.2 rsi_band .......................................................................................................................... 18
5.1.3 rsi_config ......................................................................................................................... 19
5.1.4 rsi_init ............................................................................................................................. 19
5.1.5 rsi_select_antenna........................................................................................................... 20
5.1.6 rsi_per_mode .................................................................................................................. 21
5.1.7 rsi_p2p_config ................................................................................................................. 23
5.1.8 rsi_scan ........................................................................................................................... 24
5.1.9 rsi_bg_scan ...................................................................................................................... 25
5.1.10 rsi_roam_params ............................................................................................................. 26
5.1.11 rsi_ht_caps ...................................................................................................................... 27
5.1.12 rsi_wmm_ps .................................................................................................................... 28
5.1.13 rsi_wps_method .............................................................................................................. 29
5.1.14 rsi_load_web_page .......................................................................................................... 30
5.1.15 rsi_webpage_clear_files ................................................................................................... 31
5.1.16 rsi_webpage_erase_files .................................................................................................. 32
5.1.17 rsi_json_create ................................................................................................................ 32
5.1.18 rsi_json_erase_files ......................................................................................................... 33
5.1.19 rsi_multicast .................................................................................................................... 33
5.1.20 rsi_multicast_mac_filter .................................................................................................. 34
5.1.21 rsi_join ............................................................................................................................ 35
5.1.22 rsi_set_eap ...................................................................................................................... 36
5.1.23 rsi_set_certificate ............................................................................................................ 37
5.1.23.1 How to load certificates in USB/SPI interfaces........................................................... 39
5.1.23.2 How to load certificates through UART interface ...................................................... 39
5.1.24 rsi_ip_param_set ............................................................................................................. 40
5.1.25 rsi_ipv6_param_set ......................................................................................................... 41
5.1.26 rsi_snmp_enable ............................................................................................................. 42
5.1.27 rsi_snmp_get_rsp ............................................................................................................ 42
5.1.28 rsi_snmp_get_next_rsp.................................................................................................... 43
5.1.29 rsi_snmp_trap ................................................................................................................. 44
5.1.30 rsi_socket ........................................................................................................................ 45
5.1.31 rsi_socket_close .............................................................................................................. 48
5.1.32 rsi_ltcp_conn_status ........................................................................................................ 48
5.1.33 rsi_query_fw_version ...................................................................................................... 49
5.1.34 rsi_query_mac_address ................................................................................................... 49
5.1.35 rsi_send_data .................................................................................................................. 49
5.1.36 rsi_frame_read ................................................................................................................ 50
5.1.37 rsi_send_raw_data .......................................................................................................... 51
5.1.38 rsi_disconnect ................................................................................................................. 51
5.1.39 rsi_query_rssi .................................................................................................................. 52
5.1.40 rsi_flashtype .................................................................................................................... 52
silabs.com | Building a more connected world. Page 4
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
5.1.41 rsi_query_net_parms ....................................................................................................... 52
5.1.42 rsi_query_conn_status ..................................................................................................... 53
5.1.43 rsi_query_go_parms ........................................................................................................ 53
5.1.44 rsi_http_get ..................................................................................................................... 53
5.1.45 rsi_http_post ................................................................................................................... 54
5.1.46 rsi_dns_query .................................................................................................................. 55
5.1.47 rsi_dns_server ................................................................................................................. 56
5.1.48 rsi_set_mac_addr ............................................................................................................ 57
5.1.49 rsi_cfg_save ..................................................................................................................... 57
5.1.50 rsi_cfg_get ....................................................................................................................... 58
5.1.51 rsi_cfg_enable ................................................................................................................. 58
5.1.52 rsi_per_stats .................................................................................................................... 58
5.1.53 rsi_set_ap_config............................................................................................................. 59
5.1.54 rsi_set_wepkey ................................................................................................................ 61
5.1.55 rsi_send_ludp_data ......................................................................................................... 62
5.1.56 rsi_power_mode ............................................................................................................. 62
5.1.57 rsi_wireless_fwupgrade.c ................................................................................................. 63
5.1.58 rsi_sys_init ....................................................................................................................... 63
5.1.59 rsi_ulp_wakeup_init ........................................................................................................ 63
5.1.60 rsi_interrupt_handler....................................................................................................... 64
5.1.61 rsi_register_interrupt_irq................................................................................................. 64
5.1.62 rsi_debug_prints .............................................................................................................. 64
5.1.63 rsi_psk ............................................................................................................................. 65
5.1.64 rsi_set_region .................................................................................................................. 66
5.1.65 rsi_sleep_timer ................................................................................................................ 66
5.1.66 rsi_rejoin_params ............................................................................................................ 67
5.1.67 rsi_send_url_rsp .............................................................................................................. 68
5.1.68 rsi_gpio_config ................................................................................................................ 69
5.1.68.1 rsi_req_wakeup ....................................................................................................... 69
5.1.68.2 rsi_wait4wakeup ...................................................................................................... 69
5.1.68.3 rsi_allow_sleep ........................................................................................................ 70
5.1.69 rsi_user_store_config ...................................................................................................... 70
5.1.70 rsi_set_region_ap ............................................................................................................ 88
5.1.71 rsi_ping_request .............................................................................................................. 89
5.1.72 rsi_bytes_sent_count....................................................................................................... 90
5.1.73 rsi_uart_flow_control ...................................................................................................... 91
5.1.74 rsi_socket_config ............................................................................................................. 91
5.1.75 rsi_trigger_auto_config .................................................................................................... 92
5.1.76 rsi_http_abort ................................................................................................................. 93
5.1.77 rsi_rf_current_config ....................................................................................................... 93
5.1.78 rsi_spi_high_speed_enable .............................................................................................. 94
5.1.79 rsi_http_credentials ......................................................................................................... 94
5.1.80 FTP client ......................................................................................................................... 95
5.1.80.1 rsi_ftp_client ............................................................................................................ 95
5.1.80.2 rsi_ftp_file_write_content ........................................................................................ 98
5.1.81 SNTP Client ...................................................................................................................... 99
5.1.82 MDNS and DNS-SD ......................................................................................................... 100
5.1.83 SMTP Client ................................................................................................................... 102
5.1.84 Read Data ...................................................................................................................... 104
5.1.85 POP3 Client .................................................................................................................... 105
5.1.86 Set RTC time .................................................................................................................. 108
silabs.com | Building a more connected world. Page 5
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
6 Hardware Abstraction Layer (HAL) Files ............................................................... 110
6.1.1 rsi_hal.h......................................................................................................................... 110
6.1.2 rsi_hal_mcu_timers.c ..................................................................................................... 110
6.1.3 rsi_hal_mcu_spi.c .......................................................................................................... 110
6.1.4 rsi_hal_mcu_ioports.c .................................................................................................... 112
6.1.5 rsi_hal_mcu_interrupt.c ................................................................................................. 114
7 WLAN Applications ............................................................................................... 116
7.1.1 Using rsi_config.h for various modes .............................................................................. 136
7.1.1.1 Client mode with Personal Security ............................................................................ 136
7.1.1.2 WiFi Direct Mode ....................................................................................................... 136
7.1.1.3 Client Mode with Enterprise Security ......................................................................... 136
7.1.1.4 TCP/IP ........................................................................................................................ 136
7.1.1.5 Configuring in AP mode .............................................................................................. 137
7.1.1.6 ICMP-PING ................................................................................................................. 137
7.1.1.7 WLAN PARAMETERS .................................................................................................. 137
7.1.2 Command Sequence ...................................................................................................... 137
7.1.3 Typical Usage of APIs ..................................................................................................... 139
7.2 Response Data Structures ......................................................................................... 139
7.2.1 Read Response Data Structure (From module) ............................................................... 139
8 APIs for bootup .................................................................................................... 141
8.1 rsi_bootup_config.c .................................................................................................. 141
8.1.1 rsi_waitfor_boardready() ............................................................................................... 142
8.1.2 rsi_upgrade_fw() ........................................................................................................... 142
8.1.3 rsi_select_option() ......................................................................................................... 143
9 HTML Documentation .......................................................................................... 144
10 WLAN Powersave state machine ...................................................................... 145
11 Documentation Paths for BT,BLE,Zigbee API User guides ................................ 146
silabs.com | Building a more connected world. Page 6
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
Table of Figures
Figure 1 : HOST API Architecture Diagram ................................................................................................ 8
Figure 2:Module configured for SPI operations in different Operating modes ..................................... 138
Figure 3: WiFi PowerSave State machine ............................................................................................. 145
silabs.com | Building a more connected world. Page 7
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
1 Overview
RS9113-WiSeConnect module support WiFi/BT/BLE/ZigBee only and Coexistence modes
(WiFi+BT/ WiFi+BLE/ WiFi+ZigBee) modes. This document contains description about
RS9113-WiSeConnect WiFi API’s. The source code of API Library and reference
applicationare provided in the software package. The developer can port HAL layer to the
target platform and customize the application as per their application requirement. This
section describes the APIs to configure and operate RS9113-WiSeConnect module. It also
discusses the requirements of the MCU’s HAL APIs. These API’s must be used in conjunction
with Wi-Fi Commands in Binary mode sections of PRM. The API library is platform
independent and is written in C language.
silabs.com | Building a more connected world. Page 8
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
2 Host API Architecture
RS9113-WiSeConnect Host API’s are designed in layers, where each Layer is independent
and uses the service of underlying layers.
Figure 1 : HOST API Architecture Diagram
Application Layer:
Application Layer contains application specific functionality. Application Layer need to call
Core Layer API’s to configure and operate the RS9113-WiSeConnect module.
Core API Layer:
Core API Layer contains collection of API’s which are called from the application Layer to
configure and operate the RS9113-WiSeConnect module. Core API contain API’s for Module
initialization, WiFi configuration, TCP/IP configuration and data transfer. User are
recommended to use given API’s without any modification for transparent migration to
API’s enhancement in next releases.
APPLICATION LAYER
CORE API LAYER
HARDWARE ABSTRACTION LAYER
UART
(HAL)
SPI
(HAL)
USB
(HAL)
SDIO
(HAL)
INTERFACE LAYER
UART (API)
SPI
(API)
USB
(API)
SDIO
(API)
silabs.com | Building a more connected world. Page 9
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
Interface Specific API Layer:
RS9113-WiSeConnect module support 4 different host interfaces (UART, SPI, SDIO,
USB).These API’s are collection of functions specific to particular interface. Interface
functions between Core API Layer and Interface Specific API Layer are independent of Host
interface used. So Application Layer can migrate to different interfaces without any change.
Note: SDIO host interface is not supported in current release.
HAL API Layer:
Hardware Abstraction Layer API’s are platform specific API’s. User need to implement or
modify these API’s to their platforms.
Reference Applications:
Packages contain reference applications to operate the module in different modes. User
can use these applications as reference or customize these applications as per their
requirement.
silabs.com | Building a more connected world. Page 10
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
3 File Organization
APIs are organized into following directory structure
Path(Within RS9113.WC.GENR.x.x.x folder)
Core APIs
host/binary/apis/wlan/core/
Interface Specific APIs
host/binary/apis/intf/
HAL APIs
host/binary/apis/hal/
Reference Applications
host/binary/apis/wlan/ref_apps/
AT APIs
host/at/
Reference Projects
host/binary/reference_projects
Sample EAP/SSL Certificates
host/binary/apis/wlan/ref_apps/include
or
host/at/apis/ref_apps/include
silabs.com | Building a more connected world. Page 11
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
4 Porting Steps
The following are the general steps required to port the driver into the target platform.
1. Modify the Hardware abstraction layer (HAL) based on hardware MCU platform and
interface selected. For example configuring SPI involves configuring the SPI pins (SPI_MISO
/SPI_MOSI/SPI_CLK/SPI_CS), Interrupt signal of module, Clock polarity (CPOL), Clock phase
(CPHASE), SPI read/write APIs and optionally timers.
HAL specific files are present in following location in package:
RS9113.WC.GENR.x.x.x/host/binary/apis/hal/
2. Modify the application to fit the actual evaluation set-up. User configurations can be
changed in rsi_config.h file.
These files are present in following foldersin Release package:
RS9113.WC.GENR.x.x.x/host/binary/apis/wlan/ref_apps/include/rs
i_config.h
Or
RS9113.WC.GENR.x.x.x/host/at/apis/ref_apps/include/rsi_config.
h
3. Build the APIs along with the application using toolchain provided with the Host MCU.
silabs.com | Building a more connected world. Page 12
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
5 WLAN API Library
The API Library provides APIs which are called by the Application of the MCU in order to
configure the Wi-Fi module and also exchange data over the network. In addition to this, a
Makefile is provided for the user to compile the library. For detailed descriptions of the
parameters please refer to “Binarycommands” section of PRM. The parameters are only briefly
described here.
The return type of all the APIs are same. Following are list of possible values that API’s will
returns based on API’s execution status (Successful/Failure).
In AT+ command mode :
Return
value
==0
>0
<0
In Binary mode :
Return
value
0
-1
-2
-3
5.1.1 rsi_oper_mode
This APIis for the “Set Operating Mode” command.
Description:
This API is used to select the module’s mode of operation and also to configure TCP/IP,
WLAN & customization features. This API is the first to be called after CARD READY
operation.
API Prototype :
int16 rsi_oper_mode(rsi_uOperMode *uOperMode)
Parameters:
rsi_uOperMode *uOperMode : Pointer to operating mode structure.
typedef union{
struct {
silabs.com | Building a more connected world. Page 13
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
uint32 oper_mode;
uint32 feature_bit_map;
uint32 tcp_ip_feature_bit_map;
uint32 custom_feature_bit_map;
} operModeFrameSnd;
uint8 uOperModeBuf[16];
} rsi_uOperMode;
Structure Member Name
Structure
Member Type
Description
oper_mode
uint32
To select the modules mode of
operation.
oper_mode contains two parts
<operating_mode,coex_mode>.
Lower two bytes represent oper_mode
and higher two bytes represent
coex_mode.
Operating_mode:
0-Client mode
1-WiFi Direct
2-Enterprise security client mode
6-AP mode
8- PER Mode
Coex_mode:
0– WLAN only mode
3– WLAN and Zigbee coexistence
mode.
5– WLAN and BT coexistence mode.
13- WLAN and BTLE coexistence
mode.
feature_bit_map
uint32
Following bits are need to be set to
use respective features.
BIT(0)-Open mode(No security)
BIT(1)-PSK security
BIT(2)- WLAN Aggregation
BIT(3)-To enable LP GPIO based
handshake
BIT(4)-To enable ULP GPIO based
handshake
BIT(5)-To select module to host
wakeup pin(ULP_GPIO_1 or GPIO 21)
BIT(6)-RF supply voltage
BIT(7)-To Disable WPS in AP mode
BITs[8:31]- set to ‘0’
silabs.com | Building a more connected world. Page 14
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
Structure Member Name
Structure
Member Type
Description
Note:feature_bit_map
BIT(0)&BIT(1) are valid only in WiFi
Client mode.
tcp_ip_feature_bit_map
uint32
Following bits need to be set to use
respective TCP/IP features.
BIT(0)-TCP/IP bypass
BIT(1)-HTTP server
BIT(2)-DHCPv4 client
BIT(3)-DHCPv6 client
BIT(4)-DHCPv4 server
BIT(5)-DHCPv6 server
BIT(6)- Dynamic update of customer
webpages(JSON)
BIT(7)-HTTP client
BIT(8)-DNS client
BIT(9)-SNMP agent
BIT(10)-SSL
BIT(11)-Ping from module
BIT(12)-HTTPS server
BIT(16)-SNTP client
BIT(17)- IPv6 mode
BIT(13) to BIT(31) are
reserved bits(should set to 0)
IPv6 will also get enabled if DHCP v6
client/DHCP v6 server is enabled
irrespective of BIT(17)
BIT(19)- MDNS and DNS-SD
BIT(20)- SMTP client
BIT(21)-BIT(24) - To select
no of sockets
possible values are 1 to 10 . If User
tried to select more than 10 sockets
it will be reset to 10 sockets only .
Default no of sockets is 10, if this
selection is not done by the user.
BIT(25)- To select Single SSL
socket
0 – selecting single socket is
Disabled
1- Selecting single socket is
silabs.com | Building a more connected world. Page 15
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
Structure Member Name
Structure
Member Type
Description
enabled
NOTE: By default two SSL
sockets are supported
BIT(27)- To load SSL certificate
on to RAM
BIT(28)-To enable TCP-IP data
packet Dump on
UART1
BIT(29)- POP3 client
Note1: SSL related bits
(BIT(10)&BIT(12))are supported
only in client mode.
Note2:Tcp Ip features supported in coex
mode :
WLAN+BT : TCPIP Bypass
WLAN+BLE: TCPIP Bypass , DHCPV4 client
, Http client , DNS client , FTP client
WLAN+ZB : TCPIP Bypass , DHCPV4 client
, HTTP Server , DHCPV6 client , HTTP
client , DNS client , SNMP client , FTP
client
custom_feature_bit_map
uint32
Following bits need to be set to use
respective custom features.
BIT(2)-If this bit is set to ‘1’ in AP
mode, Then DHCP server reside in
module does not send out a
Gateway address, and sends only
the assigned IP and Subnet values to
the clients. It is highly
recommended to keep this value at
‘0’ as the changed behavior is
required in only very specialized use
cases and not in normal AP
functionality. The default value of
this bit is ‘0’.
BIT(5)- If this bit is set to ‘1’,
Hidden SSID is enabled in case of AP
mode. The default value of this bit is
‘0’.
BIT(6)- To enable/disable DNS
server IP address in DHCP offerin AP
silabs.com | Building a more connected world. Page 16
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
Structure Member Name
Structure
Member Type
Description
mode.
1- In AP mode, DHCP server sends
DNS server IP address in DHCP offer
0- Not to include DNS server
address in DHCP offer
BIT(8)- Enable/Disable DFS
channel support
1- Enable DFS channel support
0-Disable DFS channel support
BIT(9)– To on/off LED after
module initialization.
1- Tokeep LED on
0– To off LED after initialization
BIT(10)- Used to enable or
disable asynchronous messages to
host to indicate the module state.
1- Enable asynchronous message to
host
0-Disableasynchronousmessage to
host
BIT(11)- To make the module to
wait for confirmation from host for
the packet pending indication (from
module to host) in UART mode.
1 – Enable to makemodule to wait
for host confirmation.
0 - Disable the module to wait for
host confirmation.
BIT(12)-To bypass AP blacklist
feature.
1 – Bypass AP black list feature
0 – Enable AP black list
BIT[13:16]-Used to set the
maximum number of stations or
client to support in AP or wifi Direct
mode.Possible values are 1 to 8 in
AP mode and 1 to 4 in WiFi Direct.
Note1: If these bits are not set,
default maximum clients
silabs.com | Building a more connected world. Page 17
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
Structure Member Name
Structure
Member Type
Description
supported is set to 4.
BIT(17)-This bit is used to select
between de-authentication or Null
data (with power management bit
set) based roaming, Depending on
selected method station will roam
from connected AP to newly
selected AP.
1- To enable de-authentication
based roaming
0 – To enable Null data based
roaming
BIT(20)-To make modulepause
auto connection process on bootup
until host trigger the module using
trigger command.
1 – Enable
0 – Disable
BIT(22)-To enable/ disable per
station power save buffer limit
1 – Enable
0 – Disable
BIT(23)- To enable/ disable
http/https server authentication
1 – Enable
0 – Disable
BIT[24]: To enable/disable
higher clock frequency in module to
improve throughputs
1 - Enable
0 – Disable
BIT[25]: To give http server
credentials to host, in get
configuration command response
1 – To include http server
credentials in get configuration
command response
0 – To exclude http server
credentials in get configuration
command response
silabs.com | Building a more connected world. Page 18
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
Structure Member Name
Structure
Member Type
Description
BIT[26]: To accept or reject new
connection request when maximum
clients are connected in case of
LTCP.
1 - Reject
0 – Accept
By default this bit value is zero.
When BIT[26] is zero: For a LTCP
socket when maximum clients are
connected if a new connection
request is received, then this
connection request will not be
rejected. Instead module will
maintain this connection request in
LTCP pending list.
This request will be served when
any of the connected client is
disconnected.
When BIT[26] is set: For a
LTCP socket when maximum clients
are connected if a new connection
request is received, then this
connection request will be rejected
immediately. Module will not
maintain this connection request in
LTCP pending list.
BIT[0:1],BIT[3:4],BIT(7),B
IT[18:19],BIT(21),BIT[31:
27] Reserved, should be set to ‘0’
5.1.2 rsi_band
This API for the “Band” command.
Description:
This API to select module operating Band.
API Prototype:
int16 rsi_band(uint8 band)
Parameters:
silabs.com | Building a more connected world. Page 19
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
uint8 band
Structure
Member
Name
Structure
Member
Type
Description
band
uint8
0– 2.4GHz
1– 5GHz
2- Dual band(2.4GHz/5GHz)
5.1.3 rsi_config
This API is for configuring WLAN parameters.
Note:This API is used only for configuring RTS threshold value.
Description:
This API is for configuring WLAN parameters.
API Prototype :
int16 rsi_config(int16 config_type, int16 config_value)
Parameters:
Uint16config_type
Uint16config_value
Structure
Member
Name
Structure
Member
Type
Description
Config_type
uint16
1-To configure RTS threshold value
Config_value
uint16
[256-2346]
Any value in the above range.
5.1.4 rsi_init
This API for the “Init” command.
Description:
This API to initialize the module.
API Prototype :
silabs.com | Building a more connected world. Page 20
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
int16 rsi_init(void)
Parameters:
None
5.1.5 rsi_select_antenna
This API for the “Antenna Selection” command.
Description:
This API to select antenna parameters.
API Prototype:
int16 rsi_select_antenna(uint8 antenna_val,unit8 gain_2g,
uint8 gain_5g, uint8 antenna_path, uint8 antenna_type)
Parameters:
uint8 antenna_val – Parameter to select between internal and external
antenna.
uint8 gain_2g – Antenna gain in db for 2.4 GHz band and valid values are 0
to 10 .
uint8 gain_5g – Antenna gain in db for 5 GHz band and valid values are 0
to 10 .
uint8 antenna_path –Parameter to select the path of antenna values are
1 – internal antenna
2 - U.Fl/External antenna
uint8 antenna_type –Parameter to select type of antenna need to place at
the antenna_path values are,
1 – REDPINE antenna (Default antenna)
2 - FRACTUS antenna
3 - MOLEX antenna
Structure
Member Name
Structure
Member
Type
Description
antenna_val
uint8
0– Internal antenna selected
1– uFL selected for external antenna
gain_2g
uint8
0 to 10
gain_5g
uint8
0 to 10
silabs.com | Building a more connected world. Page 21
RS9113 WiSeConnect Host API Guide
V
V
e
e
r
r
s
s
i
i
o
o
n
n
1
1
.
.
7
7
.
.
9
9
Structure
Member Name
Structure
Member
Type
Description
antenna_path
uint8
1 – internal antenna
2 - U.Fl/External antenna
antenna_type
uint8
1 – REDPINE antenna (Default antenna)
2 - FRACTUS antenna
3 - MOLEX antenna
5.1.6 rsi_per_mode
This API is for the “PER (Packet Error Rate) Mode” command.
Description:
This API is used to configure the module for PER mode.
API Prototype:
int16 rsi_per_mode(rsi_uPerMode *uPerModeFrame)
Parameters:
rsi_uPerMode *uPerModeFrame – Pointer to per mode structure.
typedef union {
struct {
uint8 per_mode_enable[2];
uint8 power[2];
uint8 rate[4];
uint8 length[2];
uint8 mode[2];
uint8 channel[2];
uint8 rate_flags[2];
uint8 reserved1[2];
uint8 aggr_enable[2];
uint8 reserved2[2]; uint8
no_of_pkts[2];
uint8 delay[4];
} perModeFrameSnd;
uint8 uPerModeBuf[28];
}rsi_uPerMode;
Structure Member Name
Structure
Member
Type
Description
per_mode_enable[2]
uint8
to enable or disable PER Mode.
/