Update documentation for WiFi drivers and shields (#39)

ARM-software · Jan 21, 2025 · 03f3216 · 03f3216
1 parent f2ccd07
commit 03f3216
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 42 deletions.
diff --git a/ARM.CMSIS-Driver.pdsc b/ARM.CMSIS-Driver.pdsc
@@ -19,6 +19,7 @@
         - Eliminated usage of sscanf (to enable driver to work with GCC newlib-nano)
         - Corrected opt_len parameter check in WiFi_SocketSetOpt function
         - Enabled Event Recorder from CMSIS-View pack
+      - Updated documentation for WiFi drivers and shields
     </release>
   </releases>
 

diff --git a/Documentation/Doxygen/src/images/Sparkfun_ESP8266_Reset_Connection.png b/Documentation/Doxygen/src/images/Sparkfun_ESP8266_Reset_Connection.png
diff --git a/Documentation/Doxygen/src/introduction.txt b/Documentation/Doxygen/src/introduction.txt
@@ -288,7 +288,9 @@ The \ref driver_pack_content provides implementations of <a href="https://arm-so
 
 The documentation for the Renesas DA16200 can be found here: https://www.renesas.com/eu/en/products/interface-connectivity/wireless-communications/wi-fi/da16200-ultra-low-power-wi-fi-soc-battery-powered-iot-devices
 
-DA16200 FreeRTOS SDK Firmware Image v3.2.3.0 (or newer) is required. Firmware image and programming instructions "DA16200 DA16600 FreeRTOS Getting Started Guide" are also available on the above web site.
+__Required Firmware__ : **DA16200 FreeRTOS SDK Firmware Image v3.2.3.0 (or newer)**
+
+Firmware image and programming instructions **DA16200 DA16600 FreeRTOS Getting Started Guide** are also available on the above web site.
 
 \subsection driver_ESP32 ESP32
 
@@ -302,52 +304,13 @@ The documentation for the Espressif ESP8266 can be found here: https://www.espre
 
 The documentation for the Inventek ISM43362 can be found here: https://www.inventeksys.com/ism4336-m3g-l44-e-embedded-serial-to-wifi-module/
 
-\subsubsection ismart43362_e_firmware_download Flashing a different firmware to ISMART43362-E Shield
-
-The ISMART43362-E Shield has two options to communicate with the underlying target hardware: UART and SPI. By default, the module is
-flashed with the firmware for UART communication. To enable SPI communication, follow these steps to flash the module:
-
-\b Prepare \b the \b hardware
-- Set the power supply jumper on ISMART43362-E to connect 5V_USB and 5V_BOARD.
-- Set the SW3 switch to position 1 (factory default position).
-
-\b Prepare \b the \b software
-- Download
-  [ISM43362_M3G_L44_SPI_C6.2.1.7.zip](https://www.inventeksys.com/iwin/wp-content/uploads/ISM43362_M3G_L44_SPI_C6.2.1.7.zip)
-  and extract it locally.
-- Download [eS-WIFi_Demo](https://www.inventeksys.com/iwin/wp-content/uploads/eS-WIFi_Demo.zip)
-- Unzip the file and install the application on your PC. 
-- Start es-WiFi Demo and select <b>Menu - Install Drivers</b> and install both, CYW9WCD1EVAL1 and BCM9WCD1EVAL1:
-  \image html ISM43362_install_drivers.png
-- Connect the ISMART43362-E to the PC using the Mini-USB connector. In Device Manager, you should see WICED USB Serial Port
-  (COMx).
-- If not already done, assign a low COM port number.
-- In the es-WiFi Demo application, execute:
-  - Go to <b>Setup - Serial Port - Configure/Open</b>:
-    \image html ISM43362_set_COM_port_conf.png
-  - Check the following settings (Serial Port being the one added just now):
-    \image html ISM43362_set_COM_port.png
-  - Go to <b>Menu - Firmware - Update</b>:
-    \image html ISM43362_update_firmware.png
-  - Select the binary image file extracted in the first step (ISM43362_M3G_L44_SPI_C6.2.1.7.bin). Make sure it is an SPI
-    firmware variant:
-    \image html ISM43362_module_detected.png
-- After the firmware is updated, the console will show the message "Resetting...":
-  \image html ISM43362_update_firmware_resetting.png
-  You can now disconnect the module from the PC as it contains the new SPI firmware.
-
-  If you want to flash a different firmware later, please visit
-  [Inventek's Firmware page](https://www.inventeksys.com/iwin/firmware/) for the latest binary files.
+__Required Firmware__ : **SPI v6.2.1.7**
 
-\note Firmware version ISM43362_M3G_L44_SPI_C6.2.1.8 is not supported!
+For firmware update procedure see \ref shield_Inventek_ISMART43362-E_fw "Inventek ISMART43362-E Shield Firmware" section.
 
 \subsection driver_WizFi360 WizFi360
 
 The documentation for the WIZnet WizFi360 can be found here: https://docs.wiznet.io/Product/Wi-Fi-Module/WizFi360
-
-The latest firmware images are available on GitHub: https://github.com/wizfi/Release. Instructions on how to flash the
-firmware onto the device can be found on the WIZnet Documents page:
-https://docs.wiznet.io/Product/Wi-Fi-Module/WizFi360/documents#firmware-update-guide.
 */
 
 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
@@ -832,6 +795,46 @@ The shield is connected via an Arduino header using an SPI interface.
 | ARDUINO_UNO_D9,D10        | CMSIS-Driver GPIO connected to Arduino digital I/O pins D9,D10 |
 | CMSIS-RTOS2               | CMSIS-RTOS2 compliant RTOS                                     |
 
+\subsubsection shield_Inventek_ISMART43362-E_fw Firmware
+
+The ISMART43362-E Shield has two options to communicate with the underlying target hardware: UART and SPI.  
+By default, the module is flashed with the firmware for UART communication.  
+To enable SPI communication, follow these steps to flash the module:
+
+\b Prepare \b the \b hardware
+- Set the power supply jumper on ISMART43362-E to connect 5V_USB and 5V_BOARD.
+- Set the SW3 switch to position 1 (factory default position).
+
+\b Prepare \b the \b software
+- Download
+  [ISM43362_M3G_L44_SPI_C6.2.1.7.zip](https://www.inventeksys.com/iwin/wp-content/uploads/ISM43362_M3G_L44_SPI_C6.2.1.7.zip)
+  and extract it locally.
+- Download [eS-WIFi_Demo](https://www.inventeksys.com/iwin/wp-content/uploads/eS-WIFi_Demo.zip)
+- Unzip the file and install the application on your PC. 
+- Start es-WiFi Demo and select <b>Menu - Install Drivers</b> and install both, CYW9WCD1EVAL1 and BCM9WCD1EVAL1:
+  \image html ISM43362_install_drivers.png
+- Connect the ISMART43362-E to the PC using the Mini-USB connector. In Device Manager, you should see WICED USB Serial Port
+  (COMx).
+- If not already done, assign a low COM port number.
+- In the es-WiFi Demo application, execute:
+  - Go to <b>Setup - Serial Port - Configure/Open</b>:
+    \image html ISM43362_set_COM_port_conf.png
+  - Check the following settings (Serial Port being the one added just now):
+    \image html ISM43362_set_COM_port.png
+  - Go to <b>Menu - Firmware - Update</b>:
+    \image html ISM43362_update_firmware.png
+  - Select the binary image file extracted in the first step (ISM43362_M3G_L44_SPI_C6.2.1.7.bin). Make sure it is an SPI
+    firmware variant:
+    \image html ISM43362_module_detected.png
+- After the firmware is updated, the console will show the message "Resetting...":
+  \image html ISM43362_update_firmware_resetting.png
+  You can now disconnect the module from the PC as it contains the new SPI firmware.
+
+  If you want to flash a different firmware later, please visit
+  [Inventek's Firmware page](https://www.inventeksys.com/iwin/firmware/) for the latest binary files.
+
+\note Firmware version ISM43362_M3G_L44_SPI_C6.2.1.8 is not supported!
+
 \subsection shield_Sparkfun_DA16200 Sparkfun DA16200
 
 Shield layer for [Sparkfun DA16200](https://www.sparkfun.com/products/18567) Arduino Uno WiFi Shield.
@@ -860,6 +863,23 @@ The shield is connected via an Arduino header using an UART interface.
 | ARDUINO_UNO_UART          | CMSIS-Driver USART connected to Arduino UART pins D0..D1       |
 | CMSIS-RTOS2               | CMSIS-RTOS2 compliant RTOS                                     |
 
+\subsubsection shield_Sparkfun_ESP8266_important Important considerations
+
+For correct operation of the Sparkfun ESP8266 WiFi Shield using the **Arduino R3** header, make sure that the jumpers are fitted as described in the table below:
+
+| Jumper | Setting |
+|:------:|:-------:|
+| J26    | closed  |
+| J27    | 1-2     |
+
+For correct operation, the Sparkfun ESP8266 WiFi Shield requires a proper reset functionality ensured by connecting together
+the **RESET** pin on the Arduino connector with the **RST** pin in the area marked as **ESP8266 GPIO**, see the picture below:
+
+![Connection on the Sparkfun ESP8266 WiFi Shield](./images/Sparkfun_ESP8266_Reset_Connection.png)
+
+For stable operation, make sure that you are using an external **DC 5V** power supply (connected to **J2**).  
+Also, fit a jumper **J1** to **1-2** closed and set the switch **SW1** to position **2-3**.
+
 \subsection shield_WizNet_WizFi360-EVB WizNet WizFi360-EVB
 
 Shield layer for [WizNet WizFi360-EVB](https://docs.wiznet.io/Product/Wi-Fi-Module/WizFi360/wizfi360_evb_shield) Arduino Uno WiFi Shield.
@@ -874,4 +894,11 @@ The shield is connected via an Arduino header using an UART interface.
 | ARDUINO_UNO_UART          | CMSIS-Driver USART connected to Arduino UART pins D0..D1       |
 | CMSIS-RTOS2               | CMSIS-RTOS2 compliant RTOS                                     |
 
+\subsubsection shield_WizNet_WizFi360-EVB_fw Firmware
+
+The latest firmware images are available on the GitHub: https://github.com/wizfi/Release.
+
+Instructions on how to flash the firmware onto the device can be found on the WIZnet Documents page:
+https://docs.wiznet.io/Product/Wi-Fi-Module/WizFi360/documents#firmware-update-guide.
+
 */