LM Technologies AT Commands Manual - BR/EDR LM951 and LM961

Transcription

1 LM Technologies AT Commands Manual - BR/EDR LM951 and LM961

2 History Version Last Name Changes description /07/2015 Marco First release Contents 1. Overview AT Commands Summary History Terminology AT Commands Summary Common Responses Detailed Description ACON ACON? ACON ACON ADDR ADDR? AUTO BAUD BAUD=XX BAUD? BOND BOND=XXXXXXXXXX BOND BOND? CONN CONN CONN=XXXXXXXXXXXX CONNn DCOV

3 DCOV? DCOV DCOV DROP ECHO ECHO? ECHO ECHO ESC ESC? ESC ESC FIND FIND? FIND FLOW FLOW? FLOW FLOW IOTYPE IOTYPE=X IOTYPE? MITM MITM? MITM MITM NAME NAME=name NAME? PAR PAR=X PAR? RESET RESP RESP

4 RESP RESP? ROLE ROLE=X ROLE? RSSI RSSI? STOP STOP=X STOP? UPGRADE UPGRADE=password VER VER? Overview 4

5 This document describes the AT commands to control the operation of the LM951 and LM961 Bluetooth Smart Ready module. Related to BR/EDR functionality only. 2. AT Commands Summary 2.1. History The AT command set was developed by Hayes to control the operation of telephony modems. The command set has been extended to control Bluetooth devices primary operation such as enquiry, connection setup/ disconnection etc. Other AT commands is also available to control the serial port setup and other user friendly features. The Bluetooth device powers up in unconnected state and can be configured using UART interface similar to telephony modems. The device will act as Bluetooth slave by default and can be enquired/connected from a Bluetooth master device. The AT commands can be used to change the default behaviour and settings for the current as well as future power up cycles Terminology Symbol Description ASCII value (Hex) <CR> Carriage Return 0x0D <LF> Line Feed 0x0A <CLRF> Carriage return and line 0x0D, 0x0A feed XXXXXXXXXXXX 12 hexadecimal BD address sequence 2.3. AT Commands Summary Command Type Parameter Command Device Information Firmware Version AT+VER Reset Restore Factory Settings AT+RESET Serial Port Baud Rate AT+BAUD Stop Bits AT+STOP Parity Bits AT+PAR Flow Control AT+FLOW Character Echo AT+ECHO Command Response AT+RESP 5

6 Modem Signals AT+MODEM CTS line status AT+CTS RTS line status AT+RTS Bluetooth Type Device Role AT+ROLE Information BD Address AT+ADDR Enquire devices AT+FIND RSSI AT+RSSI Settings Device Name AT+NAME Discovery AT+DCOV Connection Connect device AT+CONN Drop connection AT+DROP Bonding AT+BOND Auto Connect AT+ACON BT2.1 Device Type AT+IOTYPE Security MITM protection AT+MITM Misc Escape Sequence handling AT+ESC Mode switch AT+AUTO Low power mode AT+SLEEP Firmware upgrade AT+UPGRADE 2.4. Common Responses In case of invalid AT command (anyone not listed in this document) a generic error message is sent as below: <ERROR><CLRF> In case a valid command is not followed by a valid character type (?, +, -, etc.) a command generic error response is sent as below: <+<at_com>: ERROR><CLRF>: where <at_com> represents the AT command required such as ADDR, ECHO, etc. 3. Detailed Description Each command sequence sent to the module must be terminated by the \n (EOL) character in order to be effectively received and parsed from the module ACON This command is used to get current auto-connect feature state or to set it as enabled or disabled. 6

