Commands for Addressing RSD Devices

Commands_for_Addressing_RSD_Devices

Commands for Addressing RSD devices

POLL_RSD_CRC (3AH)

Table 1-21: POLL_RSD_CRC Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	3AH
4	Length	00H
5	Frame Check Sequence	CRC LSB
6		CRC MSB

POLL_RSD_CHECKSUM (74H)

Table 1-22: POLL_RSD_CHECKSUM Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	74H
4	Length	00H
5	Frame Check Sequence	CHECKSUM

GET_RSD_INFORMATION (3CH)

Table 1-23: GET_RSD_INFO Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	3CH
4	Length	00H
5/6	Frame Check Sequence	CRC or CHECKSUM

(*) GET_RSD_FULL_CONFIGURATION (47H/02H)

Table 1-24: GET_RSD_INFO Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	47H
4	Length	01H
5	Sub Command	02H
6/7	Frame Check Sequence	CRC or CHECKSUM

(*) SET_RSD_CONFIGURATION (77H)

Table 1-25: SET_RSD_INFO Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address (1)	Refer to RSD Address Space section
3	Type	77H
4	Length	06H
5	Low RSD RF Address	00H to FFh & not AAH (2), (10)
6	High RSD RF Address	00H to FFh & not AAH (2), (10)
7	Low APM Range	00H to FFh & not AAH (3)
8	High APM Range	00H to FFh & not AAH (3)
9	New RSD Address	00H to FFh & not AAH (4)
10	DCS and Feature (5), (10)	Bit 7-6 reserved
		Bit 5 (1G only)
		...... 1=DCS enabled
		...... 0=DCS disabled
		Bit 4-3 (Next GenAD400 only)
		Extended Status Reporting Config (9)
		...... 00 = Disabled
		...... 01 = Enabled
		...... 10 = Reserved
		...... 11 = Reserved
		Bit 2-0 (Next Gen AD400only)
		...... 000=DCS Disabled
		...... 001=DCS enabled, channel set 1 (6)
		...... 010=DCS enabled, channel set 2 (7)
		...... 011=DCS enabled, channel set 3 (8)
		...... 111=no change
11/12	Frame Check Sequence	CRC or CHECKSUM

NOTES: #'s shown in ()

(1) If byte 2 is set to AAH, then all RSD’s on the RS485 bus will accept and respond to this command, therefore AAH address should only be used when there is only one RSD on the RS485 bus and its current RSD RS485 address is not known.

(2) If bytes 5 and 6 are both set to FFH, then the RSD’s RF address is not changed. Applies only to PIM400-485.

(3) If bytes 7 and 8 are both set to FFH, then the RSD’s APM range is not changed. Applies only to PIM400-485.

(4) If byte 9 is set to FFH, then the RSD’s RS485 address is not changed. Applies to PIM400-485 and AD-300.

(5) If byte 10 is set to FFH, then the RSD’s DCS (dynamic channel switching) state is not changed. Applies only to PIM400-485.

(6) Channels 1, 4, and 7 are used in channel set 1 in the AD400/PIM400-485. Channels 6 and 9 are used in channel set 1 in the AD400-B/PIM400-485-B

(7) Channels 2, 5, and 8 are used in channel set 2 in the AD400/PIM400-485. Channels 7 and 10 are used in channel set 2 in the AD400-B/PIM400-485-B.

(8) Channels 3, 6, and 9 are used in channel set 3 in the AD400/PIM400-485. Channel set 3 is not a valid option for an AD400-B/PIM400-485-B.

(9) All reserved values for extended status reporting configuration are treated as extended status reporting disabled. However, these reserved values should not be used as the means to disable this feature as they could take on a different meaning in the future.

(10) RF address and DCS features are not applicable to ENGAGE products. Changes to these data fields will be ignored by an ENGAGE Gateway device.

(*) SET_RSD_CHANNEL (47H/01H)

NOTE: Channel number selection is not supported by ENGAGE products.

NOTE: DCS selection takes priority over the single channel selection. This command will not cause any change if DCS is already enabled in the case of AD wireless products.

Table 1-26: SET_RSD_CHANNEL Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	47H
4	Length	02H
5	Data	Sub Command: 01H
6		Channel Number: 01D-10D (1)
7/8	Frame Check Sequence	CRC or CHECKSUM

(1) The valid channel range for the AD400/PIM400-485 is 1 through 10. The valid channel range for the AD400-B/PIM400-485-B is 6 through 10.

GET_APM/RSD_ASSOCIATION (65H)

Table 1-27: GET_APM/RSD_ASSOCIATION Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	APM Address	Refer to APM Address Space section
3	Type	65H
4	Length	00H
5/6	Frame Check Sequence	CRC or CHECKSUM

