Skip to content

Commit

Permalink
Update README.md (+3 squashed commits)
Browse files Browse the repository at this point in the history
Squashed commits:

[a2f8810] Update README.md

[7f6a340] Update README.md

[31ceb35] Fix udp_multicast file name.
  • Loading branch information
wiznet-grace committed Dec 12, 2024
1 parent 54ff449 commit 37185cf
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 18 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
set(TARGET_NAME udp_multicast_receiver)
set(TARGET_NAME w5x00_udp_multicast_receiver)

add_executable(${TARGET_NAME}
${TARGET_NAME}.c
Expand Down
39 changes: 22 additions & 17 deletions examples/udp_multicast/udp_multicast_receiver/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# How to Test UDP multicast Example
# How to Test UDP multicast receiver Example





## Step 1: Prepare software

The following serial terminal programs are required for Loopback example test, download and install from below links.
The following serial terminal programs are required for UDP multicast receiver example test, download and install from below links.

- [**Tera Term**][link-tera_term]
- [**Hercules**][link-hercules]
Expand All @@ -25,9 +25,9 @@ If you are using W5100S-EVB-Pico, W5500-EVB-Pico, W55RP20-EVB-Pico, W5100S-EVB-P



## Step 3: Setup UDP multicast Example
## Step 3: Setup UDP multicast receiver Example

To test the UDP multicast example, minor settings shall be done in code.
To test the UDP multicast receiver example, minor settings shall be done in code.

1. Setup SPI port and pin in 'w5x00_spi.h' in 'WIZnet-PICO-C/port/ioLibrary_Driver/' directory.

Expand All @@ -45,7 +45,7 @@ Setup the SPI interface you use.
#define PIN_RST 20
```
If you want to test with the UDP multicast example using SPI DMA, uncomment USE_SPI_DMA.
If you want to test with the UDP multicast receiver example using SPI DMA, uncomment USE_SPI_DMA.
```cpp
/* Use SPI DMA */
Expand All @@ -64,7 +64,7 @@ If you want to test with the UDP multicast example using SPI DMA, uncomment USE_
```
2. Setup network configuration such as IP in 'udp_multicast_receiver.c' which is the UDP multicast example in 'WIZnet-PICO-C/examples/udp_multicast/udp_multicast_receiver/' directory.
2. Setup network configuration such as IP in 'w5x00_udp_multicast_receiver.c' which is the receiver example in 'WIZnet-PICO-C/examples/udp_multicast/udp_multicast_receiver/' directory.
Setup IP and other network settings to suit your network environment.
Expand All @@ -81,7 +81,7 @@ static wiz_NetInfo net_info =
};
```

3. Setup multicast configuration in 'udp_multicast_receiver.c' in 'WIZnet-PICO-C/examples/udp_multicast/udp_multicast_receiver/' directory.
3. Setup multicast configuration in 'w5x00_udp_multicast_receiver.c' in 'WIZnet-PICO-C/examples/udp_multicast/udp_multicast_receiver/' directory.

```cpp
static uint8_t multicast_ip[4] = {224, 0, 0, 5}; // multicast ip address
Expand All @@ -90,29 +90,31 @@ static uint16_t multicast_port = 30000; // multicast port
## Step 4: Build
1. After completing the UDP multicast example configuration, click 'build' in the status bar at the bottom of Visual Studio Code or press the 'F7' button on the keyboard to build.
1. After completing the receiver example configuration, click 'build' in the status bar at the bottom of Visual Studio Code or press the 'F7' button on the keyboard to build.
2. When the build is completed, 'udp_multicast_receiver.uf2' is generated in 'WIZnet-PICO-C/examples/udp_multicast/udp_multicast_receiver/' directory.
2. When the build is completed, 'w5x00_udp_multicast_receiver.uf2' is generated in 'WIZnet-PICO-C/examples/udp_multicast/udp_multicast_receiver/' directory.
## Step 5: Upload and Run
1. While pressing the BOOTSEL button of Raspberry Pi Pico, W5100S-EVB-Pico, W5500-EVB-Pico, W55RP20-EVB-Pico, W5100S-EVB-Pico2 or W5500-EVB-Pico2 power on the board, the USB mass storage 'RPI-RP2' is automatically mounted.
2. Drag and drop 'udp_multicast_receiver.uf2' onto the USB mass storage device 'RPI-RP2'.
![][link-raspberry_pi_pico_usb_mass_storage]
2. Drag and drop 'w5x00_udp_multicast_receiver.uf2' onto the USB mass storage device 'RPI-RP2'.
3. Connect to the serial COM port of Raspberry Pi Pico, W5100S-EVB-Pico, W5500-EVB-Pico, W55RP20-EVB-Pico, W5100S-EVB-Pico2 or W5500-EVB-Pico2 with Tera Term.
![][link-connect_to_serial_com_port]
4. Reset your board.
5. Configure the UDP multicast test using the Hercules program. Open UDP with the previously configured multicast address and port, and send a message.
5. Configure the UDP multicast receiver test using the Hercules program. Open UDP with the previously configured multicast address and port, and send a message.
![][link-test_using_the_Hercules]
6. If the UDP multicast example works correctly on the Raspberry Pi Pico, W5100S-EVB-Pico, W5500-EVB-Pico, W55RP20-EVB-Pico, W5100S-EVB-Pico2, or W5500-EVB-Pico2, you will be able to check the network information of the respective board and see the messages sent by the source with membership to the multicast address.
6. If the UDP multicast receiver example works correctly on the Raspberry Pi Pico, W5100S-EVB-Pico, W5500-EVB-Pico, W55RP20-EVB-Pico, W5100S-EVB-Pico2, or W5500-EVB-Pico2, you will be able to check the network information of the respective board and see the messages sent by the source with membership to the multicast address.
![][link-connect_to_UDP_multicast_receiver]
Expand All @@ -128,9 +130,12 @@ static uint16_t multicast_port = 30000; // multicast port
Link
-->
[link-connect_to_serial_com_port]: https://github.com/WIZnet-ioNIC/WIZnet-PICO-C/blob/main/static/images/udp_multicast/udp_multicast_receiver/connect_to_serial_com_port.png
[link-test_using_the_Hercules]: https://github.com/WIZnet-ioNIC/WIZnet-PICO-C/blob/main/static/images/udp_multicast/udp_multicast_receiver/test_using_the_Hercules.png
[link-connect_to_UDP_multicast_receiver]: https://github.com/WIZnet-ioNIC/WIZnet-PICO-C/blob/main/static/images/udp_multicast/udp_multicast_receiver/connect_to_UDP_multicast_receiver.png
[link-multicast_receive_message]: https://github.com/WIZnet-PICO-C/static/images/udp_multicast/udp_multicast_receiver/multicast_receive_message.PNG
[link-captured_using_Wireshark]: https://github.com/WIZnet-ioNIC/WIZnet-PICO-C/blob/main/static//images/udp_multicast/udp_multicast_receiver/captured_using_Wireshark.png
[link-tera_term]: https://osdn.net/projects/ttssh2/releases/
[link-hercules]: https://www.hw-group.com/software/hercules-setup-utility
[link-raspberry_pi_pico_usb_mass_storage]: https://github.com/WIZnet-ioNIC/WIZnet-PICO-C/blob/main/static/images/udp_multicast_receiver/raspberry_pi_pico_usb_mass_storage.png
[link-connect_to_serial_com_port]: https://github.com/WIZnet-ioNIC/WIZnet-PICO-C/blob/main/static/images/udp_multicast_receiver/connect_to_serial_com_port.png
[link-test_using_the_Hercules]: https://github.com/WIZnet-ioNIC/WIZnet-PICO-C/blob/main/static/images/udp_multicast_receiver/test_using_the_Hercules.PNG
[link-connect_to_UDP_multicast_receiver]: https://github.com/WIZnet-ioNIC/WIZnet-PICO-C/blob/main/static/images/udp_multicast_receiver/connect_to_UDP_multicast_receiver.PNG
[link-multicast_receive_message]: https://github.com/WIZnet-ioNIC/WIZnet-PICO-C/blob/main/static/images/udp_multicast_receiver/multicast_receive_message.PNG
[link-captured_using_Wireshark]: https://github.com/WIZnet-ioNIC/WIZnet-PICO-C/blob/main/static/images/udp_multicast_receiver/captured_using_Wireshark.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 37185cf

Please sign in to comment.