7 ACON? Get actual auto-connect feature state. The module sends one the following responses: a) <+ACON: ACON+><CLRF>: if auto-connect is enabled; b) <+ACON: ACON-><CLRF>: if auto-connect is disabled ACON+ Set auto-connect to enabled. This operation succeeds always and so the module sends always the following response: <+ACON: OK><CLRF> ACON- Set auto-connect to enabled. This operation succeeds always and so the module sends always the following response: <+ACON: OK><CLRF> 3.2. ADDR This command can be used to get the local device address only ADDR? This is the only possible command and the module sends back a waiting response followed by the data response containing the address: a) <+ADDR: WAIT><CLRF> b) <+ADDR: XXXX-XX-XXXX><CLRF>: where XXXX-XX-XXXX represents the requested Bluetooth address of the local device AUTO This command is sent to exit from command mode and return to pass-through data mode. The response can be one of the following ones: a) <+AUTO: OK><CLRF>: if request succeeds. It means that the module is connected to a remote device and it was previously in command mode. The module is now in data mode; b) <+AUTO: ERROR><CLRF>: if request fails. It means that the module is not connected to a remote device. Note: if this command is sent during a connection and when the module is in data mode then the command is passed through to the connected remote device as any data. To parse this command it is necessary to switch into command mode by sending an escape sequence (as any other command needed to be parsed). 7

8 3.4. BAUD This command sets a new UART baud rate value or to get the current one. In case of new baud rate setting, the response is sent with the previous baud rate value and then the baud rate will be immediately updated. So, the module will expect next command at the new baud rate value BAUD=XX This command sequence changes the baud rate value according to XX string parameter. This parameter can be in a range between 10 and 20 whit respectively a meaning of 1200bps and bps. See table below: XX Baud rate [bps] Table 1 The response can be one of the following ones: a) <+BAUD: OK><CLRF>: if the parameter is valid value; b) <+BAUD: ERROR><CLRF>: if the parameter is not a valid value BAUD? This command is used to get the current baud rate value. It is followed by a response from the module containing the coded baud rate value according to table 1. The operation can also fail due to internal error (memory corruption or other serious problems), so a related response will be sent. The two responses are below: a) <+BAUD: XX><CLRF>: where XX is a string containing the coded baud rate number value as shown on table 1; b) <+BAUD: ERROR><CLRF>: if an internal error occurs reading the current baud rate value BOND This command is used to set or reset a remote bonded address. 8

9 BOND=XXXXXXXXXX This command sequence set a required address as bonded and the parameter string represents the Bluetooth address represented with 12 characters only (no dashes). The response can be as following: a) <+BOND: OK><CLRF>: if the operation succeeded; b) <+BOND: ERROR><CLRF>: if the operation failed or the parameter length is different than the expected one, 12 characters BOND- This command clears an eventual previously bonded device. Note: the operation is executed successfully even if a remote address has not been set previously. The response can be as following: a) <+BOND: OK><CLRF>: if the operation succeeded; b) <+BOND: ERROR><CLRF>: if the operation failed for an internal error BOND? This command returns the current bonded remote address. If the address has not been set then an empty string is returned. The response is always as following: <+BOND: XXXX-XX-XXXX ><CLRF>: where the XXXX-XX-XXXX string is the full 14 characters Bluetooth address with dashes CONN This command is used to require a connection to a specific remote address or to the bonded one CONN The only command name without parameter requires a connection to the bonded remote device. The module will start a new connection, if the bonded address is valid, replying with a waiting message else the operation fails. So, response can be as below: a) <+CONN: WAIT><CLRF>: if the bonded address is valid (not null); and (followed by) <+CONN: CONNECTED><CLRF> or <+CONN: FAIL><CLRF>: respectively if the connection procedure succeeded or failed; b) <+BOND: ERROR><CLRF>: if the bonded address is not valid (null because previously cleared or not configured yet) CONN=XXXXXXXXXXXX This command start a connection to the specified address in the 12 characters format. The response can be as following: a) <+CONN: WAIT><CLRF>: if the given address is valid (length is 12); and (followed by) <+CONN: CONNECTED><CLRF> or <+CONN: FAIL><CLRF>: respectively if the connection procedure succeeded or failed; b) <+CONN: FAIL><CLRF>: if the given address is not valid (invalid length) CONNn This command allows to require a connection to a n device previously listed as result of a FIND command. TO BE DEFINED 9