SET_POLL (49H)

NOTE: When using the SET_POLL command to set the polling addresses only one RSD can be on the RS485 bus. All other RSD’s must be temporarily disconnected.

Table 1-28: SET_POLL Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	49H
4	Length	02H
5	Data	Low APM range (0 to FEH, not AAH)
6		High APM range (0 to FEH, not AAH)
7/8	Frame Check Sequence	CRC or CHECKSUM

SET_LINK (45H)

Permits linking using the RSI protocol without needing a HHD/SUS. For ENGAGE Gateway, issuing a set link command against an existing APM Address immediately deletes the existing link.

Table 1-29: SET_LINK Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	APM Address	Refer to APM Address Space section
3	Type	45H
4	Length	00H
5/6	Frame Check Sequence	CRC or CHECKSUM

ABORT_LINK (32H)

For ENGAGE Gateway, issuing an abort link command against an existing APM Address deletes the existing link. It is recommended that an abort link command be sent before a new set link when reassigning an existing APM address.

Table 1-30: ABORT_LINK Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	APM Address	Refer to APM Address Space section
3	Type	32H
4	Length	00H
5/6	Frame Check Sequence	CRC or CHECKSUM

GET_OEM_CODE (6FH)

Table 1-31: SEND_OEM_CODE Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	6FH
4	Length	00H
5/6	Frame Check Sequence	CRC or CHECKSUM

(*) SET_RSD_WOR (47H/07H)

NOTE: WOR is always enabled for ENGAGE Gateway and is not configurable. Changes in the WOR data field are ignored and always return a value of 5 seconds.

Table 1-32: SET_RSD_WOR Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	47H
4	Length	02H
5	Data	Sub Command: 07H
6		WOR: 0-10 seconds; 0=WOR disabled.
7/8	Frame Check Sequence	CRC or CHECKSUM

(*) SET_WOR_WAKEUP (47H/08H)

Table 1-33: SET_WOR_WAKEUP Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	47H
4	Length	05H
5	Data	Sub Command: 08H
6		Lock Bit Map Low Byte: .
		Bit0-1st lock on the PIM
		1-wake up this lock
		0-don’t wake up this lock
7		Lock Bit Map High Byte
		Bit0 – 9th lock on the PIM
		1-wake up this lock
		0-don’t wake up this lock
8		Control Bit Map Low Byte
		1-unlock, 0-relock
9		Control Bit Map High Byte
		1-unlock, 0-relock
10/11	Frame Check Sequence	CRC or CHECKSUM

(*) GET_WOR_WAKEUP_STATUS (47H/09H)

Table 1-34: GET_WOR_WAKEUP_STATUS Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	47H
4	Length	01H
5	Data	Sub Command: 09H
6/7	Frame Check Sequence	CRC or CHECKSUM

GET_FIRMWARE_VERSION (2CH)

Table 1-35: GET_FIRMWARE_VERSION Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	2CH
4	Length	00H
5/6	Frame Check Sequence	CRC or CHECKSUM

(*) GET_FULL_FIRMWARE_VERSION (47H/0AH)

Table 1-36: GET_FULL_FIRMWARE_VERSION Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	47H
4	Length	01H
5	Data	Sub Command: 0AH
6/7	Frame Check Sequence	CRC or CHECKSUM

(*) GET_RSD_SERIAL_NUMBERS (4BH/01H)

Table 1-37: GET_RSD_SERIAL_NUMBERS Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	4BH
4	Length	01H
5	Data	Sub Command: 01H
6/7	Frame Check Sequence	CRC or CHECKSUM

(*) GET_RSD_MANUFACTURE_DATES (4BH/02H)

Table 1-38: GET_RSD_MANUFACTURE_DATES Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	4BH
4	Length	01H
5	Data	Sub Command: 02H
6/7	Frame Check Sequence	CRC or CHECKSUM

(*) GET_RSD_HARDWARE_VERSIONS (4BH/03H)

Table 1-39: GET_RSD_HARDWARE_VERSIONS Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	4BH
4	Length	01H
5	Data	Sub Command: 03H
6/7	Frame Check Sequence	CRC or CHECKSUM

(*) GET_AD_RSD_OEM_CODE (47H/0CH)

Table 1-40: GET_AD_RSD_OEM_CODE Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	47H
4	Length	01H
5	Sub Command	0CH
6/7	Frame Check Sequence	CRC or CHECKSUM

(*) GET_AD_RSD_PARTNER_ID (47H/0EH)

NOTE: Partner ID is not supported by ENGAGE products.

Table 1-41: GET_AD_RSD_PARTNER_ID Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	47H
4	Length	01H
5	Sub Command	0EH
6/7	Frame Check Sequence	CRC or CHECKSUM

(*) GET_READER_INFO (47H/0FH)

