Man Down Pendant Message Structure

The WPAN Gateway will create and format PPEN messages based on input from the pendant.

$PPEN,AAAAAAAAAAAAAAAA,BB,XXXXXXX*hh<CR><LF>

Where:
AAAAAAAAAAAAAAAA is the Pendant/Device ID
BB is the Sequence number
XXXXX is the message payload see table below
hh is the message checksum

Examples:

$PPEN,ID,SEQ,PANIC*hh<CR><LF>	ID = pendant’s ID, SEQ=sequence number, PANIC = Alert notification (“Man Down”) message
$PPEN,ID,SEQ,DRVID*hh<CR><LF>	ID = pendant’s ID, SEQ=sequence number, DRVID = Device id message

The WPAN Gateway will understand messages in the PPQ format and will relay/query the pendant.

$PPQ,PAN,AAAAAAAAAAAAAAAA,BB,XXXXXXX*hh<CR><LF>

Where:
AAAAAAAAAAAAAAAA is the Pendant/Device ID
BB is the Sequence number
XXXXX is the message payload see table below
hh is the message checksum

Examples:

$PPQ,PAN,ID,SEQ,ACK*hh<CR><LF>	ID= pendant’s ID, SEQ=sequence number, ACK= acknowledgement string
$PPQ,PAN,ID,SEQ,NACK*hh<CR><LF>	ID= pendant’s ID, SEQ=sequence number, NACK= Negative acknowledgement string
$PPQ,PAN,ID,SEQ,CONF=xx*hh<CR><LF>	ID= pendant’s ID, SEQ=sequence number, CONF=configures sound and vibration state

When the Man Down Pendant is powered on and generates messages, each message will have a sequence number associated with it. The sequence number starts at 00 and increments to FF (hex) at which point it will roll over to 00. The sequence numbers must match for the message to be considered valid.

For example, if the following outbound message is generated:

$PPEN,0123456789ABCDEF,35,PANIC

It must be acknowledged by an inbound message:

$PPQ,PAN, 0123456789ABCDEF,35,ACK

When a PPEN message(PANIC,MPANIC,CPANIC,DRVID,ATTACK) is generated that expects a PPQ acknowledgement (ACK) string, there is a minimum roundtrip time within which the message must be delivered to the pendant before a negative acknowledgement is indicated to the user. By default this time is set to 12 seconds. The round trip response time should be configured from 12 sec to 63 seconds using the bits 2 to 7 of the CONF command. The round trip response time should not be set to a time interval of less than 12 seconds.

For example:

$PPQ,PAN,0123456789ABCDEF,35,CONF=43  will define the roundtrip time to be 16 seconds. 

43=01000011   is 16 seconds with sound and vibration configured to be on
83=10000011   is 32 seconds with sound and vibration configured to be on

PPEN Outgoing Gateway Message	Description	PPQ Expected response
ACK	Acknowledge a configuration change	none
ACKxx<	Return round trip response time, sound, vibration state In hex.	none
ACKxxx	Return battery voltage in decimal, ie ACK300 indicates 3 v	none
ON	Pendant sends this message every time it transitions from off to on state.	none
OFF	Pendant sends this message every time it transition from on to off state.	none
DRVID	ID message	ACK means that the driver’s ID has been accepted. NACK means that it has been rejected. The pendant will continue to send DRVID messages until either a NACK or ACK has been received or up to a total of 5 retries. The response will trigger either positive or negative audible-vibrating indication. The timing of the resending of the DRVID message is controlled by the CONF value.
PANIC	Panic message (push button activated)	ACK means that the message has been received. The pendant will keep sending PANIC messages until either a NACK or ACK has been received. The response will trigger either positive or negative audible-vibrating indication. The timing of the resending of the PANIC message is controlled by the CONF value.
MPANIC	anic message (motion sensor activated)	ACK means that the message has been received. The pendant will keep sending MPANIC messages until either a NACK or ACK has been received. The response will trigger either positive or negative audible-vibrating indication. The timing of the resending of the PANIC message is controlled by the CONF value.
ATTACK	Incoming message receipt acknowledgement.	ACK means that the message has been successfully acknowledged. If there is no response, pendant will retry up to 5 times. The timing of the resending of the ATTACK message is controlled by the CONF value. The response will trigger either positive or negative audible-vibrating indication.
CPANIC	Cancel panic message	ACK means that the message has been received. The pendant will keep sending CPANIC messages until either a NACK or ACK has been received or up to a total of 5 retries of the . The response will trigger either positive or negative audible-vibrating indication. The timing of the resending of the CPANIC message is controlled by the CONF value.
OUTOFRANGE	Gateway generates “out of range” message when associated Pendant moves out of coverage area. Controlled by AT^SESSIONALERT command	none
BACKINRANGE	Gateway generates “back in range” message when associated Pendant back into coverage area. Controlled by AT^SESSIONALERT command	none

PPQ Incoming Gateway Message	Description	PPEN Message Response
ACK	Acknowledge PPEN message	none
NACK	Negative Acknowledge message	none
CONF=xx	Configure panic button. xx is a hex value of the configuration byte, bit mapped as follows: Bit 0: Sound ON/OFF Bit 1: Vibration ON/OFF Bit2 to Bit7: defines round trip response time for ACK generation. (1-63 seconds)	ACK means that the configuration has been saved.
CONF?	Query pendant configuration byte	ACKxx xx is a hex value described above.
BATT?	Query pendant battery voltage level	ACKxxx xxx is a decimal value: E.g. Vbat=3.00V would return ACK300.
ATT	Incoming message for User	ATTACK
TEMP?	Query the pendant temperature	ACKxx xx is a hex value as signed char in °C. E.g.  19 => 25°C, FB => -5°C
BUZZER=xx	Make the pendant beep until power down	ACK xx is a hex value of frequency divided by 100. E.g. 10 => 1.6 KHz BUZZER=s1 preconfigured parameter to play “positive ACK” sound sequence BUZZER=s2 preconfigured parameter to play “negative ACK”  sound sequence BUZZER=s3 preconfigured parameter to play “out of range” sound sequence
PD	Make the pendant power down	None
VIBR	Make the pendant vibrate twice	ACK
VER?	Query the pendant’s firmware version	Vx.x x.x is the pendant firmware version.
PANID=nnnn	Configure PAN ID of Pendant	PANIDACKnnnn where nnnn is the 4 digit hex value of the PAN ID (0000 to FFFE)