Resource Centre / Command Reference / WPAN Gateway Command Reference

WPAN Gateway Command Reference

Browse the command reference section below to find common commands for WPAN Gateways.

General AT Commands
Command Description
ATZ Reload configuration from non-volatile (NV) memory
AT&F1 Recall Factory configuration
AT&W save Profile
ATIn Product Information:
0 Gateway
1 Cypress Solutions Inc.
2 Version
3 Build info
ATEn Echo off/on, 0 turns off, 1 turns on
ATVn Verbalize, 1 Displays result messages as English words (verbal). (default)
0 Displays result messages as code numbers (nonverbal).
ATQn Quiet, 0 results codes displayed (default), 1 turns off the result codes.
A/ Repeat last command
ATOWNID? View the Gateway device ID
AT/\VER? View the Gateway firmware version
ATO Go Online, returns the Gateway to PAD mode after and escape sequence (+++)
(this command is used where the gateway is communicating with Wireless Serial Gateways (WSG’s))

Back to top
WPAN Gateway Commands
AT^HOSTSP (configure the serial port)
AT^HOSTSP=bbbbbb,P,D,S   bbbbbb is data rate, (1200/2400/4800/9600
/19,200/38,400/57,600/115,200)

P is parity, N or n=none/E or e=even/O or o=odd
D is data bits, 7/8 data bits
S is stop bits, 1/2 stop bit(s)
AT^HOSTSP=115200,N,8,1    Sets communication to 115,200bps, no parity, 8 data bits, 1 stop bit
AT^HOSTSP?      Displays current parameters

The default serial port configuration for the WPAN Gateway is:
Data rate: 9600 baud
Data bits: 8
Parity: None
Stop bits: 1
Flow control: None
AT^ZBEEADDDEV (add a new WPAN device)
WPAN devices must have their device IDs registered with the Gateway in order for the Gateway to establish communications.

AT^ZBEEADDDEV=<string> add a new device, where <string> = device id (eg. 0013A20040440658),hyphens optional, not case sensitive.
AT^ZBEEDELDEV=<string>   delete a device, where  <string> = device id (eg. 0013A2004044066F), hyphens optional, not case sensitive.
AT^ZBEEADDDEV=FFFFFFFFF
FFFFFFF		 If this value is entered as a device ID, the Gateway will accept messages from any pendant in range with the same PANID.
Previous device ID’s entered are superseded.
Note: This command is valid for Man Down Pendants only.
AT^ZBEEDEV?    View all device IDs that are registered in the WPAN Gateway.
AT&W       saves configuration

AT^ZBEEDELDEV (delete a WPAN device)
WPAN devices must have their device IDs registered with the Gateway in order for the Gateway to establish communications.

AT^ZBEEADDDEV=<string> add a new device, where <string> = device id (eg. 0013A20040440658),hyphens optional, not case sensitive.
AT^ZBEEDELDEV=<string>   delete a device, where <string> = device id (eg. 0013A2004044066F), hyphens optional, not case sensitive.
AT^ZBEEADDDEV=FFFFFFFFF
FFFFFFF		 If this value is entered as a device ID, the Gateway will accept messages from any pendant in range with the same PANID.
Previous device ID’s entered are superseded.
Note: This command is valid for Man Down Pendants only.
AT^ZBEEDEV?    View all device IDs that are registered in the WPAN Gateway.
AT&W       saves configuration

AT^ZBEEDEV (view all device IDs registered in the WPAN Gateway)
WPAN devices must have their device IDs registered with the Gateway in order for the Gateway to establish communications.

AT^ZBEEADDDEV=<string> add a new device, where <string> = device id (eg. 0013A20040440658),hyphens optional, not case sensitive.
AT^ZBEEDELDEV=<string>   delete a device, where  <string> = device id (eg. 0013A2004044066F), hyphens optional, not case sensitive.

AT^ZBEEADDDEV=FFFFFFFFF
FFFFFFF

 If this value is entered as a device ID, the Gateway will accept messages from any pendant in range with the same PANID.
Previous device ID’s entered are superseded.
Note: This command is valid for Man Down Pendants only.
AT^ZBEEDEV?    View all device IDs that are registered in the WPAN Gateway.
AT&W       saves configuration

AT^AUTOSESSION (WPAN session management)
AT^AUTOSESSION=n

Where:
n = 0 Disable (Default)
n = 1 Enable

AT^AUTOSESSION?
Queries the value of autosession

Note: Autosession setting takes effect immediately after entering AT&W and a power cycle.

The following events need to be reported in the case of manual session management or Autosession=0

  • Endpoint registration attempt
  • Endpoint connection established
  • Endpoint connection lost

Event notification will use NMEA messages in the following format:

