Blue Radio nBlue BT5.0 Manual Download Page 5

Page: 5 / 195

Page 5 of 195

AT.s LE Command Set v5.1.1b

200 S. Wilcox St., Unit 158 • Castle Rock, CO 80104 • USA • 303-957-1003 •

www.BlueRadios.com

PIO Configuration (ATSPIO) ................................................................................................................................ 87

PIO Level (ATPIOL) ............................................................................................................................................. 89

LED Configuration (ATSLED) ............................................................................................................................. 90

Get ADC (ATADC?) ............................................................................................................................................. 91

Get Battery Level (ATBL?) .............................................................................................................................. 93

Get Temperature (ATT?)................................................................................................................................... 94

Calibrate Temperature Sensor (ATCT) ............................................................................................................. 94

8.8

DVERTISING

............................................................................................................................................................. 95

Advertise (ATDSLE) ............................................................................................................................................. 95

Advertising Configuration (ATSDSLE) ................................................................................................................ 96

Advertising Timing Configuration (ATSDSTLE) ................................................................................................. 98

Advertising/Scan Response Data (ATSDSDLE) ................................................................................................... 99

8.9

ISCOVERY

............................................................................................................................................................... 104

Discovery (ATDILE) ........................................................................................................................................... 104

Discovery Configuration (ATSDILE) ................................................................................................................. 105

Discovery Timing Configuration (ATSDITLE) .................................................................................................. 107

Discovery Event Formatting (ATSDIF) .............................................................................................................. 108

8.10

ONNECTION

............................................................................................................................................................ 110

Connect (ATDMLE) ....................................................................................................................................... 110

Connect Last (ATDMLLE) ............................................................................................................................. 112

Last Connect Address (ATLCALE?) .............................................................................................................. 113

Connect Configuration (ATSDMLE) .............................................................................................................. 114

Connect Timing Configuration (ATSDMTLE) ............................................................................................... 115

Connection Parameters .................................................................................................................................... 116

Default MTU (ATSDMTU) ............................................................................................................................ 120

Connection PHYS ........................................................................................................................................... 121

Connection Status (ATCS?) ............................................................................................................................ 124

Connection RSSI (ATRSSI?) .......................................................................................................................... 126

Continuous Connection RSSI (ATCRSSI) ...................................................................................................... 127

Disconnect Command (ATDH) ....................................................................................................................... 128

8.11

AIRING

.................................................................................................................................................................... 129

Pair Command (ATPLE) ................................................................................................................................. 129

Pairing Configuration (ATSPLE) .................................................................................................................... 131

Unpair Device (ATUPLE)............................................................................................................................... 134

Clear Pair List (ATCPLE) ............................................................................................................................... 134

Passkey Response (ATPKR) ........................................................................................................................... 135

Passkey Confirm (ATPKC) ............................................................................................................................. 136

Fixed Passkey (ATSPK) .................................................................................................................................. 137

8.12

HITE

IST

.............................................................................................................................................................. 139

White List Device (ATSWL) .......................................................................................................................... 139

Un White List Device (ATUWL) .................................................................................................................... 140

Clear White List (ATCWL) ............................................................................................................................ 141

8.13

GATT

LIENT

.......................................................................................................................................................... 142

Discover All Primary Services (ATGDPS) ..................................................................................................... 142

Discover Primary Services by UUID (ATGDPSU) ........................................................................................ 143

Discover All Characteristics (ATGDC) .......................................................................................................... 144

Discover Characteristics by UUID (ATGDCU) .............................................................................................. 145

Characteristic Descriptor Discovery (ATGDCD) ........................................................................................... 146

Summary of Contents for nBlue BT5.0

Page 1: ...l and proprietary to BlueRadios Incorporated and all manufacturing reproduction use and sale rights pertaining to such subject matter are expressly reserved The recipient by accepting this material ag...

Page 2: ...COMPATIBILITY 16 2 3 KNOWN ISSUES 16 2 4 RELATED APPLICATIONS 16 2 5 RELATED DOCUMENTS 16 HARDWARE NOTES 17 3 1 POWER MODES 17 3 2 ELECTRICAL SPECIFICATIONS SUMMARY 17 3 3 POWER UP AND RESET 17 3 4 D...

Page 3: ...ESPONSE VALUE DESCRIPTIONS 23 5 3 BT5 0 ADDRESS FORMAT 24 COMMAND STATUS RESPONSES 25 6 1 OK 25 6 2 ERROR 25 EVENTS 26 7 1 GENERAL 26 Reset RESET 26 Bootloader NBOOT 27 Done DONE 28 7 2 DISCOVERY 29 N...

Page 4: ...se Mode ATSRM 59 8 2 RESET 61 Reset ATRST 61 Factory Reset ATFRST 62 8 3 CONFIGURATION CONTROL 63 Configuration Lock ATSCL 63 Configure Flash Storage Configuration ATSFC 65 Flash Configuration ATFC 66...

Page 5: ...110 Connect ATDMLE 110 Connect Last ATDMLLE 112 Last Connect Address ATLCALE 113 Connect Configuration ATSDMLE 114 Connect Timing Configuration ATSDMTLE 115 Connection Parameters 116 Default MTU ATSD...

Page 6: ...5 RF TESTING 169 LE Direct Test Mode ATDTM 169 Test Mode ATTEST 169 Transmitter Test ATTXT 170 Receiver Test ATRXT 171 RF Observation ATRFO 172 8 16 BOOTLOADER 173 Run Bootloader ATBOOT 173 Bootloader...

Page 7: ...rary changing of PIO output level ATSDMLE Allows Channel_Map to be set for ATDMLE and default BRSP mode to be set ATSDMTU Allows the default MTU Maximum Transmission Unit to be set ATSSPHY Sets the PH...

Page 8: ...t Changes The BT5 0 Address and address type have now been combined into a single parameter for all commands events using an address See BT5 0 Address Format for more details PIO Functionality Changes...

Page 9: ...to allow pull ups downs for inputs and drive strength for outputs ATSLED 2 more LEDs can now be configured PIO_7 PIO_8 ATADC Added support for changing Resolution Gain and Acquisition Time ATDSLE ATD...

