« Back to documentation index
Wifly Class Reference
The Wifly class.
More...
#include <Wifly.h >
Inherited by WiflyInterface .
Wifly (PinName tx, PinName rx, PinName reset, PinName tcp_status, const char *ssid, const char *phrase, Security sec) Constructor. void baudr (int baudrate) Set communication baudrate Higher baudrates tends to be unstable. bool join () Connect the wifi module to the ssid contained in the constructor. 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. bool isDHCP () Return true if the module is using dhcp.
Detailed Description
The Wifly class.
Definition at line 50 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
)
Constructor.
Parameters:
tx mbed pin to use for tx line of Serial interface rx mbed pin to use for rx line of Serial interface reset reset pin of the wifi module () tcp_status connection status pin of the wifi module (GPIO 6) ssid ssid of the network phrase WEP or WPA key sec Security type (NONE, WEP_128 or WPA)
Definition at line 45 of file Wifly.cpp .
Member Function Documentation
void baudr
(
int
baudrate )
Set communication baudrate Higher baudrates tends to be unstable.
Definition at line 68 of file Wifly.cpp .
Close a tcp connection.
Returns: true if successful Definition at line 387 of file Wifly.cpp .
To enter in command mode (we can configure the module)
Returns: true if successful, false otherwise Definition at line 331 of file Wifly.cpp .
bool connect
(
const char *
host ,
int
port
)
Open a tcp connection with the specified host on the specified port.
Parameters:
host host (can be either an ip address or a name. If a name is provided, a dns request will be established) port port
Returns: true if successful Definition at line 230 of file Wifly.cpp .
Disconnect the wifly module from the access point.
Returns: true if successful Reimplemented in WiflyInterface .
Definition at line 346 of file Wifly.cpp .
To exit the command mode.
Returns: true if successful, false otherwise Definition at line 410 of file Wifly.cpp .
Read a character.
Returns: the character read Definition at line 433 of file Wifly.cpp .
bool is_connected
(
void
)
Check if a tcp link is active.
Returns: true if successful Definition at line 361 of file Wifly.cpp .
Return true if the module is using dhcp.
Returns: true if the module is using dhcp Definition at line 208 of file Wifly.h .
Connect the wifi module to the ssid contained in the constructor.
Returns: true if connected, false otherwise Definition at line 84 of file Wifly.cpp .
Write a character.
Parameters:
the character which will be written
Definition at line 403 of file Wifly.cpp .
Check if characters are available.
Returns: number of available characters Definition at line 423 of file Wifly.cpp .
Reboot the wifi module.
Definition at line 375 of file Wifly.cpp .
Reset the wifi module.
Definition at line 367 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:
str string to be sent len string length ACK string which must be acknowledge by the wifi module. If ACK == NULL, no string has to be acknoledged. (default: "NO") res this 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 457 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:
str string to be sent ACK string which must be acknowledge by the wifi module. If ACK == NULL, no string has to be acknoledged. (default: "NO") res this 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 318 of file Wifly.cpp .
bool setProtocol
(
Protocol
p )
Set the protocol (UDP or TCP)
Parameters:
Returns: true if successful Definition at line 191 of file Wifly.cpp .
Check if characters are available.
Returns: number of available characters Definition at line 428 of file Wifly.cpp .
1.7.2