Library to use a wifly module: RN 131 C/G
Dependents: RN-XV_simple_server
Diff: Wifly.h
- Revision:
- 1:e2f18a3d5215
- Parent:
- 0:2f38aaabc810
- Child:
- 2:dd0911f3af8e
--- a/Wifly.h Fri Aug 12 11:20:42 2011 +0000 +++ b/Wifly.h Fri Aug 12 11:26:33 2011 +0000 @@ -104,45 +104,45 @@ /** * Send a string to the wifi module by serial port * - * @ param str string to be sent - * @ param ACK string which must be acknowledge by the wifi module + * @param str string to be sent + * @param ACK string which must be acknowledge by the wifi module * - * @ return true if ACK has been found in the response from the wifi module. False otherwise or if there is no response in 3s. + * @return true if ACK has been found in the response from the wifi module. False otherwise or if there is no response in 3s. */ bool Send(char * str, char * ACK); /** * Connect the wifi module to the network. Return true if set correctly, false if not. * - * @ return true if connected, false otherwise + * @return true if connected, false otherwise */ bool Join(); /** * Create an adhoc network with the ssid contained in the constructor * - * @ return true if the network is well created, false otherwise + * @return true if the network is well created, false otherwise */ bool CreateAdhocNetwork(); /** * Receive a string to the wifi module by serial port * - *@ param str string to be read + *@param str string to be read */ void read(char * str); /** * To enter in command mode (we can configure the module) * - * @ return true if successful, false otherwise + * @return true if successful, false otherwise */ bool CmdMode(); /** * To exit the command mode * - * @ return true if successful, false otherwise + * @return true if successful, false otherwise */ bool exit(); @@ -154,21 +154,21 @@ /** * To check if a character is available * - * @ return true if a character is available, false otherwise + * @return true if a character is available, false otherwise */ bool readable(); /** * Read a character * - * @ return the character read + * @return the character read */ char getc(); /** * Write a character * - * @ param the character which will be written + * @param the character which will be written */ void putc(char c);