Page 10: ...ument Changes Fixed Sync_White_List default value set to 1 in Pairing Configuration ATSPLE 5 0 11 11 10 21 2020 Document Changes Added support for PAN1780 AT 5 1 0 0 12 04 2020 New Features Custom Pro...

Page 11: ...ADC Added Oversampling Mode with default value of 0 Disabled 5 1 0 0a 01 21 2021 Documentation Changes ATSCPS Fixed characteristic descriptor Maximum Attribute Value Lengths to be uint16 in little end...

Page 12: ...can be configured commanded and controlled through simple ASCII strings through the hardware serial UART or over a remote BT5 0 RF connection 1 2 Background BT5 0 low energy was designed to enable th...

Page 13: ...s that should concern the user The GAP layer controls device discovery advertising and connections The GATT layer handles the exchanging of data The nBlue modules contain a full stack all the way up t...

Page 14: ...ifferent PHYs Measurements were taken when streaming either with the UART at 921600 baud or through USB with a default MTU of 247 and default connection interval of 20ms Using a lower baud rate for th...

Page 15: ...ture can be disabled through ATSDFU Remote command mode is enabled by default allowing AT commands to be sent to the device over the air through the BRSP service If you do not want remote command mode...

Page 16: ...indicating a GATT request is already pending 2 4 Related Applications nBlue Programmer nBlue Programmer nBP is a Windows application that allows firmware to be updated on all BlueRadios nBlue BT4 0 5...

Page 17: ...awn from the VDD pin during power up and the VDDH rise time to 3V is 1ms This will be fixed in the next nRF52840 revision See Errata 197 and 202 of the nRF52840 Rev 1 Errata for more info https infoce...

Page 18: ...nfigure PIO_5 to go low on the BR LE5 0 S1 or high on the PAN1780 AT when the module is sleeping and high on the BR LE5 0 S1 or low for the PAN1780 AT when it is awake If PIO_3 is held high on the BR...

Page 19: ...ertising pulsing PIO_14 will perform an ATDC to cancel advertising The module will respond with the same response as if the command was entered through the UART 3 6 UART Interface UART_TX UART_RX UART...

Page 20: ...ing Disabling Sleep Mode Sleep mode can be enabled by executing the ATZ command or by pulsing PIO_3 high on the BR LE5 0 S1 or low for the PAN1780 AT while the module is awake ATSZ can also be used to...

Page 21: ...a 100ms interval at 8dB Sleep Mode Disabled and Idle When sleep mode is disabled the UART will be enabled and the module will consume 625 A Sleep Mode Disabled and Not Idle 750 A when advertising at a...

Page 22: ...ter to slave 4 8 Whitelist The ATSWL command can be used to add device addresses to a whitelist that can be enabled with the ATSDSLE and ATSDMLE commands to only allow connections to specific devices...

Page 23: ...lash any time an ATS prefixed command is sent This behavior can be changed using the ATSFC command allowing automatic flash storage to be disabled When disabled the ATFC command can be used to manuall...

Page 24: ...ingle parameter for all commands events using an address Within the parameter the address will consist of 12 characters and 1 address type character separated by a character for example ECFE7E123456 0...

Page 25: ...RESPONSE Function All successful commands will respond immediately with an OK response except for ATRST and ATFRST Example s RESPONSE cr_lf OK cr_lf 6 2 Error ERROR STATUS RESPONSE Function All unsuc...

Page 26: ...ng reset Event Format RESET Factory_Reset Reason Module_Type Event Values Factory_Reset 0 Module was not factory reset 1 Module was factory reset Reason 0 Software Reset ATRST ATFRST 1 Reset Pin 2 Pow...

Page 27: ...update is complete If USB was being used the port will close when the module enters the bootloader Event Format NBOOT Reason Version Module_Type Event Values Reason 0 Module entered the bootloader vi...

Page 28: ...SLE 1 ATDILE 2 ATDMLE Command_Type 2 General 0 Command Complete Command_Type 3 Continuous RSSI Completed_Command Conn_Handle of connection continuous RSSI was cancelled on Example s 1 The advertising...

Page 29: ...e below Each one consists of a different type of data which is defined by the AD EIR Type Non extended advertising and scan response data can be up to 31 bytes long Extended advertising packets can be...

Page 30: ...ta structures found Data Structures The data structures are returned in the format specified by ATSDIF This value will be 0 if the Data_Structure_Count is 0 Example s 1 The ATDILE command is used to s...

Page 31: ...Scannable Directed Advertisement Addr The address and address type of the discovered device RSSI The RSSI of the packet received from the device 127 20 dBm Primary_PHY 1 1M 1Mbps Standard 4 LR 125Kbp...

Page 32: ...yphens disabled the maximum length is 550 7 3 Connection Connect CONNECT CONNECT EVENT Function The connect event will be sent when a connection is established Event Format CONNECT Conn_Handle Conn_Ro...

Page 33: ...isconnect_Reason Event Values Conn_Handle Connection handle Disconnect_Reason 0 Local Disconnect Requested 1 Remote Disconnect Requested 2 Link Supervision Timeout 3 Unacceptable Connection Interval 4...

Page 34: ...is enabled in the ATSDCP command Event Format SCCPS Conn_Handle Status Event Values Conn_Handle Connection handle Status 0 Connection Parameter Update Accepted 1 Connection Parameter Update Rejected E...

Page 35: ..._Interval Integer value from 6 to 3200 1 25ms Slave_Latency Integer value from 0 to 499 connection intervals Supervision_Timeout Integer value from 10 to 3200 10ms Example s 1 A connection parameter u...

Page 36: ...nimum then an MTU exchange will not be attempted and the MTU event will never occur In this case GATT commands can be sent immediately after the CONNECTION event Event Format MTU Conn_Handle MTU Event...

Page 37: ...ent will still occur but the PHYs will stay the same Event Format PHYU Conn_Handle Status RX_PHY TX_PHY Event Values Conn_Handle Connection handle RX_PHY 1 1M 1Mbps Standard 2 2M 2Mbps High Speed 4 LR...

