manualshive.com logo in svg

Stollmann BlueMod+S, Command Reference Manual

Share
Download
Stollmann BlueMod+S Command Reference Manual Download Page 24

 

S 

AT Command Reference 

Release r02 

www.stollmann.de 

Page 24 of 33 

 

The presence of parameters 

par

1

,..,par

n

 depends on the value of <

type

>: 

type 

par

1

 

par

2

 

par

3

 

pserv 
 
Mandatory 

uuid=<

16/128bit UUID

> 

 
Mandatory 
 
Coding: hexadecimal. 

 

 

char 
 
Mandatory 

prop=<

properties

> 

 
Mandatory 
 
Coding: hexadecimal. 
 

properties

 may have the 

bitmask values 

Read

, 

Write Without Response

, 

Write

, 

Notify

 and 

Indicate

 

set. 
 
Note: internally the 
controller generates an 
additional Client 
Characteristic 
Configuration Descriptor 
(CCCD) attribute with 
permissions „readable and 
writable without 
authentication or 
authorization“ if bits 

Notify

 

or 

Indicate

 are set. 

 

 

 

charval 
 
Mandatory 

uuid=<

16/128bit UUID

> 

 
Mandatory 
 
Coding: hexadecimal. 
 

perm=<

permissions

> 

 
Mandatory 
 
Coding: hexadecimal. 
 
16-bit value that decodes 
the access permissions 
and authentication 
requirements. 

len=<

length

> 

 
Mandatory 
 
Coding: decimal. 
 
Maximum supported length 
is 20 bytes. 

Summary of Contents for BlueMod+S

Page 1: ...BlueMod S AT Command Reference Release r02 ...

Page 2: ... may occur due to individual differences between such devices Product samples were tested in a reference environment for compliance with the legal requirements applicable to the reference environment No representation is made regarding the compliance with legal regulatory or other requirements in other environments No representation can be made and no warranty can be assumed regarding the suitabil...

Page 3: ...BMITM SSP Man in the middle protection 10 BMUX Activate Multiplexing Mode 11 BNAME Local Device Name 11 BNDDEL Delete Bonding Information 12 BNDLIST Show Bonded Device List 12 BNDS Storage Mode for Bonds 12 BNDSIZE Bonded Devices List Size 13 BOAD Bluetooth Own Device Address 13 BPAIRMODE Configure Pairable Mode 13 BSSPPIN SSP Passkey Response 14 E Local Echo 14 H Disconnect 14 I Display Version I...

Page 4: ...nnection Interval 19 LEROLE Bluetooth Low Energy Device Role 20 LESLAVELAT Slave Latency 20 LETIO Enable Terminal I O Service 20 LEADDATA Setup Advertise Data for Customized Advertising 21 LEADE Enable Customized Advertising 21 LEADPAR Setup Parameters for Customized Advertising 22 LESCDATA Setup Scan Response Data for Customized Advertising 22 2 3 GATT 23 2 3 1 GATT Server 23 LEATTRIB Define Attr...

Page 5: ...case characters A command line can have a maximum length of 80 characters It is automatically discarded if the input is longer Corrections are made using BS Multiple commands on the same command line are not allowed Commands have the following syntax Syntax Description AT command value CR Write the value of the command Responses are sent back to the host and can be any of the following Responses D...

Page 6: ...th field sets the length of the payload to send or to received in bytes The data field consists of the payload data to send or receive Start of frame channel ID length and data are always transmitted in direct binary form AT commands have to be sent to the channel ID FF simply prefixed with start of frame 0xFF and length byte Data received from the AT command interface are marked by channel ID FF ...

Page 7: ...ctions and CONNECT for outgoing connections and is valid until the connection is terminated message NO CARRIER For customer defined GATT services the channel ID is assigned while service definition for each defined characteristic separately and is valid until the BlueMod S is resetted 1 4 Hangup An active data connection can be disconnected by setting the HANGUP pin GPIO4 to high level ...

Page 8: ...values of the commands are marked using the bold letter format 2 1 General B Baud Rate AT syntax AT B value This command determines the baud rate for the UART The following standard baud rates are supported Value Description 4 9 600 bps 5 19 200 bps 6 38 400 bps 7 57 600 bps 8 115 200 bps 9 230 400 bps 22 460 800 bps 23 921 600 bps Additionally to the standard baud rates described above it is poss...

Page 9: ...he desired value in the command Examples AT B9 Set baud rate to 230 400 bps AT B250000 Set baud rate to 250 000 bps Note Information regarding the deviation of the real baud rate to the value set can be found in the BlueMod S Hardware Reference 1 F Load Factory Defaults AT syntax AT F value The factory default values will be loaded For storing values in non volatile memory use the W command Value ...

