Anybus AWB2000, AWB3000 User guide
Anybus®Wireless Bolt/Bridge II
AT Commands
REFERENCE GUIDE
SCM-1202-004 1.2 ENGLISH
Important User Information
Liability
Every care has been taken in the preparation of this document. Please inform HMS Industrial Networks AB of any
inaccuracies or omissions. The data and illustrations found in this document are not binding. We, HMS Industrial
Networks AB, reserve the right to modify our products in line with our policy of continuous product development.
The information in this document is subject to change without notice and should not be considered as a commitment by HMS Industrial Networks AB. HMS Industrial Networks AB assumes no responsibility for any errors that
may appear in this document.
There are many applications of this product. Those responsible for the use of this device must ensure that all the
necessary steps have been taken to verify that the applications meet all performance and safety requirements including any applicable laws, regulations, codes, and standards.
HMS Industrial Networks AB will under no circumstances assume liability or responsibility for any problems that
may arise as a result from the use of undocumented features, timing, or functional side effects found outside the
documented scope of this product. The effects caused by any direct or indirect use of such aspects of the product
are undefined, and may include e.g. compatibility issues and stability issues.
The examples and illustrations in this document are included solely for illustrative purposes. Because of the many
variables and requirements associated with any particular implementation, HMS Industrial Networks AB cannot assume responsibility for actual use based on these examples and illustrations.
Intellectual Property Rights
HMS Industrial Networks AB has intellectual property rights relating to technology embodied in the product described in this document. These intellectual property rights may include patents and pending patent applications in
the USA and other countries.
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Table of Contents
Page
1 Preface ............................................................................................................................... 5
1.1 About This Document .....................................................................................................5
1.2 Document history...........................................................................................................5
1.3 Trademark Information ...................................................................................................5
2 Introduction ...................................................................................................................... 6
2.1 Data Types ....................................................................................................................6
2.2 Sample Scripts ..............................................................................................................7
3 Standard Commands ..................................................................................................... 9
3.1 AT&F Restore to Factory Settings ...................................................................................9
3.2 AT* List Available Commands .........................................................................................9
3.3 AT Attention ...................................................................................................................9
4 Network Commands ..................................................................................................... 10
4.1 AT*ANDHCP DHCP Mode............................................................................................10
4.2 AT*ANIP IP Settings..................................................................................................... 11
4.3 AT*ANHN Hostname .................................................................................................... 12
5 Bluetooth Classic Commands ................................................................................... 13
5.1 AT*BCP Connect Peer .................................................................................................13
5.2 AT*BCC Close Connection ........................................................................................... 13
5.3 AT*BC Connect ...........................................................................................................14
5.4 AT*BND Name Discovery ............................................................................................. 14
5.5 AT*BDD Device Discovery............................................................................................15
5.6 AT*BI Inquiry ...............................................................................................................15
5.7 AT*BSP Server Profile.................................................................................................. 16
5.8 AT*BFP Fixed PIN .......................................................................................................17
5.9 AT*BPM Pairing Mode.................................................................................................. 17
5.10 AT*BSM Security Mode ................................................................................................18
5.11 AT*BBD Bonded Devices ............................................................................................. 18
5.12 AT*BUB Unbond .......................................................................................................... 19
5.13 AT*BLEM Low Emission Mode...................................................................................... 20
5.14 AT*BDM GAP Discoverability Mode...............................................................................21
5.15 AT*BCM GAP Connectability Mode ...............................................................................22
5.16 AT*BCA Connection Accept.......................................................................................... 22
5.17 AT*BLN Local Name ....................................................................................................23
5.18 AT*BRSS Read RSSI...................................................................................................23
5.19 AT*BLQ Read Link Quality............................................................................................ 24
5.20 AT*BLP Limited Pairing ................................................................................................ 24
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Table of Contents
5.21 AT*BCHM Channel Map ............................................................................................... 25
5.22 AT*BPP Packet policy ..................................................................................................26
5.23 AT*BMSP Master Slave policy ......................................................................................27
5.24 AT*BLCOD Local class of device................................................................................... 28
5.25 AT*BRCD Read Connected Devices.............................................................................. 28
5.26 AT*BCLC Clear the Connection list................................................................................29
5.27 AT*BCLR Read the Connection list................................................................................29
5.28 AT*BCLW Write an entry in the Connection list ...............................................................30
6 WLAN General Commands .........................................................................................31
6.1 AT*WMODE WLAN Mode............................................................................................. 31
6.2 AT*WKEY Encryption/Authentication Key ...................................................................... 32
6.3 AT*WKEYI Write Encryption/Authentication Key (with Index) ........................................... 32
6.4 AT*WACTKEY Active Encryption/Authentication Key ...................................................... 33
7 WLAN Access Point Commands............................................................................... 34
7.1 AT*WASSID Access Point SSID....................................................................................34
7.2 AT*WACH Access Point Channel ..................................................................................35
7.3 AT*WAAM Authentication Mode for AP .......................................................................... 36
8 WLAN Client Commands.............................................................................................37
8.1 AT*WSMAC WLAN MAC address ................................................................................. 37
8.2 AT*WSBM WLAN Bridge Mode..................................................................................... 38
8.3 AT*WSC Connect ........................................................................................................39
8.4 AT*WSCC Close Connection ........................................................................................39
8.5 AT*WSCP Connect Peer ..............................................................................................40
8.6 AT*WSSCAN Scan ...................................................................................................... 41
8.7 AT*WSAM Authentication Mode for Station ....................................................................42
8.8 AT*WSRSS Read RSSI................................................................................................ 42
8.9 AT*WSLNK Read Link Status .......................................................................................43
8.10 AT*WSUSER User name for WLAN LEAP/PEAP authentication......................................43
8.11 AT*WSDOMAIN Domain for WLAN LEAP/PEAP authentication. .....................................44
8.12 AT*WSPASS Pass phrase for WLAN LEAP/PEAP authentication. ...................................45
8.13 AT*WSCHL Channel list ...............................................................................................46
8.14 AT*WSCLC Clear the Connection list ............................................................................46
8.15 AT*WSCLR Read the Connection list ............................................................................47
8.16 AT*WSCLW Write an entry (AP) in the Connection list ....................................................48
9 Informational Commands ...........................................................................................49
9.1 AT*AILVI Local Version Info .......................................................................................... 49
9.2 AT*AIMAC Read MAC.................................................................................................. 49
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Table of Contents
10 Miscellaneous Commands .........................................................................................50
10.1 AT*AMLI Login............................................................................................................. 50
10.2 AT*AMLO Logout ......................................................................................................... 50
10.3 AT*AMPW Password....................................................................................................51
10.4 AT*AMSTAT System status...........................................................................................51
10.5 AT*AMESS Event and Status Subscriber .......................................................................52
10.6 AT*AMEECM Execute Easy Configuration Mode ............................................................ 52
10.7 AT*AMECFL Read/Write Easy Configuration Modes Function List ...................................53
10.8 AT*AMTFTP TFTP Upgrade .........................................................................................53
10.9 AT*AMPID Product ID ..................................................................................................54
10.10 AT*AMGD General Data...............................................................................................54
10.11 AT*AMTL TCP Listener................................................................................................. 55
10.12 AT*AMBD Bridging Disable........................................................................................... 55
10.13 AT*AMLCR Layer 2 Configuration Receiver ...................................................................56
10.14 AT*AMREBOOT Reboot............................................................................................... 56
11 S Registers......................................................................................................................57
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
This page intentionally left blank
Preface 5 (60)
1 Preface
1.1 About This Document
This document describes the available ATcommands for Anybus Wireless Bolt/Bridge II.
The reader of this document is expected to be familiar with the product and have a good knowledge of wireless communication and network technology.
For additional related documentation, file downloads and technical support, please visit the
Anybus support website at www.anybus.com/support.
1.2 Document history
Revision list
Version Date Description
1.0 2016-06-27 Beta release
1.1 2016-10-01 First public release
1.2 2017-03-31 Updated for Wireless Bridge II
1.3 Trademark Information
Anybus®is a registered trademark of HMS Industrial Networks AB. All other trademarks mentioned in this document are the property of their respective holders.
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Introduction 6 (60)
2 Introduction
AT commands allow more configuration options than the web interface and can be scripted for
batch configuration of multiple units. A string of ATcommands can for example be sent from a
PLC for automatic configuration during initial setup or when replacing units.
Each command line can only contain a single command and must not exceed 300 characters.
Some commands may have additional limitations. This document describes the structure and
syntax of each command and also includes examples for most of them.
Some of the commands require that the unit is rebooted before they become effective. This is
indicated in the description of the command.
UPPER CASE is only used for clarity in this manual, AT commands are not case sensitive.
2.1 Data Types
The description of each command also specifies the data types used for the parameter values.
There are five different data types:
String
Strings can contain all the printable characters from the ISO 8859-1 (8-bit ASCII) character set
except " (double quote) , (comma) and \ (backslash).
The string does not need surrounding quotes.
Integer
Integer values can be entered in decimal form or as a hexadecimal string beginning with 0x; e.g.
15 can also be entered as 0x0000000F.
Boolean
Boolean values can be either 0 (false) or 1 (true).
NetworkAddress
Used for IP addresses. Must be entered as four integer values in the range 0 to 255 separated
by periods, e.g. 192.168.0.98.
MACAddress
Used for Ethernet and Bluetooth MAC addresses. Addresses must be entered as six groups of
two hexadecimal digits in one of the following formats:
00A0F7101C08
00:A0:F7:10:1C:08
00–A0–F7–10–1C–08
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Introduction 7 (60)
2.2 Sample Scripts
The following command scripts can be copied and pasted directly into the AT Commands text
box in the web interface. The order of the commands in the scripts is important and should not
be changed. All scripts start from the factory default configuration.
See also the descriptions of the individual AT commands for more information.
These scripts are only intended as examples. The IP addresses, channels, passwords, etc. in
the scripts should be changed as required for your application.
2.2.1 WLAN Access Point with 7 Clients
This example will set up one unit as a WLAN access point and up to 7 units as WLAN clients.
The access point unit has the SSID “MyNewAP” and is using channel 3 on the 2.4 GHz band.
Security mode is WPA2-PSK with the passkey “Sesame2016”.
Each device will reboot after applying the new configuration. The IP addresses will change to
192.168.0.100 for the access point, and 192.168.0.101–107 for the clients.
WLAN Access Point
AT*ANDHCP=0,1
AT*ANIP=192.168.0.100,255.255.255.0,192.168.0.100,1
AT*WMODE=1,1
AT*WASSID=MyNewAP,1
AT*WACH=3,1
AT*WAAM=2,1
AT*WKEY=Sesame2016,1
AT*AMREBOOT
WLAN Client 1
AT*ANDHCP=0,1
AT*ANIP=192.168.0.101,255.255.255.0,192.168.0.100,1
AT*WMODE=0,1
AT*WSAM=2,1
AT*WKEY=Sesame2016,1
AT*WSCP=,MyNewAP,3
AT*AMREBOOT
The IP address of each additional client must be unique on the network. This is achieved by
changing the first parameter in the AT*ANIP command:
WLAN Client 2
AT*ANIP=192.168.0.102,255.255.255.0,192.168.0.100,1
WLAN Client 3
AT*ANIP=192.168.0.103,255.255.255.0,192.168.0.100,1
...and so on.
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Introduction 8 (60)
2.2.2 WLAN Client Roaming Between 2 Access Points
This example will set up two units as WLAN access points, and a third unit as a WLAN client
roaming between them.
The access points use different channels in the 2.4 GHz band (channels 1 and 6) to avoid interference. They share the same SSID “MyNetwork”, and use WPA2-PSK security with the same
passkey “Sesame2016”.
Each unit will reboot after applying the new configuration. The IP addresses will change to
192.168.0.100/101 for the two access points, and 192.168.0.102 for the client.
WLAN Access Point 1
AT*ANDHCP=0,1
AT*ANIP=192.168.0.100,255.255.255.0,192.168.0.100,1
AT*WMODE=1,1
AT*WASSID=MyNetwork,1
AT*WACH=1,1
AT*WAAM=2,1
AT*WKEY=Sesame2016,1
AT*AMREBOOT
WLAN Access Point 2
AT*ANDHCP=0,1
AT*ANIP=192.168.0.101,255.255.255.0,192.168.0.100,1
AT*WMODE=1,1
AT*WASSID=MyNetwork,1
AT*WACH=6,1
AT*WAAM=2,1
AT*WKEY=Sesame2016,1
AT*AMREBOOT
WLAN Client
The example MAC addresses in the AT*WSCLW command should be replaced with the actual
MAC addresses of the units configured as access points.
AT*ANDHCP=0,1
AT*ANIP=192.168.0.102,255.255.255.0,192.168.0.100,1
AT*WMODE=0,1
AT*WSAM=2,1
AT*WKEY=Sesame2016,1
AT*WSCLW=0,020133004E00,MyNetwork,1,1
AT*WSCLW=1,020136004B00,MyNetwork,6,1
AT*WSC
AT*AMREBOOT
About WLAN Roaming
The client unit will initially connect to the access point with the best RSSI. If the RSSI falls below
a certain value the client will poll the access points in the list that was set up with the AT*WSCLW
command. If any of them is available and has a better RSSI the current connection will be
dropped and a new connection is initiated.
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Standard Commands 9 (60)
3 Standard Commands
3.1 AT&F Restore to Factory Settings
AT&F
This command instructs the unit to set all parameters to their defaults as specified by the
manufacturer.
Syntax:
AT&F
3.2 AT* List Available Commands
Returns a list of all available AT commands
AT*
Syntax:
AT*
Example:
TODO
3.3 AT Attention
AT
Attention command determining the presence of a DCE
Syntax:
AT
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Network Commands 10 (60)
4 Network Commands
4.1 AT*ANDHCP DHCP Mode
Set/get the DHCP mode. If activated, this will take precedence over settings made with
AT*ANIP
AT*ANDHCP=
Set the DHCP mode
Syntax:
AT*ANDHCP=<dhcp_client>,<dhcp_server>,<store>
Input Parameters:
Name
dhcp_client Integer 0: Off, use static IP address (default value)
dhcp_server Integer 0: Off, Disable DHCP server(default value)
store
Type Description
1: On, acquire an IP address using DHCP
1: ON, Enable DHCP server
2: DHCP Relay, Relay DHCP messages to an external DHCP
server.
Boolean If store is 1 the new value is stored permanently.
Requires a reboot for the changes to take effect
AT*ANDHCP?
Read the current DHCP setting
Syntax:
AT*ANDHCP?
Example:
AT*ANDHCP? *ANDHCP:<dhcp_client>,<dhcp_server>
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Network Commands 11 (60)
4.2 AT*ANIP IP Settings
Set/get IP settings for the device
AT*ANIP=
Short description for AT*ANIP=
Syntax:
AT*ANIP=<ip_addr>,<netmask>,<gateway>,<store>
Input Parameters:
Name
ip_addr NetworkAddress IP address for the device
netmask NetworkAddress Netmask for the device
gateway NetworkAddress The IP address of the gateway
store Boolean If store is 1 the new value is stored permanently.
Requires a reboot for the changes to take effect
Type Description
AT*ANIP?
Get the IP settings
Syntax:
AT*ANIP?
Example:
AT*ANIP? *ANIP:<ip_addr>,<netmask>,<gateway>
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Network Commands 12 (60)
4.3 AT*ANHN Hostname
Set/get the hostname used with dynamic DNS
AT*ANHN=
Set hostname
Syntax:
AT*ANHN=<hostname>,<store>
Input Parameters:
Name
hostname String The hostname to set. Maximum of 240 characters.
store Boolean If store is 1 the new value is stored permanently.
Requires a reboot for the changes to take effect
Type Description
AT*ANHN?
Get hostname
Syntax:
AT*ANHN?
Example:
AT*ANHN? *ANHN:<hostname>
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Bluetooth Classic Commands 13 (60)
5 Bluetooth Classic Commands
5.1 AT*BCP Connect Peer
AT*BCP=
Bluetooth Connect to Peer. The connection will not be retried if unsuccessful.
Syntax:
AT*BCP=<bd_addr>,<name>,<role>
Input Parameters:
Name
bd_addr MACAddress If specified the MAC address of the remote Bluetooth device must
name
role Integer The role of the remote device:
Type Description
match this value.
String If name is specified and S register 2017 is 1 the remote name must
match this value exactly. If S register 2017 is 0 this is a case sensitive substring of the remote name to connect to, e.g. if specified to
DUT it will try to connect to DUT, DUTx, xDUT and xDUTx, but not
to dut.
100: PAN User role, PAN Profile
101: Network Access Point role, PAN Profile,
103: PAN, This will first try to connect to PANU, and if it fails, con-
nect to NAP
All others:Reserved
Example:
Input: AT*BCP=8C8B83EE2ACB,,101 will return the handle of the connection
and OK if the connection succeeds, ERROR otherwise.
5.2 AT*BCC Close Connection
AT*BCC=
Bluetooth Close Connection
Syntax:
AT*BCC=<handle>
Input Parameters:
Name
handle Integer The handle of the connection to close. If set to 0 and there is no
Example:
Type Description
connection with handle 0 any ongoing connection attempts and retries will be aborted.
Input: AT*BCC=0 gives OK when the connection with handle 0 is closed.
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Bluetooth Classic Commands 14 (60)
5.3 AT*BC Connect
AT*BC
Bluetooth Connect (according to the Connection List).
Syntax:
AT*BC
Example:
Input: AT*BC will return the handle of the connection and OK if the
connection succeeds, ERROR otherwise.
5.4 AT*BND Name Discovery
AT*BND=
Bluetooth Name Discovery
Syntax:
AT*BND=<bd_addr>
Input Parameters:
Name
bd_addr MACAddress MAC address of the Bluetooth device to get the name of.
Example:
Input: AT*BND=8C8B83EE2ACB gives the name of the device and OK if
successful, ERROR otherwise.
Type Description
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Bluetooth Classic Commands 15 (60)
5.5 AT*BDD Device Discovery
AT*BDD
Perform a Bluetooth Device Discovery i.e. an Inquiry followed by a named lookup for any device
that does not report a name in the inquiry response.
Syntax:
AT*BDD
Example:
Input: AT*BDD returns *BDD:<bd_addr>,<cod>,<device_name_
valid>,<bluetooth_name>,<rssi> for each found device followed by OK or
ERROR.
5.6 AT*BI Inquiry
AT*BI
Perform a Bluetooth inquiry.
Syntax:
AT*BI
Example:
Input: AT*BI returns *BI:<bd_addr>,<cod>,<device_name_
valid>,<bluetooth_name>,<rssi> for each found device followed by OK or
ERROR.
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Bluetooth Classic Commands 16 (60)
5.7 AT*BSP Server Profile
AT*BSP=
Sets the Bluetooth server profile. A reboot is needed for the setting to take effect. Please note
that following values will be affected depending on what role is selected: NAP: AT*BMSP Master Slave policy will be set to 0, ATS2010 max number of connections will be set to 7, AT*BCM
Connectability mode will be set to 2 PANU: AT*BMSP Master Slave policy will be set to 1,
ATS2010 max number of connections will be set to 1, AT*BCM Connectability mode will be set
to 1 IMPORTANT: As the device is connectable after NAP has been set an appropriate Security
Mode should be configured.
Syntax:
AT*BSP=<role>
Input Parameters:
Name
role Integer The role of the device:
Type Description
100: PAN User role, PAN Profile
101: Network Access Point role, PAN Profile.
Requires a reboot for the changes to take effect
Example:
Input: AT*BSP=101 sets the device to the Network Access Point role.
AT*BSP?
Gets the Bluetooth server profile.
Syntax:
AT*BSP?
Example:
Input: AT*BSP? returns the server profile. See AT*BSP= for values.
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Bluetooth Classic Commands 17 (60)
5.8 AT*BFP Fixed PIN
AT*BFP=
Set the fixed pin/passkey used for BT authentication
Syntax:
AT*BFP=<pin>,<store>
Input Parameters:
Name
pin String The pin/passkey to set. A numerical value 0..999999.
store Boolean If store is 1 the new value is stored permanently.
AT*BFP?
Get the fixed pin/passkey used for BT authentication.
Type Description
Syntax:
AT*BFP?
5.9 AT*BPM Pairing Mode
AT*BPM=
Set the pairing mode for BT
Syntax:
AT*BPM=<mode>,<store>
Input Parameters:
Name
mode Integer The mode to set. Pairing off = 1, Pairing on = 2.
store Boolean If store is 1 the new value is stored permanently.
AT*BPM?
Type Description
Get the pairing mode for BT. Pairing off = 1, Pairing on = 2.
Syntax:
AT*BPM?
Example:
Input: AT*BPM?
Anybus®Wireless Bolt/Bridge II AT Commands Reference Guide SCM-1202-004 1.2
Loading...