$PEVN,ID,CODE*hh<CR><LF>                    Generated by WPAN device
Where:
ID is the 64-bit hex address of the endpoint device
CODE is 7-bit hex event code
hh is NMEA checksum

Event code can have the following values:
Code Description
00 Registration Attempt
01 Connection Established
02 Connection Lost


$PEVA,ID,CODE*hh<CR><LF>                    Generated by DCE device
Where:
ID is the 64-bit hex address of the endpoint device
CODE is 8-bit hex event code with bit 7 set to 1 to allow or 0 to reject. If CODE=FF the session must be broken
hh is NMEA checksum

Example:

$PEVN,0013A20040111213,00*79
If automatic session management is disabled on the Gateway, the external DCE device such as a modem must acknowledge the above messages using the following format:

$PEVA,0013A20040111213,80*7E => Allow session establishment
$PEVA,0013A20040111213,00*76 => Reject session with the device
$PEVA,0013A20040111213,FF*76 => Close current session with this device.

ATOWNID (display Gateway ID)
ATOWNID? Will query the unique 16 digit (64 bit, Hex) gateway ID

Example:

ATOWNID?
0013A200404B959D

AT^PANID (configure Gateway Pan ID)
Each WPAN Device and Gateway communicates using a 4 digit hex number. The Pan ID must match between WPAN device and Gateway in order to have any communication between devices. By default this number is 4465 and does not normally need to be changed. The PAN ID on the Engine Vehicle Diagnostic Transmitter can only be changed at the factory.


Query the PAN ID of a Gateway:
AT^PANID? Returns current PAN ID  nnnn where nnnn is a 4 digit hex number (range 0000 to FFFE)


Query the PAN ID of a Man Down Pendant:
This is a two step process:

1. Send the Gateway the following  AT command

AT^RMTPANID?aaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaa = 64-bit hex address of the Pendant

2. Trigger the pendant to broadcast its PAN ID

Press and hold the pendant button for >= 20 seconds until the pendant makes 2 short beeps.
Panic alert messages will still be generated during the press and hold process, this is normal.

Note: The PANID will be broadcast from the pendant. The Gateway will stay in this mode until a character is received on its serial port. Once a character has been received, the Gateway goes back into AT command mode.

The response should be a 4-digit hex value of the PAN ID as follows:
PANIDACKnnnn nnnn= PAN ID in hex where nnnn is a 4 digit hex number (range 0000 to FFFE)


Configure a Gateway's PAN ID:
AT^PANID=nnnn nnnn = 4-digit PAN ID in hex (Range from 0000 to FFFE, Defaults to 4465)

This command takes effect immediately, to save the command enter AT&W


Configure a Man Down Pendant’s PAN ID:
PANID=nnnn nnnn=4-digit hex value of the new PAN ID (Range from 0000 to FFFE,Defaults to 4465)

Example of PPQ message:
$PPQ,PAN,0013A200403047EE,30,PANID=4465*18
The pendant will respond with PANIDACKnnnn

Example of Gateway generated message:
$PPEN,0013A200403047EE,30,PANIDACK4465*45

Back to top
WPAN Gateway Commands to work with a Man Down Pendant
AT^SESSIONALERT (session alert (Man Down Pendant))
AT^SESSIONALERT=n  n=1   If wildcard ID is configured in the Gateway, in/out of range messages will be generated for any pendant. (default)
n=2    If wildcard ID is configured, no in/out of range messages will be generated unless pendant’s ID has been programmed into the Gateway. Note that communication still works for any pendant.
n=0       disabled
AT^SESSIONALERT?  Query session status
              
When Session alert is enabled, the Gateway will create an “Out of Range” message when the Man Down Pendant leaves the coverage area. A “Back in Range” message will be generated when the pendant reenters the coverage area.

Examples of Gateway generated messages:

$PPEN,0013A200402CB49A,2E,OUTOFRANGE*42

$PPEN,0013A200402CB49A,39,BACKINRANGE*74

AT^RMTPANID (remote PAN ID configuration (Man Down Pendant))
Each WPAN Device and Gateway communicates using a 4 digit hex number. The Pan ID must match between WPAN device and Gateway in order to have any communication between devices. By default this number is 4465 and does not normally need to be changed. The PAN ID on the Engine Vehicle Diagnostic Transmitter can only be changed at the factory.


Query the PAN ID of a Gateway:
AT^PANID? Returns current PAN ID nnnn where nnnn is a 4 digit hex number (range 0000 to FFFE)


Query the PAN ID of a Man Down Pendant:
This is a two step process:

1. Send the Gateway the following AT command:
AT^RMTPANID?aaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaa = 64-bit hex address of the pendant

2. Trigger the pendant to broadcast its PAN ID

Press and hold the pendant button for >= 20 seconds until the pendant makes 2 short beeps.
Panic alert messages will still be generated during the press and hold process, this is normal.