Table 1-42: GET_READER_INFO Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	47H
4	Length	02H
5	Sub Command	0FH
6	APM Address	Refer to APM Address Space section
7/8	Frame Check Sequence	CRC or CHECKSUM

(*) START_FW_DOWNLOAD (15H/00H)

Table 1-43: START_FW_DOWNLOAD Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	15H
4	Length	04H
5	Data	Sub Command: 00H
6		Download Target:
		0x00 = MG(K)/MS(K) Reader
		0x01 = KP/PR(K)/SM(K)/MT(K)/MI(K)/FMK Reader
		0x02 = AD-300 Main
		0x03 = AD-400 Main
		0x04 = PIM400-485
		0x05 = MT(K)2/MI(K)2/Si(K)2/FMK2 Reader
		0x06 = NDE
		0x07 = ADE-COM
		0x08 = ADE-Main
		0x09 = ENGAGE Gateway
		0x0A = BE467/FE410
		0x0B = LE
		0x0C = AD-302 Main
		0x0D = AD-402 Main
		0x0E = RMRU
		0x0F = NDEB
		0x10 = LEMSB
		0x11 = LEMBB
		0x12 = LEMDB
		0x13-0xFF = Reserved
7		*Lock Bit Map Low Byte:
		Bit0 = 1st lock on the PIM
		1 = Download intended for this lock
		0 = Download not intended for this lock
8		*Lock Bit Map High Byte .
		Bit0 = 9th lock on the PIM
		1 = Download intended for this lock
		0 = Download not intended for this lock
9/10	Frame Check Sequence	CRC or CHECKSUM

NOTES: *These bytes are required only if download target is an ENGAGE Edge Device, an AD-400, or a reader that is attached to an AD-400. If download target is not one of these then these bytes should be sent as 0x00.

*For ENGAGE™ Edge Devices the Lock Bit Map shall only include the devices that match the download target.

(*) FW_FILE_BLOCK (15H/01H)

Table 1-44: FW_FILE_BLOCK Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	15H
4	Length	43H
5	Data	Sub Command: 01H
6-7		*FW Block Id. Low byte sent first.
8-71		64 bytes of Firmware File Data. Lowest byte sent first
72/73	Frame Check Sequence	CRC or CHECKSUM

*This is a 2-byte sequence number used to ensure the firmware file is received in the correct order. This should start at 0x0001 and be incremented by one for each new block that is sent by the ACP. The low byte of the value should be sent first.

(*) END_FW_DOWNLOAD (15H/02H)

Table 1-45: END_FW_DOWNLOAD Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	15H
4	Length	01H
5	Data	Sub Command: 02H
6/7	Frame Check Sequence	CRC or CHECKSUM

(*) ABORT_FW_DOWNLOAD (15H/03H)

Table 1-46: ABORT_FW_DOWNLOAD Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	15H
4	Length	03H
5	Data	Sub Command: 03H
6		*Lock Bit Map Low Byte:
		Bit0 = 1st lock on the PIM
		1 = Abort download for this lock
		0 = Do not abort download for this lock
7		*Lock Bit Map High Byte .
		Bit0 = 9th lock on the PIM
		1 = Abort download for this lock
		0 = Do not abort download for this lock
8/9	Frame Check Sequence	CRC or CHECKSUM

* These bytes are required only if aborting the download of an ENGAGE™ Edge Device, AD-400, or a reader that is attached to an AD-400. If aborting download for a device that is not one of these, then these bytes should be sent as 0x00.

* For ENGAGE™ Edge Devices, the Lock Bit Map includes only the same model type device(s) (i.e. all NDE, all LE, all NDE and all LE, etc, but not a partial mix). The Lock Bit Map should not include any non-linked device(s).

(*) START_FW_REFLASH (15H/04H)

Table 1-47: START_FW_REFLASH Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	15H
4	Length	04H
5	Data	Sub Command: 04H
6		Reflash Target:
		0x00 = AD-300 and/or Reader Attached to AD-300
		0x01 = *WAPM and/or Reader Attached to WAPM (including ENGAGE locks)
		0x02 = PIM400-485/ENGAGE Gateway
		0x03-0xFF = Reserved
7		**Lock Bit Map Low Byte:
		Bit0 = 1st lock on the PIM
		1 = Reprogram this lock with most recently downloaded firmware file(s)
		0 = Do not reprogram this lock
8		**Lock Bit Map High Byte
		Bit0 = 9th lock on the PIM
		1 = Reprogram this lock with most recently downloaded firmware file(s)
		0 = Do not reprogram this lock
9/10	Frame Check Sequence	CRC or CHECKSUM

*Current Release supports only AD400 WAPMs. In the future this may include other wireless devices.

