WLAN Commands#

The following sections document RS9116 WiSeConnect commands, parameters, responses and availability. For error codes returned by commands, see https://docs.silabs.com/rs9116-wiseconnect/latest/wifibt-wc-sapi-reference/error-codes

Index#

Note!

• All the commands should be input in decimal unless specified otherwise and must be terminated with \r\n (CRLF).

rsi_opermode :: Operating Mode#

Description#

This is the first AT command that needs to be sent from the Host after receiving the card ready frame from the module. This command configures the module in different functional modes.

Command Format#

Note that all parameters are shown on a new line to make the command format easier to read.

at+rsi_opermode=<oper_mode>,
                <feature_bit_map>,
                <tcp_ip_feature_bit_map>,
                <custom_feature_bit_map>,
                <ext_custom_feature_bit_map>,
                <bt_feature_bit_map>,
                <ext_tcp_ip_feature_bit_map>,
                <ble_feature_bit_map>,
                <ble_coustom_ext_feature_bit_map>,
                <config_feature_bit_map>

Some arguments for the rsi_opermode command are only enabled when conditions according to the following table are met.

Parameters#

oper_mode

• Sets the mode of operation. <oper_mode> contains two parts <wifi_oper_mode, coex_mode>. The lower two bytes represents wifi_oper_mode and higher two bytes represents coex_modes.

  oper_mode = ((wifi_oper_mode) | (coex_mode << 16))

where ...

Note!

When operating in Concurrent Mode:

1. Upto 4 station devices can be connected to Concurrent AP.

2. The STA and AP may operate in different security modes.

3. The AP's MAC address can be determined by incrementing the last byte of STA's MAC address by 1.

4. In TCP/IP non-bypass mode, Broadcast / Multicast packet goes to first created interface (e.g. if station connects first, the broadcast / multicast packet goes to the network that belongs to station).

5. Background scan, aggregation or IPv6 are not supported.

6. The station and AP interfaces must be configured to the same channel.

7. If AP is started first and selected channel scan is issued, it may return results from other channels. However, it is only possible to join in Concurrent AP's channel.

8. If STA is connected first, then AP should be explicitly started in the same channel as STA. Auto channel selection (channel 0) for AP is not supported in this case.

9. If AP and STA are running and the channel of external AP (to which the concurrent STA is connected) is changed, then the STA may attempt to rejoin in the old channel only.

Note!

1. Co-ex modes are supported only in 384K memory configuration.

2. For WLAN Co-ex mode, AP mode scan is not allowed.

If Co-ex mode is enabled in opermode command, then BT / BLE protocol will start and give corresponding card ready in parallel with opermode command response (which will be handled by corresponding application). BT card ready frame is described in the RS9116W BT Classic AT Command Programming Reference Manual and BLE card ready frame is described in the RS9116W BLE AT Command Programming Reference Manual

Other Parameters#

• <feature_bit_map>, see feature_bit_map.

• <tcp_ip_feature_bit_map>, see tcp_ip_feature_bit_map.

• <custom_feature_bit_map>, see custom_feature_bit_map.

• <ext_custom_feature_bit_map>, see ext_custom_feature_bit_map.

• <bt_feature_bitmap>, see bt_feature_bitmap.

• <ext_tcpip_feature_bitmap>, see ext_tcpip_feature_bitmap.

• <ble_feature_bit_map>, see ble_feature_bit_map.

• <ble_custom_ext_feature_bit_map>, see ble_custom_ext_feature_bit_map.

• <config_feature_bitmap>, see config_feature_bitmap.

Response#

Possible error codes are 0x0021, 0x0025, 0xFF73, 0x002C, 0xFF6E, 0xFF6F, 0xFF70, 0xFFC5.

Example 1#

When only oper_mode is given in Command Format

Command

at+rsi_opermode=0
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x6F 0x70 0x65 0x72 0x6D 0x6F 0x64 0x65 0x3D 0x30 0x0D 0x0A

Response

OK

0x4F 0x4B 0x0D 0x0A

Example 2#

When other parameters along with mode_val is given in opermode Command Format This command configures the device into Wi-Fi client mode with HTTP server enabled in Open security mode.

at+rsi_opermode=0,1,2,0
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x6F 0x70 0x65 0x72 0x6D 0x6F 0x64 0x65 0x3D 0x30 0x2C 0x31 0x2C 0x32 0x2C 0x30 0x0D 0x0A

[ Go to top ]

rsi_band :: Radio Band#

Description#

This command configures the radio band. This command has to be issued after opermode command.

at+rsi_band=<band_value>

Parameters#

The valid values for the parameter for this command are as follows:

band_value (1 byte)

Note!

1. Dual band is supported in station mode

2. 802.11J is only supported in 5 GHz

Response#

Possible error codes are 0x0005, 0x0021, 0x0025, 0x002C, 0x003c.

Availability#

This command is available in all operating modes.

Example#

Command

at+rsi_band=0
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x62 0x61 0x6E 0x64 0x3D 0x30 0x0D 0x0A

Response

OK
0x4F 0x4B 0x0D 0x0A

[ Go to top ]

rsi_config :: WLAN Configuration#

Description#

This command configures WLAN parameters. This command must be issued after init command.

Command Format#

at+rsi_config=<config_type>,<config_val>

Parameters#

config_type (2 bytes)

• 1 - Configure RTS (Request to send) threshold value other values are reserved for future use.

config_value (2 bytes)

• 0-2347 - Range of RTS (Request to send) threshold value

Note! Only RTS_THRESHOLD config type is supported.

Response#

Possible error codes are 0x0063, 0x0064.

Availability#

This command is available in all operating modes.

Example#

Command

at+rsi_config=1,256
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x63 0x6F 0x6E 0x66 0x69 0x67 0x3D 0x31 0x2C 0x32 0x35 0x36 0x0D 0x0A

Response

OK
0x4F 0x4B 0x0D 0x0A

[ Go to top ]

rsi_setmac :: Set MAC Address#

Description#

This command sets the MAC address of module. This command must be issued before the rsi_band command.

Command Format#

at+rsi_setmac=<mac_address>

Parameters#

mac_address (6 bytes)

• MAC address to be set for module.

Note! In concurrent mode, given MAC is applied to station mode and AP mode MAC address last byte will differ from station mode MAC. AP mode MAC address last byte will be one plus the station mode MAC address last byte given by host.

Response#

Possible error codes are 0x0021, 0x0025, 0x002C.

Availability#

This command is available in all operating modes.

Example#

Command

at+rsi_setmac=001122334455
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x73 0x65 0x74 0x6D 0x61 0x63 0x3D 0x30 0x30 0x31 0x31 0x32 0x32 0x33 0x33 0x34 0x34 0x35 0x35 0x0D 0x0A

Response

OK
0x4F 0x4B 0x0D 0x0A

[ Go to top ]

rsi_init :: Initialize PHY and Radio#

Description#

This command programs Baseband and RF components of the module and returns the MAC address of module to the host. This command must be issued after band command.

Command Format#

at+rsi_init

Parameters#

None.

Response#

For Non-concurrent Mode#

For Concurrent Mode#

| Result Code | Description | | OK <MAC_Address1><MAC_Address2>| Successful execution of command. MAC_Address1 is the station MAC Address and MAC_Address2 is of the AP created in the module.| | ERROR <Error code> | Failure. |

Possible error codes are 0x0021, 0x0025, 0x002C, 0x0002.

Availability#

This command is available in all operating modes

Example 1 - Client or AP mode#

Command

at+rsi_init
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x69 0x6E 0x69 0x74 0x0D 0x0A

Response

OK <MAC_Address>

0x4F 0x4B 0x80 0xC9 0x55 0x34 0xF0 0x10 0x0D 0x0A

Example 2 - Concurrent mode#

at+rsi_init
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x69 0x6E 0x69 0x74 0x0D 0x0A

Response

OK <MAC_Address1><MAC_Address2>

0x4F 0x4B 0x80 0xC9 0x55 0x34 0xF0 0x10 0x80 0xC9 0x55 0x34 0xF0 0x11 0x0D 0x0A

[ Go to top ]

rsi_gain_table :: Configure Gain Table#

Description#

This command overwrites the default region based gain tables (present in firmware) with user-defined region based gain tables. The 2.4 GHz and 5 GHz gain tables can be loaded consecutively by changing the band. This command should be issued immediately after the init command. Customer can load the two gain tables (i.e., 2.4GHz-20Mhz, 5GHz-20Mhz) one after other by changing band.

Note! Internally, firmware maintains two tables : Worldwide table and Region-based table. Worldwide table is populated by firmware with Max power values that chip can transmit that meets target specifications like EVM. Region-based table has default gain value set.

1. When certifying with user antenna, Region must be set to Worldwide and sweep the power from 0 to 21 dBm. Arrive at max power level that is passing certification especially band-edge.

2. These FCC/ETSI/TELEC/KCC Max power level should be loaded in end-to-end mode via WLAN User Gain table. This must be called done every boot-up since this information is not saved inside flash. Region based user gain table sent by application is copied onto Region based table .SoC uses this table in FCC/ETSI/TELEC/KCC to limit power and not to violate allowed limits.

For Worldwide region, the firmware uses Worldwide table for Tx. For other regions (FCC/ETSI/TELEC/KCC), the firmware uses min value out of Worldwide & Region based table for Tx. Also, there will be part to part variation across chips and offsets are estimated during manufacturing flow which will be applied as correction factor during normal mode of operation. This frame must be used by customers who has done FCC/ETSI/TELEC/KCC certification with their own antenna. All other customers should not use this. Inappropriate use of this frame may result in violation of FCC/ETSI/TELEC/KCC or any certifications, and Silicon Labs is not liable for that.

Precondition#

This command can be issued any time before or after the rsi_opermode command.

Command Format#

at+rsi_gain_table=<band_value>,<bandwidth>,<payload_length>,<payload>

Parameters#

band_value (1-byte)

bandwidth (1-byte)

payload_length (2-bytes)

• Max table size in 2.4 GHz band is 128 bytes

• Max table size in 5 GHz band is 64 bytes

payload (n-bytes, see table)

• Pass channel gain values for different regions in the format shown as follows.

• Gain table Format for 2.4 GHz band.

  • Each entry in the table is 1 byte.

  • In the 2.4 GHz, the maximum Gain/Power obtained from certification must be multiplied by 2.