Page 38: ...SSI RSSI RSSI EVENT Function The RSSI event will be sent after an RSSI reading has been requested using the ATRSSI command Event Format RSSI Conn_Handle RSSI_Value Event Values Conn_Handle Connection...

Page 39: ...sts pairing and automatic pairing request accept is not enabled The ATP or ATPLE command is used to accept a pairing request Event Format PAIR_REQ Conn_Handle Addr Event Values Conn_Handle Connection...

Page 40: ...Encrypted Not Authenticated 3 Encrypted Authenticated 4 Encrypted LESC Authenticated Addr The address and address type of the paired device Example s 1 LE pairing is initiated using the ATPLE command...

Page 41: ...nnection handle Addr The address and address type of the remote device Reason 0 Pairing Timeout 1 Invalid Passkey 3 IO Capabilities Cannot Meet Authentication Requirements 5 Pairing Not Supported 6 En...

Page 42: ...type of the remote device Example s 1 LE pairing is initiated using the ATPLE command to connection handle 0 Authentication is required by one side or the other and based on the module s IO_Capabilit...

Page 43: ...vent Example s 1 LE pairing is initiated using the ATPLE command to connection handle 0 Authentication is required by one side or the other and based on the module s IO_Capabilities ATSPLE PK_DIS is s...

Page 44: ...device s public address Example s 1 An LE discovery is performed and a device using a private resolvable address of 7CED99C0E2B3 is found COMMAND ATDILE cr RESPONSE cr_lf OK cr_lf EVENT cr_lf DISCOVER...

Page 45: ...address has been resolved the public address is shown instead of the private address COMMAND ATDILE cr RESPONSE cr_lf OK cr_lf EVENT cr_lf DISCOVERY 2 ECFE7E000001 0 45 4 020106 020A04 051208000800 1...

Page 46: ...TGR ATGRU 5 ATGW 6 ATGRL 7 ATGWP 8 ATGWPE 9 ATGRM Error 0 No Error 1 Invalid Attribute Handle 2 Read Not Permitted 3 Write Not Permitted 4 Invalid PDU 5 Insufficient Authentication 6 Request Not Suppo...

Page 47: ...it 158 Castle Rock CO 80104 USA 303 957 1003 sales blueradios com www BlueRadios com EVENT cr_lf GATT_DONE 0 4 1 cr_lf 2 A GATT write is requested on handle 19 and after successfully completing a GATT...

Page 48: ...ute in the service If the discovered service is the last service in a devices attribute table this value will be 65535 1 65535 Svc_UUID UUID of the discovered service 16 bit UUID 4 chars 128 bit UUID...

Page 49: ...lue_Att_Handle Characteristic value attribute handle 1 65535 Char_Properties Hex Formatted The properties determine how the characteristic can be used 0x01 Broadcast 0x02 Read 0x04 Write Without Respo...

Page 50: ...ery Level characteristic on a remote device First ATGDPSU is used to find the BAS service which has a start handle of 25 and an end handle of 28 COMMAND ATGDPSU 0 180F cr RESPONSE cr_lf OK cr_lf EVENT...

Page 51: ...nn_Handle Connection handle Value_Att_Handle Value attribute handle 1 65535 0 if Read Multiple Response Value_Event_Type 0 Read Response 1 Notification 2 Indication 3 Read Multiple Response Value_Form...

Page 52: ...t_Handle Value_Offset Value_Length Value Event Values Conn_Handle Connection handle Value_Att_Handle Value attribute handle 1 65535 Value_Offset Offset of partial data into entire value Value_Length L...

Page 53: ...Automatic mode with Critical_Level set to a non zero value the BATT event will fire to alert the application that the battery has dropped below the critical level It will continue to fire each time th...

Page 54: ...ommand Mode All data received on the UART will continue to be parsed locally as commands Data can be sent over BRSP using the ATBRSPW command RX_Mode 0 Serial Port Mode All data received over the air...

Page 55: ...at BRSPD Conn_Handle Data_Length Data Event Values Conn_Handle Connection handle Data_Length Length of the Data field in bytes Data ASCII BRSP data Example s 1 A connection is made to ECFE7E000001 wit...

Page 56: ...2 Desc_Index The descriptor index as an Integer value from 0 62 or 63 When set to a value of 63 this index will be ignored thus setting the specified characteristic index value Example s 1 A client on...

Page 57: ...Event Values Conn_Handle Connection handle Svc_Index The service index as an Integer value from 0 14 Char_Index The characteristic index as an Integer value from 0 62 Desc_Index The descriptor index a...

Page 58: ...heck communication with the module It will always respond with an OK Example s COMMAND AT cr RESPONSE cr_lf OK cr_lf AT Function AT will respond with a list of all available commands Example s COMMAND...

Page 59: ...d events that do not contain requested data will not be sent 3 Custom Individual responses and events can be enabled or disabled Disconnected_Mode 0 Command Mode 1 No AT commands are accepted and UART...

Page 60: ...s COMMAND ATSRM 0 0 cr RESPONSE cr_lf OK cr_lf Note s When switching to limited or minimal response mode the OK response will not come back after the ATSRM command GET RESPONSE MODE Function Sets the...

Page 61: ...r value from 0 to 65535 ms to delay reset Default 0 Reset immediately Example s 1 An ATRST is sent and once the module has reset the RESET event is triggered COMMAND ATRST cr RESPONSE cr_lf RESET 0 0...

Page 62: ...ar_Paired 0 Clear paired list 1 Keep paired list Example s 1 An ATFRST is sent and once the module has reset the RESET event is triggered COMMAND ATFRST cr RESPONSE cr_lf RESET 1 0 BR LE5 0 S1 cr_lf N...

Page 63: ...factory reset using PIO_4 is the only way to reset it Command Format ATSCL Lock Password Command Parameter s Lock 0 Unlock 1 Lock Password 1 20 alphanumeric characters Case sensitive includes spaces...

Page 64: ...200 S Wilcox St Unit 158 Castle Rock CO 80104 USA 303 957 1003 sales blueradios com www BlueRadios com GET CONFIGURATION LOCK Function Gets the configuration lock setting Command Format ATSCL Response...

Page 65: ...TFC 1 Enabled All configuration changes will be automatically stored in flash Store_Last_Connect_Address 0 Disabled Last connected address will not be stored in flash 1 Enabled Last connected address...

