Funciones Wifi - Clase UDP

La clase UDP permite enviar y recibir mensajes.

FUNCIONES

WifiUDP

Descripcion:
Crea una instancia de la clase WiFi UDP que puede enviar y recibir mensajes UDP.

Sintaxis:
WifiUDP

Parámetros:
Ninguno
________________________________________________________________________

WiFiUDP.begin(); 
Descripción:
Inicializa la biblioteca y la configuración de la red Wi-Fi UDP. Inicia el conector WiFiUDP, escuchando en el puerto local PORT.
Sintaxis:
WiFiUDP.begin(port); 
Parámetros:
port: el puerto local a escuchar (int)
Retornos:
1: si tiene éxito
0: si no hay enchufes disponibles para su uso
________________________________________________________________________

available()

Descripción:

Obtiene el número de bytes (caracteres) disponibles para la lectura del buffer. Se trata de datos que ya han llegado.Esta función sólo se puede llamar con éxito después de llamar a WiFi UDP.parsePacket ().

Sintaxis:
WiFiUDP.available()
Parámetros:
Ninguno
Retornos:
el número de bytes disponibles en el paquete actual
0: si UDP.parsePacket WiFi () no se ha llamado todavía
_________________________________________________________________________________

WiFiUDP.beginPacket()

Descripción:
Inicia una conexión para escribir datos UDP en la conexión remota
Sintaxis:
WiFiUDP.beginPacket(hostName, port); 
WiFiUDP.beginPacket(hostIp, port);

Parámetros:
hostName: la dirección del host remoto. Se acepta una cadena de caracteres o una dirección IP
host IP: la dirección IP de la conexión remota (4 bytes)
port: el puerto de la conexión remota (int)

Retornos:
1: si tiene éxito
0: si hay un problema con la dirección IP proporcionada o puerto
_________________________________________________________________________________

WiFiUDP.endPacket()

Descripción:

Esta función se llama después de escribir datos UDP en la conexión remota. Termina el paquete y lo envía.

Sintaxis:
WiFiUDP.endPacket(); 
Parámetros:
Ninguno
Retornos:
1: si el paquete fue enviado con éxito
0: si hubo un error
___________________________________________________________________________

WiFiUDP.write()

Descripción:

Escribe los datos UDP en la conexión remota. Debe colocarse entre beginPacket () y endPacket (). beginPacket () inicializa el paquete de datos, no se envía hasta que se llama a endPacket ().

Sintaxis:
WiFiUDP.write(byte);
WiFiUDP.write(buffer, size);

Parámetros:
byte: el byte saliente
buffer: el mensaje saliente
size: el tamaño de la memoria intermedia (buffer)

Retornos:
- un solo byte en el paquete
- tamaño en bytes del buffer en el paquete
_________________________________________________________________________________

WiFiUDP.parsePacket()

Descripción:

Inicia el procesamiento del siguiente paquete de entrada disponible, comprueba la presencia de un paquete UDP, e informa del tamaño. parsePacket () debe ser llamado antes de leer el búfer con UDP.read ().

Sintaxis:
UDP.parsePacket(); 
Parámetros:
Ninguno
Retornos:
- el tamaño del paquete en bytes
- 0: si no hay paquetes disponibles
_________________________________________________________________________________

peek()

Descripción:

Lee un byte del archivo sin avanzar a la siguiente posición. Es decir, las llamadas sucesivas a peek () devolverán el mismo valor, al igual que la siguiente llamada a read ().

Sintaxis:
WiFiUDP.peek()
Parámetros:
Ninguno
Retornos:
b: el siguiente byte o carácter
-1: Si no hay ninguno disponible
_________________________________________________________________________________

 WiFiUDP.read()

Descripción:

Lee los datos de la memoria intermedia UDP especificada. Si no se dan argumentos, devolverá el siguiente carácter en el buffer.

Sintaxis:
WiFiUDP.read();
WiFiUDP.read(buffer, len); 

Parámetros:
buffer: tampón para mantener los paquetes entrantes (char *)
len: tamaño máximo de la memoria intermedia (int)

Retornos:
b: los caracteres en el búfer (char)
size: el tamaño de la memoria intermedia
-1: si no está disponible el buffer
_________________________________________________________________________________

 flush()

Descripción:

Descarta cualquiera de los bytes que se han escrito para el cliente, pero que aún no han sido leídos.

Sintaxis:

WiFiUDP.flush()

Parámetros:
ninguno

Retornos:
Ninguno
_________________________________________________________________________________

 stop()

Descripción:

Desconectarse del servidor. Liberar cualquier recurso que se utiliza durante la sesión UDP.

Sintaxis:

WiFiUDP.stop()

Parámetros:
Ninguno

Retornos:
Ninguno
_________________________________________________________________________________

 WiFiUDP.remoteIP()

Descripción:

Obtiene la dirección IP de la conexión remota.
Esta función debe ser llamada después de llamar a WiFi UDP.parsePacket ().

Sintaxis:

WiFiUDP.remoteIP(); 

Parámetros:
Ninguno

Retornos:
4 bytes: la dirección IP del host que envió el paquete de entrada actual
_________________________________________________________________________________

 WiFIUDP.remotePort()

Descripción:

Obtiene el puerto  UDPde la conexión remota.
Esta función debe ser llamada después de llamar a UDP.parsePacket ().

Sintaxis:

UDP.remotePort(); 

Parámetros:
Ninguno

Retornos:
El puerto del host que envió el paquete de entrada actual



No hay comentarios:

Publicar un comentario