Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of
WiflyInterface
by 
mbed official
Wifly Class Reference
#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) | |
| Constructor. | |
| 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)
Member Function Documentation
| bool close | ( | ) |
| bool cmdMode | ( | ) |
| bool connect | ( | const char * | host, |
| int | port | ||
| ) |
| bool disconnect | ( | ) |
Disconnect the wifly module from the access point.
- Returns:
- true if successful
Reimplemented in WiflyInterface.
| bool exit | ( | ) |
| char getc | ( | ) |
| bool is_connected | ( | void | ) |
| bool isDHCP | ( | ) |
| bool join | ( | ) |
| int putc | ( | char | c ) |
| int readable | ( | ) |
| 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.
| 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
| bool setProtocol | ( | Protocol | p ) |
Generated on Wed Jul 13 2022 07:41:28 by
1.7.2