Page 66: ...NewModuleName cr Set Configuration ATSCFG SET CONFIGURATION Function Can be used to set the entire module configuration with just a few commands If the OK response is received the configuration will...

Page 67: ...600352E302E302E31322D5331000107000000000000000000000000000000000 0000000000000030808000000C00002020100000101020202020202020000050000 02020202000002020202020202020202020202020202020202020000000064FFFF0...

Page 68: ...ATSFC 1 1 cr_lf ATSZ 0 0 0 cr_lf ATSN BlueRadiosB7CF09 0 cr_lf ATSAPP 0 cr_lf ATSAT 1 0 900 cr_lf ATSDBLE 1 0 cr_lf ATSDPL 8 8 cr_lf ATSUART 7 0 0 1 cr_lf ATSUSB 1 0 cr_lf ATSNFC 0 cr_lf ATSPIO 0 2 0...

Page 69: ...ut it on the UART while it is in sleep mode If shutdown is enabled the module will enter its lowest power state where it can only be woken back up by a reset or by pulsing PIO_3 which will trigger a r...

Page 70: ...E5 0 S1 or high on the PAN1780 AT when sleep mode is enabled and high on the BR LE5 0 S1 or low for the PAN1780 AT when sleep mode is disabled and the module is awake and able to receive commands 2 PI...

Page 71: ...at Sleep_On_Reset Wake_On_Rx PIO_7_Sleep_Status Shutdown_PIO_State Example s COMMAND ATSZ cr RESPONSE cr_lf OK cr_lf cr_lf 1 0 1 0 cr_lf 8 5 Module Information Module Type ATMT GET MODULE TYPE Functio...

Page 72: ...t ATV Response Format Firmware_Version Response Values Firmware_Version Module Firmware Version Major AT Version Minor AT Version Bug Fix Version 0 Module_Type_Abbr The first two digits Major AT Versi...

Page 73: ...USA 303 957 1003 sales blueradios com www BlueRadios com BT5 0 Device Address ATA GET ADDRESS Function Gets the module s BT5 0 Device Address Command Format ATA Response Format Addr Response Values A...

Page 74: ...Default BlueRadios Part or all the BT5 0 Device Address can be automatically added into the name by including 2 or more characters in the name If only a portion of the address is included the least si...

Page 75: ...al appearance of the module Command Format ATSAPP Appearance Command Parameters Appearance 16 bit integer value Valid values can be found at https www bluetooth com wp content uploads Sitecore Media L...

Page 76: ...Privacy_Type Private_Addr_Cycle_Time Command Parameters Addr_Type 0 Public Address The unique BT5 0 Device Address with BlueRadios OUI ECFE7E will be used 1 Static Random Address A random address that...

Page 77: ...k CO 80104 USA 303 957 1003 sales blueradios com www BlueRadios com GET ADDRESS TYPE Function Gets the current address type and address being used by the module Command Format ATSAT Response Format Ad...

Page 78: ...mmand Format ATSLE Response Format Idle_Testing Advertising Discovering Connecting Connected Response Values Idle_Testing 0 Not Idle 1 Idle 2 Testing ATTXT ATRXT Advertising 0 Not Advertising 1 Advert...

Page 79: ...hite List BRSP Remote Command Mode Trigger 0 Idle 1 Idle UART Data Cannot be used if ATSDB Trigger 1 Example s 1 The module s default behavior is set to advertise on idle ATSLE is used to confirm that...

Page 80: ...the background such as ATDM ATDS or ATDI This command can come in handy for a quick exit from commands like ATDI if there are no devices in the area and you do not want to wait for a timeout Not pass...

Page 81: ...tising and peripheral incoming connections Scan_TX_Power Transmit power level for discovery and central outgoing connections If not specified will be set to the same value as Ad_TX_Power Supported Val...

Page 82: ...e Connection handle of connection to update TX_Power 40 20 16 12 8 4 0 2 3 4 5 6 7 8 dBm Example s COMMAND ATSCPL 0 8 cr RESPONSE cr_lf OK cr_lf Note s See the Module User s Guide or Module Datasheet...

Page 83: ...bps Value 9600 3 19200 4 38400 5 57600 6 115200 7 230400 8 460800 9 921600 10 Parity 0 None 2 Even Stop_Bits 0 One Flow_Control 0 Flow Control Off 1 Flow Control On Example s COMMAND ATSUART 7 0 0 1...

Page 84: ...x St Unit 158 Castle Rock CO 80104 USA 303 957 1003 sales blueradios com www BlueRadios com GET UART Function Gets the UART configuration Command Format ATSUART Response Format Baud_Rate Parity Stop_B...

Page 85: ...controlled through this port through AT commands and events in the same way it can over the UART 0 Disable 1 Enable Enable_USB_Event_Port If enabled and USB is enabled a 2nd USB CDC ACM serial port wi...

Page 86: ...ommunication subsystem When enabled the module can pair with another device using NFC Command Format ATSNFC Enable Command Parameter s Enable 0 Disabled 1 Enabled Example s COMMAND ATSNFC 1 cr RESPONS...

Page 87: ...evel Pull_Drive_Strength Command Parameter s PIO_Num 0 44 Excluding 3 4 6 14 17 18 23 24 Direction 0 Input 1 Output 2 Pin Disconnected Default_Level Direction 0 2 No Effect Direction 1 0 Low 1 High Pu...

Page 88: ...04 USA 303 957 1003 sales blueradios com www BlueRadios com GET PIO CONFIG Function Reads PIO settings Command Format ATSPIO PIO_Num Command Parameter s PIO Number 0 46 Excluding 3 4 6 17 18 23 24 Res...

Page 89: ...at ATPIOL PIO_Num Level Command Parameter s PIO_Num 0 44 Excluding 3 4 6 14 17 18 23 24 Level 0 Low 1 High Example s COMMAND ATPIOL 7 1 cr RESPONSE cr_lf OK cr_lf Note s The value of PIO_2 and PIO_5 c...

Page 90: ...100 If the Duty_Cycle is set to 0 the status LED functionality will be disabled and the PIO can be controlled manually using the ATSPIO command PIO_2 Default 100 PIO_5 Default 10 PIO_7 Default 100 PIO...

