A Serial Interface for SIMCOM modules.
Revision 1:6f42bbd5eb48, committed 2017-08-10
- Comitter:
- BorjaTarazona
- Date:
- Thu Aug 10 10:35:22 2017 +0000
- Parent:
- 0:9c2d61688e70
- Commit message:
- Change in the comment sections
Changed in this revision
ATCommand.h | Show annotated file Show diff for this revision Revisions of this file |
diff -r 9c2d61688e70 -r 6f42bbd5eb48 ATCommand.h --- a/ATCommand.h Thu Aug 10 10:04:19 2017 +0000 +++ b/ATCommand.h Thu Aug 10 10:35:22 2017 +0000 @@ -22,28 +22,37 @@ /** Create a Serial Interface for AT Commands * - * @param tx Tx pin for the UART, rx RX pin for the UART, baudrate Baudrate for the UART + * @param tx Tx pin for the UART + * @param rx RX pin for the UART + * @param baudrate Baudrate for the UART * **/ ATSerial(PinName tx, PinName rx, int baudrate); /** Function to send a command to the SIM module * - * @param tx Tx pin for the UART, rx RX pin for the UART, baudrate Baudrate for the UART + * @param tx Tx pin for the UART + * @param rx RX pin for the UART + * @param baudrate Baudrate for the UART * **/ void sendCmd(char *cmd); /** Function to check if we receive the string we want and returns if we have received it or not * - * @param cmd Command to send, str String we want to receive, len Length of the String we want, timeout Time we wait for that string + * @param cmd Command to send + * @param str String we want to receive + * @param len Length of the String we want + * @param timeout Time we wait for that string * **/ int waitForAString(char* cmd, char* str,int len, int timeout); /** Function to wait for a string and store in the buffer what comes after that string * - * @param words String we are waiting for, timeout Time we wait for that string, buffer String where we store the string we want + * @param words String we are waiting for + * @param timeout Time we wait for that string + * @param buffer String where we store the string we want * **/ int waitForWord(char* words, int timeout, char* buffer); @@ -57,7 +66,8 @@ /** Function to send a command and wait for the response * - * @param cmd Command to send, timeout Time to wait for the response + * @param cmd Command to send + * @param timeout Time to wait for the response * **/ char* sendCmdAndWaitForResp(char *cmd, int timeout);