10 3.7. DCOV This command allows to set and get discoverability feature status DCOV? This command returns the current discoverability status. The module can respond with two status as following: a) <+DCOV: DCOV+><CLRF>: if the current discoverability feature is enabled; b) <+DCOV: DCOV-><CLRF>: if the current discoverability feature is disabled DCOV+ This command enables the discoverability feature. The response is always the same: <+DCOV: OK><CLRF> DCOV- This command enables the discoverability feature. The response is always the same: <+DCOV: OK><CLRF> DROP This command drops an eventual connection in progress. If the module is not connected or actual connection cannot be dropped then an error message is sent back as response. Possible responses are the followings: a) <+DROP: OK><CLRF>: if the module is connected and drop command succeeded; b) <+DROP: ERROR><CLRF>: if the module is not connected or the drop operation of an active connection failed ECHO This command allows to set and get the discoverability feature status. Changing this feature status has immediate effect stating from next command ECHO? This command returns the current echo feature status. Responses are the followings: a) <+ECHO: ECHO+><CLRF>: if echo feature is enabled; b) <+ECHO: ECHO-><CLRF>: if echo feature is disabled ECHO+ This command enables the echo feature. The response is always as below: <+ECHO: OK><CLRF> ECHO- This command disables the echo feature. The response is always as below: <+ECHO: OK><CLRF>. 10

11 3.11. ESC This command allows to set and get the escape sequence option status ESC? This command returns the current echo feature status. Responses are the followings: a) <+ESC: ESC+><CLRF>: if escape sequence option is enabled; b) <+ESC: ESC-><CLRF>: if echo feature is disabled ESC+ This command enables the escape sequence option. The response is always as below: <+ESC: OK><CLRF> ESC- This command disables the escape sequence option. The response is always as below: <+ESC: OK><CLRF> FIND This command starts a procedure to find other Bluetooth devices. The module will not start a new scan if it is not in master role or it is already connected FIND? This command starts a new scan if the module is allowed to do it. Possible responses are the followings: a) <+FIND: WAIT><CLRF>: if the module is in master mode and it is not already connected; and (followed by) <+FIND: Name: name Address: XXXX-XX-XXXX><CLRF>: where name is a string representing the device name and XXXX-XX-XXXX is the Bluetooth address. This response is sent for each found device. Note: it a device name could not be resolved a Read Failed string is placed instead of the name; and (followed by) <+FIND: Inquiry End. n device(s) found.><clrf>: where n is the number of found devices; b) <+FIND: ERROR><CLRF>: if the module is not in master role or it is already connected FIND- This commands stops an eventual ongoing scan sequence. The response is always as below: <+FIND: Inquiry cancelled><clrf>. TODO: consider to send an error message if this command is received when no scan procedure is running FLOW This command is used to get or set the UART hardware flow control configuration. 11

12 FLOW? This command returns the current configuration. The response can be as the following ones: a) <+FLOW: FLOW+><CLRF>: if hardware flow control is enabled; b) <+FLOW: FLOW-><CLRF>: if hardware flow control is disabled FLOW+ This command enables the hardware flow control. The response is always as below: <+FLOW: OK><CLRF> FLOW- This command disables the hardware flow control. The response is always as below: <+FLOW: OK><CLRF> IOTYPE This command is used to get or set the I/O type configuration IOTYPE=X This command sequence sets the I/O type configuration to X character parameter. This parameter can be in a range between 0 and 4 meaning as shown on table below: X Device type / capability 0 Display only 1 Display with yes or no 2 Keyboard only 3 No display No keyboard 7 Reject connection with Bluetooth 2.1 devices Table 2 The response can be as below: a) <+IOTYPE: OK><CLRF>: if the configuration change succeeded; b) <+IOTYPE: ERROR><CLRF>: if the configuration change fails (invalid parameter) IOTYPE? This command sequence return the current I/O type configuration. The response can be as below: a) <+IOTYPE: X><CLRF>: where X is the character related to a specific capability as shown on table 2. b) <+IOTYPE: ERROR><CLRF>: if the operation fails due to an internal error (memory corruption or any other serious issue) MITM This command get or set the Main In The Middle feature status MITM? This command sequence returns the current MITM feature status. Response can be as below: a) <+MITM: MITM+><CLRF>: if the MITM feature is enabled; 12

