CB-OWSPA311GI-01 ConnectBlue, CB-OWSPA311GI-01 Datasheet
CB-OWSPA311GI-01
Specifications of CB-OWSPA311GI-01
Related parts for CB-OWSPA311GI-01
CB-OWSPA311GI-01 Summary of contents
Page 1
... OWSPA311g i/x™ cB-0908 AT Command Set INDUSTRIAL WIRELESS™ ...
Page 2
... OWSPA31 1g i/x™ cB-0908 AT Command Set ...
Page 3
... All rights reserved. Release: 2009-11 Document version: 1.6.6 Document number: cBProject-0604-02 (2) Printed in Sweden. Trademarks Registered trademarks from other companies are: Microsoft™, Windows™, Windows NT™, Windows 2000™, Windows CE™, Windows ME™, are registered trademarks ...
Page 4
Contents 1 Introduction 1.1 Related Documents ...........................................................................7 1.2 References.........................................................................................8 1.3 Compatibility ......................................................................................9 2 Data Mode and AT Mode 3 Baud Rate 4 Restoring Default Configuration 4.1 Serial Settings ..................................................................................12 5 Configuration and Operation 5.1 LED Indication..................................................................................13 5.2 Creating Serial Connections ...
Page 5
Example 2, Enable DHCP and configure a Remote Peer ...........26 Example 3, Static IP Address and TCP Listener .........................27 Example 4, Find the DHCP Assigned Address and RSSI Value.27 Example 5, WLAN Connection with WEP Encryption .................28 Example 6, WLAN ...
Page 6
... AT*AMMP Max output power ......................................................55 AT*AMTU MTU Size....................................................................55 AT*AMGD General Purpose Data ...............................................56 AT*AMTL TCP Listener Activation...............................................56 AT*AMUR UDP Receiver Activation............................................57 AT*AMDS DSR/DTR Control.......................................................57 AT*AMRD Regulatory Domain Control........................................58 AT*AMRFM Read Feature Mask .................................................58 AT*AMWFM Write Feature Mask ................................................58 AT*ACCB Configuration over WLAN ...........................................59 Licenses .......................................................................................................60 Version 1.6.6 - 2009-11 6 ...
Page 7
Introduction 1.1 Related Documents There are some documents related to the OWSPA311g Wireless LAN Serial Port Adapter: • • The OWSPA AT Command Set contains information on how to use the OW- SPA311g module. Study this document before moving ...
Page 8
References • OWSPA311g i/x Electrical and Mechanical Datasheet • RFC1738 Uniform Resource Locators Version 1.6.6 - 2009-11 8 ...
Page 9
... AT*AGLN included for compatibility reasons. AT*ANHN Hostname is the preferred way to manipulate this setting. AT*AGRSS RSSI Value returns error when module is not connected. Stop-mode will not work properly with the engineering samples with green PCB. Version 1.6.6 - 2009-11 AT*AMMP Max out- 9 ...
Page 10
... Any connection that you have with the OWSPA311g module serial, TCP or UDP can be used to enter AT mode. The procedure is the same as described above. Note: By default only possible to enter AT mode from the serial connection. This behavior can be changed using the AT command AT*ACCB Configuration over WLAN. Version 1.6.6 - 2009-11 10 ...
Page 11
Baud Rate The default RS232 settings are 57600 bits/s, 8 data bits, no parity, 1 stop bit and hardware flow control. See chapter 4 for information on how to restore the default serial settings. The module does not support ...
Page 12
Restoring Default Configuration 4.1 Serial Settings In some situations it is necessary to restore all settings to their default values. Default values for all settings are listed in the AT Command Reference chapter. The default values of the most ...
Page 13
Configuration and Operation This chapter gives some guidelines on how to perform basic configuration and operation. There are several request packets that can be used to configure the module. Many of these request packets take an Integer parameter called ...
Page 14
WEP 128 • TKIP • AES/CCMP The following matrix shows valid combinations of authentication and encryption methods (• means valid combination): Open con- nection • No encryption WEP 64 WEP128 TKIP AES/CCMP Version 1.6.6 - 2009-11 Shared se- WPA/WPA2 ...
Page 15
Note: The OWSPA311g will not indicate any errors if you enter an invalid combination. There are a few important considerations that need to be addressed as well. If you choose WPA/WPA2 PSK and TKIP, this is considered a WPA connection. ...
Page 16
... These modules effectively operate on different networks and will not be able to communicate. To try to remedy this issue connectBlue has introduced a trigger setting into its OWSPA311g module. This trigger will activate if one module has been alone in a network for too long. It will then try to scan for present network and connect possible ...
Page 17
Figure 2 DTR mode = at connection Version 1.6.6 - 2009-11 17 ...
Page 18
Power Save Modes It is possible to lower the module power consumption by configuring different power save modes. Generally, lowering the overall power consumption leads to higher system response times hard to find a configuration to fit ...
Page 19
To optimize the power consumption further the WLAN beacon listening interval can be re- duced. By doing so, the time the WLAN chipset is active is reduced. This setting is configured with the ATS3001 AT command. Version 1.6.6 - 2009-11 ...
Page 20
Syntax 7.1 Command Line Format Each command line sent from the DTE to the DCE is made prefix, body and terminator. As prefix for the OWSPA311g AT commands, only “AT” (ASCII 65, 84) and “at” (ASCII ...
Page 21
An empty string is represented by two adjacent de- limiters, "". Integer An integer value consists of a sequence of characters all in the range {0..9}. Numeric constants are expressed in decimal ...
Page 22
User Guide 8.1 Overview The OWSPA311g is an 802.11g based serial port adapter capable of transporting serial informa- tion across an IP network. The IP network relies on a link layer consisting of an 802.11 b/g to- pology that ...
Page 23
... If the port is not given it defaults to 0 (zero). Examples: tcp://10.0.0.9:5003 tcp://www.connectblue.se:80 udp://192.168.0.42:6809 Once a remote TCP peer is connected, it can not be disconnected via any commands. The peer will have to be removed from the settings and the module rebooted. If the other end of the connection decides to close the connection the OWSPA311g will close the connections grace- fully ...
Page 24
The OWSPA311g only acts as an intermediary and does not produce any data itself. The OW- SPA311g can receive data in two different ways; the UART (local peer) and the network (remote peers). Any data received on the UART will ...
Page 25
Hostname • System description with version information • Capabilities (Tells the network that the OWSPA311g is a station only) Level 2: • System services (TCP Listener on / UDP Receiver on) Level 3 (default): • Peer list (Sends a ...
Page 26
The address range managed by the DHCP server is derived from the manually set netmask and ip address. If the netmask set to a range that is less than the maximum of 7 possible clients, the manageable range is reduced ...
Page 27
The module will now restart and associate with the access point. When associated it will request an IP address from the DHCP. When it has got a DHCP lease it will try to connect to the IP address 10.0.0.9 ...
Page 28
... DNS. In the example we use one DNS server with the address 192.168.0.5 and a remote peer with the name test.connectblue.se. 1. Configure WLAN and static IP settings (Example 3, Static IP Address and TCP Listener, step 1-3) 2 ...
Page 29
... Configure one or more remote TCP peers or enable the TCP listener (UDP peers don’t make sense because one way communication channel). 3. Enable remote configuration with the command AT*ACCB=1,1 4. Let the module associate with the network. 5. From any of the remote TCP peers send the escape sequence to enter AT mode (for more information, see Chapter 2) ...
Page 30
Use case 2 Sensor network, infrastructure, polled Problem description: The same company as in Use case 1 has a number of other sensors that they want to request data from at certain times. For instance, when the humidity rises above ...
Page 31
Note: The definition of R+/R-,T+/T- may vary between manufacturers. RS485 The OWSPA311g can be used with an RS485 connection. For two-wire RS485 the following connection setup shall be used: Note: The definition of R+/R-,T+/T- may vary between manufacturers. Version 1.6.6 ...
Page 32
AT Command Reference The “store” variable that is used in some commands will not be returned when performing a read. 9.1 Standard AT Commands AT Attention Command Syntax AT<CR> Responses <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT* List Available Commands Syntax AT*<CR> Responses ...
Page 33
... See description of the AT&F command. Description Successful response Error response Description This command instructs the unit to set all parameters to their hardcoded static defaults as specified by connectBlue. Description Successful response Error response Description This command turns off character echoing from the DTE when in AT mode. ...
Page 34
Responses <CR><LF>echo_on<CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> ATQ Result Codes On/Off Syntax ATQ<result_off><CR> ATQ? Parameters Type result_off Integer Responses <CR><LF>result_off<CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> ATS2 Escape Character Syntax ATS2=<esc_char><CR> ATS2? Parameters Type esc_char Integer Responses <CR>>LF>esc_char<CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> Unit echoes characters during command ...
Page 35
ATS3 Command Line Termination Character Syntax ATS3=<line_term><CR> ATS3?<CR> Parameters Type line_term Integer Responses <CR><LF>line_term<CR><LF>OK<CR><LF> <line_term><LF>OK<line_term><LF> <CR><LF>ERROR<CR><LF> ATS4 Response Formatting Character Syntax ATS4=<term><CR> ATS4? Parameters Type term Integer Responses <CR><LF>term<CR><LF>OK<CR><LF> <CR><term>OK<CR><term> <CR><LF>ERROR<CR><LF> Description Write command line termination character. This setting changes ...
Page 36
ATS5 Backspace Character Syntax ATS5=<backspace><CR> ATS5? Parameters Type backspace Integer Responses <CR><LF>backspace<CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> ATS General Settings S Register Manipulation Syntax ATS<register>=<value><CR> ATS<register>? Parameters Type register Integer value Interger Responses <CR><LF>value<CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> Register Description 3000 WLAN preamble ...
Page 37
WLAN scan type Active scan (default Passive scan 3005 WLAN lower RSSI trigger value to trigger a rescan. In dBm + offset 128 38…113 (default 38) (-90 dBm …-15 dBm, default -90 ...
Page 38
Enabled 4000 Number of milliseconds to wait before stop mode is entered after a valid stop mode condition is detected. Lowering this value will minimize power consumption but affect system responsive- ness in a negative way. 0…360000000 (default ...
Page 39
LLDP information level. The levels are additive. I.e. level 2 include level 0 and 1 as well as level 2. 0…3 (default Send macaddress and ip-address 1 = Send system name (user defined hostname), system description ...
Page 40
Integer Responses <CR><LF>*AGAM:<amode><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AGEM Encryption Mode Syntax AT*AGEM=<emode>,<store><CR> AT*AGEM? Parameters Type emode Integer store Integer Responses <CR><LF>*AGEM:<emode><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AGSM Security Mode Syntax AT*AGSM=<smode>,<store><CR> AT*AGSM? Parameters Type smode Integer 2 = WPA/WPA2 PSK 3 = LEAP 0 ...
Page 41
Integer Responses <CR><LF>*AGSM:<smode><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AGOM Operational Mode Syntax AT*AGOM=<omode>,<store><CR> AT*AGOM? Parameters Type omode Integer store Integer Responses <CR><LF>*AGOM:<omode><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AGFP Encryption/Authentication Key Syntax AT*AGFP=<key>,<store><CR> Parameters Type key String store Integer Responses <CR><LF>OK<CR><LF> Shared-WEP128 (AM=1,EM=2) 3 ...
Page 42
AT*AGFPWI Write Encryption/Authentication Key (with Index) Syntax AT*AGFPWI=<keyindex>,<key>,<store><CR> Parameters Type keyindex Integer key String store Integer Responses <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AGAFP Active Encryption/Authentication Key Syntax AT*AGAFP=<keyindex>,<store><CR> AT*AGAFP? Parameters Type keyindex Integer store Integer Responses <CR><LF>*AGAFP:<keyindex><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AGUN Username Syntax ...
Page 43
Integer Responses <CR><LF>*AGUN:<username><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AGSSID SSID Syntax AT*AGSSID=<ssid>,<store><CR> AT*AGSSID? Parameters Type ssid String store Integer Responses <CR><LF>*AGSSID:<ssid><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AGRSS RSSI Value Syntax AT*AGRSS? Parameters Type rssi Integer Responses <CR><LF>*AGRSS:<rssi><CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AGCH Channel Number Syntax ...
Page 44
AT*AGCH=<ch_no>,<store><CR> AT*AGCH? Parameters Type ch_no Integer store Integer Responses <CR><LF>*AGCH:<ch_no><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AGSCAN Syntax AT*AGSCAN? Parameters Type bssid MAC_Addr op_mode Integer ssid String channel Integer rssi Integer encryption Integer information_element String Responses <CR><LF>*AGSCAN:<bssid>,<op_mode>,<ssid>, <channel>,<rssi>,<encryption>, <information_element><CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> Write channel number to ...
Page 45
AT*AGRTE Data Rate and Link Adaptation Syntax AT*AGRTE=<data_rate >, <link_adaptation>,<store><CR> AT*AGRTE? Parameters Type data_rate Integer link_adaptation Integer store Integer Responses <CR><LF>*AGRTE:<data_rate>,<link_adaption><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AGCL Channel List Syntax AT*AGCL=<ch1>,<ch2>,<ch3>,<ch4>,<ch5>,<ch6>,<ch7>,<ch8>, <ch9>,<ch10>,<ch11>,<ch12>,<ch13>,<ch14>,<store><CR> AT*AGCL? Parameters Type ch# Integer store Integer Description Write data rate ...
Page 46
Responses <CR><LF>*AGCL:<ch1>,<ch2>,…,<ch14><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> Example: To use only channel 1,6, and 11 use the command AT*AGCL=1,6,11,0,0,0,0,0,0,0,0,0,0,0,1 Note: The channels will be scanned in the order they are listed by this command. AT*AGLN Local Name AT*AGLN manipulates the same setting as ...
Page 47
AT*ANDHCP DCHP Activation Syntax AT*ANDHCP=<on>,<store><CR> AT*ANDHCP? Parameters Type on Integer store Integer Responses <CR><LF>*ANDHCP:<on><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*ANHN Hostname Syntax AT*ANHN=<hostname>,<store><CR> AT*ANHN? Parameters Type hostname String store Integer Responses <CR><LF>*ANHN:<hostname><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*ANDNS DNS Settings Syntax AT*ANDNS=<dns1>,<dns2>,<store><CR> AT*ANDNS? Parameters Type Description ...
Page 48
IP_Addr dns2 IP_Addr store Integer Responses <CR><LF>*ANDNS:<dns1>,<dns2><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> 9.4 Data Mode Commands AT*ADDM Enter Data Mode Syntax AT*ADDM<CR> Responses <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*ADMRP Read Maximum Number of Remote Peers Syntax AT*ADMRP?<CR> Parameters Type nr_of_peers Integer Responses <CR><LF>*ADMRP:<nr_of_peers><CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*ADNRP ...
Page 49
Parameters Type nr_of_peers Integer store Integer Responses <CR><LF>*ADMRP:<nr_of_peers><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*ADRDRP Read Default Peer Syntax AT*ADRDRP=<peer_id><CR> Parameters Type peer_id Integer address String conn_scheme Integer update_on_incoming Integer name String Responses <CR><LF>*ADRDRP:<address>, <conn_scheme>, <update_on_incoming>, <name>, <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*ADWDRP Write Remote Peer Information ...
Page 50
Parameters Type peer_id Integer address String conn_scheme Integer reserved Integer name String store Integer Responses <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> 9.5 Informational Commands AT*AILBA Read MAC address Syntax AT*AILBA?<CR> Parameters Type mac_address MAC_Addr Responses <CR><LF>*AILBA:<mac_address> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AILVI Local Version Information Syntax AT*AILVI=<manufacturer>,<store> ...
Page 51
... Syntax AT*AMRS= <baud_rate>, <data_bits>, <stop_bits>, <parity>, Serial port adapter manufacturer, example “connectBlue” Serial port adapter software version, example ”1.0.2 [11:32:15,May 14 2007]” WLAN host driver version, example “1.0” WLAN firmware version, example "1.3.15.32" WLAN hardware manufacturer, example “NXP” ...
Page 52
AT*AMRS? Parameters Type baud_rate Integer data_bits Integer stop_bits Integer parity Integer flow_control Integer reserved Integer store Integer Read the RS-232 settings. Description Sets the baud rate 300 2 = 1200 3 = 2400 4 ...
Page 53
Note: If you do not set one of the predefined baud rates the OWSPA311g will try to use the value you set. It calculates a “true baud rate” that it can use, taking into ac- count the UART clock. If ...
Page 54
Parameters Type min_time_before Integer min_time_after Integer store Integer Responses <CR><LF>*AMET:<min_time_before>, <min_time_after><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AMWS Watchdog Settings Syntax AT*AMWS=<reserved1>, <inactivity_timeout>, <reserved3>, <reserved4>, <reset>, <store><CR> AT*AMWS? Parameters Type reserved1 Integer inactivity_timeout Integer reserved3 Integer disconnect_reset Integer reset Integer store Integer Responses <CR><LF>*AMWS: ...
Page 55
AT*AMPM Power Mode Syntax AT*AMPM=<power_mode>,<store> <CR> AT*AMPM? Parameters Type power_mode Integer store Integer Responses <CR><LF>*AMPM:<power_mode><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AMMP Max output power Syntax AT*AMMP=<max_power>,<store>< CR> AT*AMMP? Parameters Type max_power Integer store Integer Responses <CR><LF>*AMPM:<max_power><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AMTU MTU Size Syntax AT*AMTU=<mtu_length>,<store> ...
Page 56
Parameters Type mtu_length Integer store Integer Responses <CR><LF>*AMTU:<mtu_length><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AMGD General Purpose Data Syntax AT*AMGD=<data>,<store><CR> AT*AMGD? Parameters Type data String store Integer Responses <CR><LF>*AMGD:”<data>”<CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AMTL TCP Listener Activation Syntax AT*AMTL=<port>,<tl_on>,<store><CR> AT*AMTL? Parameters Type port Integer tl_on Integer ...
Page 57
AT*AMUR UDP Receiver Activation Syntax AT*AMUR=<port>,<ul_on>,<store ><CR> AT*AMUR? Parameters Type port Integer ul_on Integer store Integer Responses <CR><LF>*AMUR:<port>,<ul_on><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AMDS DSR/DTR Control Syntax AT*AMDS=<DTR_on>,<DSR_on>, <store><CR> AT*AMDS? Parameters Type DTR_on Integer DSR_on Integer store Integer Responses <CR><LF>*AMDS:<DRT_on>,<DSR_on> ...
Page 58
AT*AMRD Regulatory Domain Control Syntax AT*AMRD=<domain>,<store><CR> AT*AMRD? Parameters Type domain Integer store Integer Responses <CR><LF>*AMRD:<domain><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AMRFM Read Feature Mask Syntax AT*AMRFM=<mask_id><CR> Parameters Type mask_id Integer mask_value Integer Responses <CR><LF>*AMRFM:<mask_id>,<mask_value> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*AMWFM Write Feature Mask Syntax AT*AMWFM=<mask_id>,<mask_value>, <store><CR> ...
Page 59
... Parameters Type mask_id Integer mask_value Integer Responses <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> AT*ACCB Configuration over WLAN Syntax AT*ACCB=<allow>,<store><CR> AT*ACCB? Parameters Type allow Integer Responses <CR><LF>*ACCB:<allow><CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> <CR><LF>ERROR<CR><LF> ...
Page 60
Licenses This product contains software under the following licenses Copyright (c) 2001, 2002 Swedish Institute of Computer Science. * All rights reserved Redistribution and use in source and binary forms, with or without modification, * are ...