Revision History#
Revision History
Version Number | Date | Changes |
---|---|---|
1.0 | Nov 2017 | Advance version |
1.2 | Jun 2018 | Added rsi_wlan_filter_broadcast() API description |
Added command type for multicast | ||
Clarified the differences between WiSeConnect/WiSeMCU | ||
1.3 | Jun 2018 | Alignment issues are resolved |
1.4 | Jul 2018 | Structural issues are resolved |
1.5 | Jun 2019 | Added rsi_get_ram_log() API |
1.51 | Sep 2019 | Modified the BLE CBFC API's and other missed API's Parameters. |
Modified the | ||
Updated missing API's for BT Classic | ||
1.6 | Oct 2019 | Added SAPI error codes |
1.7 | Nov 2019 | Added SAPI error codes |
1.8 | Jan 2020 | Added MITM params info for BLE section. Modified the GATT Write event structure |
1.9 | Feb 2020 | Added async behaviour note for rsi_connect() API |
1.10 | Apr 2020 | Added WLAN STATS in rsi_wlan_get() API. |
Added Weekday in set and get rtc timer. | ||
Added new rsi_bt_set_bd_addr() API and its related information | ||
2.0 | Sep 2020 | Documentation changes including ... |
New sections for API categories: Driver APIs, NWK APIs, API Configuration, Mechanism Changes and Enhancements' which describes major changes in SAPI library from previous release | ||
Moved 'BSD Socket API' section from WLAN APIs to 'NWK APIs' section | ||
Moved 'Network Application Protocol' section from WLAN APIs to 'NWK APIs' section. | ||
Moved 'WLAN API call sequence examples' from WLAN APIs to 'Appendix A: WLAN API Call Sequence Examples'. | ||
Renamed 'RS9116 Connectivity Resources' section to 'RS9116W Resources' | ||
Removed sections: RS9116 Connectivity Resources, BT-Classic and BT-LE Common Features | ||
Added description for the bits | ||
Added supported bits information of MODE argument in rsi_config_ipaddress() | ||
Added note in rsi_wireless_init(), regarding coex mode memory configuration | ||
Update BT Classic and BLE APIs | ||
Removed WMCU references | ||
Corrected maximum length of SSID to 32 bytes from 34 bytes | ||
Added EMB_MQTT_APIs | ||
Updated description, response parameters and parameters for some APIs | ||
Added description for parameter payload length in rsi_wlan_update_gain_table() API | ||
Added missing APIs from SAPI library | ||
Added the information required for the support of 3 SSL_Certificates loaded to FLASH in rsi_wlan_set_certificate_index() API | ||
Modified the parameters of MODE argument in rsi_config_ipaddress() API | ||
Added description for the bits | ||
Added note points for corresponding parameters of rsi_wlan_get() API in Master WLAN API | ||
Removed PBAP API, HFP, PBAP register callbacks, AVRCP register callbacks from Master Bluetooth classic APIs | ||
Added precondition for rsi_mqtt_poll_for_recv_data API in NWK API section | ||
Added a note in rsi_socket API in NWK APIs section | ||
Updated the rsi_wlan_scan() in WLAN APIs section | ||
Added a note WLAN_STATS only support in AP and STATION mode in WLAN API section | ||
Added note about 384K in wireless_init() API | ||
USB and SDIO Interfaces are removed from Host Interfaces section, as they are not currently supported | ||
Modified ‘Socket create command response’ structure according to the source code | ||
Modified NOTE for 40MHz limitation | ||
Added Operating modes in Features section | ||
Added information for GPIO based power save handshake mechanism in | ||
Added recommended api flow for restarting RS9116W module from host in | ||
Added supported Curve IDs for Ciphers in section 'Configure SSL parameters' | ||
Newly added WLAN APIs ... | ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
Newly added BT/BLE APIs ... | ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
Newly added Driver APIs ... | ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
2.1 | Feb 2021 | Modified rsi_ble_setphy() and rsi_ble_readphy() API parameters description as per spec |
Specified that region-based user Gain values in 2GHz has to be doubled before loading rsi_wlan_update_gain_table() API. | ||
Modified the macro RSI_TIMEOUT_BIT_MAP to | ||
Added the API note for rsi_ble_set_local_att_value() and rsi_ble_get_local_att_value() | ||
Added the appropriate return values and their description in rsi_recvfrom(), rsi_recv() API's. | ||
Modified SO_TCP_KEEP_ALIVE in rsi_setsockopt() value into seconds. | ||
Added Description of Power Save Modes in WLAN APIs. | ||
Enhanced the API note for rsi_ble_set_local_att_value() | ||
Enhanced the API notes for rsi_ble_set_local_att_value() and rsi_ble_notify_value() | ||
Modified the description for return values in rsi_socket() API | ||
Added description for resp parameters ( | ||
Added description for few missing structure members for the following callbacks ... | ||
> rsi_ble_on_adv_report_event_t (report type) | ||
> | ||
> | ||
> | ||
> | ||
> | ||
Modified the following callbacks and corrected spelling errors for structure name and variables ... | ||
> | ||
> | ||
> | ||
> | ||
> | ||
> | ||
> | ||
Added the following missing callback functions ... | ||
> | ||
> | ||
> | ||
> | ||
> | ||
Changed the names for the following GAP register callbacks ... | ||
> | ||
> | ||
> | ||
> | ||
Added information about modifying the MACROs in | ||
Added a note about rsi_wlan_enable_auto_config() in WLAN APIs | ||
Added BITs information in | ||
Added rsi_send_freq_offset() API | ||
Added rsi_calib_write() API under section | ||
Added information about | ||
Added a note "Maximum number of SSL sockets to be opened is including user opened sockets and internal sockets" before Configure scan parameters. | ||
Updated Modified SAPI's, rsi_bt_a2dp_init(), rsi_bt_avrcp_init(), rsi_bt_avrcp_target_register_callbacks() | ||
Added vendor specific API rsi_ble_vendor_dynamic_pwr() | ||
2.4 | Jun 2021 | Noted error code 0xFF5F, at return values of the API rsi_sntp_client_create_async() under section Network API's. |
Replaced the appropriate define | ||
Updated the parameters and added note for the following APIs ... | ||
Added information about | ||
Added roaming configuration (Power save based/De-authentication based details in | ||
Added rsi_sort_scan_results_array_based_on_rssi() API in WLAN | ||
Added an error code | ||
Added suggested roaming configuration in Wi-Fi APIs APIs section | ||
Added BSD socket error codes under BSD socket API in NWK API's | ||
Added note for set local name | ||
Added Note for latency parameter in rsi_ble_connect_with_params() API and | ||
Changed the timeout values for rsi_wlan_scan(), rsi_wlan_scan_async() and rsi_wlan_connect() API's | ||
Added a note rsi_wlan_enable_auto_config() in Wi-Fi APIs APIs | ||
Added detailed description about | ||
Added note about MQTT with SSL under section Network APIs API's | ||
Added Enhanced MAX PSP configuration info in Wi-Fi APIs APIs section | ||
Added SAPI Timeout error indication recovery mechanism | ||
Removed the BT and BLE alone opermodes and updated the Note for the rsi_wireless_init() API | ||
Added a note regarding rsi_transmit_test_start() power parameter | ||
Added a note in rsi_ap_start() for channel parameter | ||
Added rsi_calib_write(), rsi_send_freq_offset() APIs to perform chip calibration | ||
Added a bit | ||
Added feature for loading firmware via HTTP(s) using rsi_http_fw_update() API | ||
Added API rsi_tcp_window_update() for updating TCP window dynamically | ||
Added a bit | ||
Added a bit | ||
Added a bit | ||
Added API rsi_register_wait_timeout_error_callbacks() in host for registering SAPI wait timeout | ||
Added API rsi_assert() to indicating the assertion value to host in case of assertion | ||
Added API rsi_sort_scan_results_array_based_on_rssi() to sort the list of scan_results based on RSSI | ||
Added API rsi_send_feature_frame_dyn() for configuring feature enables dynamically | ||
Added a flag | ||
Added bits for selecting specific cipher in SSL ssl-ciphers-selection | ||
Added a bit | ||
Added Opermode Command Parameters section for feature selection opermode | ||
Added SAPI Timeout Error Indication and Recovery Mechanism section changelog | ||
Updated SAPI Directory Structure section with new folder structure. Refer folder structure changes information in the document WiSeConnect release folder structure chang | ||
Replaced the appropriate define | ||
Added a bit | ||
Added a BSD socket error codes under BSD socket API error-codes | ||
Updated the timeout values for rsi_wlan_scan(), rsi_wlan_scan_async() and rsi_wlan_connect() APIs | ||
Added a note for rsi_wlan_enable_auto_config() API | ||
Updated info about | ||
Added a note for MQTT over SSL in rsi_emb_mqtt_connect() API | ||
Added a note about power parameter in rsi_transmit_test_start() API | ||
Added a note about channel parameter in rsi_wlan_ap_start() API |