Note: The PANID will be broadcast from the pendant. The Gateway will stay in this mode until a character is received on its serial port. Once a character has been received, the Gateway goes back into AT command mode.

The response should be a 4-digit hex value of the PAN ID as follows:
PANIDACKnnnn nnnn= PAN ID in hex where nnnn is a 4 digit hex number (range 0000 to FFFE)


Configure a Gateway's PAN ID:
AT^PANID=nnnn nnnn = 4-digit PAN ID in hex (Range from 0000 to FFFE, Defaults to 4465)

This command takes effect immediately, to save the command enter AT&W


Configure a Man Down Pendant’s PAN ID:
PANID=nnnn nnnn=4-digit hex value of the new PAN ID (Range from 0000 to FFFE,Defaults to 4465)

Example of PPQ message:
$PPQ,PAN,0013A200403047EE,30,PANID=4465*18
The pendant will respond with PANIDACKnnnn

Example of Gateway generated message:
$PPEN,0013A200403047EE,30,PANIDACK4465*45

AT^WANSTATUS (Wireless Area Network status (Man Down Pendant))
In certain scenarios there may be a requirement where the DCE device communicates to the Gateway indicating that it is in a connected state with the WAN(cellular, satellite, etc.) in order to successfully communicate data to a monitoring server.

The message from the DCE device to the Gateway is:

AT^WANSTATUS=n
Where:
n=0   disconnected (Default)
n=1   connected

The command returns OK if WANCTRL=1, otherwise it returns ERROR. This setting is not saved in non-volatile memory.

To enable this feature use the following command:

AT^WANCTRL=n
Where:
n=0 = disabled (Default)
n=1 = enabled

This command takes effect immediately, to save the command enter AT&W

AT^WANCTRL?
Queries the setting

Man Down RANGE messages will be acknowledged by the Gateway if:
WANCTRL=0
OR
WANCTRL=1 AND WANSTATUS=1

Otherwise RANGE messages will not be acknowledged and the Man Down Pendant will indicate an out of range condition.

AT^WANCTRL (Wireless Area Network control (Man Down Pendant))
In certain scenarios there may be a requirement where the DCE device communicates to the Gateway indicating that it is in a connected state with the WAN(cellular, satellite, etc.) in order to successfully communicate data to a monitoring server.

The message from the DCE device to the Gateway is:

AT^WANSTATUS=n
Where:
n=0   disconnected (Default)
n=1   connected

The command returns OK if WANCTRL=1, otherwise it returns ERROR. This setting is not saved in non-volatile memory.

To enable this feature use the following command:

AT^WANCTRL=n
Where:
n=0 = disabled (Default)
n=1 = enabled

This command takes effect immediately, to save the command enter AT&W

AT^WANCTRL?
Queries the setting

Man Down RANGE messages will be acknowledged by the Gateway if:
WANCTRL=0
OR
WANCTRL=1 AND WANSTATUS=1

Otherwise RANGE messages will not be acknowledged and the Man Down Pendant will indicate an out of range condition.

AT^DTRPANIC (Data Terminal Ready panic (Man Down Pendant))
A Man Down request can be indicated on devices that do not support serial data communications by changing the state of the DTR RS232 line. The state of the RTS line is also changed based on whether a DRVID (Driver ID) message has been triggered.

Note: Active state is defined as (-5V), Inactive state is defined as (+5V)

  1. In normal mode (no PANIC or MPANIC requests) DTR should be inactive.
  2. Once a PANIC or MPANIC is received, DTR is set to Active. Note that the NMEA message still goes out on the RxD/TxD pins.
  3. DTR stays Active until one of the following occurs:
    • CPANIC message is received from the pendant that triggered PANIC or MPANIC state
    • DSR is set to Active state.

The Gateway sends ACKs in both cases so the pendant clears its panic state.
If more than 1 pendant sends Man Down, PANIC requests at the same time, only the first one will be acknowledged. The next PANIC request from the second one will trigger DTR output again.
If local ACK is desired (No external modem involved), DSR can be connected to DTR.

For DRVID operation:

  1. In normal mode (no DRVID requests) RTS should be Inactive.
  2. Once a DRVID is received, RTS is set to Active state. Note that the NMEA message still goes out on the RxD/TxD pins.
  3. RTS is kept Active for 8 seconds and then is set Inactive, the state of the CTS line is ignored.

The Gateway sends an ACK back as soon it receives the DRVID message.

The following command is used to control this feature:
AT^DTRPANIC=n    n = 0 Disabled (Default) n = 1 Enabled
AT^DTRPANIC? Queries the current value

A Man Down Alert message can be cleared. If no Man Down messages are received (button press or no-motion), the Gateway can now clear the DTR output:

