This section contains APIs when module as a WiFi station and used for Multicast data traffic.

rsi_multicast_join

Prototype int32_t rsi_multicast_join(uint8_t flags, int8_t *ip_address);
Input Arguments uint8_t flags: To select the IP version.

BIT(0) – RSI_IPV6

Set this bit to enable IPv6 , by default it is configured to IPv4

int8_t *ip_address: IPv4/IPv6 address of multicast group.

Return Value
  • On Success :  0
  • On Failure   :
  • if return value is less than 0
  •  -3 : Command given in wrong state
  • -4 : Buffer not available to serve the command
  • if return value is greater than 0
  • 0x0021,0x002C,0x0015,0xBB16,0xBB17
  • Please refer Error Codes for description of above error codes.
Description This API  is used to join to a multicast group.

Note : Device supports only one Multicast group. It should leave the previous group

Example Usage rsi_multicast_join(0,&multicast_ip);

rsi_multicast_leave

Prototype int32_t rsi_multicast_leave(uint8_t flags, int8_t *ip_address);
Input Arguments uint8_t flags: To select the IP version.

BIT(0) – RSI_IPV6

Set this bit to enable IPv6 , by default it is configured to IPv4

int8_t *ip_address: IPv4/IPv6 address of multicast group.

Return Value
  • On Success :  0
  • On Failure   :
  • if return value is less than 0
  •  -3 : Command given in wrong state
  • -4 : Buffer not available to serve the command
  • if return value is greater than 0
  • 0x0021,0x002C,0x0015,0xBB16,0xBB17
  • Please refer Error Codes for description of above error codes.
Description This API  is used to leave the multicast group.

Note : Device supports only one Multicast group. It should leave the previous group, if it wants to join a new Multicast group

Example Usage rsi_multicast_leave(0,&multicast_ip);