arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-04-19 23:22:16 +03:00
Code
esp8266/doc/esp8266wifi/udp-class.rst
Ivan Grokhotkov 283eb97cd3 docs: convert to .rst and add readthedocs
2017-05-14 11:44:16 -05:00

2.2 KiB
Raw Blame History

orphan

UDP Class

Methods documented for WiFiUDP Class in Arduino

  1. begin()
  2. available()
  3. beginPacket()
  4. endPacket()
  5. write()
  6. parsePacket()
  7. peek()
  8. read()
  9. flush()
  10. stop()
  11. remoteIP()
  12. remotePort()

Methods and properties described further down are specific to ESP8266. They are not covered in Arduino WiFi library documentation. Before they are fully documented please refer to information below.

Multicast UDP

uint8_t  beginMulticast (IPAddress interfaceAddr, IPAddress multicast, uint16_t port) 
virtual int  beginPacketMulticast (IPAddress multicastAddress, uint16_t port, IPAddress interfaceAddress, int ttl=1) 
IPAddress  destinationIP () 
uint16_t  localPort ()

The WiFiUDP class supports sending and receiving multicast packets on STA interface. When sending a multicast packet, replace udp.beginPacket(addr, port) with udp.beginPacketMulticast(addr, port, WiFi.localIP()). When listening to multicast packets, replace udp.begin(port) with udp.beginMulticast(WiFi.localIP(), multicast_ip_addr, port). You can use udp.destinationIP() to tell whether the packet received was sent to the multicast or unicast address.

For code samples please refer to separate section with examples <udp-examples> dedicated specifically to the UDP Class.