In order to clear panic indication for situations where the Man Down Pendant goes out of range after generating PANIC alert, a timeout can be set using DTRPANICTIMEOUT command. If this timeout is set, panic indicating state of the Gateway will be reset automatically if no communication is detected from the panic state triggering Man Down Pendant.

AT^DTRPANICTIMEOUT=n

where n is the number of seconds (0-65535)
n=0 disables the timeout
default value is 60

AT^DTRPANICTIMEOUT?  Returns the value for the timeout

AT^DTRPANICTIMEOUT (Data Terminal Ready panic timeout (Man Down Pendant))
A Man Down request can be indicated on devices that do not support serial data communications by changing the state of the DTR RS232 line. The state of the RTS line is also changed based on whether a DRVID (Driver ID) message has been triggered.

Note: Active state is defined as (-5V), Inactive state is defined as (+5V)

  1. In normal mode (no PANIC or MPANIC requests) DTR should be inactive.
  2. Once a PANIC or MPANIC is received, DTR is set to Active. Note that the NMEA message still goes out on the RxD/TxD pins.
  3. DTR stays Active until one of the following occurs:
    • CPANIC message is received from the pendant that triggered PANIC or MPANIC state
    • DSR is set to Active state.

The Gateway sends ACKs in both cases so the pendant clears its panic state.
If more than 1 pendant sends Man Down, PANIC requests at the same time, only the first one will be acknowledged. The next PANIC request from the second one will trigger DTR output again.
If local ACK is desired (No external modem involved), DSR can be connected to DTR.

For DRVID operation:

  1. In normal mode (no DRVID requests) RTS should be Inactive.
  2. Once a DRVID is received, RTS is set to Active state. Note that the NMEA message still goes out on the RxD/TxD pins.
  3. RTS is kept Active for 8 seconds and then is set Inactive, the state of the CTS line is ignored.

The Gateway sends an ACK back as soon it receives the DRVID message.

The following command is used to control this feature:

AT^DTRPANIC=n    n = 0 Disabled (Default) n = 1 Enabled
AT^DTRPANIC? Queries the current value

A Man Down Alert message can be cleared. If no Man Down messages are received, (button press or no-motion) the Gateway can now clear the DTR output:

In order to clear panic indication for situations where the Man Down Pendant goes out of range after generating PANIC alert, a timeout can be set using DTRPANICTIMEOUT command. If this timeout is set, panic indicating state of the Gateway will be reset automatically if no communication is detected from the panic state triggering Man Down Pendant.

AT^DTRPANICTIMEOUT=n

where n is the number of seconds (0-65535)
n=0 disables the timeout
default value is 60

AT^DTRPANICTIMEOUT?  Returns the value for the timeout

Back to top
WPAN Gateway Commands to work with a Wireless Serial Gateway
AT^PAD (PAD (Packet Assembly and Disassembly) (WSG))
The commands listed in this section refer to the configuration of the Gateway and Wireless Serial Gateway when used as a serial line replacement solution. The Gateway is the server connected to the DCE device and the Wireless Serial Gateway (WSG) is the client and is connected to the remote serial device (ie, RTU).

PAD refers to Packet Assembly and Disassembly and is the protocol by which serial data is packetized to be sent over the wireless link. The receiving side disassembles these packets and outputs raw serial data.

There are two modes of operation of the Wireless Serial Gateway (WSG) and Gateway:
transparent mode and multi-point/multi device.
In transparent PAD mode (WSG client and Gateway (PAD=2 mode)), serial data is buffered until a condition is met for sending it over the wireless link. The condition can be one of the following:

  1. Maximum data length reached (PADFWDL)
  2. Maximum packetization timeout expired (PADFWDT) 
The Wireless Serial Gateway (WSG) or client is always using transparent mode.
In Multi-point/multi device mode Gateway data is formatted into sentences in the form:

$PWPAN,ID,HeaderPayload*hh<CR><LF>
Where:
ID = 64-bit hex address of the device that sent the message
HeaderPayload = 3-byte header and variable length payload formatted as hex digits.


Messages to the WSG or client are in the form of:

$PPQ,WPAN,ID,HeaderPayload*hh<CR><LF>
Where:
ID = 64-bit hex address of the endpoint device
HeaderPayload = 3-byte header and variable length payload formatted as hex digits.

AT^PAD=n n=0 => PAD disabled (default)
n=1 => PAD client enabled (transparent client mode)
n=2 => PAD server enabled (transparent server mode)
AT^PAD?     Queries the command setting

Note: If a transparent connection is required, the Wireless Serial Gateway (client) is configured as PAD=1 and the Gateway (server) as PAD=2.
If point to multi point communication is required, the Wireless Serial Gateway (WSG)(client) is configured as PAD=1 and the Gateway(server) must be configured as PAD=0.

AT^PADFWDL=n n is forwarding data length in characters (1-64). Default=20.
AT^PADFWDL? Queries the command setting