**These bytes are required only if starting firmware reprogramming of a WAPM or a reader that is attached to the WAPM. If reprogramming firmware for a device that is not one of these, then these bytes should be sent as 0x00.

*For ENGAGE™ Edge Devices, the Lock Bit Map includes only the same model type device(s) (i.e. all NDE, all LE, all NDE and all LE, etc, but not a partial mix). The Lock Bit Map should not include any non-linked device(s).

(*) GET_ONR_STATUS (15H/05H)

Table 1-48: GET_ONR_STATUS Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	15H
4	Length	01H
5	Data	Sub Command: 05H
6/7	Frame Check Sequence	CRC or CHECKSUM

(*) LARGE_FW_FILE_BLOCK (15H/06H)

Table 1-49: LARGE_FW_FILE_BLOCK Command Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	15H
4	Length	44H
5	Data	Sub Command: 06H
6-8		*FW Block Id. Low byte sent first
9-72		64 bytes of Firmware File Data. Lowest byte sent first
72/73	Frame Check Sequence	CRC or CHECKSUM

* This is a 3-byte sequence number used to ensure the firmware file is received in the correct order. This should start at 0x0001 and be incremented by one for each new block that is sent by the ACP. The low byte of the value should be sent first.

(*) SET_RSD_DIAGNOSTICS_CONFIGURATION (50H)

Table 1-50: SET_RSD_DIAGNOSTICS_CONFIGURATION Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD Address	Refer to RSD Address Space section
3	Type	50H
4	Length	01H
5	Data	00H = Disable Diagnostics Credential Read
		01H = Enable Diagnostics Credential Read
		02H-FFH = Reserved
6/7	Frame Check Sequence	CRC or CHECKSUM

(*) RSD_SECURE_HOST_CONFIG (20H/09H)

Table 1-51: RSD_SECURE_HOST_CONFIG Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD address	Refer to RSD Address Space section
3	Type	20H
4	Length	08H
5	Data	1 byte	Sub command: 09H
		1 byte	00H – Disable secure mode
			01H – Enable secure mode
			02H-FFH – Reserved
		2 bytes	Session timeout value (in minutes)
			0000 – Not allowed
			Byte 2 – SessionTimeoutLSB
			Byte 3 – SessionTimeoutMSB
		1 byte	Bit 0:
			1 = Select ACP Default Key
			0 = Select Allegion Default Key
			Bit 1-7 = RFU (should always be zero)
		3 bytes	Reserved for future use
13/14	Frame check sequence	CRC or CHECKSUM

(*) RSD_START_SECURE_SESSION (20H/01H)

Table 1-52: RSD_START_SECURE_SESSION Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD address	Refer to RSD Address Space section
3	Type	20H
4	Length	04H
5	Data	1 byte	Sub command: 01H
		1 byte	00H = Establish Normal Secure Session
			01H = Establish Admin Secure Session
			02H – FFH = RFU (should be zero)
		2 bytes	Reserved for future.
9/10	Frame check sequence	CRC or CHECKSUM

(*) RSD_START_SECURE_SESSION_ACK (20H/02H)

Table 1-53: RSD_START_SECURE_SESSION_ACK Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD address	Refer to RSD Address Space section
3	Type	20H
4	Length	11H
5	Data	1 byte	Sub command: 02H
		16 byte	Encrypted and Permuted RSD Random Number and ACP Random Number
22/23	Frame check sequence	CRC or CHECKSUM

(*) RSD_SET_ACP_KEY (20H/10H)

NOTE: This command is always sent encrypted during an Admin Secure Session.

Table 1-54: RSD_SET_ACP_KEY Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD address	Refer to RSD Address Space section
3	Type	20H
4	Length	12H
5	Data	Byte 1	Sub Command: 10H
		Byte 2	00H = Set/Replace the new ACP Default Key
			01H = Set/Replace the new Master key
			02H-FFH = RFU
		16 bytes	New AES-128 bits key.
24/25	Frame check sequence	CRC or CHECKSUM

(*) GET_RSD_SECURE_MODE_STATUS (20H/08H)

Table 1-55: GET_RSD_SECURE_MODE_STATUS Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD address	Refer to RSD Address Space section
3	Type	20H
4	Length	01H
5	Data	Sub command: 08H
6/7	Frame check sequence	CRC or CHECKSUM

(*) RSD_SECURE_COMMAND (2EH)

Table 1-56: RSD_SECURE_COMMAND Packet Format

Byte	Field	Data/Description
1	Start-of-Frame	0AH
2	RSD address	Refer to RSD Address Space section
3	Type	2EH
4	Length	Variable (always a multiple of 16)
5 – n	Data	Encrypted Original Command
n+1/n+2	Frame check sequence	CRC or CHECKSUM