Page 10: ...ription Examples ATA Accepts connection in normal mode ATA 0x01 Accepts connection in MUX mode at channel ID 0x01 BIOCAP SSP I O Capabilities AT syntax AT BIOCAP value This command sets the input and output capabilities of the device used for SSP Value Description 0 Display only 1 Display Yes No 2 Keyboard only 3 No input no output 4 Display and keyboard BMITM SSP Man in the middle protection AT s...

Page 11: ...r receiving OK in the response of the BMUX 1 command all subsequent commands have to be entered in multiplexing frame format The multiplexing mode is not stored persistent To disable the multiplexing mode the device must be reset In multiplexing mode extended result codes are always active see chapter 3 3 Extended Result Codes BNAME Local Device Name AT syntax AT BNAME name This command allows the...

Page 12: ...ueMod S Value Description Bluetooth address Delete the bond of the device with specified address from bndlist Delete all bonded devices from bndlist BNDLIST Show Bonded Device List AT syntax AT BNDLIST This command shows information about the devices bonded with the BlueMod S Each entry in the BNDLIST contains the Bluetooth address and the linktype see chapter 3 1 Example AT BNDLIST 0080254800DA 0...

Page 13: ...the Bluetooth devices own device address Note This command is read only BPAIRMODE Configure Pairable Mode AT syntax AT BPAIRMODE mode This command controls the pairable mode of the BlueMod S When set to 0 the module is only connectable for clients stored in the local bondlist New pairing requests will be rejected Mode Description 0 No pairing allowed BlueMod S advertises TIO as functional 1 Pairin...

Page 14: ...erates an event SSPPIN and asks the user for the SSP passkey Event SSPPIN Bluetooth address The user has to answer this request with the SSP passkey displayed on the remote device Example SSPPIN 00802507C08D AT BSSPPIN 00802507C08D 314546 OK RING CONNECT Receive SSP passkey request Send SSP passkey response E Local Echo AT syntax ATE value This command selects the local echo in command mode Value ...

Page 15: ... 4 Returns the manufacturers name Stollmann E V GmbH 5 Returns ERROR 6 Returns the copyright string c Copyright Stollmann E V GmbH 7 Returns OK 8 Returns ERROR 9 Returns OK 77 Returns bootloader version 99 Returns the firmware creation date IOACFG Config of Pin IOA AT syntax AT IOACFG value This command configures the function of the IOA pin GPIO8 GPIO8 can be configured as output signal Device Re...

Page 16: ...result codes and messages Value Description 0 or empty Enable result messages after command input 1 Suppress result messages after command input RESET Reset Device AT syntax AT RESET This command resets the whole functionality of the BlueMod S by a forced hardware reset like power off on RFMAXTXPWR Maximum Output Power AT syntax AT RFMAXTXPWR value This command sets the maximum output power of the...

Page 17: ... Sx 1 Set register Sx to 1 AT command S register set all values in decimal format Register Value Description S0 1 Immediate call acceptance Note Setting of S0only allow value 1 for BLE In case of BLE connections always one RING is signalised and automatic call acceptance is set S2 43 Character for escape sequence S3 13 Carriage return character S4 10 Line feed character S5 08 Backspace character S...

Page 18: ...extended result codes Value Description 0 or empty Result message is presented without extended result codes 1 Result message is presented with extended result codes include error causes 2 2 Bluetooth Low Energy LEADINTMAX Maximum Advertising Interval AT syntax AT LEADINTMAX value This command configures the maximum advertising interval in milliseconds for a Bluetooth Low Energy Peripheral Value D...

Page 19: ... The unit is in 1 25 milliseconds timeslots Value Description n 6 3200 Use maximum connection interval of n 1 25 ms 32 Use maximum connection interval of 40 ms Note Make sure that the value of LECONINTMAX is higher or equal the value of LECONINTMIN LECONINTMIN Minimum Connection Interval AT syntax AT LECONINTMIN value This command configures the minimum connection interval for a Bluetooth Low Ener...

Page 20: ...d configures the slave latency in connection intervals for a Bluetooth Low Energy connection Value Description n 0 499 Use a slave latency of n connection intervals 0 Use no slave latency LETIO Enable Terminal I O Service AT syntax AT LETIO value This command controls the Terminal I O service If set to 0 the Terminal I O service is disabled To activate the change it is necessary to store the setti...

Page 21: ...yntax AT LEADE value This command controls the advertising behavior With AT LEADE 0 only the build in Terminal I O service is advertised With AT LEADE 1 only the customized advertisimg value is advertised With AT LEADE 3 the module stops all advertising With disabled advertising the client e g iPhone is not able to discover the device or to connect to the device This should only be done when the s...