AT^PADFWDT=n n is the forwarding data time in 50ms increments.
n=0 => disabled
n=20 => 1s (default)
n=255 => maximum value
AT^PADFWDT? Queries the command setting


AT^PADECHO=n Controls pad echo.
n=0 => echo disabled
n=1 => echo enabled (default)
AT^PADFWDT? Queries the command setting

AT^PADFWDL (PAD forwarding data length (WSG))
The commands listed in this section refer to the configuration of the Gateway and Wireless Serial Gateway when used as a serial line replacement solution. The Gateway is the server connected to the DCE device and the Wireless Serial Gateway (WSG) is the client and is connected to the remote serial device (ie, RTU).

PAD refers to Packet Assembly and Disassembly and is the protocol by which serial data is packetized to be sent over the wireless link. The receiving side disassembles these packets and outputs raw serial data.

There are two modes of operation of the Wireless Serial Gateway (WSG) and Gateway:
transparent mode and multi-point/multi device.
In transparent PAD mode (WSG client and Gateway (PAD=2 mode)), serial data is buffered until a condition is met for sending it over the wireless link. The condition can be one of the following:

  1. Maximum data length reached (PADFWDL)
  2. Maximum packetization timeout expired (PADFWDT) 
The Wireless Serial Gateway (WSG) or client is always using transparent mode.
In Multi-point/multi device mode Gateway data is formatted into sentences in the form:

$PWPAN,ID,HeaderPayload*hh<CR><LF>
Where:
ID = 64-bit hex address of the device that sent the message
HeaderPayload = 3-byte header and variable length payload formatted as hex digits.


Messages to the WSG or client are in the form of:

$PPQ,WPAN,ID,HeaderPayload*hh<CR><LF>
Where:
ID = 64-bit hex address of the endpoint device
HeaderPayload = 3-byte header and variable length payload formatted as hex digits.

AT^PAD=n n=0 => PAD disabled (default)
n=1 => PAD client enabled (transparent client mode)
n=2 => PAD server enabled (transparent server mode)
AT^PAD?     Queries the command setting

Note: If a transparent connection is required, the Wireless Serial Gateway (client) is configured as PAD=1 and the Gateway (server) as PAD=2.
If point to multi point communication is required, the Wireless Serial Gateway (WSG)(client) is configured as PAD=1 and the Gateway(server) must be configured as PAD=0.

AT^PADFWDL=n n is forwarding data length in characters (1-64). Default=20.
AT^PADFWDL? Queries the command setting


AT^PADFWDT=n n is the forwarding data time in 50ms increments.
n=0 => disabled
n=20 => 1s (default)
n=255 => maximum value
AT^PADFWDT? Queries the command setting


AT^PADECHO=n Controls pad echo.
n=0 => echo disabled
n=1 => echo enabled (default)
AT^PADFWDT? Queries the command setting
AT^PADFWDT (PAD forwarding data time (WSG))
The commands listed in this section refer to the configuration of the Gateway and Wireless Serial Gateway when used as a serial line replacement solution. The Gateway is the server connected to the DCE device and the Wireless Serial Gateway (WSG) is the client and is connected to the remote serial device (ie, RTU).

PAD refers to Packet Assembly and Disassembly and is the protocol by which serial data is packetized to be sent over the wireless link. The receiving side disassembles these packets and outputs raw serial data.

There are two modes of operation of the Wireless Serial Gateway (WSG) and Gateway:
transparent mode and multi-point/multi device.
In transparent PAD mode (WSG client and Gateway (PAD=2 mode)), serial data is buffered until a condition is met for sending it over the wireless link. The condition can be one of the following:

  1. Maximum data length reached (PADFWDL)
  2. Maximum packetization timeout expired (PADFWDT) 
The Wireless Serial Gateway (WSG) or client is always using transparent mode.
In Multi-point/multi device mode Gateway data is formatted into sentences in the form:

$PWPAN,ID,HeaderPayload*hh<CR><LF>
Where:
ID = 64-bit hex address of the device that sent the message
HeaderPayload = 3-byte header and variable length payload formatted as hex digits.


Messages to the WSG or client are in the form of:

$PPQ,WPAN,ID,HeaderPayload*hh<CR><LF>
Where:
ID = 64-bit hex address of the endpoint device
HeaderPayload = 3-byte header and variable length payload formatted as hex digits.

AT^PAD=n n=0 => PAD disabled (default)
n=1 => PAD client enabled (transparent client mode)
n=2 => PAD server enabled (transparent server mode)
AT^PAD?     Queries the command setting

Note: If a transparent connection is required, the Wireless Serial Gateway (client) is configured as PAD=1 and the Gateway (server) as PAD=2.
If point to multi point communication is required, the Wireless Serial Gateway (WSG)(client) is configured as PAD=1 and the Gateway(server) must be configured as PAD=0.