<TABLE NAME>[] = 
{
  <NUMBER OF REGIONS>,
  <REGION NAME 1>, 
  <CHANNEL CODE 2G>,
  <CHANNEL NUMBER 1>,   <2 * MAX POWER 11b RATE>, <2 * MAX POWER 11g RATE>, <2 * MAX POWER 11n RATE>,
  <CHANNEL NUMBER 2>,   <2 * MAX POWER 11b RATE>, <2 * MAX POWER 11g RATE>, <2 * MAX POWER 11n RATE>,
     ...
  <CHANNEL NUMBER m-1>, <2 * MAX POWER 11b RATE>, <2 * MAX POWER 11g RATE>, <2 * MAX POWER 11n RATE>,
  <CHANNEL NUMBER m>,   <2 * MAX POWER 11b RATE>, <2 * MAX POWER 11g RATE>, <2 * MAX POWER 11n RATE>,

  <REGION NAME 2>, 
  <CHANNEL_CODE_2G>,
  <CHANNEL NUMBER 1>,   <2 * MAX POWER 11b RATE>, <2 * MAX POWER 11g RATE>, <2 * MAX POWER 11n RATE>,
  <CHANNEL NUMBER 2>,   <2 * MAX POWER 11b RATE>, <2 * MAX POWER 11g RATE>, <2 * MAX POWER 11n RATE>,
     ...
  <CHANNEL NUMBER m-1>, <2 * MAX POWER 11b RATE>, <2 * MAX POWER 11g RATE>, <2 * MAX POWER 11n RATE>,
  <CHANNEL NUMBER m>,   <2 * MAX POWER 11b RATE>, <2 * MAX POWER 11g RATE>, <2 * MAX POWER 11n RATE>,
     ...
};

Gain table Format for 5 GHz band

• In 5GHz, Max Gain/Power obtained from certification should be loaded.

• Each entry in the table is 1 byte.

<TABLE NAME>[] = 
{
  <NUMBER OF REGIONS>,
  <REGION NAME 1>, 
  <CHANNEL CODE 5G>,
  <CHANNEL NUMBER IN BAND 1 IF ANY> / <BAND NUMBER 1>, <MAX POWER 11a RATE>, <MAX POWER 11n RATE>,
  <CHANNEL NUMBER IN BAND 2 IF ANY> / <BAND NUMBER 2>, <MAX POWER 11a RATE>, <MAX POWER 11n RATE>,
  <CHANNEL NUMBER IN BAND 3 IF ANY> / <BAND NUMBER 3>, <MAX POWER 11a RATE>, <MAX POWER 11n RATE>,
  <CHANNEL NUMBER IN BAND 4 IF ANY> / <BAND NUMBER 4>, <MAX POWER 11a RATE>, <MAX POWER 11n RATE>
     ...
  <REGION NAME 2>, 
  <CHANNEL CODE 5G>,
  <CHANNEL NUMBER IN BAND 1 IF ANY> / <BAND NUMBER 1>, <MAX POWER 11a RATE>, <MAX POWER 11n RATE>,
  <CHANNEL NUMBER IN BAND 2 IF ANY> / <BAND NUMBER 2>, <MAX POWER 11a RATE>, <MAX POWER 11n RATE>,
  <CHANNEL NUMBER IN BAND 3 IF ANY> / <BAND NUMBER 3>, <MAX POWER 11a RATE>, <MAX POWER 11n RATE>,
  <CHANNEL NUMBER IN BAND 4 IF ANY> / <BAND NUMBER 4>, <MAX POWER 11a RATE>, <MAX POWER 11n RATE>
     ...
   };

<REGION NAME #>

Substitute the <REGION NAME #> corresponding to the desired region.

<CHANNEL CODE 2G>

An 8-bit value encoded as follows:

• If the transmit power of all the channels are the same, use <CHANNEL_CODE_2G> = 17 and <CHANNEL NUMBER> = 255.

• If the transmit power is not the same for all channels, use <CHANNEL_CODE_2G> as number of channels and specify transmit power values for all channels.

<CHANNEL CODE 5G>

An 8-bit value encoded as number of rows in a region 5 GHz band.

• 5 GHz is divided into 4 sub bands

  • band 1: channel number <= 48

  • band 2: channel number > 48 and channel number <= 64

  • band 3: channel number > 64 and channel number <= 140

  • band 4: channel number > 140

• If any channel in a specific band has a differing set of power values, specify the channel number followed by the power values.

• If all channels in band X have identical power values, specify the band number as X followed by the power value.

Note!

• As worldwide certification is not possible, a gain table for worldwide is not applicable.

• Length of the <payload> must match with the <payload_len> parameter value.

Response#

Possible error codes are 0x0021, 0x003E.

Availability#

This command is available in WLAN operating modes.

Example#

Command

at+rsi_gain_table=1,0,67,<payload>

Note!

1. For the <payload_len> parameter, the user must provide the actual length of the payload. If the gain table length is 70 and the user enters 128 then the module will return an error (0x003E).

2. To calculate the value of <payload_len>, add the number of bytes in the <payload> excluding spaces and commas.

Response

OK
0x4F 0x4B 0x0D 0x0A

Payload Examples#

This is a payload example for:

• band = 2.4 GHz

• bandwidth = 20 MHz

{      3,                 // Number of Regions
     FCC,                 // Region Name
      13,                 // Number of channels
       1, 34, 20, 20,     // rate, 11b, 11g, 11n
       2, 34, 28, 28,
       3, 34, 32, 32,
       4, 34, 36, 36,
       5, 34, 38, 38,
       6, 34, 40, 40,
       7, 34, 38, 38,
       8, 34, 36, 36,
       9, 34, 32, 32,
      10, 34, 32, 32,
      11, 34, 24, 24,
      12, 34, 16, 24,
      13, 34, 12, 12,
   TELEC,                 // Region Name
      17,                 // Number of channels
     255, 20, 16, 16,     // rate, 11b, 11g, 11n
     KCC,                 // Region Name
      17,                 // Number of channels
     255, 26, 20, 20,     // rate, 11b, 11g, 11n
}

This is a payload example for:

• band = 5 GHz

• bandwidth = 20 MHz

{
       2,          // Number of Regions
     FCC,          // Region Name
       6,          // Number of rows in 5 GHz region
       1, 9, 10,   // band 1 
       2, 8, 9,    // band 2 
     100, 4, 4,    // band 3 
       3, 6, 8,    // band 3 
     149, 3, 3,    // band 4 
       4, 6, 7,    // band 4
   TELEC,          // Region Name
       4,          // Number of rows in 5 GHz region
       1, 9, 10,   // band 1 
       2, 8, 10,   // band 2 
       3, 6, 8,    // band 3 
       4, 6, 7,    // band 4 
}

Example 2#

Customers using Certified MARS antenna should use the following gain table.

This is a payload example for:

• band = 2.4 GHz

• bandwidth = 20 MHz

{ 
       3,                // Number of Regions       
     FCC,                // Region Name
      13,                // Number of channels
       1, 28,  32, 30,   // rate, 11b, 11g, 11n
       2, 28,  32, 30, 
       3, 28,  32, 30, 
       4, 30,  28, 34, 
       5, 30,  28, 34, 
       6, 30,  28, 34, 
       7, 30,  28, 34, 
       8, 30,  28, 34, 
       9, 28,  30, 30, 
       10, 28, 30, 30, 
       11, 28, 30, 30, 
       12, 28, 30, 30, 
       13, 28, 30, 30, 
    TELEC,               // Region Name
       17,               // Number of channels
      255, 20, 16, 16,   // rate, 11b, 11g, 11n
      KCC,               // Region Name 
       17,               // Number of channels  
      255, 26, 20, 20,   // rate, 11b, 11g, 11n     
};

This is a payload example for:

• band = 5 GHz

• bandwidth = 20 MHz

{
        2,          // Number of Regions 
      FCC,          // Region Name
        6,          // Number of rows
        1, 12, 12,  // band 1
        2, 11, 11,  // band 2
      100, 10, 12,  // band 3
        3, 13, 13,  // band 3
      140, 10, 11,  // band 4
        4, 13, 13,  // band 4 
    TELEC,          // Region name 
        4,          // Number of rows in 5GHz region
        1, 9, 10,   // band 1
        2, 8, 10,   // band 2
        3, 6, 8,    // band 3
        4, 6, 7,    // band 4
}

[ Go to top ]

rsi_per :: PER Mode/Transmit Test#

Description#

This command configures the PER (Packet Error Rate) Mode in RS9116-WiSeConnect. This command should be issued after rsi_init command.

Command Format#

at+rsi_per=<per_mode_enable>,<power>,<rate>,<length>,<mode>,<channel>,<rate_flags>,<aggr_enable>,<no_of_pkts>,<delay>

Parameters#

per_mode_enable (2 bytes)

• Enable or disable PER Mode.

  • 0 – Disable PER mode

  • 1 – Enable PER mode

power (2 bytes)

• Set transmit power in dbm. Valid values are from 2dBm to 18dBm.

Note! To configure the maximum power level for a particular frequency band, set <power> = 127.

rate (4 bytes)

• Set transmit data rate.

Note!

• Date rate of 1, 2, 5.5, 11 Mbps (i.e., rate parameter: 0, 2, 4, 6) are not supported when operating in 5 GHz channel.

length (2 bytes)

• Configure length of the transmit packet. Valid values are in the range:

  • [24 .. 1500] bytes in burst mode

  • [24 ... 260] bytes in continuous mode

mode (2 bytes)

• Transmit mode

Note!

Burst Mode

DUT transmits a burst of packets with the given power, rate, length in the channel configured. The burst size will be determined by the <number of packets> and if its zero, then DUT keeps transmitting till a rsi_transmit_test_stop API is called.

Continuous Mode

The DUT transmits an unmodulated waveform continuously.

Continuous Wave Mode (Non-Modulation) in DC Mode:

The DUT transmits a spectrum only at the center frequency of the channel. A basic signal with no modulation is that of a sine wave and is usually referred to as a continuous wave (CW) signal. A basic signal source produces sine waves. Ideally, the sine wave is perfect. In the frequency domain, it is viewed as a single line at some specified frequency.

Continuous Wave Mode (Non-Modulation) in Single Tone Mode (Center frequency -2.5 MHz):

The DUT transmits a spectrum that is generated at -2.5 MHz from the center frequency of the channel selected. Some amount of carrier leakage will be seen at Center Frequency.

For example, for 2412 MHz the output will be seen at 2409.5 MHz

Continuous Wave Mode (Non-Modulation) in Single Tone Mode (Center frequency +5 MHz):

The DUT transmits a spectrum that is generated at 5MHz from the center frequency of the channel selected. Some amount of carrier leakage will be seen at Center Frequency.

For example, for 2412 MHz the output will be seen at 2417 MHz.

Note!

• Before starting CW mode, it is required to start Continuous mode with power and channel values which is intended to be used in CW mode as follows:

  • Start Continuous mode with intended power value and channel value; pass any valid values for rate and length

  • Stop Continuous mode

  • Start CW mode.