Page 22: ...or the minimum and maximum of the advertising interval may be set with the LEADINTMIN and LEADINTMAX commands Example AT LEADPAR ADVTYPE 0 Set type of advertising undirected LESCDATA Setup Scan Response Data for Customized Advertising AT syntax AT LESCDATA value1 valuen This command is used to setup the scan response data for a customized advertising Valuek represents an octet in hexadecimal forma...

Page 23: ...he maximum number of services and characteristics depends on the used features Every combination results in a different number of possible service and characteristic combinations The maximum number of possible characteristics is limited to 20 This restriction results from the limited size of the internal definition array If the space is completely used the command AT LEATTRIB charval returns ERROR...

Page 24: ...out Response Write Notify and Indicate set Note internally the controller generates an additional Client Characteristic Configuration Descriptor CCCD attribute with permissions readable and writable without authentication or authorization if bits Notify or Indicate are set charval Mandatory uuid 16 128bit UUID Mandatory Coding hexadecimal perm permissions Mandatory Coding hexadecimal 16 bit value ...

Page 25: ...ng Note Since Extended Properties see type char parameter properties description are not supported the remote peer may not write to this characteristic descriptor The number of characters is limited to 13 Internally the character sequence is terminated by a zero byte resulting in an ASCII Z string perm permissions Optional Coding hexadecimal 16 bit value that decodes the access permissions and aut...

Page 26: ... attribute permissions parameter perm permissions are bit coded in a 16 bit hexadecimal value Bit Value Function 0 1 0 1 2 3 Read not permitted Read permitted Read with authentication permitted Read with authentication and MITM protection permitted 2 3 Reserved 4 5 0 1 2 3 Write not permitted Write permitted Write with authentication permitted Write with authentication and MITM protection permitte...

Page 27: ...LEATTRIB chardxxx AT LEATTRIB charval Definition of second service AT LEATTRIB pserv Definition of first characteristic of second service AT LEATTRIB char optional characteristic descriptors AT LEATTRIB chardxxx AT LEATTRIB charval Completion of service and characteristics definition AT LEATTRIB complete Upon successful execution of the LEATTRIB command with type charval the device returns the dat...

Page 28: ...RIB charval uuid 2A19 perm 0001 len 1 CC FF 08 0D 0A 30 78 30 32 0D 0A CC FF 06 0D 0A 4F 4B 0D 0A 0x02 OK Declares the battery level value one byte in the range 0 100 Battery level values are exchanged over multiplexer channel 2 CC FF 15 41 54 2B 4C 45 41 54 54 52 49 42 3D 63 6F 6D 70 6C 65 74 65 0D human readable AT LEATTRIB complete CC FF 06 0D 0A 4F 4B 0D 0A OK Completes the service definition ...

Page 29: ... otherwise 3 3 Extended Result Codes Extended result codes numerical and verbose are available after activation with W1 command In multiplexing mode extended result codes are always active 3 3 1 CONNECT For the AT result code CONNECT the following extended result codes are available Syntax normal mode CONNECT Bdaddr linktype Syntax MUX mode CONNECT Bdaddr linktype channel ID Examples Normal mode N...

Page 30: ...RIER Bluetooth release error code channel ID The following table shows the release error codes Error code Meaning 0x0000 Success 0x0001 Accept 0x0002 Reject 0x0003 Resource error 0x0004 Invalid parameter 0x0005 Invalid state 0x0006 Connection disconnect 0x0007 Connection paused 0x0008 Connection lost 0x0009 Authentication failed 0x000A Flowcontrol violation 0x000B Init timeout 0x000C Init out of s...

Page 31: ...BlueMod S AT Command Reference Release r02 www stollmann de Page 31 of 33 3 4 Events Text Description SSPPIN Bdaddr SSP passkey request see BSSPPIN command ...

Page 32: ...AT Command Reference Release r02 www stollmann de Page 32 of 33 4 Related Documents 1 BlueMod S Hardware Reference 2 BlueMod S User Guide 3 Bluetooth 4 0 Core Specification 4 BlueMod S BlueMod SR Delta Reference ...

Page 33: ...ve ATS30 r02d02 05 08 2014 ta Add BPAIRMODE command r02 27 08 2014 or Modified gatt server parameter Added note for MUX mode results Added note for AT F More detailed description for returned channel format Correct characteristic default value description Remove note from LEATTRIB table Revised description of LEADPAR Stollmann Entwicklungs und Vertriebs GmbH Mendelssohnstraße 15 D 22761 Hamburg Ge...

Reviews:

No comments

Brands by name

Popular brands

Load more brands