AT^PADFWDL=n n is forwarding data length in characters (1-64). Default=20.
AT^PADFWDL? Queries the command setting


AT^PADFWDT=n n is the forwarding data time in 50ms increments.
n=0 => disabled
n=20 => 1s (default)
n=255 => maximum value
AT^PADFWDT? Queries the command setting


AT^PADECHO=n Controls pad echo.
n=0 => echo disabled
n=1 => echo enabled (default)
AT^PADFWDT? Queries the command setting
AT^PADECHO (PAD echo (WSG))
The commands listed in this section refer to the configuration of the Gateway and Wireless Serial Gateway when used as a serial line replacement solution. The Gateway is the server connected to the DCE device and the Wireless Serial Gateway (WSG) is the client and is connected to the remote serial device (ie, RTU).

PAD refers to Packet Assembly and Disassembly and is the protocol by which serial data is packetized to be sent over the wireless link. The receiving side disassembles these packets and outputs raw serial data.

There are two modes of operation of the Wireless Serial Gateway (WSG) and Gateway:
transparent mode and multi-point/multi device.
In transparent PAD mode (WSG client and Gateway (PAD=2 mode)), serial data is buffered until a condition is met for sending it over the wireless link. The condition can be one of the following:

  1. Maximum data length reached (PADFWDL)
  2. Maximum packetization timeout expired (PADFWDT)
The Wireless Serial Gateway (WSG) or client is always using transparent mode.
In Multi-point/multi device mode Gateway data is formatted into sentences in the form:

$PWPAN,ID,HeaderPayload*hh<CR><LF>
Where:
ID = 64-bit hex address of the device that sent the message
HeaderPayload = 3-byte header and variable length payload formatted as hex digits.


Messages to the WSG or client are in the form of:

$PPQ,WPAN,ID,HeaderPayload*hh<CR><LF>
Where:
ID = 64-bit hex address of the endpoint device
HeaderPayload = 3-byte header and variable length payload formatted as hex digits.

AT^PAD=n n=0 => PAD disabled (default)
n=1 => PAD client enabled (transparent client mode)
n=2 => PAD server enabled (transparent server mode)
AT^PAD?     Queries the command setting

Note: If a transparent connection is required, the Wireless Serial Gateway (client) is configured as PAD=1 and the Gateway (server) as PAD=2.
If point to multi point communication is required, the Wireless Serial Gateway (WSG)(client) is configured as PAD=1 and the Gateway(server) must be configured as PAD=0.

AT^PADFWDL=n n is forwarding data length in characters (1-64). Default=20.
AT^PADFWDL? Queries the command setting


AT^PADFWDT=n n is the forwarding data time in 50ms increments.
n=0 => disabled
n=20 => 1s (default)
n=255 => maximum value
AT^PADFWDT? Queries the command setting


AT^PADECHO=n Controls pad echo.
n=0 => echo disabled
n=1 => echo enabled (default)
AT^PADFWDT? Queries the command setting
AT^PADDEVTYPE (PAD device type (WSG))
In order to be able to distinguish between different kinds of devices device type needs to be programmable on the PAD client side.

The configuration is done using the following command:
AT^PADDEVTYPE=n n=10-20 (default = 10)
AT^PADDEVTYPE? Queries the command setting

Examples:

In the examples below, the client refers to the Wireless Serial Gateway connected to the remote serial device and the server refers to the Gateway connected to the DCE device.

Transparent Mode Configurations:
Client settings (Wireless Serial Gateway / WSG):
AT^PADECHO=0
AT^PAD=1
AT&W

Server settings (Gateway):
AT^PADECHO=0
AT^PAD=2
AT^ZBEEADDDEV=0013A200........
AT&W

Multi-point Mode Configurations:

Client settings (Wireless Serial Gateway / WSG):
AT^PADECHO=0
AT^PAD=1

Server settings (Gateway):
AT^PADECHO=0
AT^PAD=0
AT^ZBEEADDDEV=0013A200........
AT^ZBEEADDDEV=0013A200........
AT^ZBEEADDDEV=0013A200........

AT^PADREGT (PAD registration (WSG))
In order to reduce power consumption of the WSG client side and extend operating life, a power saving mode has been implemented. It works by reducing the frequency of registration attempts and keeping the device in low power mode between attempts.
The Client side is required to register to the server. In order to save battery power, this registration period is configurable. This is done using the following command:

AT^PADREGT=p,i
Where:
p is the registration period in seconds.
p=0 => try registering with no delay
p=10 => 10seconds (default)
p=255 => maximum value
i is the registration period increment
i=1 => minimum value
i=10 => 10s (default)
i=255 => maximum value

After power up or lost connection, the client will try registering immediately. If it fails, it will wait for a period that increments by i every failed attempt until it reaches the value of p, where it will continue to attempt to register until a valid connection is made.