• To switch CW mode, stop PER mode and then give CW mode to where the user wants to switch to

• Generally, it is recommended to measure the TX power with "Burst mode or Continuous mode" only. "Continuous wave mode" for TX power measurement is not recommended. "Continuous wave mode" can be used for certification purposes and that to measure the frequency error.

channel (2 bytes)

• Sets the channel number in 2.4 GHz / 5 GHz. The following tables map the channel number to the actual radio frequency in the 2.4 GHz spectrum. To support PER mode in channels 12 and 13, the correct region command must be given by the host before the PER command.

• Channel numbers in the 5 GHz band are in the range 36 to 165. The following table maps the channel number to the actual radio frequency in the 5 GHz spectrum for 20MHz channel bandwidth.

• The following tables maps the channel number to the actual radio frequency in the 4.9 GHz spectrum for 802.11J. 802.11J features are only valid when the Japan region is set. For other regions, even if 802.11J is enabled, it has no effect.

rate_flags (2 bytes)

• Rate flags contain short GI, Greenfield and channel width values. Various fields in rate_flags are divided as specified below:

• Short GI. Set rate_flags[0] = 1 to enable Short GI (Short GI is not available in all software releases).

• Greenfield. Set rate_flags[1] = 1 to enable Greenfield mode.

• Channel width should be set to zero to set 20MHz channel width.

• Reserved: This field can be ignored. Set '0'.

• Immediate Transfer : CCA is enabled by default, set this bit to transfer packets immediately by ignoring CCA.

• Reserved: This field can be ignored. Set '0'.

Note! Only per_mode_enable, power, rate, length , mode, channel, rate_flags fields are valid. Remaining fields are not supported.

Response#

Possible error codes are 0x000A, 0x0021, 0x0025, 0x002C, 0x0033.

Availability#

This command is available when the module is configured in operating mode 8.

Example

To start transmitting

at+rsi_per=1,18,139,30,0,1,0,0,0,0
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x70 0x65 0x72 0x3D 0x31 0x2C 0x31 0x38 0x2C 0x31 0x33 0x39 0x2C 0x33 0x30 0x2C 0x30 0x2C 0x31 0x2C 0x30 0x2C 0x30 0x2C 0x30 0x2C 0x30 0x0D 0x0A

To stop transmitting

at+rsi_per=0
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x70 0x65 0x72 0x3D 0x30 0x0D 0x0A

Response#

OK
0x4F 0x4B 0x0D 0x0A

[ Go to top ]

rsi_freq_offset :: Frequency Offset Correction#

Command Description#

This command is used during the RF calibration process and requires PER mode transmissions to be initiated prior. This command sends freq_offset (deviation) as observed on the signal analyzer against the expected channel frequency. This command is relevant in PER mode.

Command Format#

at+rsi_freq_offset=<freq_offset_in_khz>

Parameters#

freq_offset_in_khz

• Frequency deviation in kHz or ppm.

Response#

Possible error codes are 0x00FC, 0X00FB.

Availability#

This command is available when the module is configured in Operating Mode 8.

Example#

To send frequency offset as 10 ppm:

Command

at+rsi_freq_offset=10

Response

OK

[ Go to top ]

rsi_calib_write :: Write Calibration Data#

Description#

This API is used during the RF calibration process and requires PER mode transmissions to be initiated prior. This API will command the firmware to update the existing Flash/EFuse calibration data with the xo ctune (given or picked from hardware register) and gain offset values. This command is relevant in PER mode.

The rsi_freq_offset command needs to be called before this command when xo ctune value from hardware register is to be used.

Command Format#

at+rsi_calib_write=<target>,<flags>,<gain_offset_low>,<gain_offset_mid>,<gain_offset_high>,<xo_ctune>

Parameters#

target (1 byte)

• Sets the target for calibration data

  • 0 - BURN_INTO_EFUSE. Burns calibration data to EFuse

  • 1 - BURN_INTO_FLASH. Burns calibration data to Flash

flags (1 byte)

• Bit 0 = RESERVED_0

  • Reserved

• Bit 1 = BURN_FREQ_OFFSET

  • 0 - Skip XO Ctune update

  • 1 - Update XO Ctune to calibration data

• Bit 2 = SW_XO_CTUNE_VALID

  • 0 - Use XO Ctune value as read from hardware register

  • 1 - Use XO Ctune provided as argument to update calibration data

• Bit 3 = BURN_XO_FAST_DISABLE

  • This BIT is used to apply patch for cold temperature issue on CC0/CC1 module.

• Bit 4 = BURN_GAIN_OFFSET_LOW

  • 0 - Skip low sub-band gain-offset update

  • 1 - Update gain offset for low sub-band (2 GHz).

• Bit 5 = BURN_GAIN_OFFSET_MID

  • 0 - Skip mid sub-band gain-offset update

  • 1 - Update gain offset for mid sub-band (2 GHz).

• Bit 6 = BURN_GAIN_OFFSET_HIGH

  • 0 - Skip high sub-band gain-offset update

  • 1 - Update gain offset for high sub-band (2 GHz).

• Bits 31-4 = Reserved

gain_offset_low (1 byte)

• gain_offset as observed in dBm in channel-1

gain_offset_mid (1 byte)

• gain_offset as observed in dBm in channel-6

gain_offset_high (1 byte)

• gain_offset as observed in dBm in channel-11

xo_ctune (1 byte)

• This field allows user to directly update xo_ctune value to calibration data bypassing the freq offset loop, valid only when BURN_FREQ_OFFSET and SW_XO_CTUNE_VALID flags are set.

Note!

For gain-offset calibration in 2 GHz, the user needs to calibrate gain-offset for low sub-band (channel-1), mid sub-band (channel-6), and high sub-band (channel-11) and input the three gain-offsets to this command and set the corresponding flags to validate it#

Response#

Example#

The gain offset can be calculated with the following equation.

gain_offset = observed_power_level + cable_loss - configured_power_level

where ...

• observed_power_level = 14.3 dBm

• cable_loss = 1.7 dB

• configured_power_level = 18.0 dBm

To write the gain offset as -2 dBm into flash/efuse, use the following command.

at+rsi_calib_write=1,1,-2

To write the xo_ctune value available in the hardware register to flash/efuse (after frequency calibration is performed), use the following command.

at+rsi_calib_write=1,2,0

To write a user configured xo_ctune value to flash/efuse (without performing the frequency calibration process), use the following command. Note that xo_ctune is in the range [0..255].

at+rsi_calib_write=1,2,0,<xo_ctune>

Note! To recalibrate the gain offset after it has been burnt to flash, the gain offset must be reset first, followed by the standard calibration flow. Recalibration is not possible if the EFuse is being used instead of flash. To reset the gain offset, use rsi_calib_write = 1,1,0.

Response

OK

[ Go to top ]

rsi_apconf :: Configure AP Mode#

Description#

This command is used to set the configuration information for AP mode. This command must be issued after the rsi_init command.

Command Format#

at+rsi_apconf = <channel_no>,<ssid>,<security_type>,<encrypt_type>,<psk>,<beacon_interval>,<dtim_period>,<sta support>,<ap_keepalive_type>,<ap_keepalive_period>

Parameters#

channel_no (2 bytes)

• The channel in which the AP operates. A value of zero enables the Auto channel selection (ACS) feature to automatically determine which channel configuration to use. The channel with the least traffic will be selected.

• The following table maps the channel number to the actual radio frequency in the 2.4 GHz spectrum.

Note! Operation in channels 12/13 requires configuration of the correct regulatory region using the set_region command.

• The following table maps the channel number to the actual radio frequency in the 5 GHz spectrum.

Note! DFS channels are not supported in AP mode.

ssid (34 bytes)

• SSID of the AP to be created.

Note!

1. To support a comma , in the SSID, enclose the SSID in double quotes e.g. “MY, NETWORK”

2. Double quotes " in the SSID are not supported.

3. The maximum length of the SSID is 32 bytes; the remaining 2 bytes are reserved for NULL termination and internal alignment.

security_type (1 byte)

• Security type

Note

• For AP mode with WPA3 security, only SAE-H2E method is supported. SAE Hunting and pecking method is not supported.

• PMKSA is not supported in WPA3 AP mode.

encrypt_type (1 byte)

• Encryption type

Note

• Bit 7 to 4 are being used for Transition Disable Indication(TDI).

• TDI can be enable in WPA3(Personal or Personal Transition mode) security mode in AP if bit 4 is set.

psk (64 bytes)

• PSK of the AP in security mode.

  • If the AP is in Open mode, this parameter can be set to 0.

  • If the security mode is WPA/WPA2, the PSK must between 8 and 63 bytes.

beacon_interval (2 bytes)

• Beacon interval of the AP in milliseconds. Allowed values are integers in the range 100 to 1000 in multiples of 100.

dtim_period (2 bytes)

• DTIM period. Allowed values are from 1 to 255

ap_keepalive_type (1 byte)

• This is the bitmap to enable AP keep alive functionality and to select the keep alive type.

  • BIT[0] - Enable/disable keep alive functionality.

    • 0 - To disable keep alive functionality

    • 1 - To enable keep alive functionality

  • BIT[1] - Select AP keep alive method.

    • 0 - Default keep alive functionality i.e. disconnect the station if there are no wireless exchanges from station with in ap_keepalive_period

    • 1 - Enable null data frame based keep alive functionality.

ap_keepalive_period (1 byte)

• This is the period after which AP will disconnect the station if there are no wireless exchanges from station to AP. Keep alive period is calculated in terms of 32 multiples of beacon interval i.e if there are no wireless transfers from station to AP with in (32 x beacon_interval = keep_alive_period) milliseconds time period, station will be disconnected. If null data based method is selected, AP checks the connectivity of station by sending null data packet. If station does not acknowledge the packet, that station will be disconnected from AP after 4 retries.

max_sta_support (2 bytes)

• Number of clients supported. This value should be less than or equal to the value given in custom feature select bit map BIT[13:16] of the Set Operating Mode command. If value is not set in custom feature select bit map BIT[13:16] of the Set Operating Mode then maximum supported stations are 4.