Page 91: ...Duty Cycle Period Override_Default_Behavior Example s COMMAND ATSLED 1 cr RESPONSE cr_lf OK cr_lf cr_lf 10 2000 0 cr_lf Get ADC ATADC GET ADC Function Takes a reading from one of the module s ADCs in...

Page 92: ...0 1 6 1 1 5 2 1 4 3 1 3 4 1 2 5 1 6 2 7 4 Acquisition_Time 0 5 Value Acq Time Max Source Resistance 0 3 S 10 k 1 5 S 40 k 2 10 S 100 k 3 15 S 200 k 4 20 S 400 k 5 40 S 800 k Oversampling_Mode 0 8 0 D...

Page 93: ...ts the battery level as a percentage from 0 100 The level is only valid if a 3 0V coin cell is connected directly to VDD Command Format ATBL Response Format Batt_Level Response Value s Batt_Level 0 10...

Page 94: ...it Response Value s Temp_Celsius Temperature in Celsius Temp_Fahrenheit Temperature in Fahrenheit Example s 1 The module will return floating point values with two decimal places COMMAND ATT cr RESPON...

Page 95: ...ket of data Selecting Ad_Type 5 Extended Scannable Indirect Advertisement will use the same extended advertising data as a non scannable Ad_Type but it will make it so the remote device must actively...

Page 96: ...in the slave role can only be connected to one master at a time Advertising Configuration ATSDSLE SET ADVERTISING Function This command is used to configure the advertising ATDSLE settings Command For...

Page 97: ...oded Long Range Extended_Anonymous Only applies if using an extended Ad_Type 0 Device address will be included in the advertising packet 1 Device address will not be included in the advertising packet...

Page 98: ...ected_Ad_Interval Integer value from 32 to 16384 625ms This is the interval that advertisements will be sent when the module is not connected Default 160 100ms Connected_Ad_Interval Integer value from...

Page 99: ...gnedNumbers generic_access_profile htm Descriptions of each AD Type can be found in the following document https www bluetooth org DocMan handlers DownloadDoc ashx doc_id 282152 Data Checks All data i...

Page 100: ...609FFFFFFFFFF 16 bit Service List 0302FFFF This ad data structure will automatically list enabled 16 bit services such as HRS Heart Rate but DIS Device Information and BAS Battery will never be listed...

Page 101: ...1107796022A0BEAFC0BDDE487962F1842BDA Data_Type Scan Response Data 3 31 bytes 6 62 characters If the value is set to 00 the scan response will be disabled Default 05FFFFFFFFFF1509FFFFFFFFFFFFFFFFFFFFFF...

Page 102: ...DLE 0 0201FF07FF850000010203 cr RESPONSE cr_lf ERROR 01 cr_lf 4 This example fails because the length was set to 7 but only 6 bytes of data were passed COMMAND ATSDSDLE 0 0201FF07FF8500FF0102 cr RESPO...

Page 103: ...he ad data is changed When not using auto populating data for the flags structure and trying to advertise using white list filtering with ATSDSLE White List Filter neither the Limited Discoverable nor...

Page 104: ...channels so the 2M PHY is not allowed When scanning for extended advertising packets is enabled non extended advertising packets will still be received as well 0 The module will not receive extended a...

Page 105: ...Command Parameter s White_List_Filter The whitelist can be configured using the ATSWL command 0 Disabled 1 Discover White List devices only Limited_Filter 0 Disabled Discover all discoverable devices...

Page 106: ...39 7 37 38 39 Example s COMMAND ATSDILE 0 0 1 10 0 7 cr RESPONSE cr_lf OK cr_lf Note s This command cannot be used when the module is in the Discovering State GET DISCOVERY LE Function Gets the disco...

Page 107: ...e value scanning will run continuously during the discovery Command Format ATSDITLE Timeout Interval Window Command Parameter s Timeout Integer value from 1 to 65535 s A value of 0 can be used to disa...

Page 108: ...mple Pairing Optional OOB Tags 32 0x0020 Device ID 64 0x0040 Security Manager OOB Flags 128 0x0080 Slave Connection Interval Range 256 0x0100 Service Solicitation 512 0x0200 Service Data 1024 0x0400 T...

Page 109: ...E Extended Global_Format 0 Separate events for non extended and extended discovery events 1 All discovery events will use the extended discovery format with the DISCOVERY event tag Example s COMMAND A...

Page 110: ...s to scan on the primary advertising channels when connecting to a device using extended advertising packets All PHYs will automatically be used for scanning on the secondary advertising channels The...

Page 111: ...OK cr_lf cr_lf DONE 1 2 cr_lf Note s A single mode module can only connect in the LE master role to one device at a time A dual mode module can connect to up to 4 LE slaves If the remote Slave device...

Page 112: ...0 2 0 ECFE7E000001 0 cr_lf EVENT cr_lf BRSP 1 cr_lf Note s To verify the last address that will be connected to use the ATLCALE Command The module can connect out to up to 4 devices at a time If the...

Page 113: ...radios com www BlueRadios com Last Connect Address ATLCALE GET LAST CONNECT ADDRESS Function Gets the BT5 0 device address from the last LE CONNECT event Command Format ATLCALE Response Format Addr Re...

Page 114: ...to 65535 s A value of 0 can be used to disable the timeout 0 No BRSP On Connect The module will stay in command mode upon connecting 1 BRSP Data Mode The module will go into BRSP data mode upon conne...

Page 115: ...ly the module should scan and the Window sets how long it will scan at each Interval If both are set to the same value scanning will run continuously while in the Connecting State Command Format ATSDM...

Page 116: ...will result in higher throughput lower latency but will use more power and a longer connection interval will result in lower throughput higher latency and less power consumption Slave Latency Allows a...

Page 117: ...Integer value from 10 to 3200 10ms Must be greater than 2 Max_Conn_Interval 1 Slave_Latency Default 400 4s Slave_Auto_Update 0 If connected to as a slave the module will accept any connection paramet...

