Damien Frost / WiflyInterfaceMessaging

- Added messages

Fork of WiflyInterface by Damien Frost

Embed: (wiki syntax)

« Back to documentation index

Wifly Class Reference
Public Member Functions | Static Public Attributes

Wifly Class Reference

The Wifly class. More...

#include <Wifly.h>

Inherited by WiflyInterface.

Public Member Functions

 Wifly (PinName tx, PinName rx, PinName reset, PinName tcp_status, const char *ssid, const char *phrase, Security sec, Serial *messagesPort)
 Constructor.
bool join ()
 Connect the wifi module to the ssid contained in the constructor.
void setBaud (int baudrate)
 Sets the baudrate of the serial port used to communicate with the ethernet/wifi adapter.
bool disconnect ()
 Disconnect the wifly module from the access point.
bool connect (const char *host, int port)
 Open a tcp connection with the specified host on the specified port.
bool setProtocol (Protocol p)
 Set the protocol (UDP or TCP)
void reset ()
 Reset the wifi module.
bool reboot ()
 Reboot the wifi module.
int readable ()
 Check if characters are available.
int writeable ()
 Check if characters are available.
bool is_connected ()
 Check if a tcp link is active.
char getc ()
 Read a character.
void flush ()
 Flush the buffer.
int putc (char c)
 Write a character.
bool cmdMode ()
 To enter in command mode (we can configure the module)
bool exit ()
 To exit the command mode.
bool close ()
 Close a tcp connection.
int send (const char *str, int len, const char *ACK=NULL, char *res=NULL, int timeout=DEFAULT_WAIT_RESP_TIMEOUT)
 Send a string to the wifi module by serial port.
bool sendCommand (const char *cmd, const char *ack=NULL, char *res=NULL, int timeout=DEFAULT_WAIT_RESP_TIMEOUT)
 Send a command to the wify module.
int checkNetworkStatus (void)
 Check if the wifly module is still connected to the network:
bool isDHCP ()
 Return true if the module is using dhcp.
void sleep (void)
 Puts the module to sleep.

Static Public Attributes

static Serial * SerialCommPort
 Serial port to display debug messages.

Detailed Description

The Wifly class.

Definition at line 57 of file Wifly.h.

Constructor & Destructor Documentation

Wifly ( PinName  tx,
PinName  rx,
PinName  reset,
PinName  tcp_status,
const char *  ssid,
const char *  phrase,
Security  sec,
Serial *  messagesPort 
)

Constructor.

Parameters:
txmbed pin to use for tx line of Serial interface
rxmbed pin to use for rx line of Serial interface
resetreset pin of the wifi module ()
tcp_statusconnection status pin of the wifi module (GPIO 6)
ssidssid of the network
phraseWEP, WPA or WPA2 key
secSecurity type (NONE, WEP_128 or WPA, WPA2)

Definition at line 36 of file Wifly.cpp.

Member Function Documentation

int checkNetworkStatus ( void   )

Check if the wifly module is still connected to the network:

Returns:
0: if not connected 1: if connected

Definition at line 626 of file Wifly.cpp.

bool close (  )

Close a tcp connection.

Returns:
true if successful

Definition at line 438 of file Wifly.cpp.

bool cmdMode (  )

To enter in command mode (we can configure the module)

Returns:
true if successful, false otherwise

Definition at line 374 of file Wifly.cpp.

bool connect ( const char *  host,
int  port 
)

Open a tcp connection with the specified host on the specified port.

Parameters:
hosthost (can be either an ip address or a name. If a name is provided, a dns request will be established)
portport
Returns:
true if successful

Definition at line 262 of file Wifly.cpp.

bool disconnect (  )

Disconnect the wifly module from the access point.

Returns:
true if successful

Reimplemented in WiflyInterface.

Definition at line 389 of file Wifly.cpp.

bool exit (  )

To exit the command mode.

Returns:
true if successful, false otherwise

Definition at line 461 of file Wifly.cpp.

void flush (  )

Flush the buffer.

Definition at line 351 of file Wifly.cpp.

char getc (  )

Read a character.

Returns:
the character read

Definition at line 484 of file Wifly.cpp.

bool is_connected ( void   )

Check if a tcp link is active.

Returns:
true if successful

Definition at line 404 of file Wifly.cpp.

bool isDHCP (  )

Return true if the module is using dhcp.

Returns:
true if the module is using dhcp

Definition at line 221 of file Wifly.h.

bool join (  )

Connect the wifi module to the ssid contained in the constructor.

Returns:
true if connected, false otherwise

Definition at line 107 of file Wifly.cpp.

int putc ( char  c )

Write a character.

Parameters:
thecharacter which will be written

Definition at line 454 of file Wifly.cpp.

int readable (  )

Check if characters are available.

Returns:
number of available characters

Definition at line 474 of file Wifly.cpp.

bool reboot (  )

Reboot the wifi module.

Definition at line 426 of file Wifly.cpp.

void reset (  )

Reset the wifi module.

Definition at line 410 of file Wifly.cpp.

int send ( const char *  str,
int  len,
const char *  ACK = NULL,
char *  res = NULL,
int  timeout = DEFAULT_WAIT_RESP_TIMEOUT 
)

Send a string to the wifi module by serial port.

This function desactivates the user interrupt handler when a character is received to analyze the response from the wifi module. Useful to send a command to the module and wait a response.

Parameters:
strstring to be sent
lenstring length
ACKstring which must be acknowledge by the wifi module. If ACK == NULL, no string has to be acknoledged. (default: "NO")
resthis field will contain the response from the wifi module, result of a command sent. This field is available only if ACK = "NO" AND res != NULL (default: NULL)
Returns:
true if ACK has been found in the response from the wifi module. False otherwise or if there is no response in 5s.

Definition at line 514 of file Wifly.cpp.

bool sendCommand ( const char *  cmd,
const char *  ack = NULL,
char *  res = NULL,
int  timeout = DEFAULT_WAIT_RESP_TIMEOUT 
)

Send a command to the wify module.

Check if the module is in command mode. If not enter in command mode

Parameters:
strstring to be sent
ACKstring which must be acknowledge by the wifi module. If ACK == NULL, no string has to be acknoledged. (default: "NO")
resthis field will contain the response from the wifi module, result of a command sent. This field is available only if ACK = "NO" AND res != NULL (default: NULL)
Returns:
true if successful

Definition at line 356 of file Wifly.cpp.

void setBaud ( int  baudrate )

Sets the baudrate of the serial port used to communicate with the ethernet/wifi adapter.

Parameters:
baudrateThe baudrate that the connection should be set to. Valid values are: 2400, 4800, 9600, 19200, 38400, 115200, 230400, 460800, 921600 do NOT go above 230400

Definition at line 86 of file Wifly.cpp.

bool setProtocol ( Protocol  p )

Set the protocol (UDP or TCP)

Parameters:
pprotocol
Returns:
true if successful

Definition at line 221 of file Wifly.cpp.

void sleep ( void   )

Puts the module to sleep.

Definition at line 657 of file Wifly.cpp.

int writeable (  )

Check if characters are available.

Returns:
number of available characters

Definition at line 479 of file Wifly.cpp.

Field Documentation

Serial * SerialCommPort [static]

Serial port to display debug messages.

Definition at line 235 of file Wifly.h.

Generated on Thu Jul 14 2022 01:09:33 by  doxygen 1.7.2