Example: p=60, i=10

Attempt Delay (seconds)
1 0
2 10
3 20
4 30
5 40
6 50
7 60
8 60
9 60
.. ..
… …
…. …..

Back to top
WPAN Gateway Commands to work with an E-VDT
AT^OBDSP (configure E-VDT protocol (E-VDT))
In order to successfully connect to an engine or vehicle diagnostic port, the protocol must match between the transmitter and engine/vehicle.

With the default setting, the E-VDT will search for a valid protocol and connect to it. However, this auto search feature may not work on some vehicles; in this case, the user will need to change the protocol setting of the E-VDT. Protocols 1 to 9 are for OBD II compliant vehicles. 
              
0 – Automatic
1 – SAE J1850 PWM
2 – SAE J1850 VPW
3 – ISO 9141-2
4 – ISO 14230-4 KWP (slow)
5 – ISO 14230-4 KWP (fast)
6 – ISO 15765-4 CAN (11-bit ID, 500k baud)
7 – ISO 15765-4 CAN (29-bit ID, 500k baud)
8 – ISO 15765-4 CAN (11-bit ID, 250k baud)
9 – ISO 15765-4 CAN (29-bit ID, 250k baud)
10 – SAE J1939 CAN (29-bit ID, 250k baud)
11 – USER1 CAN (11-bit ID, 125k baud)
12 – USER2 CAN (11-bit ID, 50k baud)

AT^OBDSP=n  configure protocol setting 
n=0 – 12
AT^OBDSP?    show protocol setting

                                   
Examples:
To change the protocol setting, for example, you want to change to ISO 9141-2:
at^obdsp=3  set protocol to ISO 9141-2
at^&w   save changes
                                               
To show the protocol setting, type in the following:
at^obdsp?   display protocol setting
Returned string: 3

AT^POBDA (configure E-VDT Report A (E-VDT))
AT^POBDA=n1[,n2][,n3][,n4] configures report A
AT^POBDB=n1[,n2][,n3][,n4]  configures report B
AT^POBDC=n1[,n2][,n3][,n4]  configures report C
AT^POBDD=n1[,n2][,n3][,n4] configures report D

Where:
n1..n4 are parameters to be displayed, n2..n4 are optional.
These commands and their associated parameters are not case sensitive.
The valid values for n1 – n4 are parameters from the E-VDT table.

Example:
at^pobda=p2,p8,p25 configure POBDA message to report parameters P2,P8 and P25

AT^POBDA? view the configuration of report A
AT^POBDB? view the configuration of report B
AT^POBDC?   view the configuration of report C
AT^POBDD?   view the configuration of report D

Gateway to DCE message:

n1[,n2][,n3][,n4] <CR><LF>

Where:
n1..n4 are parameters to be displayed, n2..n4 are optional.
These commands and their associated parameters are not case sensitive.
The valid values for n1 – n4 are parameters from the E-VDT table.

Example:

AT^POBDA =P1,P2,P3,P5

Returned String:
P1,P2,P3,P5

AT^POBDB (configure E-VDT Report B (E-VDT))
AT^POBDA=n1[,n2][,n3][,n4] configures report A
AT^POBDB=n1[,n2][,n3][,n4]  configures report B
AT^POBDC=n1[,n2][,n3][,n4]  configures report C
AT^POBDD=n1[,n2][,n3][,n4] configures report D

Where:
n1..n4 are parameters to be displayed, n2..n4 are optional.
These commands and their associated parameters are not case sensitive.
The valid values for n1 – n4 are parameters from the E-VDT table.

Example:
at^pobda=p2,p8,p25 configure POBDA message to report parameters P2,P8 and P25

AT^POBDA? view the configuration of report A
AT^POBDB? view the configuration of report B
AT^POBDC?   view the configuration of report C
AT^POBDD?   view the configuration of report D

Gateway to DCE message:

n1[,n2][,n3][,n4] <CR><LF>

Where:
n1..n4 are parameters to be displayed, n2..n4 are optional.
These commands and their associated parameters are not case sensitive.
The valid values for n1 – n4 are parameters from the E-VDT table.

Example:

AT^POBDA =P1,P2,P3,P5

Returned String:
P1,P2,P3,P5

AT^POBDC (configure E-VDT Report C (E-VDT))
AT^POBDA=n1[,n2][,n3][,n4] configures report A
AT^POBDB=n1[,n2][,n3][,n4]  configures report B
AT^POBDC=n1[,n2][,n3][,n4]  configures report C
AT^POBDD=n1[,n2][,n3][,n4] configures report D

Where:
n1..n4 are parameters to be displayed, n2..n4 are optional.
These commands and their associated parameters are not case sensitive.
The valid values for n1 – n4 are parameters from the E-VDT table.

