AT COMMANDS
Use AT commands on our Web Terminal. Click here
AT
- Basic AT-Command.
| Command | Syntax |
|---|---|
| AT | AT |
Example:
AT
OK
AT
{"C":1,"cmd":"AT"}
{"A":1,"err":0,"errMsg":"ok"}
{"E":1,"nol":3}
ATA
- Shows/hides ASCII values from notification/indication/read responses. ATA0 hides the ASCII values, ATA1 shows the ASCII values.
| Command | Syntax |
|---|---|
| ATA | ATA0 |
| ATA1 |
Example of a notification response with and without ASCII value shown With ASCII on:
handle_evt_gattc_notification: conn_idx=0000 handle=0039 length=5
Value received: #Eg‰
Hex: 0x0123456789
Size: 5
{777:"0000","001f":{"ascii":"{638:{T:"00DC",H:"00EA",CO2:"01AE",IAQ:"0075",PPM:"00C8"}}","len":59}}
{777:"0000","001f":{"hex":"0x7B3633383A7B543A2230304443222C483A2230304541222C434F323A2230314145222C4941513A2230303735222C50504D3A2230304338227D7D00","len":59}}
With ASCII off:
handle_evt_gattc_notification: conn_idx=0000 handle=0039 length=5
Hex: 0x0123456789
Size: 5
{"777": "0000","001f": {"hex": "0x7B3633383A7B543A2230304443222C483A2230304541222C434F323A2230314145222C4941513A2230303735222C50504D3A2230304338227D7D00","len": 59}}
Example:
ATA0
Show ASCII Off!
ATA1
{"C":1,"cmd":"ATA1"}
{"A":1,"err":0,"errMsg":"ok"}
{"R":1,"showAscii":true}
{"E":1,"nol":4}
ATA0
{"C":2,"cmd":"ATA0"}
{"A":2,"err":0,"errMsg":"ok"}
{"R":2,"showAscii":false}
{"E":2,"nol":4}
ATASPS
- Toggle between ascii and hex responses received from SPS. ATASPS0 shows hex values, ATASPS1 shows ASCII. ASCII is on by default.
| Command | Syntax |
|---|---|
| ATASPS | ATASPS0 |
| ATASPS1 |
Example of a SPS response with HEX shown and with ASCII shown
With ASCII shown:
# On Server:
[Received]: HELLO
# On Client:
handle_evt_gattc_notification: conn_idx=0000 handle=000d length=6
HELLO
# Client
{777:"0000","SPS":{"ascii":"TEST","len":5}}
# Server
{279:"0000","SPS":{"ascii":"TEST","len":5}}
With Hex shown:
# On Server:
(conn_idx=0000 len=6)
48454C4C4F00
# On Client:
(conn_idx=0000 length=6)48454C4C4F00
# Client
{777:"0000","SPS":{"hex":"0x5445535400","len":5}}
# Server
{279:"0000","SPS":{"hex":"0x5445535400","len":5}}
Example:
ATASPS0
Show SPS Ascii Off!
ATASPS1
{"C":3,"cmd":"ATASPS1"}
{"A":3,"err":0,"errMsg":"ok"}
{"R":3,"showSPSAscii":true}
{"E":3,"nol":4}
ATASPS0
{"C":4,"cmd":"ATASPS0"}
{"A":4,"err":0,"errMsg":"ok"}
{"R":4,"showSPSAscii":false}
{"E":4,"nol":4}
ATDS
- Turns auto discovery of services when connecting on/off. ATDS0 off, ATDS1 on. On by default. This command can be used in both central and peripheral role.
| Command | Syntax |
|---|---|
| ATDS | ATDS0 |
| ATDS1 |
Example:
ATDS0
Auto discover Services Off!
ATDS1
{"C":5,"cmd":"ATDS1"}
{"A":5,"err":0,"errMsg":"ok"}
{"R":5,"autoDiscoverSvc":true}
{"E":5,"nol":4}
ATDS0
{"C":6,"cmd":"ATDS0"}
{"A":6,"err":0,"errMsg":"ok"}
{"R":6,"autoDiscoverSvc":false}
{"E":6,"nol":4}
ATE
- Turn echo on/off. (On per default).
| Command | Syntax |
|---|---|
| ATE | ATE0 |
| ATE1 |
Example:
ATE0
ECHO OFF
ATE0
{"C":7,"cmd":"ATE0"}
{"A":7,"err":0,"errMsg":"ok"}
{"R":7,"showEcho":false}
{"E":7,"nol":4}
{"C":8,"cmd":"ATE1"}
{"A":8,"err":0,"errMsg":"ok"}
{"R":8,"showEcho":true}
{"E":8,"nol":4}
ATEW
- Turn WRITTEN DATA echo on/off after GATTCWRITE commands. (On per default).
| Command | Syntax |
|---|---|
| ATEW | ATEW0 |
| ATEW1 |
| Commands affected |
|---|
| AT+GATTCWRITE |
| AT+GATTCWRITEB |
| AT+GATTCWRITEWR |
| AT+GATTCWRITEWRB |
Instead of response for AT+GATTCWRITE & AT+GATTCWRITEWR
DATA WRITTEN: <data>
or for AT+GATTCWRITEB & AT+GATTCWRITEWRB
DATA WRITTEN: <data>
Size: <size>
It will instead acknowledge that the command has been accepted with "DATA WRITTEN!".
An example using AT+GATTCWRITEWRB with GATTC WRITE ECHO OFF (ATEW0):
AT+GATTCWRITEWRB=001B 0101
DATA WRITTEN!
Example:
ATEW0
GATTC WRITE ECHO OFF
ATEW1
{"C":10,"cmd":"ATEW1"}
{"A":10,"err":0,"errMsg":"ok"}
{"R":10,"showGattcWriteEcho":true}
{"E":10,"nol":4}
ATEW0
{"C":11,"cmd":"ATEW0"}
{"A":11,"err":0,"errMsg":"ok"}
{"R":11,"showGattcWriteEcho":false}
{"E":11,"nol":4}
ATI
- Device information query. Returns firmware version, hardware type and unique organization identifier.
| Command | Syntax |
|---|---|
| ATI | ATI |
Example:
ATI
Smart Sensor Devices
DA14683
Smart USB Dongle
Firmware Version: 1.1.0
Peripheral role
Not Connected
Not Advertising
ATI
{"C":12,"cmd":"ATI"}
{"A":12,"err":0,"errMsg":"ok"}
{"R":12,"dev":"Smart Sensor Devices","hw":"DA14683","name":"BleuIO"}
{"R":12,"fwVer":"2.1.5b","gap_role:"peripheral"}
{"R":12,"connected":false,"advertising":false}
{"E":12,"nol":6}
ATR
- Trigger platform reset.
| Command | Syntax |
|---|---|
| ATR | ATR |
Example:
ATR
OK
ATR
{"C":14,"cmd":"ATR"}
{"A":14,"err":0,"errMsg":"ok"}
{"R":14,"action":"restart"}
{"E":14,"nol":4}
ATV
- Turn VERBOSE mode on/off. (Off per default).
| Command | Syntax |
|---|---|
| ATV | ATV0 |
| ATV1 |
Changes the format for all the BleuIO's output. See the VERBOSE Mode information page for more details. Example:
ATV1
VERBOSE ON
ATV0
{"C":13,"cmd":"ATV0"}
{"A":13,"err":0,"errMsg":"ok"}
{"R":13,"verboseOn":false}
{"E":13,"nol":4}
ATV1
VERBOSE ON
AT+ADVDATA
- Sets or queries the advertising data. Data must be provided as hex string.
The content will take effect only after advertising is restarted.
If you want to send several data types separate it with a space.
| Command | Syntax |
|---|---|
| AT+ADVDATA | |
| AT+ADVDATA=xx:xx:xx:xx:xx:xx | |
| AT+ADVDATA=(xx:xx:xx:xx) (xx:xx:xx:xx:xx) |
Example:
AT+ADVDATA=04:09:43:41:54
OK
ADVERTISING DATA: 0409434154
AT+ADVDATA
{"C":0,"cmd":"AT+ADVDATA"}
{"A":0,"err":0,"errMsg":"ok"}
{"R":0,"adv":"03FF5B071107B75C49D204A34071A0B535853EB08307000000000000000000"}
{"E":0,"nol":4}
AT+ADVDATA=04:09:43:41:54
{"C":1,"cmd":"AT+ADVDATA=04:09:43:41:54"}
{"A":1,"err":0,"errMsg":"ok"}
{"R":1,"adv":"04094341540000000000000000000000000000000000000000000000000000"}
{"E":1,"nol":4}
AT+ADVDATAI
- Sets advertising data in a way that lets it be used as an iBeacon.
| Command | Syntax |
|---|---|
| AT+ADVDATAI | AT+ADVDATAI=(UUID)(MAJOR)(MINOR)(TX) |
Example:
AT+ADVDATAI=5f2dd896-b886-4549-ae01-e41acd7a354a0203010400
OK
iBeacon created with uuid: 5f2dd896-b886-4549-ae01-e41acd7a354a
AT+ADVDATAI=5f2dd896-b886-4549-ae01-e41acd7a354a0203010400
{"C":2,"cmd":"AT+ADVDATAI=5f2dd896-b886-4549-ae01-e41acd7a354a0203010400"}
{"A":2,"err":0,"errMsg":"ok"}
{"R":2,"uuid":"5f2dd896-b886-4549-ae01-e41acd7a354a"}
{"E":2,"nol":4}
AT+ADVSTART
- Starts advertising. Advertising interval can optionally be specified in milliseconds (100 to 3000ms). Time_ms controlls how for how long the dongle will advertise. Set to 0 for unlimited. Returns ERROR if advertising is already active or if the device is in central role.
| Command | Syntax |
|---|---|
| AT+ADVSTART | AT+ADVSTART |
| AT+ADVSTART=(mode);(intv_min);(intv_max);(time_ms); |
Supported modes:
| Code | Mode |
|---|---|
| 0: | Non-connectable mode |
| 1: | Undirected mode |
| 2: | Directed mode |
| 3: | Directed Low Duty Cycle mode |
Example:
AT+ADVSTART=1;200;300;20;
Advertising type: GAP_CONN_MODE_UNDIRECTED Advertising interval minimum: 200 maximum: 300
ADVERTISING...
{"C":3,"cmd":"AT+ADVSTART"}
{"A":3,"err":0,"errMsg":"ok"}
{"R":3,"action":"advertising"}
{"R":3,"advType":"GAP_CONN_MODE_UNDIRECTED","intvMin":"1100","intvMax":"1100"}
{"E":3,"nol":5}
AT+ADVSTART=1;200;300;20;
{"C":16,"cmd":"AT+ADVSTART=1;200;300;20;"}
{"A":16,"err":0,"errMsg":"ok"}
{"R":16,"action":"advertising"}
{"R":16,"advType":"GAP_CONN_MODE_UNDIRECTED","intvMin":"200","intvMax":"300"}
{"E":16,"nol":5}
AT+ADVSTOP
- Stops advertising. Returns ERROR if not already advertising.
| Command | Syntax |
|---|---|
| AT+ADVSTOP | AT+ADVSTOP |
Example:
AT+ADVSTOP
STOPPING ADVERTISING...
ADVERTISING STOPPED.
{"C":4,"cmd":"AT+ADVSTOP"}
{"A":4,"err":0,"errMsg":"ok"}
{"R":4,"info":"stopping advertising"}
{"E":4,"nol":4}
{260:"FFFF","action":"advertising stopped"} # <--- Event
AT+ADVRESP
- Sets or queries scan response data. Data must be provided as hex string. Changes to take effect after restart of advertising.
| Command | Syntax |
|---|---|
| AT+ADVRESP | |
| AT+ADVRESP=(xx:xx:xx:xx:xx:xx:xx) |
Example:
AT+ADVRESP=04:09:43:41:54
OK
RESPONSE DATA: 0409434154
{"C":5,"cmd":"AT+ADVRESP"}
{"A":5,"err":0,"errMsg":"ok"}
{"R":5,"rsp":"1109426C6575494F0000000000000000000000000000000000000000000000"}
{"E":5,"nol":4}
AT+ADVRESP=04:09:43:41:54
{"C":6,"cmd":"AT+ADVRESP=04:09:43:41:54"}
{"A":6,"err":0,"errMsg":"ok"}
{"R":6,"adv":"0409434154"}
{"E":6,"nol":4}
AT+CANCELCONNECT
While in Central Mode, cancels any ongoing connection attempts.
Useful for when the peripheral has stopped advertising before a successful connection, or if an incorrect MAC address has been entered.
| Command | Syntax |
|---|---|
| AT+CANCELCONNECT | AT+CANCELCONNECT |
Example:
AT+CANCELCONNECT
OK
AT+CANCELCONNECT
{"C":11,"cmd":"AT+CANCELCONNECT"}
{"A":11,"err":0,"errMsg":"ok"}
{"E":11,"nol":3}
AT+CENTRAL
- Sets the device Bluetooth role to central role. Advertising must be stopped and any connection must be terminated before the role change is accepted.
| Command | Syntax |
|---|---|
| AT+CENTRAL | AT+CENTRAL |
Example:
AT+CENTRAL
OK
AT+CENTRAL
{"C":12,"cmd":"AT+CENTRAL"}
{"A":12,"err":0,"errMsg":"ok"}
{"E":12,"nol":3}
AT+CLEARINDI
- Disables indication for selected characteristic.
| Command | Syntax |
|---|---|
| AT+CLEARINDI | AT+CLEARINDI=(indication handle) |
Which is the indication handle?
0011 char 6e400001-b5a3-f393-e0a9-e50e24dcca9e prop=20 (-----I--) # <-------- The I means that the Characteristic Properties has Indication
0012 ---- 6e400003-b5a3-f393-e0a9-e50e24dcca9e # <--------- This (0012) is the handle you want to send in.
0013 desc 0x2902 # You can use AT+GATTCREAD to read the description handle (here 0013) to see if indication is set. (0x0100 = set, 0x0000 = not set)
- If the status=0 in handle_evt_gattc_write_completed string, that means you have successfully written to it.
Example:
AT+CLEARINDI=0012
handle_evt_gattc_write_completed: conn_idx=0000 handle=0013 status=0
{"C":19,"cmd":"AT+CLEARINDI=0014"}
{"A":19,"err":0,"errMsg":"ok"}
{"E":19,"nol":3}
{776:"0000","0015":{"writeStatus":0}} # <--- Event
AT+CLEARNOTI
- Disables notification for selected characteristic.
| Command | Syntax |
|---|---|
| AT+CLEARNOTI | AT+CLEARNOTI=(notification handle) |
Which is the notification handle?
0011 char 6e400001-b5a3-f393-e0a9-e50e24dcca9e prop=10 (----N---) # <-------- The N means that the Characteristic Properties has Notify
0012 ---- 6e400003-b5a3-f393-e0a9-e50e24dcca9e # <--------- This (0012) is the handle you want to send in.
0013 desc 0x2902 # You can use AT+GATTCREAD to read the description handle (here 0013) to see if notification is set. (0x0100 = set, 0x0000 = not set)
- If the status=0 in handle_evt_gattc_write_completed string, that means you have successfully written to it.
Example:
AT+CLEARNOTI=0012
handle_evt_gattc_write_completed: conn_idx=0000 handle=0013 status=0
AT+CLEARNOTI=000D
{"C":21,"cmd":"AT+CLEARNOTI=000D"}
{"A":21,"err":0,"errMsg":"ok"}
{"E":21,"nol":3}
{776:"0000","000e":{"writeStatus":0}} # <--- Event
AT+CLIENT
- Only usable in Dual role. Sets the dongle role towards the targeted connection to client.
| Command | Syntax |
|---|---|
| AT+CLIENT | AT+CLIENT |
Example:
AT+CLIENT
OK
AT+CLIENT
{"C":29,"cmd":"AT+CLIENT"}
{"A":29,"err":0,"errMsg":"ok"}
{"E":29,"nol":3}
AT+DEVICENAME
- Get or sets the device name used for GAP service. Cannot be set while connected or advertising.
| Command | Syntax |
|---|---|
| AT+DEVICENAME | AT+DEVICENAME=new_device_name |
| or | |
| AT+DEVICENAME |
Example:
AT+DEVICENAME=NEW_NAME
SET DEVICE NAME=NEW_NAME
OK
AT+DEVICENAME
{"C":30,"cmd":"AT+DEVICENAME"}
{"A":30,"err":0,"errMsg":"ok"}
{"R":30,"deviceName":"BleuIO"}
{"E":30,"nol":4}
AT+DEVICENAME=TESTNAME
{"C":0,"cmd":"AT+DEVICENAME=TESTNAME"}
{"A":0,"err":0,"errMsg":"ok"}
{"R":0,"deviceName":"TESTNAME"}
{"E":0,"nol":4}
AT+DIS
- Shows the Device Information Service information to be used.
| Command | Syntax |
|---|---|
| AT+DIS | AT+DIS |
Shows the Device Information Service information to be used. Will show the default BleuIO information if no custom information has been set.
Example:
AT+DIS
DIS Service is set but not locked in.
dis_info_start:
manufacturer=MAN_NAME
model_number=MOD_NUM
serial_number=SERIAL
hw_revision=HW_REV
fw_revision=FW_REV
sw_revision=SW_REV
dis_info_end
AT+DIS
{"C":32,"cmd":"AT+DIS"}
{"A":32,"err":0,"errMsg":"ok"}
{"R":32,"info":"DIS service info is locked in"}
{"R":32,"manuf":"Smart Sensor Devices","mdlNr":"SSD005","sNr":"000000000000"}
{"R":32,"hwRev":"Rev.A","fwRev":"2.1.5","swRev":"bleuio.2.1.5_Release"}
{"E":32,"nol":6}
AT+DUAL
- Sets the device Bluetooth role to dual role. This means it has the capabilities of both Central and Peripheral role. Advertising must be stopped and, any connection must be terminated before the role change is accepted.
| Command | Syntax |
|---|---|
| AT+DUAL | AT+DUAL |
Example:
AT+DUAL
OK
AT+DUAL
{"C":27,"cmd":"AT+DUAL"}
{"A":27,"err":0,"errMsg":"ok"}
{"E":27,"nol":3}
AT+ENTERPASSKEY
- When faced with this message: BLE_EVT_GAP_PASSKEY_REQUEST use the AT+ENTERPASSKEY command to enter the 6-digit passkey to continue the pairing request.
| Command | Syntax |
|---|---|
| AT+ENTERPASSKEY | |
| AT+ENTERPASSKEY=xxxxxx | |
Example:
AT+ENTERPASSKEY=123456
OK
AT+ENTERPASSKEY=123456
{"C":6,"cmd":"AT+ENTERPASSKEY=123456"}
{"A":6,"err":0,"errMsg":"ok"}
{"E":6,"nol":3}
AT+FINDSCANDATA
- Scans for all advertising/response data which contains the search params for infinite time unless an optional scan timer parameter is set.
Scan can be stopped at any time by sending CTRL+C (0x03).
| Command | Syntax |
|---|---|
| AT+FINDSCANDATA | AT+FINDSCANDATA=search params |
| AT+FINDSCANDATA=search params=seconds |
Example:
AT+FINDSCANDATA=FF5
SCANNING...
[00:D4:2E:CD:72:23] Device Data [ADV]: 02010618FF5B00110101010101010101011405326845343864353466757675
[D7:D3:AA:00:B5:24] Device Data [ADV]: 02010618FF540930430924302903049320943094F90890548359049E495432
[F9:0D:00:E7:72:21] Device Data [ADV]: 02010618FF540930430924302903049320943094F90890548359049E495432
[F3:00:ED:AD:8A:22] Device Data [ADV]: 02010618FF5A40930430924302903049320943094F90890548359049E49543
[F3:DE:00:D5:96:33] Device Data [ADV]: 0201061AFF5C49320943094F90890548359049E49543249320943094F90890
[C9:70:27:AF:01:54] Device Data [ADV]: 02010618FF5E924302903049320943094F9089054835992430290304932094
[D7:00:AA:07:00:EE] Device Data [ADV]: 02010618FF5301010101010101011405326845343864353466701010101010
AT+FINDSCANDATA=FF5B07
{"C":36,"cmd":"AT+FINDSCANDATA=FF5B07"}
{"A":36,"err":0,"errMsg":"ok"}
{"R":36,"action":"scanning"}
{"E":36,"nol":4}
{"SF":36,"addr":"CC:EA:2B:D7:88:48","type":0,"data":"0201061AFF5B0705040578EBDD008427E800C0005201000000000000020600"}
{"SF":36,"addr":"D0:97:8B:FE:18:6D","type":0,"data":"0201061BFF5B0705042200800E008127E900B000CF00000000000000020703"}
# Until stopped with Ctrl+C
AT+FINDSCANDATA=FF5B07=2
{"C":38,"cmd":"AT+FINDSCANDATA=FF5B07=2"}
{"A":38,"err":0,"errMsg":"ok"}
{"R":38,"action":"scanning"}
{"E":38,"nol":4}
{"SF":38,"addr":"F5:50:35:CF:B1:ED","type":0,"data":"0201061BFF5B07050422013FBD007D27E000BB00F419000000000000020A02"}
{"SF":38,"addr":"D2:B1:28:3F:42:D4","type":0,"data":"0201061BFF5B070504220049880B7F27EE00AB000A01000000000000024503"}
{"SE":38,"action":"scan completed"}
AT+FRSSI
- Sets RSSI filter for scan results, afterwards scans will only show results with the chosen max value or below.
| Command | Syntax |
|---|---|
| AT+FRSSI | AT+FRSSI=max_rssi |
Acceptable parameter range: -1 to -99
Example:
AT+FRSSI=-76
OK
AT+FRSSI=-50
{"C":40,"cmd":"AT+FRSSI=-50"}
{"A":40,"err":0,"errMsg":"ok"}
{"E":40,"nol":3}
AT+GAPADDRTYPE
- Sets or queries what address type the dongle will use. Changing address type cannot be done while advertising or while connected to other devices.
| Command | Syntax |
|---|---|
| AT+GAPADDRTYPE | AT+GAPADDRTYPE=address_type_code |
| or | |
| AT+GAPADDRTYPE |
Table of supported address types:
| Address Type | Description | Code |
|---|---|---|
| PUBLIC_STATIC_ADDRESS | Public Static Address | 1 |
| PRIVATE_STATIC_ADDRESS | Private Static Address | 2 |
| PRIVATE_RANDOM_RESOLVABLE_ADDRESS | Private Random Resolvable Address | 3 |
| PRIVATE_RANDOM_NONRESOLVABLE_ADDRESS | Private Random Non-resolvable Address | 4 |
| PRIVATE_CNTL | Private Random Resolvable address using Bluetooth LE Privacy v1.2 | 5 |
Non-static addresses will renew themselves every 150 seconds.
When 'Private Non-resolvable Address' is set BleuIO will not be able to connect to other devices or advertise in any other mode than in Non-connectable mode: GAP_CONN_MODE_NON_CONN. This will be chosen by default if starting advertising with the AT+ADVSTART command (without parameters) if Private Random Non-resolvable Address is set.
About Bluetooth LE Privacy:
"When Bluetooth LE Privacy is in use and advertising packets contain randomly generated MAC addresses disguising your device’s identity, the real MAC address remains hidden away. But what use is this if the outside world sees your device as having a different address?
The answer lies in the Bluetooth pairing process—Bluetooth® users are familiar with this process. Pairing indicates you trust the other device and want to interact with it. For example, if you pair your activity tracker with your phone, from that point on, the phone will have a special, trusted relationship with the tracker. What happens is much more involved but after pairing, the two devices will possess various encryption keys, one of which is concerned with privacy. This key is called the Identity Resolution Key (IRK). IRK allows the first device to translate those special, random MAC addresses which appear in the advertising packets from the second device, to the real MAC address in the second device. This capability is only in devices you have explicitly trusted."
- From "Bluetooth Technology Protecting Your Privacy"
Example:
AT+GAPADDRTYPE=3
OK
AT+GAPADDRTYPE
{"C":41,"cmd":"AT+GAPADDRTYPE"}
{"A":41,"err":0,"errMsg":"ok"}
{"R":41,"addrType":"PUBLIC_STATIC_ADDRESS"}
{"E":41,"nol":4}
AT+GAPADDRTYPE=2
{"C":8,"cmd":"AT+GAPADDRTYPE=2"}
{"A":8,"err":0,"errMsg":"ok"}
{"E":8,"nol":3}
AT+GAPCONNECT
- Initiates a connection with a specific slave device. Upon successfully connecting attempts to display the services of the peripheral (if auto-discover services (ATDS) is on). The dongle must be in a central role.
| Command | Syntax |
|---|---|
| AT+GAPCONNECT | AT+GAPCONNECT=[addr_type]slave_address |
| AT+GAPCONNECT=[addr_type]slave_address=intv_min:intv_max:slave_latency:supervision_timeout: |
| Address Type | |
|---|---|
| [0] | PUBLIC_ADDRESS |
| [1] | PRIVATE_ADDRESS |
If no connection parameters are entered the default values will be used (intv_min=30 intv_max=30 slave_latency=0 supervision_timeout=1000).
| Connection Parameter | Range |
|---|---|
| intv_min (Connection Interval Min) | 7.5ms-4000ms |
| intv_max (Connection Interval Max) | 7.5ms-4000ms |
| slave_latency (Slave Latency) | 0-499* |
| supervision_timeout (Supervision Time-out) | 100ms-32000ms |
(*) The slave latency can also not exceed ((supervision*timeout / (intv_max * 2)) -1).
The CI min and CI max as shown upon connection event are calculated as such: (interval in ms) * 100 / 125. So if you for example set the intv_min to 30 it will result in a CI min of 24.
*NEW(v2.1.3)* If a connection fails to be established and causes a disconnection event right after a connection event, the dongle will now automatically try to reconnect instead of showing the disconnecting event. The response shown will be: "Connection failed to be established. Reconnecting..." It will try up to 6 times. If it fails after that this response will be shown: "DISCONNECTED. FAILED TO ESTABLISH CONNECTION!" along with a disconnection event.
This command has a two-part response.
First the "Trying to connect..." response is the acknowledgement that the command has been accepted and will follow immediately after the command has been run.
The "handle_evt_gap_connected:..." response will trigger afterwards when the operation is completed. If auto-discover services (ATDS) is not turned off then all services will be discovered as well and the event "handle_evt_gattc_browse_completed:..." will trigger when it's done.
Be aware that between the first and second response other events can trigger, for example, notifications or write operations.
Example:
AT+GAPCONNECT=[0]01:01:01:01:01:01=8:8:0:100:
Trying to connect...
CONNECTED.
Target conn indx changed to=0000 # (only shown on first connection)
handle_evt_gap_connected: conn_idx=0000 address=01:01:01:01:01:01 CI max is 24.
Peripheral exchanged tx data length is 251, rx data length is 251.
Peripheral updated CI min is 24, CI max is 24.
Peripheral updated CI min is 24, CI max is 24.
{discover and shows services...} # (only if auto discover services (ATDS) is on)
AT+GAPCONNECT=[0]00:00:00:00:00:00
{"C":28,"cmd":"AT+GAPCONNECT=[0]00:00:00:00:00:00"}
{"A":28,"err":0,"errMsg":"ok"}
{"R":28,"action":"connecting","addr":"00:00:00:00:00:00"}
{"E":28,"nol":4}
{256:"0000",{"action":"target conn index changed","target":"0000"}} # <--- Event
{256:"0000",{"action":"connected","addr":"00:00:00:00:00:00","CImin":24,"CImax":24}} # <--- Event
AT+GAPDISCONNECT
- Disconnects from a peer Bluetooth device. This command can be used in both central and peripheral role.
| Command | Syntax |
|---|---|
| AT+GAPDISCONNECT | AT+GAPDISCONNECT |
Example:
AT+GAPDISCONNECT
handle_evt_gap_disconnected: conn_idx=0000 address=01:01:01:01:01:01.
DISCONNECTED.
Target conn indx changed to=0001 # (only shown if connected to multiple devices)
AT+GAPDISCONNECT
{"C":26,"cmd":"AT+GAPDISCONNECT"}
{"A":26,"err":0,"errMsg":"ok"}
{"R":26,"disconnect_target":"0000"}
{"E":26,"nol":4}
{258:"0000",{"action":"disconnected","addr":"00:00:00:00:00:00","reason":"16"}} # <--- Event
AT+GAPDISCONNECTALL
- Disconnects from all connected peer Bluetooth devices. This command can be used in both central and peripheral role.
| Command | Syntax |
|---|---|
| AT+GAPDISCONNECTALL | AT+GAPDISCONNECTALL |
This command has several responses.
First the "Disconnecting all connected devices..." response is the acknowledgement that the command has been accepted and will follow immediately after the command has been run.
The "handle_evt_gap_disconnected:..." response will trigger afterwards when a disconnection action is completed.
Lastly the "All connections terminated." response will trigger when all devices have been disconnected.
Be aware that between the different responses other events can trigger, for example, notifications or write operations.
Example:
AT+GAPDISCONNECTALL
Disconnecting all connected devices...
handle_evt_gap_disconnected: conn_idx=0000 address=01:01:01:01:01:01.
DISCONNECTED.
Target conn indx changed to=0001
handle_evt_gap_disconnected: conn_idx=0001 address=02:02:02:02:02:02.
DISCONNECTED.
Target conn indx changed to=0002
handle_evt_gap_disconnected: conn_idx=0002 address=03:03:03:03:03:03.
DISCONNECTED.
All connections terminated.
AT+GAPDISCONNECTALL
{"C":3,"cmd":"AT+GAPDISCONNECTALL"}
{"A":3,"err":0,"errMsg":"ok"}
{"R":3,"disconnect_target":"all"}
{"E":3,"nol":4}
{258:"0000",{"action":"disconnected","addr":"00:00:00:00:00:00","reason":"16"}} # <--- Event
{258:"0000",{"action":"target conn index changed","target":"0001"}} # <--- Event
{258:"0001",{"action":"disconnected","addr":"01:01:01:01:01:01","reason":"16"}} # <--- Event
{258:"0001",{"info":"all connections terminated"}} # <--- Event
AT+GAPIOCAP
- Sets or queries what input and output capabilities the device has. Parameter is number between 0 to 4. Description of supported modes bellow.
| Command | Syntax |
|---|---|
| AT+GAPIOCAP | |
| AT+GAPIOCAP=x | |
| or | |
| AT+GAPIOCAP |
Supported modes:
| Code | Mode |
|---|---|
| 0: | (GAP_IO_CAP_DISP_ONLY) Display only |
| 1: | (GAP_IO_CAP_DISP_YES_NO) Display + yes & no |
| 2: | (GAP_IO_CAP_KEYBOARD_ONLY) Keyboard only |
| 3: | (GAP_IO_CAP_NO_INPUT_OUTPUT) No input no output |
| 4: | (GAP_IO_CAP_KEYBOARD_DISP) Keyboard + display |
Example:
AT+GAPIOCAP=4
OK
I/O CAP = GAP_IO_CAP_KEYBOARD_DISP
AT+GAPIOCAP
{"C":4,"cmd":"AT+GAPIOCAP"}
{"A":4,"err":0,"errMsg":"ok"}
{"R":4,"ioCap":"GAP_IO_CAP_NO_INPUT_OUTPUT"}
{"E":4,"nol":4}
AT+GAPIOCAP=4
{"C":10,"cmd":"AT+GAPIOCAP=4"}
{"A":10,"err":0,"errMsg":"ok"}
{"R":10,"ioCap":"GAP_IO_CAP_KEYBOARD_DISP"}
{"E":10,"nol":4}
AT+GAPPAIR
- Starts a pairing (AT+GAPPAIR) or bonding procedure (AT+GAPPAIR=BOND). Depending on whether the device is master or slave on the connection, it will send a pairing or a security request respectively.
Only usable when connected to a device.
| Command | Syntax |
|---|---|
| AT+GAPPAIR | |
| AT+GAPPAIR=BOND | |
| or | |
| AT+GAPPAIR |
Example:
AT+GAPPAIR
PAIRING...
AT+GAPPAIR
{"C":19,"cmd":"AT+GAPPAIR"}
{"A":19,"err":0,"errMsg":"ok"}
{"R":19,"action":"pairing"}
{"E":19,"nol":4}
{265:"0000","action":"pair completed","status":0,"bond":"false","mitm":"false"} # <--- Event
AT+GAPPAIR=BOND
{"C":22,"cmd":"AT+GAPPAIR=BOND"}
{"A":22,"err":0,"errMsg":"ok"}
{"R":22,"action":"pairing"}
{"E":22,"nol":4}
{265:"0000","action":"pair completed","status":0,"bond":"true","mitm":"false"} # <--- Event
AT+GAPUNPAIR
- Unpair paired devices. This will also remove the device bond data from BLE storage. Usable both when device is connected and when not.
Either unpair all paired devices (AT+GAPUNPAIR) or selected paired device (AT+GAPUNPAIR=device_mac_address). Public= [0] or private= [1] address type prefix required before mac address.
| Command | Syntax |
|---|---|
| AT+GAPUNPAIR | |
| AT+GAPUNPAIR=[x]xx:xx:xx:xx:xx:xx | |
| or | |
| AT+GAPUNPAIR |
Example:
AT+GAPUNPAIR
UNPARIED.
AT+GAPUNPAIR
{"C":20,"cmd":"AT+GAPUNPAIR"}
{"A":20,"err":0,"errMsg":"ok"}
{"R":20,"action":"unpaired"}
{"E":20,"nol":4}
{258:"0000",{"action":"disconnected","addr":"00:00:00:00:00:00","reason":"16"}} # <--- Event
AT+GAPSCAN
- Starts a Bluetooth device scan with or without timer set in seconds. Only accepted when device is in central role and not connected. The scan will continue indefinitely if no parameter is set or until the amount of time set is reached. Scanning aborts if user presses CTRL+C.
| Command | Syntax |
|---|---|
| AT+GAPSCAN | AT+GAPSCAN |
| AT+GAPSCAN=seconds |
Example:
AT+GAPSCAN
SCANNING...
[01] Device: [1]30:63:C5:D0:B1:DE RSSI: -38
[02] Device: [0]D0:76:50:80:0A:98 RSSI: -75(closebeacon.com)
[03] Device: [1]27:5D:B8:2E:96:B0 RSSI: -51
[04] Device: [1]5E:CE:CF:C5:20:BB RSSI: -84
SCAN COMPLETE
AT+GAPSCAN
{"C":23,"cmd":"AT+GAPSCAN"}
{"A":23,"err":0,"errMsg":"ok"}
{"R":23,"action":"scanning"}
{"E":23,"nol":4}
{"S":23,"rssi":-86,"addr":"[1]CC:EA:2B:D7:88:48"}
{"S":23,"rssi":-63,"addr":"[1]D9:CA:5D:68:D0:79"}
# Until stopped with Ctrl+C
AT+GAPSCAN=2
{"C":5,"cmd":"AT+GAPSCAN=2"}
{"A":5,"err":0,"errMsg":"ok"}
{"R":5,"action":"scanning"}
{"E":5,"nol":4}
{"S":5,"rssi":-75,"addr":"[1]F6:9B:76:F9:A7:AB"}
{"S":5,"rssi":-60,"addr":"[1]C6:33:E2:A7:03:A4"}
{"SE":5,"action":"scan completed"}
AT+GAPSTATUS
- Reports the Bluetooth role.
| Command | Syntax |
|---|---|
| AT+GAPSTATUS | AT+GAPSTATUS |
Example:
AT+GAPSTATUS
Central role
Not Connected
Not Advertising
AT+GAPSTATUS
{"C":6,"cmd":"AT+GAPSTATUS"}
{"A":6,"err":0,"errMsg":"ok"}
{"R":6,"gap_role:"dual"}
{"R":6,"connected":true,"noConns":1,"advertising":false}
{"E":6,"nol":5}
AT+GATTCREAD
- Read attribute of remote GATT server. Can only be used in the Central role and when connected to a peripheral.
| Command | Syntax |
|---|---|
| AT+GATTCREAD | AT+GATTCREAD=handle param |
This command has a two-part response.
First "DATA WRITTEN..." response is the acknowledgement that the command has been accepted and will follow immediately after the command has been run.
The "handle_evt_gattc_read_completed:..." response will trigger afterwards when the operation is completed and will include a status code to signify if the operation was successful. (status=0 means OK, anything else means ERROR).
Be aware that between the first and second response other events can trigger, for example, notifications or connections.
Example:
AT+GATTCREAD=001B
OK
handle_evt_gattc_read_completed: conn_idx=0000 handle=001b status=0
Value read: HELLO
Hex: 0x48454C4C4F
Size: 5
AT+GATTCREAD=0003
{"C":2,"cmd":"AT+GATTCREAD=0003"}
{"A":2,"err":0,"errMsg":"ok"}
{"E":2,"nol":3}
{775:"0000","0003":{"readStatus":0,"ascii":"BleuIO","len":6}} # <--- Event
{775:"0000","0003":{"readStatus":0,"hex":"0x426C6575494F","len":6}} # <--- Event
AT+GATTCWRITE
- Write attribute to remote GATT server in ASCII. Can only be used in the Central role and when connected to a peripheral.
| Command | Syntax |
|---|---|
| AT+GATTCWRITE | AT+GATTCWRITE=(handle param) (msg) |
This command has a two-part response.
First "DATA WRITTEN..." response is the acknowledgement that the command has been accepted and will follow immediately after the command has been run.
The "handle_evt_gattc_write_completed:..." response will trigger afterwards when the operation is completed and will include a status code to signify if the operation was successful. (status=0 means OK, anything else means ERROR).
Be aware that between the first and second response other events can trigger, for example, notifications or connections.
Example:
AT+GATTCWRITE=001B HELLO
DATA WRITTEN: HELLO
handle_evt_gattc_write_completed: conn_idx=0000 handle=001b status=0
AT+GATTCWRITE=0014 TEST
{"C":4,"cmd":"AT+GATTCWRITE=0014 TEST"}
{"A":4,"err":0,"errMsg":"ok"}
{"R":4,"data":"TEST"}
{"E":4,"nol":4}
{776:"0000","0014":{"writeStatus":0}} # <--- Event
AT+GATTCWRITEB
- Write attribute to remote GATT server in Hex. Can only be used in the Central role and when connected to a peripheral.
| Command | Syntax |
|---|---|
| AT+GATTCWRITEB | AT+GATTCWRITEB=(handle param) (msg) |
This command has a two-part response.
First "DATA WRITTEN..." response is the acknowledgement that the command has been accepted and will follow immediately after the command has been run.
The "handle_evt_gattc_write_completed:..." response will trigger afterwards when the operation is completed and will include a status code to signify if the operation was successful. (status=0 means OK, anything else means ERROR).
Be aware that between the first and second response other events can trigger, for example, notifications or connections.
Example:
AT+GATTCWRITEB=001B 0101
DATA WRITTEN: 0101
Size: 2
handle_evt_gattc_write_completed: conn_idx=0000 handle=001b status=0
AT+GATTCWRITEB=0014 0101
{"C":5,"cmd":"AT+GATTCWRITEB=0014 0101"}
{"A":5,"err":0,"errMsg":"ok"}
{"R":5,"data":"0101"}
{"E":5,"nol":4}
{776:"0000","0014":{"writeStatus":0}} # <--- Event
AT+GATTCWRITEWR
- Write (without response) attribute to remote GATT server in ASCII. Can only be used in the Central role and when connected to a peripheral.
| Command | Syntax |
|---|---|
| AT+GATTCWRITEWR | AT+GATTCWRITEWR=(handle param) (msg) |
This command has a two part response.
First "DATA WRITTEN..." response is the acknowledgement that the command has been accepted and will follow immediately after the command has been run.
The "handle_evt_gattc_write_completed:..." response will trigger afterwards when the operation is completed and will include a status code to signify if the operation was successful. (status=0 means OK, anything else means ERROR).
Be aware that between the first and second response other events can trigger, for example, notifications or connections.
Example:
AT+GATTCWRITEWR=001B HELLO
DATA WRITTEN: HELLO
handle_evt_gattc_write_completed: conn_idx=0000 handle=001b status=0
AT+GATTCWRITEWR=0014 TEST
{"C":9,"cmd":"AT+GATTCWRITEWR=0014 TEST"}
{"A":9,"err":0,"errMsg":"ok"}
{"R":9,"data":"TEST"}
{"E":9,"nol":4}
{776:"0000","0014":{"writeStatus":0}} # <--- Event
AT+GATTCWRITEWRB
- Write (without response) attribute to remote GATT server in Hex. Can only be used in the Central role and when connected to a peripheral.
| Command | Syntax |
|---|---|
| AT+GATTCWRITEWRB | AT+GATTCWRITEWRB=(handle param) (msg) |
This command has a two part response.
First "DATA WRITTEN..." response is the acknowledgement that the command has been accepted and will follow immediately after the command has been run.
The "handle_evt_gattc_write_completed:..." response will trigger afterwards when the operation is completed and will include a status code to signify if the operation was successful. (status=0 means OK, anything else means ERROR).
Be aware that between the first and second response other events can trigger, for example, notifications or connections.
Example:
AT+GATTCWRITEWRB=001B 0101
DATA WRITTEN: 0101
Size: 2
handle_evt_gattc_write_completed: conn_idx=0000 handle=001b status=0
AT+GATTCWRITEWRB=0014 0101
{"C":8,"cmd":"AT+GATTCWRITEWRB=0014 0101"}
{"A":8,"err":0,"errMsg":"ok"}
{"R":8,"data":"0101"}
{"E":8,"nol":4}
{776:"0000","0014":{"writeStatus":0}} # <--- Event
AT+GETCONN
- Gets a list of currently connected devices along with their mac addresses, connection index, our role towards this connection and if it's bonded/paired.
| Command | Syntax |
|---|---|
| AT+GETCONN | AT+GETCONN |
Example:
AT+GETCONN
[0]00:08:0D:05:20:B0, conn_idx=0000, Our Role: Client, bonded=false, paired=false
[0]00:01:0D:04:65:30, conn_idx=0001, Our Role: Server, bonded=true, paired=true
AT+GETCONN
{"C":10,"cmd":"AT+GETCONN"}
{"A":10,"err":0,"errMsg":"ok"}
{"R":10,"0000":{"addr":"[0]00:00:00:00:00:00","ourRole":"Client","bonded":false,"paired":false}}
{"E":10,"nol":4}
AT+GETMAC
Returns MAC address of the BleuIO device.
| Command | Syntax |
|---|---|
| AT+GETMAC | AT+GETMAC |
AT+GETMAC
OK
OWN MAC ADDRESS:00:00:00:00:00:28
AT+GETSERVICEDETAILS
- Discovers all characteristics and descriptors of a selected service. Must run AT+GETSERVICESONLY command first to get the service handle.
| Command | Syntax |
|---|---|
| AT+GETSERVICEDETAILS | AT+GETSERVICEDETAILS=(service handle param) |
This command has a two part response.
First the "OK" response is the acknowledgement that the command has been accepted and will follow immediately after the command has been run.
The "handle_evt_gattc_browse_completed:..." response will trigger afterwards when the operation is completed and will include a status code to signify if the operation was successful. (status=0 means OK, anything else means ERROR).
Be aware that between the first and second response other events can trigger, for example, notifications or connections.
Example:
AT+GETSERVICEDETAILS=0017
OK
0017 serv 0783b03e-8535-b5a0-7140-a304d2495ce1
0018 char 0783b03e-8535-b5a0-7140-a304d2495ce1 prop=10 (----N---)
0019 ---- 0783b03e-8535-b5a0-7140-a304d2495ce2
001a desc 0x2902
001b desc 0x2901
001c char 0783b03e-8535-b5a0-7140-a304d2495ce1 prop=04 (--X-----)
001d ---- 0783b03e-8535-b5a0-7140-a304d2495ce3
001e desc 0x2902
001f desc 0x2901
0020 char 0783b03e-8535-b5a0-7140-a304d2495ce1 prop=14 (--X-N---)
0021 ---- 0783b03e-8535-b5a0-7140-a304d2495ce4
0022 desc 0x2902
0023 desc 0x2901
handle_evt_gattc_browse_completed: conn_idx=0000 status=0
AT+GETSERVICEDETAILS=0017
{"C":16,"cmd":"AT+GETSERVICEDETAILS=0017"}
{"A":16,"err":0,"errMsg":"ok"}
{"E":16,"nol":3}
AT+GETSERVICES
- Rediscovers a peripheral's services and characteristics.
| Command | Syntax |
|---|---|
| AT+GETSERVICES | AT+GETSERVICES |
This command has a two part response.
First, the "OK" response is the acknowledgement that the command has been accepted and will follow immediately after the command has been run.
The "handle_evt_gattc_browse_completed:..." response will trigger afterwards when the operation is completed and will include a status code to signify if the operation was successful. (status=0 means OK, anything else means ERROR).
Be aware that between the first and second response other events can trigger, for example, notifications or connections.
Example:
AT+GETSERVICES
OK
0001 serv 0x1800
0002 char 0x1800 prop=0a (-R-W----)
0003 ---- 0x2a00
0004 char 0x1800 prop=02 (-R------)
0005 ---- 0x2a01
0006 char 0x1800 prop=02 (-R------)
0007 ---- 0x2a04
0008 char 0x1800 prop=02 (-R------)
0009 ---- 0x2aa6
000a serv 0x1801
000b char 0x1801 prop=20 (-----I--)
000c ---- 0x2a05
000d desc 0x2902
000e serv 6e400001-b5a3-f393-e0a9-e50e24dcca9e
000f char 6e400001-b5a3-f393-e0a9-e50e24dcca9e prop=0c (--XW----)
0010 ---- 6e400002-b5a3-f393-e0a9-e50e24dcca9e
0011 char 6e400001-b5a3-f393-e0a9-e50e24dcca9e prop=10 (----N---)
0012 ---- 6e400003-b5a3-f393-e0a9-e50e24dcca9e
0013 desc 0x2902
handle_evt_gattc_browse_completed: conn_idx=0000 status=0
AT+GETSERVICES
{"C":13,"cmd":"AT+GETSERVICES"}
{"A":13,"err":0,"errMsg":"ok"}
{"E":13,"nol":3}
AT+GETSERVICESONLY
- Discovers a peripherals services.
| Command | Syntax |
|---|---|
| AT+GETSERVICESONLY | AT+GETSERVICESONLY |
This command has a two part response.
First, the "OK" response is the acknowledgement that the command has been accepted and will follow immediately after the command has been run.
The "handle_evt_gattc_discover_completed:..." response will trigger afterwards when the operation is completed and will include a status code to signify if the operation was successful. (status=0 means OK, anything else means ERROR).
Be aware that between the first and second response other events can trigger, for example, notifications or connections.
Example:
AT+GETSERVICESONLY
OK
0001 serv 0x1800
000a serv 0x1801
000b serv 0783b03e-8535-b5a0-7140-a304d2495cb7
0017 serv 0783b03e-8535-b5a0-7140-a304d2495ce1
0024 serv 0x180a
handle_evt_gattc_discover_completed: conn_idx=0000 type=SVC status=0
AT+GETSERVICESONLY
{"C":15,"cmd":"AT+GETSERVICESONLY"}
{"A":15,"err":0,"errMsg":"ok"}
{"E":15,"nol":3}
AT+INDI
- Shows list of set indication handles.
| Command | Syntax |
|---|---|
| AT+INDI | AT+INDI |
Shows list of set indication handles along with the connection index so you can see what indication you have enabled on which connected device.
Example:
AT+INDI
(conn_idx=0000 indi_handle=0012)
(conn_idx=0001 indi_handle=001F)
AT+INDI
{"C":2,"cmd":"AT+INDI"}
{"A":2,"err":0,"errMsg":"ok"}
{"R":2,"resp":"No indications set"}
{"E":2,"nol":4}
AT+MTU
- Sets or queries the max allowed MTU size. Minimum allowed value: 67, Maximum allowed value: 512
Cannot be changed while connected/connecting or advertising.
| Command | Syntax |
|---|---|
| AT+MTU | |
| AT+MTU | |
| or | |
| AT+MTU=max mtu size |
Example:
AT+MTU=300
OK
AT+MTU
OK
Max MTU Size: 300
AT+MTU=300
{"C":0,"cmd":"AT+MTU=300"}
{"A":0,"err":0,"errMsg":"ok"}
{"E":0,"nol":3}
AT+MTU
{"C":1,"cmd":"AT+MTU"}
{"A":1,"err":0,"errMsg":"ok"}
{"R":1,"maxMTUsize":"300"}
{"E":1,"nol":4}
AT+NOTI
- Shows list of set notification handles.
| Command | Syntax |
|---|---|
| AT+NOTI | AT+NOTI |
Shows list of set notification handles along with the connection index so you can see what notification you have enabled on which connected device.
Example:
AT+NOTI
(conn_idx=0000 noti_handle=000D)
(conn_idx=0000 noti_handle=0014)
(conn_idx=0000 noti_handle=0019)
(conn_idx=0000 noti_handle=0021)
AT+NOTI
{"C":17,"cmd":"AT+NOTI"}
{"A":17,"err":0,"errMsg":"ok"}
{"R":17,"0000":{"notiHandle":"000D"}}
{"R":17,"0000":{"notiHandle":"0014"}}
{"R":17,"0000":{"notiHandle":"0019"}}
{"R":17,"0000":{"notiHandle":"0021"}}
{"E":17,"nol":7}
AT+NUMCOMPA
- Used for accepting a numeric comparison authentication request or enabling/disabling auto-accepting numeric comparisons. AT+NUMCOMPA=0 for disabled and AT+NUMCOMPA=1 for enable. Enabled by default.
| Command | Syntax |
|---|---|
| AT+NUMCOMPA | |
| AT+NUMCOMPA=<0 or 1> | |
| or | |
| AT+NUMCOMPA |
Example:
AT+NUMCOMPA=0
NUMERIC COMPARISON AUTO-ACCEPT OFF
AT+NUMCOMPA=0
{"C":17,"cmd":"AT+NUMCOMPA=0"}
{"A":17,"err":0,"errMsg":"ok"}
{"R":17,"autoNumComp":false}
{"E":17,"nol":4}
AT+NUMCOMPA=1
{"C":18,"cmd":"AT+NUMCOMPA=1"}
{"A":18,"err":0,"errMsg":"ok"}
{"R":18,"autoNumComp":true}
{"E":18,"nol":4}
{276:"0000","action":"numeric request","numericKey":"972226"} # <--- Event
{276:"0000","info":"run AT+NUMCOMPA to accept"} # <--- Event
AT+NUMCOMPA
{"C":14,"cmd":"AT+NUMCOMPA"}
{"A":14,"err":0,"errMsg":"ok"}
{"E":14,"nol":3}
AT+PERIPHERAL
- Sets the device Bluetooth role to peripheral. Any connection must be terminated before the role change is accepted.
| Command | Syntax |
|---|---|
| AT+PERIPHERAL | AT+PERIPHERAL |
Example:
AT+PERIPHERAL
OK
AT+PERIPHERAL
{"C":21,"cmd":"AT+PERIPHERAL"}
{"A":21,"err":0,"errMsg":"ok"}
{"E":21,"nol":3}
AT+SCANFILTER
- Sets or queries the scanfilter. There are three types of scanfilter, filter by name, filter by uuid or by manufacturer specific ID.
| Command | Syntax |
|---|---|
| AT+SCANFILTER | |
| AT+SCANFILTER | |
| AT+SCANFILTER=NAME=name | |
| AT+SCANFILTER=UUID=XXXX or AT+SCANFILTER=UUID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | |
| AT+SCANFILTER=MFSID=XXXX | |
| AT+SCANFILTER=CLEAR |
AT+SCANFILTER can take these parameters:
| Parameter | Description | Input Value | AD Flags checked for data |
|---|---|---|---|
| NAME | Filter data that includes set local name. | Device Name (ASCII) | «Shortened Local Name» (0x08) |
| «Complete Local Name» (0x09) | |||
| UUID | Filter data that includes set service UUID. | 16-bit UUID or 128-bit UUID (Hex Big Endian) | «Incomplete List of 16-bit Service UUIDs» (0x02) |
| «Complete List of 16-bit Service UUIDs» (0x03) | |||
| «Incomplete List of 128-bit Service UUIDs» (0x06) | |||
| «Complete List of 128-bit Service UUIDs» (0x07) | |||
| MFSID | Filter data that includes set Manufacturer Specific ID. | 16-bit Company Identifier Code (Hex Big Endian) | «Manufacturer Specific Data» (0xFF) |
| CLEAR | Clears all set filters. |
| Input Value | Format | Example: | Case-sensitive? |
|---|---|---|---|
| Device Name | String | BleuIO | YES |
| 128-bit UUID | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | fa284580-9d88-4b70-9775-ce4786a6bb96 | NO |
| 16-bit UUID* | XXXX | 1801 | NO |
| 16-bit Company Identifier Code* | XXXX | 075B | NO |
* Value FFFF is invalid for 16-bit UUID and/or 16-bit Company Identifier Code
All the filters work for AT+FINDSCANDATA command results. All filters can be active at once, or two in any combination, or just a single one.
For AT+GAPSCAN command results only the NAME filter works.
No filters will be active on AT+TARGETSCAN= command results.
NOTE: For AT+FINDSCANDATA command results only the Advertising packet or the Scan response packet that includes the data set by the filter will be shown. Example: If AT+SCANFILTER=NAME=BlueIO is set and the local name BleuIO is only found in the scan response packet only the scan response packet will be shown.
Example:
AT+SCANFILTER=NAME=BleuIO
OK
AT+SCANFILTER=UUID=0783b03e-8535-b5a0-7140-a304d2495cb7
OK
AT+SCANFILTER=MFSID=075B
OK
AT+SCANFILTER
SCANFILTER=NAME= BleuIO
SCANFILTER=MFSID= 075B
SCANFILTER=UUID= 0783b03e-8535-b5a0-7140-a304d2495cb7
AT+SCANFILTER=CLEAR
OK
AT+SCANFILTER
SCANFILTER=NAME Not set!
SCANFILTER=MFSID Not set!
SCANFILTER=UUID Not set!
AT+SCANFILTER=NAME=BleuIO
{"C":0,"cmd":"AT+SCANFILTER=NAME=BleuIO"}
{"A":0,"err":0,"errMsg":"ok"}
{"E":0,"nol":3}
AT+SCANFILTER=UUID=0783b03e-8535-b5a0-7140-a304d2495cb7
{"C":1,"cmd":"AT+SCANFILTER=UUID=0783b03e-8535-b5a0-7140-a304d2495cb7"}
{"A":1,"err":0,"errMsg":"ok"}
{"E":1,"nol":3}
AT+SCANFILTER=MFSID=075B
{"C":2,"cmd":"AT+SCANFILTER=MFSID=075B"}
{"A":2,"err":0,"errMsg":"ok"}
{"E":2,"nol":3}
AT+SCANFILTER
{"C":3,"cmd":"AT+SCANFILTER"}
{"A":3,"err":0,"errMsg":"ok"}
{"R":3,"scanfilter":"NAME","set":"true","value":"BleuIO"}
{"R":3,"scanfilter":"MFSID","set":"true","value":"075B"}
{"R":3,"scanfilter":"UUID","set":"true","value":"0783b03e-8535-b5a0-7140-a304d2495cb7"}
{"E":3,"nol":6}
AT+SCANFILTER=CLEAR
{"C":4,"cmd":"AT+SCANFILTER=CLEAR"}
{"A":4,"err":0,"errMsg":"ok"}
{"E":4,"nol":3}
AT+SCANFILTER
{"C":5,"cmd":"AT+SCANFILTER"}
{"A":5,"err":0,"errMsg":"ok"}
{"R":5,"scanfilter":"NAME","set":"false"}
{"R":5,"scanfilter":"MFSID","set":"false"}
{"R":5,"scanfilter":"UUID","set":"false"}
{"E":5,"nol":6}
AT+SCANTARGET
- Scan a target device for infinite time unless an optional scan timer parameter is set. Displaying the advertising and response data as it updates. Can scan up to 3 devices at once. Separate addresses with a semicolon ';'.
Scan can be stopped at any time by sending CTRL+C (0x03).
| Command | Syntax |
|---|---|
| AT+SCANTARGET | AT+SCANTARGET=[addr_type]slave_address |
| AT+SCANTARGET | AT+SCANTARGET=[addr_type]slave_address=seconds |
Example:
AT+SCANTARGET=[0]00:00:00:00:00:01
SCANNING...
[00:00:00:00:00:01] Device Data [ADV]: DataXYZ
[00:00:00:00:00:01] Device Data [RESP]: DataXYZ
[00:00:00:00:00:01] Device Data [ADV]: DataXYZ
[00:00:00:00:00:01] Device Data [RESP]: DataXYZ
[00:00:00:00:00:01] Device Data [ADV]: DataXYZ
AT+SCANTARGET=[0]00:00:00:00:00:00
{"C":23,"cmd":"AT+SCANTARGET=[0]00:00:00:00:00:00"}
{"A":23,"err":0,"errMsg":"ok"}
{"R":23,"action":"scanning"}
{"E":23,"nol":4}
{"ST":23,"addr":"00:00:00:00:00:00","type":0,"data":"02010603FF5B071107B75C49D204A34071A0B535853EB08307000000000000"}
{"ST":23,"addr":"00:00:00:00:00:00","type":4,"data":"1109426C6575494F0000000000000000000000000000000000000000000000"}
# Until stopped with Ctrl+C
AT+SCANTARGET=[0]00:00:00:00:00:00=2
{"C":24,"cmd":"AT+SCANTARGET=[0]00:00:00:00:00:00=2"}
{"A":24,"err":0,"errMsg":"ok"}
{"R":24,"action":"scanning"}
{"E":24,"nol":4}
{"ST":24,"addr":"00:00:00:00:00:00","type":0,"data":"02010603FF5B071107B75C49D204A34071A0B535853EB08307000000000000"}
{"ST":24,"addr":"00:00:00:00:00:00","type":4,"data":"1109426C6575494F0000000000000000000000000000000000000000000000"}
{"SE":24,"action":"scan completed"}
AT+SECLVL
- Sets or queries what minimum security level will be used when connected to other devices.
When used while connected will trigger a pairing request. When used while not connected, sets what minimum security level the dongle will demand when connecting to another device. If the other device does not meet the security requirement, the dongle will disconnect.
Querying security level, while connected, will show actual security level. While not connected, querying will show what minimum security level has been set that the dongle will require when connecting to another device. Note that what security level is supported is dependent on what Input/Output capability is set. See the table for more information.
Input/Output Cababilities and supported security levels:
| IO CAP | DISPLAY ONLY | DISPLAY, YESNO | KEYBOARD ONLY | NO INPUT/OUTPUT | KEYBOARD, DISPLAY |
|---|---|---|---|---|---|
| DISPLAY ONLY | (1) (2) | (1) (2) | (1) (3) (4) | (1) (2) | (1) (4) |
| DISPLAY, YESNO | (1) (2) | (1) (2) (4) | (1) (3) (4) | (1) (2) | (1) (4) |
| KEYBOARD ONLY | (1) (3) (4) | (1) (3) (4) | (1) (4) | (1) (2) | (1) (4) |
| NO INPUT/OUTPUT | (1) (2) | (1) (2) | (1) (2) | (1) (2) | (1) (2) |
| KEYBOARD, DISPLAY | (1) (4) | (1) (4) | (1) (4) | (1) (2) | (1) (4) |
source : Bluetooth® Low Energy Security Modes and Procedures"
Supported modes:
| Code | Mode |
|---|---|
| 1: | (Security Level 1) No security (No authentication and no encryption). |
| 2: | (Security Level 2) Unauthenticated pairing with encryption. |
| 3: | (Security Level 3) Authenticated pairing with encryption. |
| 4: | (Security Level 4) Authenticated LE Secure Connections pairing with encryption. |
| Command | Syntax |
|---|---|
| AT+SECLVL | |
| AT+SECLVL=x | |
| or | |
| AT+SECLVL |
Example:
AT+SECLVL=2
OK
AT+SECLVL
{"C":25,"cmd":"AT+SECLVL"}
{"A":25,"err":0,"errMsg":"ok"}
{"R":25,"setSecLvl":1}
{"E":25,"nol":4}
AT+SECLVL=2
{"C":26,"cmd":"AT+SECLVL=2"}
{"A":26,"err":0,"errMsg":"ok"}
{"E":26,"nol":3}
AT+SERVER
- Only usable in Dual role. Sets the dongle role towards the targeted connection to server.
| Command | Syntax |
|---|---|
| AT+SERVER | AT+SERVER |
Example:
AT+SERVER
OK
AT+SERVER
{"C":29,"cmd":"AT+SERVER"}
{"A":29,"err":0,"errMsg":"ok"}
{"E":29,"nol":3}
AT+SETDIS
- Sets the Device Information Service information.
| Command | Syntax |
|---|---|
| AT+SETDIS | AT+SETDIS=<man_name>=<model_num>=<serial_num>=<hw_rev>=<fw_rev>=<sw_rev> |
Sets information used in the Device Information Servie (DIS). Information can only be set before starting advertising. If no custom information is set, the default BleuIO device information will be used. Once advertising is started the information set to be used will be locked in and cannot be changed during runtime.
To change the device information again the dongle will need to be restarted, either by unplugging it and plugging it back in, or by using the ATR command.
Max length is 100 characters per parameter.
Example:
AT+SETDIS=MAN_NAME=MOD_NUM=SERIAL=HW_REV=FW_REV=SW_REV
DIS Service info is set!
AT+SETDIS=MAN_NAME=MOD_NUM=SERIAL=HW_REV=FW_REV=SW_REV
{"C":0,"cmd":"AT+SETDIS=MAN_NAME=MOD_NUM=SERIAL=HW_REV=FW_REV=SW_REV"}
{"A":0,"err":0,"errMsg":"ok"}
{"R":0,"action":"DIS service info is set"}
{"E":0,"nol":4}
AT+SETINDI
- Enable indication for selected characteristic.
| Command | Syntax |
|---|---|
| AT+SETINDI | AT+SETINDI=(indication handle) |
Which is the indication handle?
0011 char 6e400001-b5a3-f393-e0a9-e50e24dcca9e prop=20 (-----I--) # <-------- The I means that the Characteristic Properties has Indication
0012 ---- 6e400003-b5a3-f393-e0a9-e50e24dcca9e # <--------- This (0012) is the handle you want to send in.
0013 desc 0x2902
- If the status=0 in handle_evt_gattc_write_completed string, that means you have successfully written to it.
Example of a indication response
handle_evt_gattc_indication: conn_idx=0000 handle=0039 length=5
Value received: Hello # <---- ascii value (can be shown/hidden with the ATA command)
Hex: 0x48656C6C6F # <---- hex value
Size: 5
{778:"0000","0044":{"ascii":"TEST","len":4}} # <---- ascii value (can be shown/hidden with the ATA command)
{778:"0000","0044":{"hex":"0x54455354","len":4}}
Example:
AT+SETINDI=0012
handle_evt_gattc_write_completed: conn_idx=0000 handle=0013 status=0
AT+SETINDI=0021
{"C":4,"cmd":"AT+SETINDI=0021"}
{"A":4,"err":0,"errMsg":"ok"}
{"E":4,"nol":3}
{776:"0000","0022":{"writeStatus":0}} # <--- Event
AT+SETNOTI
- Enable notification for selected characteristic.
| Command | Syntax |
|---|---|
| AT+SETNOTI | AT+SETNOTI=(notification handle) |
Which is the notification handle?
0011 char 6e400001-b5a3-f393-e0a9-e50e24dcca9e prop=10 (----N---) # <-------- The N means that the Characteristic Properties has Notify
0012 ---- 6e400003-b5a3-f393-e0a9-e50e24dcca9e # <--------- This (0012) is the handle you want to send in.
0013 desc 0x2902
- If the status=0 in handle_evt_gattc_write_completed string, that means you have successfully written to it.
Example of a notification response
handle_evt_gattc_notification: conn_idx=0000 handle=0039 length=5
Value received: Hello # <---- ascii value (can be shown/hidden with the ATA command)
Hex: 0x48656C6C6F # <---- hex value
Size: 5
{777:"0000","0047":{"ascii":"TEST","len":4}} # <---- ascii value (can be shown/hidden with the ATA command)
{777:"0000","0047":{"hex":"0x54455354","len":4}}
Example:
AT+SETNOTI=0012
handle_evt_gattc_write_completed: conn_idx=0000 handle=0013 status=0
AT+SETNOTI=0021
{"C":8,"cmd":"AT+SETNOTI=0021"}
{"A":8,"err":0,"errMsg":"ok"}
{"E":8,"nol":3}
{776:"0000","0022":{"writeStatus":0}} # <--- Event
AT+SETPASSKEY
- Setting or quering set passkey for passkey authentication.
| Command | Syntax |
|---|---|
| AT+SETPASSKEY | |
| AT+SETPASSKEY=xxxxxx | |
| or | |
| AT+SETPASSKEY |
Example:
AT+SETPASSKEY=123456
PASSKEY: 123456
OK
AT+SETPASSKEY=222222
{"C":1,"cmd":"AT+SETPASSKEY=222222"}
{"A":1,"err":0,"errMsg":"ok"}
{"R":1,"passkey":"222222"}
{"E":1,"nol":4}
AT+SETPASSKEY
{"C":5,"cmd":"AT+SETPASSKEY"}
{"A":5,"err":0,"errMsg":"ok"}
{"R":5,"passkey":"222222"}
{"E":5,"nol":4}
AT+SHOWRSSI
- Shows(1)/hides(0) RSSI in AT+FINDSCANDATA and AT+SCANTARGET scans. Hides RSSI by default.
| Command | Syntax |
|---|---|
| AT+SHOWRSSI | AT+SHOWRSSI=0 or 1 |
Example:
AT+SHOWRSSI=1
OK
AT+SHOWRSSI=0
{"C":6,"cmd":"AT+SHOWRSSI=0"}
{"A":6,"err":0,"errMsg":"ok"}
{"R":6,"showRssi":false}
{"E":6,"nol":4}
AT+SHOWRSSI=1
{"C":7,"cmd":"AT+SHOWRSSI=1"}
{"A":7,"err":0,"errMsg":"ok"}
{"R":7,"showRssi":true}
{"E":7,"nol":4}
AT+SPSSEND
- Send a message or data via the SPS profile. Without parameters it opens a stream for continiously sending data.
| Command | Syntax |
|---|---|
| AT+SPSSEND | AT+SPSSEND=(message) |
| AT+SPSSEND |
Example:
AT+SPSSEND=HELLO
[SENT]
AT+SPSSEND=TEST
{"C":11,"cmd":"AT+SPSSEND=TEST"}
{"A":11,"err":0,"errMsg":"ok"}
{"R":11,"target":"0000"}
{"E":11,"nol":4}
{776:"0000","SPS":{"writeStatus":0}} # <--- Event
AT+SPSSEND
{"C":12,"cmd":"AT+SPSSEND"}
{"A":12,"err":0,"errMsg":"ok"}
{"R":12,"action":"streaming","info":"to abort press ESC-key"}
{"E":12,"nol":4}
{"R":12,"action":"not streaming"}
# Recieved as Client
{777:"0000","SPS":{"ascii":"TEST","len":5}}
# Recieved as Server
{279:"0000","SPS":{"ascii":"TEST","len":5}}
AT+TARGETCONN
- Setting or querying the connection index to use as the targeted connection.
When connected to several devices, the target connection decides which device you target when using commands such as AT+GATTCREAD, AT+GATTCWRITE, AT+GAPDISCONNECT, AT+GETSERVICES, AT+GAPPAIR or AT+SPSSEND etc.
| Command | Syntax |
|---|---|
| AT+TARGETCONN | |
| AT+TARGETCONN=conn_idx | |
| or | |
| AT+TARGETCONN |
Example:
AT+TARGETCONN=0000
OK
AT+TARGETCONN
{"C":14,"cmd":"AT+TARGETCONN"}
{"A":14,"err":0,"errMsg":"ok"}
{"R":14,"target":"0000"}
{"E":14,"nol":4}
--H
- Shows all AT-Commands.
| Command | Syntax |
|---|---|
| --H | --H |
Example:
--H
{List of all AT-Commands...}
...
AT
{"C":15,"cmd":"--H"}
{"A":15,"err":0,"errMsg":"OK"}
{"R":15,"cmd":"AT","help":"[A] Basic AT-Command."}
{"R":15,"cmd":"ATA","help":"[A] Shows/hides ascii values from notification/indication/read responses. ATA0 off, ATA1 on."}
# Displaying all help info
...
...
...