Page 118: ...003 sales blueradios com www BlueRadios com GET DEFAULT CONNECTION PARAMETERS Function Gets the module s default connection parameters Command Format ATSDCP Response Format Min_Conn_Interval Max_Conn_...

Page 119: ...Parameter s Conn_Handle Connection handle of connection to update Min_Conn_Interval Integer value from 6 to 3200 1 25ms Can be set to 65535 No specific interval preferred on a slave role module Max_Co...

Page 120: ...s Conn_Handle Connection handle of connection to read Response Format Conn_Interval Slave_Latency Supervision_Timeout Example s COMMAND ATSCCP 0 cr RESPONSE cr_lf OK cr_lf cr_lf 8 0 400 cr_lf Default...

Page 121: ...8 1 Supported PHYS ATSSPHY SET SUPPORTED PHYS Function Sets the PHYs the module will accept if a connection PHY update is requested by another device The supported PHYs can be set separately for RX an...

Page 122: ...d 3 1M 2M 4 LR 125Kbps Coded Long Range 5 1M LR 6 2M LR 7 1M 2M LR Example s COMMAND ATSSPHY cr RESPONSE cr_lf OK cr_lf cr_lf 7 7 cr_lf 8 10 8 2 Current PHYS ATSCPHY SET CURRENT PHYS Function Requests...

Page 123: ...A PHY update to 2M is requested on connection handle 0 and fails the PHY stays at 1M COMMAND ATSCPHY 0 2 2 cr RESPONSE cr_lf OK cr_lf EVENT cr_lf PHYU 0 1 1 cr_lf GET CURRENT PHY Function Gets the cu...

Page 124: ...ad If not specified will print the connection status of all active connections Response Format Conn_Handle Conn_Role Security_Level Addr Conn_Interval Slave_Latency Supervision_Timeout MTU RX_PHY TX_P...

Page 125: ...end of the connection list COMMAND ATCS cr RESPONSE cr_lf OK cr_lf cr_lf 0 2 1 ECFE7E000000 0 16 0 400 247 1 1 8 cr_lf cr_lf DONE 2 0 cr_lf 3 Connection status for all connections is requested Two act...

Page 126: ...ONE event will not be sent if RSSI is requested for a specific connection Command Format ATRSSI Conn_Handle Command Parameter s Conn_Handle Connection handle of connection to read RSSI from If not spe...

Page 127: ...SSI is a signed number on a logarithmic scale with 1 dB steps and a 6 dBm accuracy Continuous RSSI can be cancelled using the ATDC command Command Format ATCRSSI Conn_Handle Event_Threshold Skip_Count...

Page 128: ...mand will terminate a specific connection or all active connections Command Format ATDH Conn_Handle Command Parameter s Conn_Handle Connection handle of connection to terminate If not specified all ac...

Page 129: ...t ATPLE Addr_Conn_Handle Accept_Request Command Parameter s Addr_Conn_Handle Address and address type of device or connection handle if connected If not specified the lowest numbered active connection...

Page 130: ...o read the paired LE devices Command Format ATPLE Response Format Count Addrs Response Value s Count Number of paired devices Addrs List of paired addresses separated by characters 0 if Count is 0 Exa...

Page 131: ...key Entry at least one device needs a display and the other needs a numeric keyboard All possible scenarios are shown in the IO Capability Authentication Mapping table below with the cases where authe...

Page 132: ...Just Works No Auth Passkey Entry responder displays initiator inputs Authenticated Just Works No Auth Passkey Entry responder displays initiator inputs Authenticated Numeric Keyboard Only Passkey Ent...

Page 133: ...Works No Auth Just Works No Auth Numeric Comparison both sides display and confirm Authenticated Numeric Keyboard Only Just Works No Auth Just Works No Auth Just Works No Auth Just Works No Auth Just...

Page 134: ...This command is used to delete the pairing information for an LE device Command Format ATUPLE Addr Command Parameter s Addr Device address and address type Example s COMMAND ATUPLE ECFE7E000001 0 cr...

Page 135: ...and Parameter s Conn_Handle Connection handle Passkey 6 numeric characters Example s 1 LE pairing is initiated using the ATPLE command to connection handle 0 Authentication is required by one side or...

Page 136: ...ction handle Confirm 0 Passkey does not match 1 Passkey match confirmed Example s 1 LE pairing is initiated using the ATPLE command to connection handle 0 Authentication is required by one side or the...

Page 137: ...device with a fixed passkey set to Display Only 0 Command Format ATSPK Passkey Command Parameter s Passkey 6 numeric characters If set to 0 a fixed passkey will not be used If a fixed passkey is set i...

Page 138: ...dios Inc 200 S Wilcox St Unit 158 Castle Rock CO 80104 USA 303 957 1003 sales blueradios com www BlueRadios com GET PASSKEY Function Gets the fixed passkey Command Format ATSPK Response Format Passkey...

Page 139: ...ut only the devices it cares about and ignore all others The White List works with the White_List_Filter parameters of ATSDSLE and ATSDILE as well as with ATDMLE when a specific address is not used Co...

Page 140: ...module does not have any device in its White List COMMAND ATSWL cr RESPONSE cr_lf OK cr_lf cr_lf 0 0 cr_lf 2 The module has two devices in its White List COMMAND ATSWL cr RESPONSE cr_lf OK cr_lf cr_l...

Page 141: ...s com www BlueRadios com Clear White List ATCWL CLEAR WHITE LIST Function This command is used to remove all devices from the White List Command Format ATCWL Example s COMMAND ATCWL cr RESPONSE cr_lf...

Page 142: ...s format if a 16 bit UUID of a BT5 0 defined service is discovered the service acronym will be returned instead All other UUIDs will still be returned as Hex UUIDs except for the BRSP service Example...

Page 143: ...UUID Command Parameter s Conn_Handle Connection handle UUID UUID of the service to discover 16 bit UUID 4 chars 128 bit UUID 32 chars Example s 1 ATGDPSU is issued for connection handle 0 and the GAP...

Page 144: ...y the Svc_Att_Handle of a specific service Start_Att_Handle is included in the search 1 65535 1 if not specified End_Att_Handle Attribute handle to stop searching at typically the Svc_End_Att_Handle o...