Example:
at^pobda=p2,p8,p25 configure POBDA message to report parameters P2,P8 and P25

AT^POBDA? view the configuration of report A
AT^POBDB? view the configuration of report B
AT^POBDC?   view the configuration of report C
AT^POBDD?   view the configuration of report D

Gateway to DCE message:

n1[,n2][,n3][,n4] <CR><LF>

Where:
n1..n4 are parameters to be displayed, n2..n4 are optional.
These commands and their associated parameters are not case sensitive.
The valid values for n1 – n4 are parameters from the E-VDT table.

Example:

AT^POBDA =P1,P2,P3,P5

Returned String:
P1,P2,P3,P5

AT^POBDD (configure E-VDT Report D (E-VDT))
AT^POBDA=n1[,n2][,n3][,n4] configures report A
AT^POBDB=n1[,n2][,n3][,n4]  configures report B
AT^POBDC=n1[,n2][,n3][,n4]  configures report C
AT^POBDD=n1[,n2][,n3][,n4] configures report D

Where:
n1..n4 are parameters to be displayed, n2..n4 are optional.
These commands and their associated parameters are not case sensitive.
The valid values for n1 – n4 are parameters from the E-VDT table.

Example:
at^pobda=p2,p8,p25 configure POBDA message to report parameters P2,P8 and P25

AT^POBDA? view the configuration of report A
AT^POBDB? view the configuration of report B
AT^POBDC?   view the configuration of report C
AT^POBDD?   view the configuration of report D

Gateway to DCE message:

n1[,n2][,n3][,n4] <CR><LF>

where:
n1..n4 are parameters to be displayed, n2..n4 are optional.
These commands and their associated parameters are not case sensitive.
The valid values for n1 – n4 are parameters from the E-VDT table.

Example:

AT^POBDA =P1,P2,P3,P5

Returned String:
P1,P2,P3,P5

AT^SHOWPOBDA (display E-VDT Report A (E-VDT))
AT^SHOWPOBDA  display E-VDT report A
AT^SHOWPOBDB  display E-VDT report B
AT^SHOWPOBDC   display E-VDT report C
AT^SHOWPOBDD    display E-VDT report D

Example:

AT^POBDA=P1,P2,P3,P5

Returned String:
$POBDA,A,p1=85,p2=1544,p3=50,0*74

If a parameter is not supported by the engine or vehicle, only commas will be displayed
Available parameters are listed in the Appendix.

$POBDA,A,,,p2=1544*19

AT^SHOWPOBDB (display E-VDT Report B (E-VDT))
AT^SHOWPOBDA  display E-VDT report A
AT^SHOWPOBDB  display E-VDT report B
AT^SHOWPOBDC   display E-VDT report C
AT^SHOWPOBDD    display E-VDT report D

Example:

AT^POBDA=P1,P2,P3,P5

Returned String:
$POBDA,A,p1=85,p2=1544,p3=50,0*74

If a parameter is not supported by the engine or vehicle, only commas will be displayed
Available parameters are listed in the Appendix.

$POBDA,A,,,p2=1544*19

AT^SHOWPOBDC (display E-VDT Report C (E-VDT))
AT^SHOWPOBDA  display E-VDT report A
AT^SHOWPOBDB  display E-VDT report B
AT^SHOWPOBDC   display E-VDT report C
AT^SHOWPOBDD    display E-VDT report D

Example:

AT^POBDA=P1,P2,P3,P5

Returned String:
$POBDA,A,p1=85,p2=1544,p3=50,0*74

If a parameter is not supported by the engine or vehicle, only commas will be displayed
Available parameters are listed in the Appendix.

$POBDA,A,,,p2=1544*19

AT^SHOWPOBDD (display E-VDT Report D (E-VDT))
AT^SHOWPOBDA  display E-VDT report A
AT^SHOWPOBDB  display E-VDT report B
AT^SHOWPOBDC   display E-VDT report C
AT^SHOWPOBDD    display E-VDT report D

Example:

AT^POBDA=P1,P2,P3,P5

Returned String:
$POBDA,A,p1=85,p2=1544,p3=50,0*74

If a parameter is not supported by the engine or vehicle, only commas will be displayed
Available parameters are listed in the Appendix.

$POBDA,A,,,p2=1544*19

AT^OBDPARAM (display OBD parameters (E-VDT))
Poll individual engine parameters from the Gateway

AT^OBDPARAM? pn
Where:
pn is the engine parameter

If the parameter is available and valid, the response should be in the following format:
pn=value

AT^OBDPARAM? ALL

Will query all available engine/vehicle parameters

If no engine diagnostic device is connected the command will return ERROR

Example:

AT^OBDPARAM?P1

$POBDA,A,p1=125*53

Back to top
Subscribe to our
free newsletter