13 b) <+MITM: MITM-><CLRF>: if the MITM feature is disabled MITM+ This command enables the MITM feature. The response is always as below: <+MITM: OK><CLRF> MITM- This command disables the MITM feature. The response is always as below: <+MITM: OK><CLRF> NAME This command is used to change or get the device name. The name must a string long 32 characters at most NAME=name This command changes the device name with the given one as parameter. The name string represents the new name and must be long 32 characters at most. Response can be as below: a) <+NAME: OK><CLRF>: if the name has been changed successfully. It means that the length was valid and the operation succeeded; b) <+NAME: ERROR><CLRF>: if the name length was too long NAME? This command returns the current device name. The response is supposed to contain always a valid name string as below: <+NAME: name><clrf>: where name is the name string (maximum 32 characters long) PAR This command set or get the UART parity configuration PAR=X This command sets a parity configuration according to the X character as shown on the table below: X Parity type 0 No parity 1 Odd parity 2 Even parity Table 3 The response can be as below: a) <+PAR: OK><CLRF>: if the parameter is valid and the operation succeeded; b) <+PAR: FAIL><CLRF>: if the parameter is not valid. 13

14 PAR? This command returns the current parity configuration. The response can be as the following ones: a) <+PAR: PARX><CLRF>: where the X character is the coded parity configuration as shown on table 4; b) <+PAR: ERROR><CLRF>: if the operation failed due to an internal error (memory corruption or any other serious issue) RESET This command perform a system reset. Since the reset is immediate there is no response RESP This command enables/disables command response or get its status RESP+ This command enables command responses. The following response is always as below: <+RESP: OK><CLRF RESP- This command disables command responses. The following response will be the last one and is as below: <+RESP: OK><CLRF RESP? This command returns current command response option status. Response can be as the following ones: a) <+RESP: RESP+><CLRF>: if the command response option is enabled; b) <+RESP: RESP-><CLRF>: if the command response option is disabled ROLE This command changes serial role or get its current value ROLE=X This command sets serial role according to X character that must be one of the values show on the table below: X Serial role M Master S Slave Table 4 The response can be as below: a) <+ROLE: OK><CLRF>: if the parameter is valid and the operation succeeded; b) <+ROLE: ERROR><CLRF>: if the parameter is invalid ROLE? This command returns the current serial role value. The response can be as below: 14

15 a) <+ROLE: ROLEX><CLRF>: where X is the coded serial role as shown on table 5; b) <+ROLE: ERROR><CLRF>: if the operation failed due to an internal error (memory corruption or any other serious issue) RSSI This command starts a RSSI measurement request that is followed by a waiting message and then related measurement result RSSI? This command is the only one allowed and its response is as below: <+RSSI: WAIT><CLRF>; and (followed by) <+RSSI: value><clrf>: where value is a string representing the measurement result STOP This command configures UART stop bits or gets its value STOP=X This command configures the stop bits value according to X character as shown on the table below: X Number of stop bits 1 One stop bits 2 Two stop bits Table 5 The response can be one of the followings: a) <+STOP: OK><CLRF>: if parameter is valid and operation succeeded; b) <+STOP: ERROR><CLRF>: if parameter is not valid STOP? This command returns the current stop bits configuration value. The response can be as below: a) <+STOP: STOPX><CLRF>: where X is the coded stop bits value as shown on table 6; b) <+STOP: ERROR><CLRF>: if operation failed due to an internal error (memory corruption or any other serious internal issue) UPGRADE This command is used to enter in DFU mode for flashing purpose UPGRADE=password This command is the only allowed. The parameter password represents the password string to be compared with the stored one into permanent memory. If the password is correct then the module enters in DFU mode. Response is TO BE DEFINED. 15

16 3.23. VER This command is used to get the module firmware version VER? This is the only allowed command and it is followed by the response below: <+VER: FW VERSION: XX.YY><CLRF>: where XX.YY represents the module firmware version. 16