Page 145: ...scover 16 bit UUID 4 chars 128 bit UUID 32 chars Start_Att_Handle Attribute handle to start searching at typically the Svc_Att_Handle of a specific service Start_Att_Handle is included in the search 1...

Page 146: ...End_Att_Handle Attribute handle to stop searching at typically the ending handle of the characteristic End_Att_Handle is included in the search Must be greater than or equal to Start_End_Handle 1 655...

Page 147: ...1 bytes in length The MTU Maximum Transmission Unit of a connection can be found using the ATCS Command Command Format ATGR Conn_Handle Att_Handle Value_Format Command Parameter s Conn_Handle Connecti...

Page 148: ...turned This command can read combined characteristic values up to a total of MTU 1 bytes in length The MTU Maximum Transmission Unit of a connection can be found using the ATCS Command Command Format...

Page 149: ...TGRL Conn_Handle Att_Handle Value_Format Command Parameter s Conn_Handle Connection handle Att_Handle Attribute handle of the characteristic value or descriptor to read Value_Format How the value will...

Page 150: ...value or descriptor to read 16 bit UUID 4 chars 128 bit UUID 32 chars Value_Format How the value will be formatted when returned by the GATT_VAL event 0 Hex 1 8 Bit Unsigned Decimal 2 16 Bit Unsigned...

Page 151: ...e passed in the module will perform a prepared write and internally break the packet up into separate packets Command Format ATGW Conn_Handle Att_Handle Value_Format Value Command Parameter s Conn_Han...

Page 152: ...5 0 cr_lf 4 Writing the string HELLO using Value_Format 0 This is equivalent to example 3 COMMAND ATGW 0 99 0 48454C4C4F cr RESPONSE cr_lf OK cr_lf EVENT cr_lf GATT_DONE 0 5 0 cr_lf 5 Writing the stri...

Page 153: ...tt_Handle Value_Format Value Command Parameter s Conn_Handle Connection handle Att_Handle Attribute handle of the characteristic value or descriptor to write Value_Format Value format 0 Hex 1 8 Bit Un...

Page 154: ...n length at a time ATT_MTU is the Attribute Protocol Maximum Transmission Unit which on Single Mode modules is 23 so the maximum write length per ATGWP is 18 bytes Multiple ATGWP commands can be tied...

Page 155: ...cr RESPONSE cr_lf OK cr_lf EVENT cr_lf GATT_DONE 0 7 0 cr_lf COMMAND ATGWPE 0 cr RESPONSE cr_lf OK cr_lf EVENT cr_lf GATT_DONE 0 8 0 cr_lf GATT WRITE PREPARED EXECUTE Function This command is used to...

Page 156: ...revision for the software withing the device System ID A structure containing an Organizationally Unique Identifier OUI followed by a manufacturer defined identifier and is unique for each individual...

Page 157: ...the value Characteristic_ID 0 5 1 20 byte ASCII string Characteristic_ID 6 8 byte ASCII Hex string 16 characters Characteristic_ID 7 1 20 byte ASCII Hex string 2 40 characters Characteristic_ID 8 7 b...

Page 158: ...configuration Command Format ATSDIS Characteristic_ID Command Parameter s Characteristic_ID 0 Manufacturer Name String 1 Model Number String 2 Serial Number String 3 Hardware Revision String 4 Firmwa...

Page 159: ...racteristic will be updated when read through GATT and updated at the specified update interval when connected and notifications are enabled Use if a 3 0V coin cell is connected directly to VDD If BAS...

Page 160: ...to update the level every hour 3600s with a critical level of 10 COMMAND ATSBAS 1 1 3600 10 cr RESPONSE cr_lf OK cr_lf Note s A reset is required for a change to the Service_Enable parameter to take e...

Page 161: ...s the Battery Service battery level Command Format ATSBASL Level Command Parameter s Level 0 100 Example s 1 Sets the battery level to 100 COMMAND ATSBASL 100 cr RESPONSE cr_lf OK cr_lf Note s The bat...

Page 162: ...et to take effect the Active parameter allows OTA updates to be disabled while keeping the service in place 0 DFU Service Inactive The DFU service is enabled but a remote device will not be allowed to...

Page 163: ...RSP Service_Enable Features_Flags Security_Mode TX_Mode RX_Mode Command Parameter s Service_Enable Reset required for change to take effect 0 BRSP Service Disabled 1 BRSP Service Enabled Features_Flag...

Page 164: ...escape character and no data timeout parameters Command Format ATSSP Escape_Char No_Data_Timeout Command Parameter s Escape_Char Integer value from 0 to 255 The escape character is used to put the rad...

Page 165: ...ode all UART data is interpreted locally as AT commands Command Format Escape_Char Escape_Char Escape_Char Command Parameter s Escape_Char The escape character set in the ATSSP command Example s 1 A c...

Page 166: ...rom the remote device will be sent out of the module s UART Command Format ATMD Conn_Handle Command Parameter s Conn_Handle Connection handle to enter data mode on If only one connection is active the...

Page 167: ...command mode on If only one connection is active the connection handle does not have to be specified Example s A connection is made to ECFE7E000001 using ATDMLE ATMRC is then used to put the module in...

Page 168: ...pend a carriage return to the end of the data string allowing commands to be sent with ATBRSPW when in remote command mode 0 No carriage return appended 1 Carriage return appended to data Example s 1...

Page 169: ...RESET pin Command Format ATDTM Example s COMMAND ATDTM cr RESPONSE None Note s The UART baud rate will be 19200 in Direct Test Mode The output power will be 8dBm in Direct Test Mode DTM mode cannot b...

Page 170: ...nel 2 Channel Hopping Unmodulated Transmit Transmits an unmodulated carrier transmitting a packet on each channel for the specified hop rate continuously cycling linearly through all channels 3 Channe...

Page 171: ...hannel RSSI values will be reported at the specified RSSI_Sampling_Rate and the average will be reported at the end of the test 2 Channel Hopping Receive Receives on a different channel at the specifi...

Page 172: ...the TX_PIO will toggle when the module is transmitting and the RX_PIO will go toggle when the module is receiving Command Format ATRFO Enable TX_PIO RX_PIO Active_High Command Parameter s Enable 0 RF...