Note! RS9116W supports for connecting 16 clients to the created AP by setting custom_feature_bit_map[13:16]](https://docs.silabs.com/rs9116-wiseconnect/latest/wifibt-wc-sapi-reference/opermode#rsi-custom-feature-bit-map) and extended_custom_feature_bit_map[15]](https://docs.silabs.com/rs9116-wiseconnect/latest/wifibt-wc-sapi-reference/opermode#rsi-ext-custom-feature-bit-map) by using the equation mentioned below:

Number of stations = (Stations Obtained by setting BIT[13-16] + 1 ) * 2

For example, if the host wants 16 clients support in AP, then set following bits: BIT[13], BIT[14] and BIT[15] (leave BIT[16] as 0 ) in custom feature bitmap and BIT[15] in extended custom feature bitmap, then the number of stations will become (7+1) * 2 = 16. If configuring more than 16 stations, it will throw an error. If the extended custom feature bitmap is not set, then it can configure a maximum of 8 stations. This is Backward Compatibility. Also, if configuring more than 8 stations, it will throw an error

Response#

Possible error codes are 0x0021, 0x0025, 0x002C, 0x0026, 0x004C, 0x0028, 0x001A, 0x000A, 0x001D

Availability#

This command is available when the module is configured in Operating Mode 6 and 9.

Example 1#

Configured AP with:

• channel_no: 11

• ssid: ap_ssid

• security_type: open mode

• beacon_interval: 100

• dtim_period: 3

• max_sta_support: 3

Command

at+rsi_apconf=11,ap_ssid,0,0,0,100,3,3
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x61 0x70 0x63 0x6F 0x6E 0x66 0x3D 0x31 0x31 0x2C 0x72 0x65 0x64 0x70 0x69 0x6E 0x65 0x2C 0x30 0x2C 0x30 0x2C 0x30 0x2C 0x31 0x30 0x30 0x2C 0x33 0x2C 0x33 0x0D 0x0A

Response

OK
0x4F 0x4B 0x0D 0x0A

Example 2#

Configured AP with:

• channel_no: 0 (ACS)

• ssid: MY_SSID

• security_type: WPA2

• encrypt_type: CCMP

• psk: 12345678

• beacon_interval: 100

• dtim_period: 3

• max_sta_support: 3

Command

at+rsi_apconf=0,MY_SSID,2,2,12345678,100,3,3
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x61 0x70 0x63 0x6F 0x6E 0x66 0x3D 0x30 0x2C 0x4D 0x59 0x5F 0x53 0x53 0x49 0x44 0x2C 0x32 0x2C 0x32 0x2C 0x31 0x32 0x33 0x34 0x35 0x36 0x37 0x38 0x2C 0x31 0x30 0x30 0x2C 0x33 0x2C 0x33 0x0D 0x0A

Response

OK
0x4F 0x4B 0x0A 0x00 0x0D 0x0A

[ Go to top ]

rsi_wps_method :: WPS PIN Method#

Description#

This command configures the WPS PIN method to be used in RS9116-WiSeConnect.This command should be issued before join command.

Command Format#

at+rsi_wps_method=<wps_method>,<generate_pin>,<wps_pin>

Parameters#

wps_method (2 bytes)

• Set to '1' for PIN method.

generate_pin (2 bytes)

• This parameter specifies whether to validate entered PIN or generate PIN. This parameter is valid only if wps_method is 1.

  • 0 - Use entered pin in wps_pin field

  • 1 - PIN generation

• If generate_pin is 0, module will validate the given 8 digit wps_pin. If pin given is less than 8 digit or if pin is wrong then module will give error.

wps_pin (8 bytes)

• wps_pin is of 8 digits pin. Module validates and uses this pin only in case of when

• wps_method is PIN method and generate_pin is 0.

Response#

Response contains a wps_pin payload only if PIN method is selected. In case of PUSH method response does not contains any payload.

wps_pin: The WPS PIN will be used by the module to connect with WPS AP.

Possible error codes are 0x0021, 0x0025, 0x002C, 0x0037, 0x0038.

Availability#

This command is available when the module is configured in Operating Mode 0 and 6.

Example 1#

When PIN of length 8 is given:

Command

at+rsi_wps_method=1,0,12345678
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x77 0x70 0x73 0x5F 0x6D 0x65 0x74 0x68 0x6F 0x64 0x3D 0x31 0x2C 0x30 0x2C 0x31 0x32 0x33 0x34 0x35 0x36 0x37 0x38 0x0D 0x0A

Response

OK 0x01 0x02 0x03 0x04 0x05 0x06 0x07 0x08 0x4F 0x4B 0x01 0x02 0x03 0x04 0x05 0x06 0x07 0x08 0x0D 0x0A

Example 2#

When PIN of length less than 8 is given:

Command

at+rsi_wps_method=1,1,1234
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x77 0x70 0x73 0x5F 0x6D 0x65 0x74 0x68 0x6F 0x64 0x3D 0x31 0x2C 0x30 0x2C 0x31 0x32 0x33 0x34 0x0D 0x0A

[ Go to top ]

rsi_scan :: Wi-Fi Scan#

Description#

This command scans for Access Points and gives the scan results to the host. The scan results are sorted in decreasing order of signal strength (RSSI value). The scanned access point with highest signal strength will be the first in the list. This command has to be issued after init (#rsi_init---initialize-phy-and-radio) command and before join (#rsi_join---wifi-join) command.

Command Format#

There are two command format options available:

1. Scanning multiple channels

2. Scanning a specific channel

at+rsi_scan=<channel>,<ssid>,<channel_bit_map_2_4>,<channel_bit_map_5>

at+rsi_scan=<channel>,<ssid>,<scan_feature_bitmap>

Parameters#

Channel (4 byte)

• Channel Number on which scan has to be done. If this value is 0, the module scans in all the channels in the band that is selected through the band command. The values of this parameter are listed in table below To select DFS channels user need to set custom feature bit in opermode command.

Note!

• If chan_num is 0 and channel bit maps (selective scan) are provided, then module will scan only the channels specified in bitmaps instead of scanning all channels.

• In case of 5GHz, module performs passive scan in DFS channels only when BIT[8] is set in custom feature bit map in Set Operating Mode command.

• scan feature bitmap

  • BIT[0] (QUICK SCAN feature) - It is valid only if channel number and ssid is given.

• If channel bitmap is specified, module will scan only channels which are valid in selected region

Note! Scanning in 12, 13 channels is allowed based on the region selected in Set Region command.

ssid (34 byte)

• Optional Input. For scanning a hidden Access Point, its SSID can be provided as part of the SCAN command. The maximum number of scanned networks reported to the host is 11. If not used, null characters should be supplied to fill the structure.

Note!

1. To support a comma , in the SSID, enclose the SSID in double quotes e.g. “MY, NETWORK”

2. Double quotes " in the SSID are not supported.

3. The maximum length of the SSID is 32 bytes; the remaining 2 bytes are reserved for NULL termination and internal alignment.

scan_feature_bitmap (1 byte)

• BIT[0]: Enable/disable quick scan feature.

  • 0 - Disable quick scan feature.

  • 1 - Enable quick scan feature.

• BIT[1:7]: Reserved

channel_bit_map_2_4 (2 bytes)

• channel bitmap for scanning in set of selective channels in 2.4 GHz.

channel_bit_map_5 (4 bytes)

• channel bitmap for scanning a set of selective channels in 5 GHz.

Note! For 11J, channel bit map need to give in channel_bit_map_5.

where ...

scan_count (4 bytes)

• Number of Access Points scanned

padding(4 bytes)

• padding bytes which can be ignored.

rf_channel (1 byte)

• Channel Number of the scanned Access Point

security_mode (1 byte)

• In WPA3 Personal Transition Mode if both WPA2 and WPA3 APs are available in scan results, STA will pick the AP which has strongest RSSI (it could be either WPA2 or WPA3).

rssi_val (1 byte)

• RSSI of the scanned Access Point

u_network_type(1 byte)

• Network type of the scanned Access Point 1– Infrastructure mode

ssid (34 bytes)

• SSID of the scanned Access Point

bssid (6 bytes)

• MAC address of the scanned Access Point.

reserved (2 bytes)

• Reserved bytes.

Availability#

This command is available when the module is configured in Operating Mode 0, 2, 6 and 9.

Examples#

To scan all the networks in all channels

Command

at+rsi_scan=0
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x73 0x63 0x61 0x6E 0x3D 0x30 0x0D 0x0A

To scan a specific network "Test_AP" in a specific channel 6

Command

at+rsi_scan=6,Test_AP
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x73 0x63 0x61 0x3D 0x36 0x2C 0x54 0x65 0x73 0x74 0x5F 0x41 0x50 0x0D 0x0A

Response If two networks are found with the SSID "ap_ssid_net1" and "ap_ssid_net2" in channels 6 and 10, with measured RSSI of -20dBm and -14dBm respectively, the return value is:

OK <scan_count=2> <padding> <rf_channel=0x0A> <security_mode=0x02> <rssi_val=14> <u_network_type=0x01> <ssid =ap_ssid_net2> <bssid=0x00 0x23 0xA7 0x1F 0x1F 0x15> <reserved ><rf_channel=0x06> <security_mode=0x00> <rssi_val=20> <u_network_type=0x01> <ssid=ap_ssid_net1> <bssid=0x00 0x23 0xA7 0x1F 0x1F 0x14> <reserved>

0x4F 0x4B 0x02 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x0A 0x02 0x0D 0x01 0x52 0x65 0x64 0x70 0x69 0x6E 0x65 0x5F 0x6E 0x74 0x32 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x23 0xA7 0x1F 0x1F 0x15 0x00 0x00 0x06 0x00 0x14 0x01 0x52 0x65 0x64 0x70 0x69 0x6E 0x65 0x5F 0x6E 0x74 0x31 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x23 0xA7 0x1F 0x1F 0x14 0x00 0x00 0x0D 0x0A

[ Go to top ]

rsi_join :: Wi-Fi Join#

Description#

This command is used for following:

1. Associate to an access point (operating mode = 0, 2 or 9)

2. Create an Access Point (operating mode 6 or 9)

3. To enable WPS PUSH method in Access point mode

Command Format#

at+rsi_join=<ssid>,<data_rate>,<power_level>,<security_mode>,<join_feature_bitmap>,<listen_interval>,<vap_id>,<join_bssid>

Parameters#

ssid (34 bytes)

• When the module is in Operating modes 0 or 2, this parameter is the SSID of the Access Point (assuming WPS is not enabled in the Access Point).

• When the module is in operating modes 0 or 2, and wants to connect to an access point in WPS mode then the value of this parameter is NULL .

• When an Access Point needs to be created, this parameter should be the same as the parameter ssid in the command "Configure AP mode".

Note!

1. To support a comma , in the SSID, enclose the SSID in double quotes e.g. “MY, NETWORK”

2. Double quotes " in the SSID are not supported.

3. The maximum length of the SSID is 32 bytes; the remaining 2 bytes are reserved for NULL termination and internal alignment.

data_rate (1 byte)#

power_level (1 byte)

• This fixes the Transmit Power level of the module. This value can be set as follows:

• At 2.4 GHz:

• At 5 GHz:

security_mode (1 byte)

• This variable is used to define the security mode of the Access point to which module is supposed to connect. Possible values are shown in the following table:

Note!

• Security_mode parameter is valid only if opermode is 0, 2 or 9.

• psk is required for security mode 1,2,7. Otherwise, the module returns Join failure with error 0x16.

• In Enterprise mode(Security_mode 4,5), module will derive the PSK using EAP exchanges with Authentication server.

• Module strictly obey security mode specified in Join command, not depends on PSK.

• In opermode 6, Once Access point is created host can enable WPS PUSH method by giving join command (with same parameters which were used to create Access point) again.

• WPS method is not supported in CoEx mode.

• In open mode, WEP mode, Enterprise Security, this should be filled with NULL characters.

• WPA3 STA supports both H2E and Hunting-and-pecking for WPA3 authentication. It picks authentication algorithm based on AP's capability.

• WPA3 STA supports PMKSA caching. If STA has valid PMKID (generated after first connection) with an AP it will trigger OPEN authentication for successive connection attempts. By default the lifetime for PMKSA entry is 12 hours.

• In WPA3 Personal Transition Mode if both WPA2 and WPA3 APs are available in scan results, STA will pick the AP which has strongest RSSI (it could be either WPA2 or WPA3).

• If any WPA3 AP enables Transition Disable Indication, from that moment onwards STA in transistion mode will not try connections to WPA2 APs. This behavior will persist until reset of the STA.

join_feature_bitmap (1 byte)

Note!

1. BIT[5] and BIT[6] of join_feature_bit_map must be set for enabling WPA3 Personal Mode security.

2. For enabling WPA3 Personal Transition mode security, join_feature_bit_map BIT[5] must be set and BIT[6] must be clear.

listen_interval (4 bytes)

• This is valid only if join_feature_bit_map[1] is set. This value is given in time units (1024 microseconds). This parameter is used to configure maximum sleep duration in powersave.

Note! To ensure data for module is buffered for sufficient time in access point,

1. Listen interval in association request is incremented by 6 if user configured interval is greater than 11.

2. If user configured listen interval less than or equal to 11, by default module will send listen interval 16 in association request. But during powersave module goes to sleep for user defined listen interval only

vap_id (1 byte)

• Create a virtual access point (AP).

  • 0 – Module will try to connect to scanned AP.

  • 1 – Module will create AP.

join_bssid (6 bytes)

• This contains BSSID of selected AP. This is valid only if join_feature_bitmap[4] is set otherwise module will ignore the value.

Note!

1. vap_id will be considered only in concurrent mode.

2. In concurrent mode, if connected station network is same as default dhcp server network then dhcp server will not start but join command for AP creation will give success message to host.

3. For join with BSSID don’t use spaces or colons between MAC address in join command.

Example#

To join particular AP in security mode,

Command

at+rsi_join=SILABS_AP,0,2,2
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x6A 0x6F 0x69 0x6E 0x3D 0x4E 0x41 0x4E 0x20 0x48 0x6F 0x6D 0x65 0x2C 0x30 0x2C 0x32 0x2C 0x32 0x0D 0x0A

Response

OK 
0x4F 0x4B 0x43 0x0D 0x0A

[ Go to top ]

rsi_timeout :: Set WLAN Timeouts#

Description#

This command is used to set various WLAN timeouts including authentication, association request timeouts, active scan time per channel and WLAN keepalive interval.

Command Format#

at+rsi_timeout=<timeout_bitmap>,<timeout_value>

timeout_bitmap (4 bytes)

Note! For setting WLAN keepalive timeout need to give time out command before init. If timeout is given as 0, keep alive functionality will be disabled.

Example

Set authentication and association request timeout to 1.5 seconds.

Command

at+rsi_timeout=1,1500
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x74 0x69 0x6D 0x65 0x6F 0x75 0x74 0x3D 0x31 0x2C 0x31 0x35 0x30 0x30 0x0D 0x0A

Response

OK
0x4F 0x4B 0x0D 0x0A

[ Go to top ]

rsi_rejoin_params :: Wi-Fi Rejoin#

Description#

The module automatically tries to rejoin if its existing network connection is lost. During the rejoin process, if the host sends any command to the module, the module will not accept it and will return an error with the error code 0x37. The module aborts the rejoin after a fixed number of re-tries (maximum number of retries for rejoin is 20 by default). If this happens, an asynchronous message is sent to the Host with an error code 25. User can configure the rejoin parameters using rejoin command.

Note! When rejoin fails, module will close all prior opened TCP/IP sockets.

Command Format#

at+rsi_rejoin_params=<rsi_max_try>,<rsi_scan_interval>,<rsi_beacon_missed_count >,<rsi_first_time_retry_enabled>

Parameters#

rsi_max_try (4 bytes)

• This represents the number of attempt for join before giving up the error. If the number of rejoin attempts is 0, then module will try to rejoin indefinitely.

• If this is set to 1, Rejoin feature will be disabled.

rsi_scan_interval (4 bytes)

• This is the time interval in seconds for the subsequent retry.

rsi_beacon_missed_count (4 bytes)

• This is the beacon missed count that module used to declare module connection status. If module found continuous beacon missed is greater than or equal to this value then it will declare connection as disconnected and will start rejoin process again.

rsi_first_time_retry_enable (4 bytes)

• If this is set to 1, then module will retry to connect if first join attempt fails. Number of attempts and scan interval may be configured by rsi_max_try and rsi_scan_interval respectively.

Response#

Possible error codes are 0x0025, 0x002C.

Asynchronous responses from module:

The following message indicates that module is in rejoin process. So, it is unable to process requested command.

ERROR<Error code=37>
0x45 0x52 0x52 0x4F 0x52 0x25 0x00 0x0D 0x0A

Following message to indicate rejoin failure to host.

ERROR<Error code=25>
0x45 0x52 0x52 0x4F 0x52 0x19 0x00 0x0D 0x0A

Availability#

This command is available when the module is configured in Operating Mode 0, 2.

[ Go to top ]

rsi_ap_stop :: Wi-Fi AP Stop#

Description#

This command is used to stop the access point created. The command can be issued any time after the creating AP (at+rsi_join).

Command Format#

at+rsi_ap_stop

NOTE!

• This command must be called after at+rsi_apconf and at+rsi_join commands.

Response#

Possible error codes are 0x0006,0x0021,0x0025,0x0026.

Availability#

This command is available when the module is configured in Operating Mode 6 (Access Point mode) or 9 (Concurrent mode).

[ Go to top ]

rsi_wmm_config :: WMM PS#

Description#

This command is used to enable WMM Powersave configurations. This command should be issued before join command and before powersave command.

Command Format#

at+rsi_wmm_config=<wmm_ps_enable>,<wmm_ps_type>,<wmm_ps_wakeup_interval>,<wmm_ps_uapsd_bitmap>

Parameters#

wmm_ps_enable (2 bytes)

• Enable or disable WMM PS

  • 0 - disable

  • 1 - enable

wmm_ps_type (2 bytes)

• WMM PS type

  • 0 - Transmit Based

  • 1 - Periodic

wmm_ps_wakeup_interval (4 bytes)

• Wakeup interval in milli seconds.

wmm_ps_uapsd_bitmap (1 byte)

• Bitmap, 0 to 15 possible values.

• Parameters wmm_ps_type, wakeup_interval, wmm_ps_uapsd_bitmap will be used for WMM-PS if Powersave is enabled and psp_type given as UAPSD.

Response#

Possible error codes are 0x0021, 0x0025, 0x002C.

Availability#

This command is available when the module is configured in Operating Mode 0, 2 and 6.

Example#

Command

at+rsi_wmm_config=1,1,0,10
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x77 0x6D 0x6D 0x5F 0x70 0x73 0x3D 0x31 0x2C 0x31 0x2C 0x30 0x2C 0x31 0x30 0x0D 0x0A

Response

OK
0x4F 0x4B 0x0D 0x0A

[ Go to top ]

rsi_sleeptimer :: Set Sleep Timer#

Description#

This command configures the sleep timer of the module to go into sleep during powersave operation. The command can be issued any time in case of powersave mode 9. If this command is not issued, then by default module takes 3 seconds as sleep timer.

Command Format#

at+rsi_sleeptimer=<time_value>

Parameters#

time_value (2 bytes)

• Sleep Timer value in seconds in the range [1 ... 2100].

Response#

Possible error codes are 0x0025, 0x002C.

Availability#

This command is available when the module is configured in Operating Mode 0, 2.

[ Go to top ]

rsi_pwmode :: Power Mode#

Description#

This command configures the powersave mode of the module. Powersave is disabled by default. The command can be issued any time after the #join command in case of powersave mode 1, 2 and 3.

And after #init command before join command in case of powersave mode 8 and 9.

Note!

1. RS9116-WiSeConnect doesn't support powersave modes while operating in AP or group owner mode.

2. In SPI interface when ULP mode is enabled, after wakeup from sleep, host must initialize SPI interface of the module.

3. To use num_of_dtim_skip feature, listen interval should be disable in join command, listen_interval_dtim param in at+rsi_pwmode command should be 1 (DTIM alligned).

Command Format#

at+rsi_pwmode=<power_value>,<ulp_mode_enable>,<listen_interval_dtim>,<psp_type>,<monitor_interval>,<num_of_dtim_skip>,<listen_interval>

Parameters#

power_value (1 byte)

ulp_mode_enable (1 byte)

listen_interval_dtim (1 byte)

• According to set or reset of this param, the module computes the desired sleep duration based on listen interval (from join command) and its wakeup alignment with Beacon or DTIM Beacon (based on this parameter).

  • 0 - Module wakes up before nearest Beacon that does not exceed the specified listen interval time.

  • 1 - Module wakes up before nearest DTIM Beacon that does not exceed the specified listen interval time.

psp_type (1 byte)

• This parameter shows powersave procedure type used. Following is the values for the psp_type.

  • 0 – Max powersave procedure

  • 1 – Fast powersave procedure

  • 2 – UAPSD powersave procedure

• The recommended PSP mode is called ENHANCED MAX PSP. This is essentially a MAX PSP mode but switches to Fast PSP mode if AP does not deliver data within 20ms for PS-Poll. To enable this mode please follow below procedure.

  • Enable BIT(26) in CONFIG_FEATURE_BITMAP

  • Set psp_type = 1 (Fast PSP)

  • Configure Monitor interval as required

Note!

1. When Fast PSP is enabled, module will disable powersave for monitor_interval of time for each data packet received or sent.

2. UAPSD powersave is valid only if wmm is enabled through at+rsi_wmm_config command

monitor_interval (2 bytes)

• This is the time in ms to keep module in wakeup state for each TX or RX traffic sent or received respectively. Default value for this is 50 ms.

num_of_dtim_skip (1 byte)#

• This parameter is to skip the number of DTIM. If its value is n then our module will wakeup at (n+1)th DTIM at each wakeup cycle.

• To use this feature, ensure following condition: BIT(1) is reset in the join_feature_bitmap in join command.

listen_interval (2 bytes)

• This is valid only if BIT(7) in join_feature_bit_map is set. This value is given in time units (1024 microseconds). This parameter is used to configure maximum listen interval in powersave and should be less than the listen interval configured in join command.

Note! To change the listen_interval dynamically, disable and then re-enable powersave with a new listen_interval.

Response#

Possible error codes are 0x0021, 0x0025, 0x002C, 0xFFF8, 0x0015, 0x0026, 0x0052

Availability#

This command is available when the module is configured in Operating Mode 0,5,9,13 Module can configure Coex modes are 1,5,9,12,13.

Powersave Operation#

The behavior of the module differs according to the powersave mode configured. The following terminology is used in the below section in order to describe the functionality.

Note!

1. In case of WLAN, wake up period will be calculated based on DTIM interval.

2. In case of BT-Classic, wake up period will be calculated based on inquiry scan interval in discoverable mode, page scan interval in connectable mode and sniff interval in connected mode.

3. In case of BLE, wake up period will be calculated based on advertise interval in advertising state, scan interval in scanning state and connection interval in connected state.

4. If incase BT/BLE wakeup period is less than the WLAN wakeup period, the module will wake up and serves BT/BLE and goes back to the sleep again.

Powersave: Mode 0#

In this mode, module is active and powersave is disabled. It can be configured any time, while powersave is enabled with powersave mode 2 or powersave mode 8.

Powersave: Mode 1#

Once the module is configured in powersave mode 1, it wakes up periodically based upon the DTIM interval configured in the connected AP. In power mode 1, only the RF part of the module is in power save while SoC continues to work normally. This command has to be given only when the module is in the connected state (with the AP).

After configuring the module to powersave mode 1, the host can issue subsequent commands. In powersave mode 1, the module can receive data from the host at any point in time, but it can send/receive the data to/from the remote terminal (like a remote socket), only when it wakes up at DTIM interval.

Powersave: Mode 2#

Once the module is configured in powersave mode 2, it can be woken up either by the host or periodically during its sleep-wake-up cycle based upon the DTIM interval. Power mode 2 uses GPIO based handshake.

In ULP mode, feature_bit_map[4] has to be set in opermode command.

In this mode, when the host wants to send data to the module, it sends a wakeup request to the module by asserting ULP_GPIO_5 high in the case of LP or UULP_GPIO_2 in case of ULP (which make the module wake up from powersave). After wakeup, if the module is ready for data transfer, it sends a wakeup indication to the host by asserting the UULP_GPIO_3 or UULP_GPIO_0.

The host is required to wait until the module gives the wakeup indication, before sending any data to the module. After completion of data, the host can give sleep permission to the module by de-asserting ULP_GPIO_5 in the case of LP or UULP_GPIO_2 in the case of ULP. After recognizing sleep permission from the host, the module confirms the host by de-asserting UULP_GPIO_3 or UULP_GPIO_0 and goes back to its sleep-wakeup cycle.

The module can send a received packet or response to the host at any point in time. No handshake is required on the receive path.

Powersave: Mode 3#

Powersave Mode 3 uses a Message-based handshake. In Powersave Mode 3, both radio and SoC of RS9116- WiSeConnect are in powersave.

This mode is significant when the module is connected to the AP. Module wakes up periodically every DTIM and sends a wakeup message ("WKP") to the host. The module cannot be woken up asynchronously.

Every time module intends to go to sleep it sends a sleep request message ("SLP") to the host and expects the host to send the ACK message ("ACK"). Host either sends an acknowledgment message ("ACK") or any other pending message. But once ACK is sent, the host should not send any other message until the next wakeup message from the module is received.

The module will not go into complete power save state if ACK is not received from the host for the sent sleep message ("SLP"). The module can send a received packet or response to the host at any point in time. No handshake is required on the receive path.

Powersave: Mode 8#

Powersave mode 8 uses GPIO based handshake. This command must be issued after the #init command. In Powersave Mode 8 both RF and SoC of RS9116-WiSeConnect are in complete powersave mode. This mode is significant when the module is not connected with any AP.

In ULP mode, feature_bit_map[4] has to be set in opermode command. In the case of LP (when ulp_mode_enable is 0) host can wake up the module from power save by asserting ULP_GPIO_5. In the case of ULP (when ulp_mode_enable is 1 or 2) host can wake up the module from power save by asserting UULP_GPIO_2.

When ulp_mode_enable is set to 0 or 1, once the module gets a wake-up request from the host, DUT wakes up and indicates it is awake by asserting UULP_GPIO_3 or UULP_GPIO_0 based on the Wakeup indication GPIO selection in opermode command. The host is required to wait until the module gives the wakeup indication, before sending any next command to the module. After completion of command/data, the host can give sleep permission to the module by de-asserting ULP_GPIO_5 in the case of LP or UULP_GPIO_2 in the case of ULP. After recognizing sleep permission from the host, the module confirms the host by de-asserting UULP_GPIO_3 or UULP_GPIO_0 and goes back to its sleep-wakeup cycle.

The module can send a received packet or response to the host at any point in time. No handshake is required on the receive path.

When ulp_mode_enable is set to 2, after the module wakes up from sleep, the host needs to start giving commands from the beginning(opermode) as the module's state is not retained.

Note! By default UULP_GPIO_3 is used for wakeup indication to host. If config_feature_bit_map[0] = 1 then UULP_GPIO_0 is used for wakeup indication to host.

Powersave: Mode 9#

Powersave Mode 9 uses a Message-based handshake. In this mode, the entire module, including the radio, enters powersave mode. This mode is significant when the module is not connected with any AP.

After receiving a powersave mode 9 command, the module sends SLP (Sleep) request to the host and waits for an ACK from the host. After the ACK (Acknowledgement) is received, the module goes to sleep. The sleep timer starts when powersave command is received. It can be configured by the host using the at+rsi_sleeptimer command. If the host does not set any sleep time, the timer is configured for 3 seconds by default. Upon wakeup, the module sends a wakeup message to the host and expects the host to send an ack before it goes into the next sleep cycle. The host either sends an ACK or a message. However, once an ACK is sent, no other packet should be sent before receiving the next wakeup message.

When ulp_mode_enable is set to 2, after waking up from sleep, the module sends the wakeup from sleep message (WKP FRM SLEEP) to the host when RAM retention is not enabled. After receiving the message, the host needs to start giving commands from the beginning (opermode) as the module's state is not retained.

Note! Sleep Timer starts when SLP request is sent to the host. Sleep time varies based on the ACK sent by the host. If the ACK sent by the host is delayed, Module will be in sleep state for the remaining time.

[ Go to top ]

rsi_psk :: Wi-Fi Pre-shared Key#

Description#

The command is used to set the PSK (Pre shared key) to join to WPA/WPA2-PSK enabled APs. Using this command user can also pass the PMK (PAIRWISE MASTER KEY) as a parameter and can also generate PMK by providing PSK and SSID of connecting AP.

User can directly give PMK from host to reduce the connection time. This command should be issued after init and before join command, if module needs to connect to an secure Access point. This command can be ignored if the AP is in Open mode.

Command Format#

Standard PSK Format

at+rsi_psk=<psk_type>,<psk_or_pmk>,<ap_ssid>

Length-based PSK Format enables a comma in the PSK

at+rsi_psk=<psk_type>,<length_of_psk>,<psk_or_pmk>,<ap_ssid>

Parameters#

psk_type (1 byte)

• 1 - pre_shared_key is provided in psk_or_pmk field

• 2 - pairwise_master_key is provided in psk_or_pmk field

• 3 - generate pairwise master key from given pre shared key and SSID to which module wants to connect.

• 4 - length based PSK

• 5 - generation of PMK from length based PSK and SSID

length_of_psk (1 byte)

• Length of PSK which can include a comma

• It is mandatory that the PSK length in the command is equal to length_of_psk. Inconsistent values may lead to undefined behavior.

psk_or_pmk (64 bytes)

• In this field expected parameters are pre shared key of the access point to which module wants to associate or pair wise master key. Length of this field is 64 Bytes. In case of PMK only 32 bytes are valid, In case of PSK length can vary (8 to 63).

• The PMK is 32 bytes in hex format (64 characters). The following example shows the PMK as an array.

PMK[32] = {0x71, 0x72, 0x01, 0x0A, 0x16, 0x17, 0x07,0x90, 0x71, 0x72, 0x01, 0x0A, 0x16, 0x17, 0x07,0x90, 0x71, 0x72, 0x01, 0x0A, 0x16, 0x17, 0x07,0x90, 0x71, 0x72, 0x01, 0x0A, 0x16, 0x17, 0x07, 0x90};

• The command using this PMK is

at+rsi_psk=2,7172010A161707907172010A161707907172010A161707907172010A16170790

ap_ssid (34 bytes)

• This field contains the SSID of the access point, this field will be valid only if psk_type value is 3.

  • The maximum length of SSID is 32 bytes and the remaining 2 bytes are reserved for NULL termination and alignment.

  • If user generates PMK using psk_type = 3 or 5 (i.e., by providing psk and ssid) then module uses generated PMK for connection establishment and there is no need to give pre-shared key or pair wise master key again.

Response#

Response contains following payload only if psk_type = 3or 5. In case of psk_type = 1 or 2, response does not contain any payload.

Pair wise master key of 32-bytes is given to host if psk_type is 3 or 5.

Possible error codes for this command are 0x0021, 0x0025, 0x0026, 0x0028, 0x002C, 0x0039, 0x003a, 0x003b.

Availability#

This command is available in operating mode 0 and 9.

Example 1#

To join a WPA2-PSK security enabled network with key "12345ABCDE", the command is

Command

at+rsi_psk=1,12345ABCDE
0x61 0x740x2B0x720x730x690x5F 0x70 0x73 0x6B 0x3D 0x31 0x2c 0x31 0x32 0x33 0x34 0x35 0x41 0x42 0x43 0x44 0x45 0x0D 0x0A

Response

OK
0x4F 0x4B 0x0D 0x0A

Example 2#

To join a WPA2-PSK security enable network with pairwise_master_key "ABCDEFABCDEFABCDEF12345678901234ABCDEFABCDEFABCDEF12345678901234",the command is:

Command

at+rsi_psk=2,ABCDEFABCDEFABCDEF12345678901234ABCDEFABCDEFABCDEF12345678901234

Response

OK
0x4F 0x4B 0x0D 0x0A

Example 3#

To generate pairwise_master_key for the pre_shared_key = 12345678 and SSID MY_NETWORK_NAME, the command is

Command

at+rsi_psk=3,12345678,MY_NETWORK_NAME

Response

OK <pairwise_master_key>
0x4F 0x4B <32bytes of pairwise_master_key> 0x0D 0x0A

[ Go to top ]

rsi_wepkey :: Set WEP Keys#

Description#

This command configures the WEP key in the module to connect to an AP with WEP security. This command should be issued before join.

Command Format#

at+rsi_wepkey=<index>,<key1>,<key2>,<key3>,<key4>

Parameters#

index (2 bytes)

• Selects key index configured in AP

  • 0 - Key 1 is used

  • 1 - Key 2 is used

  • 2 - Key 3 is used

  • 3 - Key 4 is used

keyX

• key1, key2, key3, key4 are the WEP keys. The module supports WEP hex mode only.

• The WEP key supplied to the AP should be of 10 characters (for 64 bit WEP mode) or 26 characters (for 128 bit WEP mode), and only the following characters are allowed for the key:

  • A, B, C, D, E, F

  • a, b, c, d ,e ,f

  • 0, 1, 2, 3, 4, 5, 6, 7, 8, 9

Response#

Possible error codes are 0x0021, 0x0025, 0x002C, 0x002D

Availability#

This command is available when the module is configured in Operating Mode 0.

Example#

Provide 4 WEP keys:

Command

at+rsi_wepkey=0,ABCDE12345,ABCDE12346,ABCDE12347, ABCDE12348

Provide one WEP key:

Command

at+rsi_wepkey=0,ABCDE12345,0,0,0

at+rsi_wepkey=2,0,0,ABCDE12345,0

Response

OK
0x4F 0x4B 0x0D 0x0A

[ Go to top ]

rsi_authmode :: WEP Authentication Mode#

Description#

This command configures the authentication mode for WEP in the module, if the AP is in WEP security mode.

Command Format#

at+rsi_authmode=<auth_mode>

Parameters#

auth_mode

• Set to 0 for open WEP authentication. WEP shared mode is NOT supported.

Response#

Possible error codes are 0x0021, 0x0025, 0x002C, 0xFFF8, 0x002D

Availability#

This command is available when the module is configured in Operating Mode 0

Example#

Command

at+rsi_authmode=0
0x61 0x74 0x2B0x72 0x73 0x69 0x5F 0x61 0x75 0x74 0x68 0x6D 0x6F 0x64 0x65 0x3D 0x30 0x0D 0x0A

Response

OK
0x4F 0x4B 0x0D 0x0A

[ Go to top ]

rsi_eap :: EAP Configuration#

Description#

This command is used to configure the EAP parameters for connecting to an Enterprise Security enabled Access Point. The supported EAP types are EAP-TLS, EAP-TTLS, EAP-PEAP, EAP-FAST and EAP-LEAP. EAP-GTC is not supported for EAP-FAST. This command can be sent any time after rsi_init and rsi_join in enterprise security mode.

Command Format#

at+rsi_eap =<eap_method>,<inner_method>,<user_identity>,<password>,<okc>,<private_key_password>

Parameters#

eap_method (32 bytes)

• Selects EAP method: TLS, TTLS, FAST, PEAP or LEAP. It should be ASCII character string.

inner_method (32 bytes)

• This field is valid only in TTLS/PEAP. In case of TTLS/PEAP supported inner methods are MSCHAP/MSCHAPV2. In case of TLS/FAST/LEAP this field is not valid and it should be fixed to MSCHAPV2.

• Here MSCHAP/MSCHAPV2 are ASCII character strings.

user_identity (64 bytes)

• User ID which is configured in the user configuration file of the radius sever.

password (128 bytes)

• Password which is configured in the user configuration file of the Radius Server for that User Identity.

okc (4 bytes)

• This argument is used to enable or disable or select multiple features from user. Below is the detailed description of this argument.

• BIT[0] of OKC is used to enable or disable opportunistic key caching (OKC),

  • 0 – disable

  • 1 – enable

  • When this is enabled, module will use cached PMKID to get MSK(Master Session Key) which is need for generating PMK which is needed for 4-way handshake.

• BIT[1] of OKC is used to enable or disable CA certificate requirement for PEAP connection.

  • 0 – CA certificate is not required.

  • 1 – CA certificate is required.

• BIT[2-12] of OKC argument are used for Cipher list selection for EAP connection. All possible ciphers are listed below

Cipher's List#

• BIT[13-31] of OKC argument is reserved.

Note!

• When user sets BIT[1] and does not provide the CA certificate then error is thrown. If user provides invalid CA certificate then also error is thrown.

• User can set either one or multiple bits from BIT[2-12] to provide the cipher's list.

• When user does not provide any value in OKC's BIT[2-12] then by default all the ciphers are selected.

private_key_password (82 bytes)

• This is password for encrypted private key given to the module. Module will use this password during decryption of encrypted private key. password length must be 80 bytes or less.

Response#

Possible error codes are 0x0021, 0x0025, 0x002C

Availability#

This command is available when the module is configured in Operating Mode 2.

Example#

Command

at+rsi_eap=PEAP,MSCHAPV2,user1,12345678,0
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x65 0x61 0x70 0x3D 0x50 0x45 0x41 0x50 0x2C 0x4D 0x53 0x43 0x48 0x41 0x50 0x56 0x32 0x2C 0x75 0x73 0x65 0x72 0x31 0x2C 0x31 0x32 0x33 0x34 0x35 0x36 0x37 0x38 0x2C 0x30 0x0D 0x0A

See the AT Command Example reference for additional examples.

Response

OK
0x4F 0x4B 0x0D 0x0A

[ Go to top ]

rsi_cert :: Set TLS Certificate#

Description#

This command is used to load/erase SSL/TLS (certificate and private keys) and enterprise security (EAP-TLS or EAP-FAST) certificates. Certificates should be loaded before using SSL/EAP. This command should be sent before join command for enterprise security mode and before socket creation for SSL sockets. Certificates will be loaded in non-volatile memory of the module, so that loading certificate is required to be done only once.

Note!

• Enable powersave before loading certificates if the module is in Wi-Fi connected state.

• Need to shut down the SSL socket for which it wants to change the certificates, if the socket is already in the connected state, otherwise, the firmware will throw an error.

Command Format#

at+rsi_cert =<cert_type>,<total_len>,<key_pwd>,<certificate>

Parameters#

cert_type (1 byte)

total_len (2 bytes)

• Certificate's total length in bytes.

Note!

• For Enterprise security, maximum certificate length should be 12280 bytes. For TLS Certificates, the max length is 12280 bytes and for the Private Keys, it is 4088 bytes.

• Module shares same TLS certificates for all supported SSL sockets.

• For enterprise, user can load certificates in two ways

  • User can provide wifiuser.pem which contains 4 certificates in a given fixed order of private key, client certificate 1, client certificate 2, CA certificate with CertType as 1.

  • User can load individual EAP certificates private key, public key, and CA certificates with CertType as 17,33 and 49 respectively. Maximum certificate length for each individual certificates is 4088 bytes

• Certificate Loading into Flash is only allowed upto init state. After init state e.g. scan/join etc certificate loading into flash is not allowed.

• Certificate Loading into RAM is allowed in connected state also provided same type of socket already does not exist. For example, loading client cert is only allowed if there does not exist any client socket. Same is for server certificates too

• Root certificate has the highest authority being at the top of the signing hierarchy.

• Root certificate is an expected/required certificate which usually comes pre-installed in the operating systems and it plays a key part in certificate chain verification when a device is performing TLS authentication with the IoT endpoint.

• On RS9116 device, we do not maintain root trust repository due to memory constraints, so it is mandatory to load Root certificate for successful mutual authentication.

• On RS9116 to authenticate, firstly Root CA is validated (validate the Root CA received with the Root CA loaded on the device). Once the Root CA is validation is successful , other certificates sent from the server are validated.

• RS9116 will not be able to authenticate to server if intermediate CA certificates are loaded instead of Root CA and would result in Handshake error.

• The valid certificate format to load into the module is .pem. It is recommended to use loading of single certificate method (wifiuser.pem)

• By default, TLS certificates will be loaded onto flash. Set BIT(27) in tcp_ip_feature_bit_map to load TLS certificate onto RAM.

key_pwd(128 bytes)

• Reserved.

certificate

• This is the data of the actual certificate.

• To erase a certificate, set total_len, key_pwd, certificate fields '0'. cert_type should be set to type of the certificate to erase as mentioned above. See the following example.

at+rsi_cert=<cert_type>,0,0,0

Response#

Possible error codes are 0x0015, 0x0021, 0x0025, 0x0026, 0x002C

Availability#

This command is available when the module is configured in Operating Mode 0,2

Example#

The following example shows the procedure for loading certificates using Python on a PC. Requirements: Python 2.7.10 and pyserial

It may not be possible to issue this command in Hyper-terminal because the content of a certificate file needs to be supplied as one of the inputs of the command. This can be done by other means, such as using a Python script.

1. Loading or erasing the certificates should be performed only after the opermode command has been issued.

2. Before loading the certificate, certificates should be erase the certificate.

3. To load the certificate, run the python script load_certificate.py available in the WiSeConnect SDK utilities folder

• Copy load_certificate.py to ...\resouces\certificates folder in the SDK.

• Ensure the serial port and baudrate of the hardware e.g. sp=serial.Serial(port="COMx",baudrate=115200,timeout=0.01))

• Run the python scripts using -> python load_certificate.py <CertType> <Certificate>

• After successful certificate loading, the script respondes with OK

Command

at+rsi_cert=1,0,0,0
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x63 0x65 0x72 0x74 0x3D 0x31 0x2C 0x30 0x2C 0x30 0x2C 0x30 0x0D 0x0A

Response

OK
0x4F 0x4B 0x0D 0x0A

[ Go to top ]

rsi_cert_index :: Set Certificate With Index#

Description#

This command is used to load/erase SSL (certificate and private keys). Certificates should be loaded before using TLS. This command should be sent before socket creation for TLS sockets. Certificates will be loaded in non-volatile memory of the module, so that loading certificate is required to be done only once.

Note!

• This command is used for standalone Wi-Fi mode in case of loading certificates for multiple TLS sockets to flash.

• This command should be sent only after opermode command.

Command Format#

at+rsi_cert_index =<cert_type>,<total_len>,<cert_index>,<key_pwd>,<certificate>

Parameters#

cert_type (1 byte)

total_len (2 bytes)

• Certificate's total length in bytes.

Note!

• For TLS certificates, the max length is 12280 bytes and for the Private Keys, it is 4088 bytes.

• Recommended to use loading of single certificate method (wifiuser.pem)

• Set BIT[27] in tcp_ip_feature_bit_map to load TLS certificate onto RAM. By default SSL certificates will be loaded onto flash.

• Set BIT[31] in tcp_ip_feature_bit_map & BIT[29] in ext_tcp_ip_feature_bit_map to open 3 SSL Client sockets.

cert_index (1 byte)#

• RS9116 can either load certificates onto RAM or FLASH, but not both at a time.

• Module can hold two sets of TLS certificate into RAM. This field is used to provide the index of the certificates and possible values are 0 and 1.

• Module can hold three sets of TLS certificate onto Flash. This field is used to provide the index of the certificates and possible values are 0, 1 and 2.

key_pwd (127 bytes)

• Reserved.

certificate

• This is the data of the actual certificate.

• To erase a certificate, set total_len, key_pwd, certificate fields '0'. cert_type should be set to type of the certificate to erase as mentioned above. See the following example.

at+rsi_cert_index=<cert_type>,0<cert_index>,0,0.

Response#

Possible error codes are 0x0015, 0x0021, 0x0025, 0x0026, 0x002C, 0x005D, 0x005E, 0x005F.

Availability#

This command is available when the module is configured in Operating Mode 0, 2.

Example#

The following example shows the procedure for loading certificates using Python on a PC. Requirements: Python 2.7.10 and pyserial

It may not be possible to issue this command in Hyper-terminal because the content of a certificate file needs to be supplied as one of the inputs of the command. This can be done by other means, such as using a Python script.

1. Loading or erasing the certificates should be performed only after the opermode command has been issued.

2. Before loading the certificate, certificates should be erase the certificate.

3. To load the certificate, run the python script load_certificate.py available in the WiSeConnect SDK utilities folder

• Copy load_certificate_with_inx.py to '...\utilities\certificates' folder.

• User needs to ensure the serial port and baudrate of the hardware e.g. sp=serial.Serial(port="COMx",baudrate=115200,timeout=0.01)

• Run the python scripts using -> python load_certificate_with_inx.py <CertType><CertInx> <Certificate>

• After successful certificate loading,scripts give 'OK' as response.

After successful certificate loading,scripts give 'OK' as response.

For erasing certificate with index 0:

Command

at+rsi_cert_index=1,0,0,0,0
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x63 0x65 0x72 0x74 x5F 0x69 0x6E 0x78 0x3D 0x31 0x2C 0x30 0x2C 0x30 0x2C 0x30 0x2C 0x30 0x0D 0x0A

Response

OK
0x4F 0x4B 0x0D 0x0A

[ Go to top ]

rsi_disassoc :: Wi-Fi Disassociate#

Description#

This command is issued to request the module to disassociate (disconnect) from an Access Point. The Host can then issue a fresh set of #init, #scan and #join commands to connect to a different Access Point or the same Access Point with a different set of connection parameters. This command can also be used to stop the module from continuing an on-going rejoin operation. Additionally, this command is used when the module is in AP mode, to remove clients from its list of connected nodes.

Command Format#

at+rsi_disassoc=<mode_flag>,<client_mac_addr>

Parameters#

mode_flag (2 bytes)

client_mac_addr (6 bytes)

• MAC address of the client to disconnect. Used when the module is in AP mode

Response#

Possible error codes are 0x0006, 0x0013, 0x0021, 0x002C, 0x0015.

Availability#

This command is available when the module is configured in Operating Mode 0, 2 and 6.

Note! After issuing disconnect command, any powersave enabled by that time will be disabled. User can reissue the powersave command after initializing the module again.

Example 1#

Module is in client mode and is connected to an AP. It wants to formally disconnect from the AP.

Command

at+rsi_disassoc=0
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x64 0x69 0x73 0x61 0x73 0x73 0x6F 0x63 0x3D 0x30 0x0D 0x0A

Example 2#

Module is in AP mode and 3 clients are connected to it. One of the clients, with MAC 0x01 0x02 0x03 0x040 0x05 0x06, needs to be disconnected by the AP.

Command

at+rsi_disassoc=1,010203040506
0x61 0x740x2B0x720x730x690x5F 0x64 0x69 0x73 0x61 0x73 0x73 0x6F 0x63 0x3D 0x31 0x2C 0x30 0x31 0x30 0x32 0x30 0x33 0x30 0x34 0x30 0x35 0x30 0x36 0x0D 0x0A

Response

OK
0x4F 0x4B 0x0D 0x0A

[ Go to top ]

rsi_ipconf :: Set IP Parameters#

Description#

This command configures the IP address, subnet mask and default gateway for the module.

Command Format#

at+rsi_ipconf=<dhcp_mode>,<ip_addr>,<netmask>,<gateway>,<hostname>,<vap_id>,<fqdn_flag>

Parameters#

dhcp_mode (1 byte)

• Used to configure TCP/IP stack in manual or DHCP modes.

  • 0 – Manual

  • 1 – DHCP enabled

  • 3 - Enable DHCP and to send host name in DHCP discover

Note!

• In AP mode only DHCP manual mode (static IP) is valid. sending host name is valid only in DHCP enable mode.

  • 4 - To enable FQDN Option with static ip (Option 81 with static IP)

  • 7 - To enable DHCP, hostname, DHCP Client FQDN option (Option 81: Fully Qualified Domain Name with Dynamic IP)

  • 9 - To support DHCP unicast Offer from server

• Module can obtain the DNS server IP address from DHCP offer, if the DHCP server supports it. However, the DNS server IP address it obtained is not accessible to the host.

ip_addr (4 bytes)

• IP address in 4 bytes hex format. This can be 0's in case of DHCP.

netmask (4 bytes)

• Subnet mask in 4 bytes hex format. This can be 0's in case of DHCP.

gateway (4 bytes)

• Gateway in 4 bytes hex format. This can be 0's in case of DHCP.

hostname (31 bytes)

• Host name for DHCP Client. This can be null, when DHCP mode is not enabled. This field is valid only when dhcp_mode value is 3. Maximum Hostname length is valid up to 31 bytes including NULL.

vap_id (1 byte)

• Virtual Access Point (AP) is only relevant in concurrent mode and when dhcp mode is manual

  • 0 – Use to assign static IP for client mode.

  • 1 - Use to start DHCP server in concurrent AP mode (should be given before AP creation i.e. join).

fqdn_flag (4 bytes)

• 0 DNS Client should update TYPE_A (host name) record and TYPE_PTR records.

• 1 DHCP Server will update both TYPE_A and TYPE_PTR records

Response#

where ...

• MAC_Address (6 bytes). MAC Address

• IP_Address (4 bytes). Assigned IP address

• Subnet_Mask (4 bytes). Assigned subnet address

• Gateway (4 bytes). Assigned gateway address

Possible error codes are 0x0021, 0x0025, 0x002C, 0xFFFC, 0xFF74, 0xFF9C, 0xFF9D.

Availability#

This command is available when the module is configured in Operating Mode 0, 2, 6 and 9.

Example 1#

To configure in manual mode, with

• 192.168.1.3 as IP address

• 255.255.255.0 as subnet mask

• 192.168.1.1 as the gateway

Command

at+rsi_ipconf=0,192.168.1.3,255.255.255.0,192.168.1.1 
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x69 0x70 0x63
0x6F 0x6E 0x66 0x3D 0x30 0x2C 0x31 0x39 0x32 0x2E
0x31 0x36 0x38 0x2E 0x31 0x2E 0x33 0x2C 0x32 0x35
0x35 0x2E 0x32 0x35 0x35 0x2E 0x32 0x35 0x35 0x2E
0x30 0x2C 0x31 0x39 0x32 0x2E 0x31 0x36 0x38 0x2E
0x31 0x2E 0x31 0x0D 0x0A

Response

OK <MAC_Address><IP_Address><Subnet_Mask><Gateway>
0x4F 0x4B 0x01 0x02 0x03 0x04 0x05 0x06 0xC0 0xA8 0x01 0x03 0xFF 0xFF 0xFF 0x00 0xC0 0xA8 0x01 0x01 0x0D0x0A

Example 2#

To configure the IP in DHCP enabled mode.

Command

at+rsi_ipconf=1,0,0,0
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x69 0x70 0x63 0x6F 0x6E 0x66 0x3D 0x31 0x2C 0x30 0x2C 0x30 0x2C 0x30 0x0D 0x0A

Response

OK <MAC_Address><IP_Address><Subnet_Mask><Gateway>
0x4F 0x4B 0x01 0x02 0x03 0x04 0x05 0x06 0xC0 0xA8 0x01 0x03 0xFF0xFF0xFF0x000xC00xA80x010x01 0x0D 0x0A

Example 3#

To configure the IP in DHCP enabled mode with hostname.

Command

at+rsi_ipconf=3,dhcp_client
0x61 0x74 0x2B 0x72 0x73 0x69 0x5F 0x69 0x70 0x63 0x6F 0x6E 0x66 0x3D 0x31 0x2C 0x30 0x2C 0x30 0x2C 0x30 0x0D 0x0A

Response

OK <MAC_Address><IP_Address><Subnet_Mask><Gateway>
0x4F 0x4B 0x01 0x02 0x03 0x04 0x05 0x06 0xC0 0xA8 0x01 0x03 0xFF0xFF0xFF0x000xC00xA80x01 0x01 0x0D 0x0A

[ Go to top ]

rsi_ipconf6 :: Set IPv6 Parameters#

Description#

This command configures the IPv6 address, prefix length and default router for the module.

Command Format#

at+rsi_ipconf6=<mode>,<prefix_length>,<ip_addr_6>,<gateway_6>\r\n

Parameters#

mode (1 byte)

• Used to configure TCP/IP stack in manual or DHCPv6 modes.

  • Static

  • DHCPv6/SLAAC (depends on Router Advertisement message)

prefix_length (2 bytes)

• Prefix length of the IPv6 address.

ip_addr_6 (16 bytes)

• IPv6 address. This can be 0's in the case of DHCPv6.

gateway_6 (16 bytes)

• Default router's IPv6 address. This should be Null in the case of DHCPv6.

IPV6 address is generally of the form - octet of four hexadecimal digits separated by "colons". e.g. 2001:0db8:1:0:0:0:0:123 (supported format) 2001:db8:1::123 (not supported format)

Double colons are used in place of continuous zeroes in IPV6 address, to minimize the IPV6 address, but in RS9116-WiSeConnect double colons are not supported. In ipconf6 command you have to supply all the eight groups of four hexadecimal digits.

Response#