UM1547 - STMicroelectronics
Contents
1. Variable Name Default Description GPIO register used to prevent the module from entering deep sleep mode A setting of none vaniy PISEERUSIDEORAWORE None means that this function is disabled Typically GPIO 3 supports this feature GPIO register used to wake up the module after it Var18 GPIO HostWakeu None enters deep sleep mode A setting of none means E P that this function is disabled Typically GPIO 3 supports this feature If true only DM1 DH1 DM3 DH3 packets are arie Hoe alPae es False allowed on a link EDR is disabled Var20 EnableAFH True Enable Disable the Adaptive Frequency Hopping mode Var EnablePowerControl Tua Enable Disable the Bluetooth Dynamic power control feature Not supported Var22 HostFlowControl 0 Reserved for future usage Sets the AT command reply prefix All events that Var23 ATReply AT AB are displayed are prefixed by this character string case sensitive Sets the Quality of Service Latency from 3 to 40 Naga dos Latency ae slots A slot period is 625 microseconds Sets the module s CPU speed 2 4 8 12 16 20 Var25 CpuMHz 32 24 28 32 36 and 64 MHz are allowed Note CPUMHz 40 to 63 are not supported Baud rate of the HCI interface to the Bluetooth Var26 HciBaudrate 921600 controller 115 200 230 400 460 800 921 600 and 2 000 000 baud are allowed Var27 SPIEnable False Enables the SPI interface to external pins Not supported Var28 SPIMode Slave Mo2. 32 5 3 Remote escape sequence 32 Appendix A FWconfigurationvariables 33 A 1 AT FW version 1 2 33 A 2 AT2FW version 1 3 35 A3 AT2 FW version 1 6 40 6 Revision history 50 6 51 DoclD023232 Rev 5 KYI UM1547 List of tables List of tables Table 1 Table 2 Table 3 Table 4 Table 5 Table 6 Table 7 Table 8 Table 9 Table 10 Table 11 Table 12 Table 13 Table 14 Definitions and acronyms AA e a WA ed ee ee 8 AT command list summary IA AA IA ee ee ee ee ee ee ed mh 10 Example commands that generate lt ErrConneci gt 29 Example commands that generate ErrExecute 29 Example commands that generate lt ErrFormat gt 30 Example commands that generate ErrlnvalidParam 30 Example commands that generate lt ErrNumParam gt 31 Example commands that generate lt ErrInProgress gt 31 AT version 1 2 system configuration settings version 1 2 33 AT2 version 1 3 system configuration settings version 1 4 35 AT2 FW version 1 3 system configuration settings
3. IAPConnect 3 241 oi AE EE RE 3 24 2 Responses IAPDisconnect 3 254 Syntax 3 252 Responses a LinkDisconnect 3 26 1 Syntax aaaea 3 26 2 Responses LOGAINGING ou Rm Rd x RR EE Reg 3 271 Syntax coco 3 27 2 RespoOnsesS eseseeeee eese PassKeyAccept S281 SYNTAX eke awe DE EE EE E ERG Ee a 3 28 2 Responses waw PortDisconnect 3 291 SyhilaX rass se nenacia p aaa adia ea iaa S 3 29 2 Responses ReadClock 3 30 1 Syntax 3 30 2 Responses IIIA eee eee 2 30 3 SyhtaX iioc kc cael ace nae BE 3 30 4 Responses p ccr 3911 SYNTAX sodes teer E eed ehe e 3 31 2 Responses RoleSwitch 3 32 11 SYNTAX cies l enata ShowGonnectiOn 29 937 SYNTAX iue cuc excesos s a e d 3 83 2 Responses ShowDev DoclD023232 Rev 5 UM1547 Contents 3 35 3 36 3 37 3 38 3 39 3 40 3 41 3 42 Error responses 4 1 4 2 4 3 44 4 5 4 6 3341 Syntax 2
4. Variable Name Default Description Default security mode should be 1 for no Var40 DefaultSecurity 4 security or 4 for authentication required Modes 2 and 3 are used for legacy compatibility Establishes which level of SSP authentication is Var41 DefaultAuthentication 5 enabled Possible values are 4 SSP Just works or 5 SSP pairing modes with MITM protection Var42 EnablelAP True Enables IAP mode to support iOS devices Var43 AllowSniff False Enables sniff mode Var44 iAPAppID A1B2C3D4E5 This variable identifies the iOS application ID Var45 iAPProtocolStrMain com Demo This variable defines the main connecting string for the OS application Var46 iAPProtocolStrAlt com Protocol This variable defines the alternative connecting Alt string for the iOS application Var47 CPI2CMode 3 Apple CP chip 12C address mode 2 or 3 Var48 SPP128UUID True This variable enables the 128 bit UUID for the Android devices Var51 RmtEscapeSequence False Set to true to enable Remote Control Mode Table 11 AT2 FW version 1 3 system configuration settings version 1 5 Variable Name Default Description Var01 BuildVersion 121016A IDPS Data code software was build read only Var03 BD_ADDR 00043e212345 Bluetooth device address read only Var04 DeviceName Amp ed Up Code used for secure connection Up to 20 characters are allowed case sensitive When true hardware RTS CTS flow control is
5. 32 51 Other responses The following subsections describe types of responses that occur under specific circumstances not necessarily as a result of a specific command They are e Reset e Escape sequence Reset Upon either a hardware reset or software reset such as the Reset command ATn FW will respond as follows after the reset is complete AT AB CommandMode AT AB BDAddress BD addr Because the BD address of the local device is reported during this response the response is different than a response to the Escape Sequence Escape sequence If the escape sequence 15796 is received and no connection is active ATn FW will immediately respond with AT AB CommandMode When the escape sequence is received while a connection is still active and there is no data for 2 seconds ATn FW will respond after those 2 seconds of no data with the same string ATn FW will now be in command mode Remote escape sequence The remote escape sequence supported by AT2 FW allows a remote device to enter in a mode where it can be controlled and configured by a BT link using a local host and Bluetooth device To enable Remote Control the configuration variable RmtEscapeSequence must be set to true The Remote escape sequence is and it must be sent by the local host in a single complete packet over the BT link with no CR or LF in the sequence When received the remote device will respond locally with AT AB RemoteMo
6. wa UM1547 y onm User manual Using the firmware of the AT command set March 2015 Introduction This document is a guide to the AT command set a firmware application embedded in ST Bluetooth module series SPBT2632C2A SPBT2632C14 and in ST evaluation tools STEVAL SPBT3ATV3 STEVAL SPBT4ATV3 The AT command set is a user friendly interface that implements cable replacement and supports communication with smartphones and Apple devices The SPBT2632C2A AT2 and SPBT2632C1A AT2 modules are equipped with the AT2 FW release which offers SPP and IAP iPOD accessory protocol service supporting communication with smartphones and Apple iOS Bluetooth enabled devices This document provides a detailed description of each command supported by the AT2 FW interface Appendix A contains the list of the system configuration variables of the AT command with each default value and range Each of the subsections in Section 3 AT command list gives the definition syntax and responses of each command Error responses are also detailed in Section 4 of this document This document applies also to the previous modules BT 2 1 version DoclD023232 Rev 5 1 51 www st com Contents UM1547 Contents 1 Definition and acronyms sae ek ks sa RR RR RA RR RR RR RR RR Re 8 2 ay ET EE ER EE dr o EE Or 9 2 1 AT command FW interface overview 9 3 AT Command ST se ue es ie RR AA ere IE ae wh eee a 10 3 1 AU
7. 3 7 2 3 8 14 51 If there is currently no connection the response is AT AB ConnectionDown ChangeBaud The host sends the ChangeBaud command in order to change the local UART speed to a new speed identified by the host This setting will only remain in effect during the current session until reset as general rule the UART baud rate must be lower than the HCI baud rate set in the variable 26 Syntax AT AB ChangeBaud rate where rate is the new baud rate 1200 e 2400 e 4800 e 9600 e 19 200 e 38 400 e 57 600 e 115 200 e 230 400 e 460 800 e 921 600 e 2 000 000 Responses If the change is accepted the response is AT AB Baudrate Changed The actual change will not occur until the response has been completely transmitted ChangeDefaultBaud The host sends the ChangeDefaultBaud command in order to change the default UART speed to a new speed identified by the host This command is used to override the default baud rate from the dynamic configuration script so that the device does not require reprogramming to update this setting The new baud rate is updated permanently until the device is either re programmed or another ChangeDefaultBaud command is issued The baud rate specified in the command will not take effect until the device is reset To change the baud rate of the current session use the ChangeBaud command as general rule the UART baud rate must be lower than the HCI baud rate set in the varia
8. awa 3 34 2 Responses SmartCableSetup 3 35 1 Syntax 3 35 2 Responses SIE Mantes Wades baw ears ones aod dvd ae die eer 3 36 1 Syntax UE eee 3 36 2 Responses iss EER RE eee ke SPPConnect CES TA BE IC AA 3 37 2 Responses ee eee eee SPPDisconnect 398 1 Syntax 2 aa paaa aao E a a ea 3 88 2 Responses III IIIA StreamingSerial 3 39 1 Syntax aaa aa 9199 2 Query III 3 89 3 Responses WWW UpdatelnquiryScan 3 40 1 Syntax II naio n a a ei 3 40 2 Responses lesser UpdatePageScan 3 41 4 Syntax else 3 41 2 Responses Version 3 421 Syntax ee 3 42 2 Responses EMOS s iere sacco ie ru daa ba Err EXECULE creciera eer aces ER ga a ErtFormat Rek RC ewe ee hak ErrlnvalidParam ErrNumParam ErrUnknownCmd DoclD023232 Rev 5 5 51 Contents UM1547 4 7 rna MR rra HR EE a IE EG 31 5 Other responses xus aces ex Ode E ROC ROCK cei cu e e cR RR ca 32 5 1 Reset EE a a A We rca cod CT a RR RS RR 32 5 2 Escape seguence
9. 115200 Main UART baud rate 1200 to 2Mbaud Var08 UartParity None Main UART parity None Even Odd 40 51 DoclD023232 Rev 5 ky UM1547 FW configuration variables Table 12 AT2 FW version 1 6 system configuration settings version 1 5 continued Variable Name Default Description Main UART data bits per character With Var09 UartDataBits 8 Even Odd parity this must be 9 data bits to include 1 bit of parity Var10 UartStopBits 1 Main UART number of stop bits 1 or 2 Timeout used to determine the end of a message yanii aie on 18 in units of bit times from 8 to 128 are allowed vari AutoSniff False This enables the sniff feature when the link is inactive automatically Var13 AutoSniffTimeout 5 The inactivity timeout in seconds used for AutoSniff above f Sniff Slot interval applied AutoSniff from 200 to yana SE 1090 1000 are allowed 0 625 ms per slot Var15 HostShallowSleepEnable True Enables shallow sleep mode Var16 HostDeepSleepEnable False Enables deep sleep mode GPIO register used to prevent the module from entering deep sleep mode A setting of none Yari GPIO HostkeepAwake None means that this function is disabled Typically GPIO 3 amp 5 support this feature GPIO register used to wake up the module after it enters deep sleep mode A setting of none Marie GPIO HosiMakeup None means that this function is disabled Typically GPIO 3 amp 5 support this feature If
10. 3 3 1 12 51 AutoReconnect The AutoReconnect command is used to automatically reconnect by both SPP and IAP profiles The 1st device in the pairing table will be used for the reconnection target When the pairing table is deleted Auto Reconnect will be disabled as well The reconnect function may be turned on or off with this command It will not affect the settings This setting is NOT saved in NVM Syntax At ab AutoReconnect enable disable Where Enable Disable is an e or E character to enable this parameter and a d or D character to disable it Responses If the change is accepted the response is AT AB AutoReconnectDone Enabled or AT AB AutoReconnectDone Disabled AutoReconnectSetup Beta version The AutoReconnectSetup command is used to configure the AutoReconnect feature Syntax At ab AutoReconnectSetup interval in seconds Interval the time in seconds between attempts 3 100 5 The target device is the first entry in the pairing table Reconnections will continue after every interval until the feature is disabled or deleted This setting is saved in NVM Responses If the operation is successful the response is AT AB AutoReconnectSetupDone Bond The Bond command is used to initiate bonding with a specified device A personal identification number PIN is also required with this command The bond table contains up to 5 devices Note the 6th device will overwrite the oldest
11. ST herein Resale of ST products with provisions different from the information set forth herein shall void any warranty granted by ST for such product ST and the ST logo are trademarks of ST All other product or service names are the property of their respective owners Information in this document supersedes and replaces information previously supplied in any prior versions of this document 2015 STMicroelectronics All rights reserved 4 DoclD023232 Rev 5 51 51
12. True All host events are sent when true Var33 BondingAllowed True Automatically allow bonding by default when true 38 51 DocID023232 Rev 5 Ly UM1547 FW configuration variables Table 11 AT2 FW version 1 3 system configuration settings version 1 5 continued Variable Var34 Var35 Name PageScan InquiryScan Default True True Description Enables page scan when true or halts page scan when false Enables inquiry scan when true or halts inquiry scan when false Var36 MPMode 0 point to point 1 multipoint using packet protocol 2 broadcast Var37 Var38 UseExtLPO False True when a 32 768 kHz low power oscillator is present and false if not present not assigned Var39 EnableEncryption True Set to true to enable the Bluetooth link encryption Var40 DefaultSecurity Default security mode should be 1 for no security or 4 for Authentication required Modes 2 and 3 are used for legacy compatibility and not supported anymore Var41 Var42 DefaultAuthentication EnablelAP True Establishes which level of SSP authentication is enabled Possible values are 4 SSP Just works or 5 SSP pairing modes with MITM protection by asking for a confirmation message during pairing Enables IAP mode to support iOS devices Var43 AllowSniff False Enables sniff mode Must be False when no 32 768KHz LPO is pr
13. version 1 5 37 AT2 FW version 1 6 system configuration settings version 1 5 40 AT2 FW version 1 6 system configuration settings version 1 5A 44 Document revision history 0 0 eae 50 DoclD023232 Rev 5 7 51 Definition and acronyms UM1547 1 Definition and acronyms The following table lists the acronyms used in this document Table 1 Definitions and acronyms Term Description meaning ASCII American standard code for information interchange a standard describing encoding of characters the use in this document is strictly US 7 bit BD Bluetooth device Modem signal data carrier detect indication from a modem that a connection has DCD been made through for example a dial up connection DTE Data terminal entity e g a computer DTR Modem signal data terminal ready indication to a modem that the data terminal is ready for a connection DUN Dial up networking profile GPIO General purpose input output IAP iPOD accessory protocol LAN Local area network PIN Personal identification number SPP Serial port profile UART Universal asynchronous receiver transmitter 4 8 51 DoclD023232 Rev 5 UM1547 Overview 2 2 1 Overview This chapter gives a basic overview of the AT and AT2 libraries which include a set of commands described in detail in Section 3 Appendix A describes the tw
14. 01234567 12949676901234567 4 5 ErrNumParam The ErrNumParam error response will be sent if there are too few parameters for the requested command A command sent with too many parameters does not generate an error instead the extra parameters are ignored Note Some commands will accept a variable number of parameters 30 51 Examples of commands that produce this error response are given in the following table 2 DoclD023232 Rev 5 UM1547 Error responses Table 7 Example commands that generate lt ErrNumParam gt Example Reason AT AB Sniff The minimum number of parameters was not specified 4 6 ErrUnknownCmd The ErrUnknownCmd error response will be sent if the requested command is not recognized The unrecognized command will be echoed back to the host Any parameters given will be ignored AT AB ErrUnknownCmd unrecognized command An accepted command always starts with the command identifier AT AB 4 7 ErrinProgress ErrlnProgress is sent in response to the Discovery command being issued when the previous one is still in progress AT AB Discovery unrecognized command Examples of commands that produce this error response are given in the following table Table 8 Example commands that generate ErrlnProgress Trying to issue the Discovery command when the previous one has not AT AB Discovery completed DoclD023232 Rev 5 31 51 Other responses UM1547 5 5 1 5 2 5 3 Note
15. 1 2 system configuration settings version 1 2 continued Variable Name Default Description Default security mode should be 1 for no Var39 DefaultSecurity 1 security or 4 for authentication required Modes 2 and 3 are used for legacy compatibility Establishes which level of SSP authentication is Var40 DefaultAuthentication 4 enabled Possible values are 4 SSP Just works or 5 SSP pairing modes with MITM protection A 2 AT2 FW version 1 3 Table 10 AT2 version 1 3 system configuration settings version 1 4 Variable Name Default Description Var01 BuildVersion xxxxxxx IDPS Date code software was built Var03 BD_ADDR 00043e212345 Bluetooth device address read only Var04 DeviceName Amp ed Up Code used for secure connection Up to 20 characters are allowed case sensitive When true hardware RTS CTS flow control is Var05 StreamingSerial T us disabled and data not able to be transmitted 9 over the link will be discarded When false RST CTS flow control is enabled Var06 PIN 1234 Code used for pairing Up to 16 characters are allowed case sensitive Var07 UartBaudrate 115200 Main UART baud rate 1200 to 921 600 baud Var08 UartParity None Main UART parity Var09 UartDataBits 8 Main UART data bits per character Var10 UartStopBits 1 Main UART number of stop bits Timeout used to determine the end of a Var11 UartTimeout 16 message in units of bit times from
16. 8 to 128 are allowed This enables the sniff feature when the link is Wave unm False inactive automatically Var13 AutoSniffTimeout 5 The inactivity timeout in seconds used for AutoSniff above Var14 AutoSniffInterval 1000 Sniff Slot interval applied AutoSniff Var15 iuis uL True Enables shallow sleep mode Var16 HostDeepSleepEnable False Enables deep sleep mode GPIO register used to prevent the module from Var17 GPIO HostKeepAwake None entering deep sleep mode A setting of none means that this function is disabled 4 DoclD023232 Rev 5 35 51 FW configuration variables UM1547 Table 10 AT2 version 1 3 system configuration settings version 1 4 continued Variable Name Default Description GPIO register used to wake up the module after Var18 GPIO HostWakeup None it enters deep sleep mode A setting of none means that this function is disabled If true only DM1 DH1 DM3 DH3 packets are sapa UsesinellPacker False allowed on a link EDR is disabled Var20 EnableAFH True Enable Disable the Adaptive Frequency Hopping mode Var21 EnablePowerControl True Enable Disable the Bluetooth Dynamic power control feature Var22 HostFlowControl 0 Reserved for future usage Sets the AT command reply prefix All events Var23 ATReply AT AB that are displayed are prefixed by this character string case sensitive Sets the Quality of Service
17. D023232 Rev 5 Ly UM1547 AT command list Table 2 AT command list summary continued AT FW version AT2 FW version AT2FW version AT2FW version AT2 FW version Command V1 2 system V1 3 system V1 3 system V1 6 system V1 6 system configuration configuration configuration configuration configuration 1 2 1 3 1 5 1 5 1 5A HostEvent S S S S S IAPConnect NS New S S S IAPDisconnect NS New S S S LinkDisconnect S S S S LocalName S S S S PassKeyAccept NS New New S S PortDisconnect S NS NS NS NS ReadClock NS NS New S S Reset S S S S RoleSwitch S S S S S ShowConnection NS NS NS New S ShowDev S S S S S SmartCableSetup S S S S S Sniff NS S S S S SPPConnect S S S S S SPPDisconnect S S S S S StreamingSerial S S S S S UpdatelnquiryScan S S S S S UpdatePageScan S S S S S Version S S S S S The following subsections describe each of these commands in detail including a description of behavior syntax including possible parameter values and types of responses Some responses will not be immediate Where applicable these will be noted and will include an approximate delay before response For commands with optional parameters all possible forms will be listed under the syntax subsection Error responses are described in Section 4 DoclD023232 Rev 5 11 51 AT command list UM1547 3 1 3 1 1 3 1 2 3 2 3 2 1 3 2 2 3 3
18. EnableBond BD addr PIN timeout Where BD addr is the BD address of the remote device with which to bond PIN is the PIN code to use up to 16 characters and timeout is the duration of the timeout in seconds 1 to 1000 3 16 2 Responses If the operation is successful the response is AT AB BondEnabled If bonding has been initiated by a remote device the notification is AT AB BondPending BD addr where BD addr is the BD address of the remote device that initiated the bonding If bonding has occurred the notification is AT AB BondOk BD addr where BD addr is the BD address of the remote device with successful bonding If bonding was initiated by a remote device but failed the notification is AT AB BondFail When the time limit for bonding has expired the notification is AT AB BondDisabled 3 17 EraseBondTable The EraseBondTable command is used to erase all of the bonded device entries Single devices cannot be erased with this command 3 17 1 Syntax AT AB EraseBondTable 3 17 2 Responses If the operation is successful the response is AT AB BondTableErased 3 18 ExitSniff The ExitSniff command is used by AT2 FW to switch a device from sniff mode to active mode DoclD023232 Rev 5 19 51 AT command list UM1547 3 18 1 3 18 2 3 19 3 19 1 3 19 2 3 20 3 20 1 3 20 2 3 21 3 21 1 20 51 Syntax AT AB ExitSniff BD address Where BD address is the BD address of the device to be switche
19. IO Pin is the pin number of the desired GPIO to read The GPIO numbering depends on the specific HW used Setting is a 1 to set a pin to high and a 0 to set a pin to low 3 22 2 Responses If the operation is successful the response is AT AB GPIOWriteDone 3 23 HostEvent The HostEvent command is used to enable disable the host notification strings This will override the default setting in the dynamic configuration only for the current session until reset 3 23 1 Syntax AT AB HostEvent Enable Disable Where Enable Disable is an e or E character to enable this parameter and a d or D character to disable it 3 23 2 Responses If the feature is successfully enabled the response is AT AB HostEvent Enabled If the feature is successfully disabled there is no response because the events have been disabled DoclD023232 Rev 5 21 51 AT command list UM1547 3 24 3 24 1 3 24 2 3 25 3 25 1 3 25 2 3 26 3 26 1 3 26 2 22 51 IAPConnect The IAPConnect command is used by AT2 FW to initiate a connection with the specified Apple iOS device The remote BD address must be specified Syntax AT AB IAPConnect BD Addr Where BD Addr is the iOS remote device s BD address to page Responses If the connection is successful the response is AT AB ConnectionUp Remote BD Addr AT AB iAP BypassMode If the connection cannot be completed the response is AT AB iAPConnectionClo
20. Latency from 3 to 20 sales QoS_Latency a slots A slot size is 625 microseconds Sets the module s CPU speed 2 4 8 12 16 Var25 CpuMHz 32 20 24 28 32 36 and 64 MHz are allowed Note CpuMHz 40 to 63 are not supported Baud rate of the HCI interface to the Bluetooth Var26 HciBaudrate 921600 controller 230 400 460 800 921 600 and 2 000 000 baud are allowed Var27 SPlEnable False Enables the SPI interface to external pins Var28 SPIMode Slave Mode of the SPI 2 Var29 I2CEnable False Enables the I C interface to external pins Note not supported Var30 COD 240404 Bluetooth Class of Device Var32 HostEvents True All host events are sent when true Var33 BondingAllowed True ie allow bonding by default when Var34 PageScan True Enables page scan when true or halts page scan when false Var35 InquiryScan Tis Enables inquiry scan when true or halts inquiry scan when false Var36 MPMode 0 0 point to point 1 multipoint using packet protocol 2 broadcast Var37 UseExtLPO False True whena 32 768 kHz low power oscillator is present and false if not present Var38 HSE MHz 13 MHz rating of the main crystal oscillator Read only Var39 EnableEncryption TRIS Set to true to enable the Bluetooth link encryption 36 51 DoclD023232 Rev 5 4 UM1547 FW configuration variables Table 10 AT2 version 1 3 system configuration settings version 1 4 continued
21. PIO 5 SDA and GPIO 6 SCL are used when true instead of RTS CTS control lines Var57 AccName Amped Test Apple accessory name field Up to 20 characters are allowed See Apple MFI documentation for further details Var58 AccManufacturer Amped RF Apple accessory manufacturer field Up to 20 characters are allowed See Apple MFI documentation for further details Var59 AccModelNumber Test Model Apple accessory model number field Up to 20 characters are allowed See Apple MFI documentation for further details Var60 A 3 AccSerialNumber AT2 FW version 1 6 Amp ed Up Apple accessory serial number field Up to 20 characters are allowed See Apple MFI documentation for further details Table 12 AT2 FW version 1 6 system configuration settings version 1 5 Variable Name Default Description Var01 BuildVersion 140124C IDPS Data code software was build read only Var03 BD_ADDR 0080e1fe54g3 Bluetooth device address read only Var04 DeviceName Amp ed Up Code used for secure connection Up to 20 characters are allowed case sensitive When true hardware RTS CTS flow control is f disabled and data not able to be transmitted varos SiteamingSeriai True over the link will be discarded When false RST CTS flow control is enabled Var06 PIN 1234 Code used for pairing Up to 16 characters are allowed case sensitive Var07 UartBaudrate
22. Reconnect 3 121 Syta i ool RR due BREER Rd 3 12 2 Responses DeleteSmartCable 3 13 1 Syntax 3 13 2 Responses iss EER RE cee Ee kke Disable BOND 3 14 1 Syntax 3 14 2 Responses DISCOVEY Loses Ah EE ERENS RS dee ER N MEE E kins 3 15 1 Syntax coco 3 15 2 Responses iss EER RE ER EE eee EnableBond 3 16 1 Syntax sese na idee ed begs HE EER vie Red 3 16 2 Responses MWAI eee EraseBondTable 3171 Syntax 2205 soos bre de 3 47 2 Responses Ee EXIM ag dos ud gore ar dcc oir d actae 3 18 1 Syntax ii II 3 18 2 Responses seeeeseees GelBDAddress 3 19 1 Syntax 3 19 2 Responses GPIOConfig 3 20 1 Syntax UA KWA Kaa 3 20 2 BESDEI AWA GPIORead IA AAA S214 SU cir a IA 3 21 2 Responses mwm GPIOWrite 3 22 1 ES A DoclD023232 Rev 5 Contents UM1547 4 51 3 23 3 24 3 25 3 26 3 27 3 28 3 29 3 30 3 31 3 32 3 33 3 34 3 22 2 Responses HostEvent 3231 ES AA Aa 3 23 2 Responses
23. Switch bd address role where e bd address is the address of the remote device that will receive the role switch e role is the new role of the local device 0 Master 1 Slave DocID023232 Rev 5 Ly UM1547 AT command list 3 33 3 33 1 3 33 2 3 34 3 34 1 3 34 2 3 35 3 35 1 ShowConnection This command is used to display the details of active links Syntax at ab ShowConnection Responses Reply format with active connection Channel ID Remote Device BD Address Status Profile 0 4cb199dccd22 Connected IAP Reply without active connection No Device Connected ShowDev The ShowDev command is used to list the contents of the Bond Table Syntax AT AB ShowDev Responses This command returns the list of all the devices bonded identified by their BD address SmartCableSetup The SmartCableSetup command is used to enable and configure a Smart Cable device A device s BD address is specified in order to automatically establish a connection replacing the need for AT connection commands This command will override the dynamic configuration of a Smart Cable device until the DeleteSmartCable command is issued it is saved in non volatile memory Syntax AT AB SmartCableSetup BD address Attempts Interval Where BD address is the BD address of the remote device to page and attempt to connect Attempts 0 999 is the number of pages that will be attempted to the specified device un
24. T AB PassKeyAccept y Example for denying confirmation AT AB PassKeyAccept n Responses If the operation is successful the module enters in bypass mode and it is automaticaly bonded or connected PortDisconnect The PortDisconnect command is used to terminate a connection with the remote device port handle it is supported by AT FW Syntax AT AB PortDisconnect Responses If the operation is successful the response is AT AB ConnectionDown DoclD023232 Rev 5 23 51 AT command list UM1547 3 30 3 30 1 3 30 2 3 30 3 3 30 4 3 31 3 31 1 3 31 2 3 32 3 32 1 24 51 ReadClock This command reads the piconet clock of the local or remote device Syntax AT AB ReadClock Responses Local clock Clock Local BDAddress clock output in HEX Syntax AT AB ReadClock Remote Address Responses Remote device clock Clock Remote BDAddress clock output in HEX Reset The Reset command is used to reset the ATn FW interface This is provided in the event that a host application wants to perform a software reset for error recovery There is a response prior to reset in order to verify that the command was received by the ATn FW interface A reset requires 1 6 seconds Syntax AT AB Reset Responses If the operation is successful the response is AT AB Reset Pending RoleSwitch The RoleSwitch command is used to change a link from to a Master or Slave role Syntax at ab Role
25. TO sie AAR EE IE EL da RE 12 3 1 1 SN 12 3 1 2 RESPONSES i s ea nek EER Ne pee dd oe o Rx CR dos 12 3 2 AutoReconnectSetup Beta version 12 3 2 1 SE A MO ML OE AR TE E 12 3 2 2 pier qe Em 12 3 3 BOD ER xai uoa ET N HOE ad 12 3 3 1 Sco MT 12 3 3 2 pcr ni mE 13 3 4 DICVEISIOD suecia en eh ouod AO Rep Eq EA einen 13 3 4 1 Snc err 13 3 5 Builders ESE RE SEIN EUREN EE mt rua pA 13 3 5 1 Sc AA Er 13 3 5 2 RESPONSES seer ER EER ER KERR ER ER PEE DERE Re eh EN Rr 13 3 6 Ee EE EE EE OR HE WA 13 3 6 1 EA EE OE OE RE EE ER 13 3 6 2 RESPONSES io rx pu RR EE POUR E ERU ANT Ron dei EES 13 3 7 ChangeBaud 14 3 7 1 A tia c bed e aki aa ER ERU RR ROO Metta ae 14 3 7 2 RESPONSES EE Ron UR RR OUR Pia Se nee EER 14 3 8 ChangeDefaultBaud 14 3 8 1 DIE AA RA OE OO OR e dar ip doe Ba e rre 15 3 8 2 RESPONSES isse sete e rae a OE dioe Ee iad Sele oe e Ron RR 15 OO es o PPP e A IA 15 3 9 1 hr aret 15 3 10 Cptest 15 10 US Lisci iit Wa KA wheal ae ee EPOR ae 15 2 51 DocID023232 Rev 5 Ly UM1547 Contents 3 11 3 12 3 13 3 14 3 15 3 16 3 17 3 18 3 19 3 20 3 21 3 22 3 10 2 Responses DefaultLocalName QI SYNTAX uas na a re ed ao eN 3 11 2 Responses EER EE ER ee eee DeleteAuto
26. a command text terminated by a carriage return or line feed that does not match the expected format starting with AT AB Examples of commands that produce this error response are given in the following table Table 5 Example commands that generate lt ErrFormat gt Example Reason AT AB discovery A valid command name that does not start with the right prefix SPPConnect 000438000000 A command that does not start with AT AB abcdef A command that does not start with AT AB ErrinvalidParam The ErrlnvalidParam error response will be sent if the parameters for the requested command are not correct The parameter s will be echoed back to the user starting from the parameter that was rejected Examples of commands that produce this error response are given in the following table Table 6 Example commands that generate sErrinvalidParam AT AB SPPConnect 8136 Example Response Reason Numeric parameter not specified with required number ATAB EminyalioParam of digits BD address must always be 12 hex AT AB ChangeBaud 1600 oe characters AT AB SPPConnect AT AB ErrlnvalidParam Unrecognized or unsupported symbolic parameter 000436008136 GOEP goep used AT AB ErrlnvalidParam Numeric parameter is out of range specified baud rate 1600 is not supported by command AT AB EnableBond 00043e000000 ALAB Ene are String parameter PIN has too many characters 123456789
27. allow bonding by default when true Var34 PageScan True Enables page scan when true or halts page scan when false Var35 InquiryScan Tre Enables inquiry scan when true or halts inquiry scan when false Var36 MPMode 0 0 point to point 1 multipoint using packet protocol 2 broadcast Var37 UseExtL PO False True when a 32 768 kHz low power oscillator is present and false if not present Var39 EnableEncryption True Set to true to enable the Bluetooth link encryption Default security mode should be 1 for no security or 4 for Authentication required Modes 2 and 3 Nardo DefaultSecurity 4 are used for legacy compatibility and not supported anymore Establishes which level of SSP authentication is m enabled Possible values are 4 SSP Just works verti Bela ente oH 5 or 5 SSP pairing modes with MITM protection by asking for a confirmation message during pairing 42 51 DoclD023232 Rev 5 Ly UM1547 FW configuration variables Table 12 AT2 FW version 1 6 system configuration settings version 1 5 continued Variable Name Default Description Var42 EnablelAP True Enables IAP mode to support iOS devices Enables sniff mode Must be False when no varas AllewsoNt False 32 768KHz LPO is present Apple MFI application ID Up to 10 characters are Var44 iAPAppID A123CDFG445 allowed See Apple MFI documentation for further details Main connecting string for an Apple MFI Var45 iAPProtocolSt
28. ble 26 DocID023232 Rev 5 Ly UM1547 AT command list 3 8 1 3 8 2 3 9 3 9 1 3 10 3 10 1 Syntax AT AB ChangeDefaultBaud rate where rate is the new baud rate e 1200 e 2400 e 4800 e 9 600 e 19 200 e 38 400 e 57 600 e 115 200 e 230 400 e 460 800 e 921 600 e 2 000 000 Responses If the change is accepted the response is AT AB Baudrate Changed Config The Config command is used to set a configuration variable Syntax AT AB Config variable name variable value The list of configuration variables is shown in Appendix A Cptest The Cptest command allows to verify the connection of the MFI chipset Syntax at ab cptest DoclD023232 Rev 5 15 51 AT command list UM1547 3 10 2 3 11 3 11 1 3 11 2 3 12 3 12 1 3 12 2 16 51 Responses If the coprocessor chipset is correctly connected the output of the command gives infos versions and ID about the coprocessor Example e CP Device Version 0x03 e CP Firmware Version 0x01 e CP Authentication protocol Major version 0x02 e CP Authentication protocol Minor version 0x00 e CP Device ID 0x00000200 When the coprocessor is not connected or badly connected the output of the command is CP Data Fail or CP Address Fail DefaultLocalName The DefaultLocalName command is used to set the name of the device to the name that is reported during device discoveries By default the ATn FW interface
29. d OutMtu must match each other Var59 AccName Amped Test Apple accessory name field Up to 20 characters are allowed See Apple MFI documentation for further details Var60 Var61 AccManufacturer AccModelNumber Amped RF Test Model Apple accessory manufacturer field Up to 20 characters are allowed See Apple MFI documentation for further details Apple accessory model number field Up to 20 characters are allowed See Apple MFI documentation for further details Var62 Var63 AccSerialNumber EnableSPPRcv Amp ed Up False Apple accessory serial number field Up to 20 characters are allowed See Apple MFI documentation for further details Enable or disable data receiving from remote SPP devices while in CommandMode Var64 EnablelAPRcv False Enable or disable data receiving from remote IAP devices while in CommandMode Table 13 AT2 FW version 1 6 system configuration settings version 1 5A Description Data code software was build read only Variable Name Default Var01 BuildVersion 141115C IDPS Var03 BD ADDR 0080e1fe54g3 Var04 DeviceName SPBTmod Bluetooth device address read only Code used for secure connection Up to 20 characters are allowed case sensitive 44 51 DoclD023232 Rev 5 2 UM1547 FW configuration variables Table 13 AT2 FW version 1 6 system configuration settings version 1 5A continu
30. d to active mode Responses If the operation is successful the response is AT AB ActiveMode GetBDAddress The GetBDAddress command is used to read the local device s Bluetooth device address or MAC address Syntax AT AB GetBDAddress Responses If the operation is successful the response is AT AB BD ADDR BD address GPIOConfig The GPIOConfig command is used to configure a GPIO pin to input or output Syntax AT AB GPIOConfig GPIO Pin Configuration where GPIO Pin is the pin number of the desired GPIO to configure The GPIO numbering depends on the specific HW used Configuration is i or I for input and o or O for output Responses If the operation is successful the response is AT AB GPIOConfigDone GPIORead The GPIORead command is used to read a GPIO pin A GPIO may be read while configured as either an input or output Syntax AT AB GPIORead GPIO Pin 4 DoclD023232 Rev 5 UM1547 AT command list where GPIO Pin is the pin number of the desired GPIO to read The GPIO numbering depends on the specific HW used 3 21 2 Responses If the operation is successful the response is AT AB GPIOReadDone result Where result is either a 1 to indicate high or 0 to indicate low 3 22 GPIOWrite The GPIOWrite command is used to set a GPIO pin to high or low A GPIO may only be set when configured as an output 3 22 1 Syntax AT AB GPIOWrite GPIO Pin Setting where GP
31. dPTC 1 be set to false KYI DoclD023232 Rev 5 49 51 Revision history UM1547 6 50 51 Revision history Table 14 Document revision history Date Revision Changes 08 Jun 2012 1 Initial release Modified Introduction Added in Table 2 cptest and role switch 23 Jul 2012 2 Added in Table 9 Var40 and 41 Added Section 3 4 3 10 1 3 10 2 3 32 3 32 1 Added in Table 10 Var51 11 Nov 2013 3 Added Table 11 Added Table 12 01 Sep 2014 Moditigd Section ad AutoReconnectSetup Beta version Minor text corrections throughout the document Corrected version number error in the footer of each page 24 Mar 2015 5 Added Table 13 2 DoclD023232 Rev 5 UM1547 IMPORTANT NOTICE PLEASE READ CAREFULLY STMicroelectronics NV and its subsidiaries ST reserve the right to make changes corrections enhancements modifications and improvements to ST products and or to this document at any time without notice Purchasers should obtain the latest relevant information on ST products before placing orders ST products are sold pursuant to ST s terms and conditions of sale in place at the time of order acknowledgement Purchasers are solely responsible for the choice selection and use of ST products and ST assumes no liability for application assistance or the design of Purchasers products No license express or implied to any intellectual property right is granted by
32. de If sent digit by digit it will not be recognized by the system DocID023232 Rev 5 Ly UM1547 FW configuration variables Appendix A FW configuration variables The system configuration settings for each firmware version are given in the tables that follow In order to set a configuration variable enter at ab config xxxx yyyy where xxxx is the variable name and yyyy is the value to set A variable name could also be specified as varzz where zz is the sequence number of the variable Note All changes require a reset to take effect A 1 AT FW version 1 2 Table 9 AT version 1 2 system configuration settings version 1 2 Variable Name Default Description Var01 BuildVersion XXXXXXX Date code software was built Var03 BD_ADDR 00043e260e73 Bluetooth device address Read only Var04 DeviceName Amp ed Up Code used for secure connection Up to 20 characters are allowed case sensitive When true hardware RTS CTS flow control is disabled and data not able to be transmitted vars StreamingSerial Mug over the link will be discarded When False RST CTS flow control is enabled Var06 PIN 1234 Code used for pairing Up to 16 characters are allowed case sensitive Var07 UartBaudrate 115200 Main UART baud rate 1200 to 921 600 baud Var08 UartParity None Main UART parity Var09 UartDataBits 8 Main UART data bits per character Var10 UartStopBits 1 Main UART number o
33. de of the SPI Not supported 46 51 DoclD023232 Rev 5 Ly UM1547 FW configuration variables Table 13 AT2 FW version 1 6 system configuration settings version 1 5A continued Variable Name Default Description Var29 PCEnable False Enables the I2C interface to external pins Note not supported Var30 COD 240404 Bluetooth Class of Device Var32 HostEvents True All host events are sent when true Var33 BondingAllowed True Automatically allow bonding by default when true Var34 PageScan True Enables page scan when true or halts page scan when false Var35 InquiryScan TRE Enables inquiry scan when true or halts inquiry scan when false 0 point to point 1 multipoint using packet varge MF M9ds d protocol 2 broadcast Var37 UseExtLPO False True when a 32 768 kHz low power oscillator is present and false if not present Var39 EnableEncryption True Set to true to enable the Bluetooth link encryption Default security mode should be 1 for no security Var40 DefaultSecurity 4 or 4 for Authentication required Modes 2 and 3 are used for legacy compatibility and not supported anymore Establishes which level of SSP authentication is Var41 DefaultAuthentication 5 enabled Possible values are 4 SSP Just works or 5 SSP pairing modes with MITM protection by asking for a confirmation message during pairing Var42 EnablelAP True Enables IAP mode to support iOS devices Ly DoclD023232 Re
34. disabled and data not able to be transmitted verde Steamingearial Tug over the link will be discarded When false RST CTS flow control is enabled Var06 PIN 1234 Code used for pairing Up to 16 characters are allowed case sensitive Var07 UartBaudrate 115200 Main UART baud rate 1200 to 921 600 baud Var08 UartParity None Main UART parity None Even Odd Main UART data bits per character With Var09 UartDataBits 8 Even Odd parity this must be 9 data bits to include 1 bit of parity Var10 UartStopBits 1 Main UART number of stop bits 1 or 2 Timeout used to determine the end of a Var11 UartTimeout 16 message in units of bit times from 8 to 128 are allowed 4 DoclD023232 Rev 5 37 51 FW configuration variables UM1547 Table 11 AT2 FW version 1 3 system configuration settings version 1 5 continued Variable Name Default Description This enables the sniff feature when the link is Var12 AutoSniff False inactive automatically Var13 AutoSniffTimeout 5 The inactivity timeout in seconds used for AutoSniff above Sniff Slot interval applied AutoSniff from 200 to vais AnloShiimanal 1990 10 000 are allowed 0 625 ms per slot Var15 HostShallowSleepEnable True Enables shallow sleep mode Var16 HostDeepSleepEnable False Enables deep sleep mode GPIO register used to prevent the module from entering deep sleep mode A setting of none varii OP elkeen Wee Nong means tha
35. ed Variable Name Default Description When true hardware RTS CTS flow control is Var05 s TOUT T disabled and data not able to be transmitted id oe e over the link will be discarded When false RST CTS flow control is enabled Var06 PIN 1234 Code used for pairing Up to 16 characters are allowed case sensitive Main UART baud rate 1200 to 2Mbaud as Var07 UartBaudrate 115200 general rule the UART baud rate must be lower than the HCI baud rate set in the variable 26 Var08 UartParity None Main UART parity None Even Odd Main UART data bits per character With Var09 UartDataBits 8 Even Odd parity this must be 9 data bits to include 1 bit of parity Var10 UartStopBits 1 Main UART number of stop bits 1 or 2 Timeout used to determine the end of a message yanii Srt 16 in units of bit times from 8 to 128 are allowed Var12 AutoSniff False This enables the sniff feature when the link is inactive automatically The inactivity timeout in seconds used for Var13 AutoSniffTimeout 5 AutoSnif above Sniff Slot interval applied AutoSniff from 200 to yarig ea 1090 1000 are allowed 0 625 ms per slot Var15 HostShallowSleepEnable True Enables shallow sleep mode Var16 HostDeepSleepEnable False Enables deep sleep mode 4 DoclD023232 Rev 5 45 51 FW configuration variables UM1547 Table 13 AT2 FW version 1 6 system configuration settings version 1 5A continued
36. esent Var44 iAPAppID A123CDFG445 Apple MFI application ID Up to 10 characters are allowed See Apple MFI documentation for further details Var45 Var46 iAPProtocolStrMain iAPProtocolStrAlt com Demo com Protocol Alt Main connecting string for an Apple MFI Application Up to 25 characters are allowed See Apple MFI documentation for further details Alternative connecting string for the Apple MFI Application Up to 25 characters are allowed See Apple MFI documentation for further details Var47 Var48 CPI2CMode SPP128UUID True Apple CP Chip 12C address mode 2 or 3 Apple CP v2 0C should default to 3 See Apple CP documentation for further details This variable enables the 128 bit UUID for the SPP profile Var51 RmtEscapeSequence False Remote escape sequence enabled Var53 CreditMax Number of buffers available for incoming data packets Var54 4 PageScanlnterlaced False DoclD023232 Rev 5 Enables the Bluetooth interlaced scan mode 39 51 FW configuration variables UM1547 Table 11 AT2 FW version 1 3 system configuration settings version 1 5 continued Variable Var55 Name MITMEvent Default False Description Sends pairing passkey to the main UART User must input at ab passkeyaccept in order to complete pairing Var56 AltCPGPIO False Alternate Apple CP pins G
37. eteSmartCableDone 3 14 DisableBond The DisableBond command is used to deny new bonding with a device This command cannot be used while a connection is active 3 14 1 Syntax AT AB DisableBond 3 14 2 Responses If the operation is successful the response is AT AB BondDisabled 3 15 Discovery The discovery command is used to initiate a device discovery The command will return the number of responses of nearby devices and then the individual responses with BD address and name of device The number of devices returned is limited to 10 Inquiry is performed with an interval of 10 24 seconds The devices are reported in the same order as the original inquiry results 3 15 1 Syntax AT AB Discovery COD filters DoclD023232 Rev 5 17 51 AT command list UM1547 3 15 2 3 16 18 51 The discovery COD optional parameters are listed here below miscellaneous computer phone lan peripheral imaging wearable toy health Responses When the discovery command has been accepted the response is AT AB InqPending Once the initial inquiry is complete and discovery has been started the response is AT AB DiscoveryPending num where num is the number of devices found in decimal up to 10 will be reported For each name request that is successful the response uses the returned names in the following format AT AB Device BD addr name where BD addr is in hexadecimal with the most signi
38. f stop bits Timeout used to determine the end of a Var11 UartTimeout 44 message in units of bit times from 8 to 128 are allowed Vari2 AutoSniff False This enables the sniff feature when the link is inactive automatically Var13 AutoSniffTimeout 5 The inactivity timeout in seconds used for AutoSniff above Var14 AutoSniffInterval 1000 Sniff Slot interval applied AutoSniff Var15 HostDeepSleepEnable False Enables deep sleep mode GPIO register used to prevent the module from Var16 GPIO HostKeepAwake None entering deep sleep mode A setting of none means that this function is disabled GPIO register used to wake up the module after Var17 GPIO HostWakeup None it enters deep sleep mode A setting of none means that this function is disabled 4 DoclD023232 Rev 5 33 51 FW configuration variables UM1547 Table 9 AT version 1 2 system configuration settings version 1 2 continued Variable Name Default Description If true only DM1 DH1 DM3 DH3 packets are varig UseSmaliPaskeis False allowed on a link EDR is disabled Var19 EnableAFH Ti e Enable disable the adaptive frequency hopping mode Var20 EnablePowerControl False Enable disable the Bluetooth dynamic power control feature Var21 HostFlowControl 0 Reserved for future usage Sets the AT command reply prefix All events Var22 ATReply AT AB that are displayed are prefixed by this charac
39. ficant byte first name is a string in double quotes For each unsuccessful name request the corresponding name is replaced by Unknown The name request may not be successful if unable to make a connection for the request AT AB Device BD addr Unknown EnableBond The EnableBond command is used to enable bonding with another device The BD address PIN and timeout parameters are optional When no BD address is specified requests from all BD Addresses are allowed If a BD address is specified bonding requests from devices with BD Addresses other than the one specified will fail and the existing link key will be deleted for that device Optionally a PIN code may be entered with this command If no PIN code is specified the default PIN code will be used Also a timeout value in seconds may be entered after the PIN code Bonding will be disabled automatically after the requested timeout If no timeout is specified bonding is enabled until reset or until the DisableBond command is used If this command is issued multiple times only the last PIN and BD address are saved Also if this command is issued before the first timeout occurs the subsequent command will extend the timeout The timeout is always set to the specified time beyond the last received EnableBond DocID023232 Rev 5 Ly UM1547 AT command list 3 16 1 Syntax AT AB EnableBond AT AB EnableBond BD addr AT AB EnableBond BD addr PIN AT AB
40. ful the response is AT AB ConnectionUp Remote BD Addr AT AB BypassMode If the connection cannot be completed the response is AT AB SPPConnectionClosed SPPDisconnect The SPPDisconnect command is used to terminate a connection with the remote device In Multipoint or Broadcast mode the master can disconnect a specific node by its ID 0 1 2 Syntax AT AB SPPDisconnect DocID023232 Rev 5 Ly UM1547 AT command list 3 38 2 3 39 3 39 1 3 39 2 3 39 3 3 40 3 40 1 3 40 2 AT AB SPPDisconnect Slave ID Responses If the connection is successful the response is AT AB SPPConnectionClosed StreamingSerial Syntax AT AB StreamingSerial Enable Disable Where Enable Disable is an e or E character to enable this parameter and a d or D character to disable it Streaming Serial will disable the RTS CTS hardware flow control and discard non transmitted data when enabled RTS CTS flow control is enabled when Streaming Serial is disabled Query An alternative syntax may be used to query the current StreamingSerial feature status This syntax is not supported by other commands AT AB StreamingSerial Responses If the feature is successfully applied or queried the response is AT AB StreamingSerial Enabled Disabled UpdatelnquiryScan The UpdatelnquiryScan command is used to modify the Inquiry scan parameters mode duration and interval Syntax AT AB UpdateInquiryScan
41. mode duration interval where mode is the discoverable mode e 0 non discoverable e 1 limited discoverability not supported e 2 discoverable duration is the scan length in slots 18 to 4096 The default duration is 18 slots interval is the period between scans in slots 18 to 4096 The default interval is 2048 slots Responses If the command is successful the response is AT AB InquiryScanUpdateDone DoclD023232 Rev 5 27 51 AT command list UM1547 3 41 3 41 1 3 41 2 3 42 3 42 1 3 42 2 28 51 UpdatePageScan The UpdatePageScan command is used to modify the Page scan parameters mode duration and interval Syntax AT AB UpdatePageScan mode duration interval where mode is the connectable mode e 0 non connectable e 1 connectable duration is the scan length in slots 18 to 4096 The default duration is 18 slots interval is the period between scans in slots 18 to 4096 The default interval is 2048 slots Responses If the command is successful the response is AT AB PageScanUpdateDone Version The version command is used to return the current version of the ATn FW interface Syntax AT AB Version Responses If the operation is successful the response is AT AB ATn FWVer x y where x y is the current version of the ATn FW interface 4 DoclD023232 Rev 5 UM1547 Error responses 4 Error responses This chapter details the err
42. o sets of configuration variables relevant to AT and AT2 FW versions The AT and AT2 FW are third party IPs developed by Amp ed RF AT command FW interface overview The AT command FW is a cable replacement application that provides communication between Bluetooth enabled devices A serial port is used to communicate with a host device through an AT command interface as shown below Figure 1 Communication between hosts Host Bluetooth Bluetooth device AT Cmds device device AM12315v1 The AT command FW provides the following basic features e AT2 FW supports point to point and multipoint connections while AT FW supports only point to point connections e Serial port profile SPP is supported for both client and server applications e iPOD accessory protocol IAP is supported only by AT2 FW enabling communication with Apple iOS Bluetooth enabled devices e Command and bypass modes it is possible to switch between command and bypass data transmit receive modes during an active connection e Security bonding and data encryption provides a secure link between two devices e Power conservation use of the Sniff feature to minimize power consumption is supported only with AT2 FW e Variable baud rates the serial port can be configured for the following baud rates 1200 2400 4800 9600 19 2k 38 4k 57 6k 115 2k default 230 4k 460 8k 921 6k 2M as general rule the UART baud rate must be lowe
43. one Syntax AT AB Bond BD Addr PIN Where BD addr is the BD address of the remote device with which to bond and PIN is the PIN code to use up to 16 characters DocID023232 Rev 5 Ly UM1547 AT command list 3 3 2 3 4 3 4 1 3 5 3 5 1 3 5 2 3 6 3 6 1 3 6 2 Responses If the request is successfully submitted the response is AT AB BondPending Remote BD Addr If the operation is successful the response is AT AB BondOk If the operation fails the response is AT AB BondFail BtcVersion The BtcVersion command is used to return the current ID of the Bluetooth controller chip Syntax AT AB BtcVersion Build The Build command is used to return the current build ID of the application firmware Syntax AT AB Build Responses If the operation is successful the response is AT AB ATn FW Build date where date is the date code of the application firmware Bypass The bypass command is used to return the ATn FW interface to the bypass mode if a connection is still available A possible use for this command is to change a setting after a connection has been made such as the UART baud rate If the ATn FW interface does not have a connection it will respond as if the connection is down Syntax AT AB Bypass Responses If a connection is still available the response is AT AB BypassMode DoclD023232 Rev 5 13 51 AT command list UM1547 3 7 3 7 1
44. or responses that occur under specific circumstances There are seven error responses that can occur beyond error responses specific to a particular command e g Discovery They are e ErrConnect e ErrExecute e ErrFormat e ErrnvalidParam e Er NumParam e ErrUnknownCmd e ErrinProgress The following subsections detail the different error responses These error responses replace the original error response AT AB ErrorCommand 4 1 ErrConnect The ErrConnect error response will be sent if ATn FW has a valid connection established and the command cannot be executed while connected even in the command mode Examples of commands that produce this error response are given in the following table Table 3 Example commands that generate lt ErrConnect gt Example Reason AT AB Discovery Performing a device discovery while a connection already exists AT AB SPPConnect 00043e000000 Establishing a connection to a device while a connection exists with another 4 2 ErrExecute The ErrExecute error response will be sent if the command cannot complete for any reason Examples of commands that produce this error response are given in the following table Table 4 Example commands that generate ErrExecute Example Reason AT AB Sniff Execution of sniff while the device is not connected DoclD023232 Rev 5 29 51 Error responses UM1547 4 3 4 4 ErrFormat The ErrFormat error response will be sent if ATn FW receives
45. r than the HCI baud set in the variable 26 DoclD023232 Rev 5 9 51 AT command list UM1547 3 AT command list This chapter details each of the AT commands including brief descriptions of behavior syntax of the command context of the command and types of responses This AT command FW reference guide covers the commands listed in Table 2 The table compares the AT FW release to the new AT2 FW pointing out additional features Table key e S command is supported in this release e NS command is not supported in this release e New command is introduced with this release Table 2 AT command list summary AT FW version AT2 FW version AT2FW version AT2FW version AT2 FW version Command V1 2 system V1 3 system V1 3 system V1 6 system V1 6 system configuration configuration configuration configuration configuration 1 2 1 3 1 5 1 5 1 5A AutoReconnect NS NS NS New S AutoReconnectSetup NS NS NS New S Bond S S S S S BtcVersion S S S S S Build S S S S S Bypass S S S S S ChangeBaud S S S S S ChangeDefaultBaud S S S S S Config NS New S S S Cptest S S S S S DefaultLocalName NS NS NS New S DeleteAutoReconnect S S S S S DeleteSmartCable S S S S S DisableBond S S S S S Discovery S S S S S EnableBond S S S S S EraseBondTable S S S S S ExitSniff S S S S S GetBdAddress New S S S S GPIOConfig S S S S S GPIORead S S S S GPIOWrite S S S S S 10 51 DocI
46. rMain com Demo Application Up to 25 characters are allowed See Apple MFI documentation for further details com Protocol Alternative connecting string for the Apple MFI Var46 iAPProtocolStrAlt i Alt Application Up to 25 characters are allowed See Apple MFI documentation for further details Apple CP Chip 12C address mode 2 or 3 Apple Var47 CPI2CMode 3 CP v2 0C should default to 3 See Apple CP documentation for further details Var48 SPP128UUID Tiu This variable enables the 128 bit UUID for the SPP profile Var51 RmtEscapeSequence False Remote escape sequence enabled Var53 CreditMax 5 Number of buffers available for incoming data packets max value 8 Var54 PageScanlnterlaced False Enables the Bluetooth interlaced scan mode Sends pairing passkey to the main UART User Var55 MITMEvent False must input at ab passkeyaccept in order to complete pairing Alternate Apple CP pins GPIO 5 SDA and Var56 AltCPGPIO False GPIO 6 SCL are used when true instead of RTS CTS control lines Mtu size for incoming packets for iAP from 150 Var57 InMtuSize 427 to 500 bytes InMtu and OutMtu must match each other 4 DoclD023232 Rev 5 43 51 FW configuration variables UM1547 Table 12 AT2 FW version 1 6 system configuration settings version 1 5 continued Variable Var58 Name OutMtuSize Default 427 Description Mtu size for outgoing packets for iAP from 150 to 500 bytes InMtu an
47. sed IAPDisconnect The IAPDisconnect command is used by AT2 FW to terminate a connection with the remote Apple iOS device Syntax AT AB IAPDisconnect Responses If the connection is successful the response is AT AB iAPConnectionClosed LinkDisconnect The LinkDisconnect command is used to terminate a connection with the remote device s link handle Syntax AT AB LinkDisconnect Responses If the connection is successful the response is AT AB ConnectionDown 4 DoclD023232 Rev 5 UM1547 AT command list 3 27 3 27 1 3 27 2 3 28 3 28 1 3 28 2 3 29 3 29 1 3 29 2 LocalName The LocalName command is used to set the name of the device to the name that is reported during device discoveries By default the ATn FW interface uses Amped UP Changing the name using this command does not permanently change the local name Syntax AT AB LocalName name Where name is a string for the new local name up to 20 characters The space character is allowed the name is assumed to be all text up to the end of the command Responses If the operation is successful the response is AT AB LocalNameOk PassKeyAccept This command is used to accept the MITM confirmation code automatically generated during the bonding phase After setting var55 true it is possible to use this command to complete the paring automatically Syntax AT AB PassKeyAccept y n Example for confirmation A
48. t this function is disabled Typically GPIO 3 amp 5 support this feature GPIO register used to wake up the module after it enters deep sleep mode A setting of none Vd ia GPIO Hostwaksup None means that this function is disabled Typically GPIO 3 amp 5 support this feature If true only DM1 DH1 DM3 DH3 packets are rat UseSinallPackets palpa allowed on a link EDR is disabled Var20 EnableAFH True Enable Disable the Adaptive Frequency Hopping mode Var21 EnablePowerControl True Enable Disable the Bluetooth Dynamic power control feature Not supported Var22 HostFlowControl 0 Reserved for future usage Sets the AT command reply prefix All events Var23 ATReply AT AB that are displayed are prefixed by this character string case sensitive Sets the Quality of Service Latency from 3 to 40 slots A slot period is 625 microseconds Sets the module s CPU speed 2 4 8 12 16 Var25 CpuMHz 32 20 24 28 32 36 and 64 MHz are allowed Note CpuMHz 40 to 63 are not supported Var24 QoS Latency 20 Baud rate of the HCI interface to the Bluetooth Var26 HciBaudrate 921600 controller 115 200 230 400 460 800 921 600 and 2 000 000 baud are allowed Var27 SPlEnable False Enables the SPI interface to external pins Var28 SPIMode Slave Mode of the SPI Enables the 12C interface to external pins Var29 12CEnable False Note not supported Var30 COD 240404 Bluetooth Class of Device Var32 HostEvents
49. ter string case sensitive Sets the quality of service latency from 3 to 20 wales QoS_Latency 20 Slots A slot size is 625 microseconds Sets the module s CPU speed 2 4 8 12 16 Var24 CpuMHz 32 20 24 28 32 36 and 64 MHz are allowed Note CpuMHz 40 to 63 are not supported Baud rate of the HCI interface to the Bluetooth Var25 HciBaudrate 921600 controller 230 400 460 800 921 600 and 2 000 000 baud are allowed Var26 SPlEnable False Enables the SPI interface to external pins Var27 SPIMode Slave Mode of the SPI 2 Var28 I CEnable False Enables the I C interface to external pins Note not supported Var29 COD 000000 Bluetooth class of device Var30 LinkSecurity False Var31 HostEvents True All host events are sent when true Var32 BondingAllowed True ml allows bonding by default when Var33 PageScan True Enables Page scan when true or halts Page scan when false Var34 InquiryScan True Enables Inguiry scan when true or halts Inguiry scan when false Var35 MPMode 0 0 point to point 1 multipoint using packet protocol 2 broadcast Var36 UseExtLPO False True when a 32 768 kHz low power oscillator is present and false if not present Var37 HSE MHz 13 MHz rating of the main crystal oscillator read only Var38 EnableEncryption False Set to true to enable the Bluetooth link encryption 34 51 DoclD023232 Rev 5 4 UM1547 FW configuration variables Table 9 AT version
50. til a connection is successful A value of 0 will not automatically page the remote device A value of 1000 will perform unlimited pages until the connection is switched from command mode to bypass mode to exchange data Interval 1 1000 is the number of 100 ms intervals 0 1 sec to 100 sec between page attempts This interval is in addition to the amount of time required by the page attempt itself DoclD023232 Rev 5 25 51 AT command list UM1547 3 35 2 3 36 3 36 1 3 36 2 3 37 3 37 1 3 37 2 3 38 3 38 1 26 51 Responses If the operation is successful the response is AT AB SmartCableConfigDone Sniff The Sniff command is used by AT2 FW to switch a device from active mode to sniff mode Syntax AT AB Sniff BD address Sniff Interval Where BD address is the BD address of the device to be switched to active mode Sniff Interval is given in slots from 66 10 000 Responses If the operation is successful the response is AT AB SniffMode SPPConnect The SPPConnect command is used to initiate a connection with the specified device The remote BD address must be specified The remote Service is optional If not specified the first registered SPP service will be used by default Syntax AT AB SPPConnect BD Addr Service Where BD Addr is the remote device s BD address to page Service is the specific service on the remote device optional Responses If the connection is success
51. true only DM1 DH1 DM3 DH3 packets are Yani UsasmaliPaskeis raise allowed on a link EDR is disabled Var20 EnableAFH True Enable Disable the Adaptive Frequency Hopping mode Var EnablePowerControl True Enable Disable the Bluetooth Dynamic power control feature Not supported Var22 HostFlowControl 0 Reserved for future usage Sets the AT command reply prefix All events that Var23 ATReply AT AB are displayed are prefixed by this character string case sensitive Ly DoclD023232 Rev 5 41 51 FW configuration variables UM1547 Table 12 AT2 FW version 1 6 system configuration settings version 1 5 continued Variable Name Default Description Sets the Quality of Service Latency from 3 to 40 tale QoS_Latency 20 slots A slot period is 625 microseconds Sets the module s CPU speed 2 4 8 12 16 20 Var25 CpuMHz 32 24 28 32 36 and 64 MHz are allowed Note CpuMHz 40 to 63 are not supported Baud rate of the HCI interface to the Bluetooth Var26 HciBaudrate 921600 controller 115 200 230 400 460 800 921 600 and 2 000 000 baud are allowed Var27 SPIEnable False Enables the SPI interface to external pins Var28 SPIMode Slave Mode of the SPI Var29 l2CEnable False Enables the 12C interface to external pins Note not supported Var30 COD 240404 Bluetooth Class of Device Var32 HostEvents True All host events are sent when true Var33 BondingAllowed True Automatically
52. uses Amp ed UP Changing the name using this command will permanently change the local name unlike the LocalName command specified hereafter Syntax AT AB DefaultLocalName name Where name is a string for the new local name case sensitive up to 20 characters The space character is allowed the name is assumed to be all text up to the end of the command Responses If the operation is successful the response is AT AB LocalNameOk DeleteAutoReconnect The DeleteAutoReconnect command is used to delete the reconnect feature The device in the reconnection memory will be deleted but the function will remain enabled and the settings will stay in effect This setting is saved in NVM Syntax At ab DeleteAutoReconnect Responses If the operation is successful the response is AT AB DeleteAutoReconnectDone 4 DoclD023232 Rev 5 UM1547 AT command list 3 13 DeleteSmartCable The DeleteSmartCable command removes the current Smart Cable settings that were entered using the SmartCableSetup command but not the setting from the dynamic configuration The Smart Cable will then be deactivated for the remainder of this session Upon reset if a dynamic configuration for a Smart Cable exists it will be activated If there is no dynamic configuration Smart Cable setup then this feature will remain deactivated 3 13 1 Syntax AT AB DeleteSmartCable 3 13 2 Responses If the operation is successful the response is AT AB Del
53. v 5 47 51 FW configuration variables UM1547 Table 13 AT2 FW version 1 6 system configuration settings version 1 5A continued Variable Name Default Description A Enables sniff mode Must be False when no wa Alowanii False 32 768KHz LPO is present Apple MFI application ID Up to 10 characters are Var44 iAPAppID A123CDFG445 allowed See Apple MFI documentation for further details Main connecting string for an Apple MFI Var45 iAPProtocolStrMain com Demo Application Up to 25 characters are allowed See Apple MFI documentation for further details Alternative connecting string for the Apple MFI Var46 iAPProtocolStrAlt com Protocol Alt Application Up to 25 characters are allowed See Apple MFI documentation for further details Apple CP Chip I2C address mode 2 or 3 Apple Var47 CPI2CMode 3 CP v2 0C should default to 3 See Apple CP documentation for further details Var48 SPP128UUID True This variable enables the 128 bit UUID for the SPP profile Var51 RmtEscapeSequence False Remote escape sequence enabled Var53 CreditMax 5 Number of buffers available for incoming data packets max value 8 Var54 PageScanlnterlaced False Enables the Bluetooth interlaced scan mode Sends pairing passkey to the main UART User Var55 MITMEvent False must input at ab passkeyaccept in order to complete pairing Alternate Apple CP pins GPIO 5 SDA and Var56 AItCPGPIO False GPIO 6 SCL are used
54. when true instead of RTS CTS control lines Mtu size for incoming packets for iAP from 150 Var57 InMtuSize 427 to 500 bytes InMtu and OutMtu must match each other 48 51 DoclD023232 Rev 5 ky UM1547 FW configuration variables Table 13 AT2 FW version 1 6 system configuration settings version 1 5A continued Variable Name Default Description Mtu size for outcoming packets for iAP from 150 Var58 OutMtuSize 427 to 500 bytes InMtu and OutMtu must match each other Apple accessory name field Up to 20 characters Var59 AccName Amped Test are allowed See Apple MFI documentation for further details Apple accessory manufacturer field Up to 20 Var60 AccManufacturer Amped RF characters are allowed See Apple MFI documentation for further details Apple accessory model number field Up to 20 Var61 AccModelNumber Test Model characters are allowed See Apple MFI documentation for further details Apple accessory serial number field Up to 20 Var62 AccSerialNumber Amp ed Up characters are allowed See Apple MFI documentation for further details Enable or disable data receiving from remote varga EnableSEEBRCY nase SPP devices while in CommandMode Var64 EnablelAPRcv False Enable or disable data receiving from remote IAP devices while in CommandMode Enable the iAP1 or iAP2 partial support Vare5 IAPEIRMode 1 1 iAP1 service 2 iAP2 service To reach high data throughput this variable must Var66 Loa
Download Pdf Manuals
Related Search