Page 173: ...ueradios com www BlueRadios com 8 16Bootloader Run Bootloader ATBOOT RUN BOOTLOADER Function This commands the module into the bootloader after the specified delay Command Format ATBOOT Delay Command...

Page 174: ...Format ATSBOOT USB_Enable UART_Baud_Rate UART_Flow_Control Command Parameter s USB_Enable 0 Disabled 1 Enabled UART_Baud_Rate 3 10 Baud rate bps Value 9600 3 19200 4 38400 5 57600 6 115200 7 230400 8...

Page 175: ...ically by the nBlue module When the attribute value is updated from the host using the Custom Profile Update Value command notifications and indications will automatically be sent to any client that h...

Page 176: ...ofile settings Command Format ATSCP No_Response_Timeout Command Parameter s No_Response_Timeout Integer value from 1 65535 ms The timeout after no response received from the host to CP_READ and CP_WRI...

Page 177: ...ncluded Characteristic Structures UUID uint8 16 Settings uint8 bit field Reserved Reserved Reserved Indicate Notify Write Write No Response Read 0 0 0 1 1 1 1 1 Read Reading the value permitted Write...

Page 178: ...ORKS 0x02 Access possible with Just Works security at least SEC_MITM 0x03 Access possible with MITM security at least Maximum Attribute Value Length uint16 little endian format Maximum value of 512 0x...

Page 179: ...40000E8DF4E40A8EC5EB89C80E29D02B3040001E8DF4E40A8EC5EB8 9C80E29D1F010301140006436861722031022AA7010104002AA800010400B304 0002E8DF4E40A8EC5EB89C80E29D15010301140006436861722032012AA70101 0400 cr RESPON...

Page 180: ...ngs Hex Value Value Characteristic UUID B3040002E8DF4E40A8EC5EB89C80E29D Characteristic Settings 15 Read Write Indicate Characteristic Read Permission 01 SEC_OPEN Characteristic Write Permission 03 SE...

Page 181: ...mat Value Command Parameter s Svc_Index The service index as an Integer value from 0 14 Char_Index The characteristic index as an Integer value from 0 62 Desc_Index The descriptor index as an Integer...

Page 182: ...n previously set the value sent will be blank Command Format ATCPRR Conn_Handle Svc_Index Char_Index Desc_Index Result Command Parameter s Conn_Handle Connection handle Svc_Index The service index as...

Page 183: ...dex Char_Index Desc_Index Result Command Parameter s Conn_Handle Connection handle Svc_Index The service index as an Integer value from 0 14 Char_Index The characteristic index as an Integer value fro...

Page 184: ...service BAS UUID 0x180F The service is found at attribute handles 25 28 COMMAND ATGDPSU 0 180F cr RESPONSE cr_lf OK cr_lf EVENT cr_lf GATT_DPS 0 25 28 180F cr_lf EVENT cr_lf GATT_DONE 0 0 0 cr_lf 3 D...

Page 185: ...ations have been enabled they will be received in GATT_VAL events If connected to an S2 module we can manually set the battery level to trigger a notification Here we set the battery level to 99 and r...

Page 186: ...tising device The 4 and 2 highlighted below indicate the device is advertising with a primary PHY of LR and a secondary PHY of 2M On Central Module COMMAND ATDILE 4 cr RESPONSE cr_lf OK cr_lf EVENT cr...

Page 187: ...ilable This should be fixed in a future release On Central Module COMMAND ATCS cr RESPONSE cr_lf OK cr_lf EVENT cr_lf 4 2 1 ECFE7E1CBAE1 0 16 0 400 247 0 0 8 cr_lf EVENT cr_lf DONE 2 0 cr_lf 6 Once co...

Page 188: ...bytes big endian Measured Power A value containing the average RSSI measured at 1m from the beacon Set to default of 59 0x5C if unknown 1 byte Relevant Commands ATSDSDLE should be used as follows to s...

Page 189: ...assign Minor ID s to each room in the house Basement 0 Media Room 1 Utility Room Main Floor 0 Garage 1 Kitchen 2 Family Room Second Floor 0 Master Bedroom 1 Guest Bedroom 2 Office A beacon for the Fam...

Page 190: ...Non Extended Discovery EXT_DISCOVERY Extended Discovery Connection CONNECT Connect DISCONNECT Disconnect SCCPS Set Current Connection Parameter Status CPU Connection Parameter Update MTU Maximum Tran...

Page 191: ...TFC Flash Config Manual ATSCFG ATSCFG Set Get Configuration X ATCFG Configuration Dump Sleep ATZ Enable Sleep Mode ATSZ ATSZ Set Get Sleep Configuration 0 0 0 0 X Module Information ATMT Get Module Ty...

Page 192: ...FFFFFFFFF Ext Advertising Data 0201FF020AFF0512FFFF FFFF1107FFFFFFFFFFF FFFFFFFFFFFFFFFFFFF FF05FFFFFFFFFF1509F FFFFFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFFFFF F X Discovery ATDILE LE Discovery ATSDILE ATSDIL...

Page 193: ...iscover Characteristics ATGDCD GATT Discover Char Descriptors ATGR ATGRU GATT Read ATGRM GATT Read Multiple ATGRL GATT Read Long ATGW ATGWN GATT Write ATGWP ATGWPE GATT Write Prepared GATT Service Con...

Page 194: ...stle Rock CO 80104 USA 303 957 1003 sales blueradios com www BlueRadios com Custom Profile ATSCP ATSCP Set Custom Profile Settings Get Custom Profile Settings 3000 ATSCPS Add Custom Profile Service AT...

Page 195: ...ess Profile GATT Generic Attribute Profile GFSK Gaussian Frequency Shift Keying GND Ground HCI Host Controller Interface IP Internet Protocol ISM Industrial Scientific and Medical LED Light Emitting D...

Search results

Summary of Contents for nBlue BT5.0

Reviews:

Related manuals for nBlue BT5.0

Brands by name

Popular brands

Blue Radio nBlue BT5.0, Manual

Search results

Summary of Contents for nBlue BT5.0

Reviews:

Related manuals for nBlue BT5.0

Brands by name

Popular brands