NEC Property Management System Communication Interface Specification

							NDA-30115  Revision 1.0Page 31
Property Management System - Communication Interface Message Formats
Chapter 4 Message Formats
All messages sent between the NEAX and the PMS must have header and trailing 
sections as defined in the following format:
Figure 4-1   Base Message Format
The message format breaks down as follows:
STX -- Start of text block. (One byte - 02H.)
SA -- System Address. (One byte - ‘1’ [31H].)
UA -- I/O Unit Address. (One byte - ‘!’ [21H].)
EI -- Entry Index. (One byte - ‘L’ [4CH].)
FTC -- Feature Code. Used in conjunction with the Function Code to uniquely 
identify a message. A list of values are included in Appendix C, “Feature 
Codes”. (Two bytes.)
MSC -- Message Count. This is the number of bytes from the FTC character up 
to the character before the ETX. (Two bytes.)
FC -- Function Code. This entry is dependent on the FTC entry. A list of values 
are included in Appendix D, “Function Codes”. (One byte.)
ETX -- End of text block. (One byte - 03H.)
BCC -- Block Check Code. This is computed by an exclusive OR of the 
message from the SA to the ETX (inclusive). Detection of an STX starts the 
computation (but the STX is not included). Detection of an ETX stops the 
computation (and the ETX is included). (One byte.)
Note 1:
Unless otherwise noted, if the data to be stored in a message field has fewer char-
acters than the size of the field, all data must be left justified and the remaining 
characters must be filled with space (20H) characters.
Note 2:
In the message diagrams, the STX, SA, UA, EI, FTC, MSC, FC and ETX fields 
will show the actual entries needed. The remaining fields will have the name of 
the field in the box and the length of the field below. For all fields, the beginning 
byte number is listed on the top of the field.
Block Check Code Range 02H‘1’03H xx ‘!’
** Options defined below
...
01234 6 89
STX SA UA EI FTC MSC FC MessageETX BCC
** ** **
Message Count Range ‘L’ 
						

							Page 32NDA-30115  Revision 1.0
Message Formats Property Management System - Communication Interface
Note 3:
In the case of messages that are almost identical, the FC will be marked with 
“**”. Also, differing FTC values will be marked with “*”. The final message is 
then constructed by simply inserting the desired FC value (and, if necessary, the 
desired FTC value).
All messages in this section have been previously defined in 
NEAX2400 IMS Hotel 
System PMS Interface Specification (except for one Maid Status message, which is 
so noted). The versions supported are Model 60 and Model 90; Model 120 
messages are not supported. Any message that is intended to work with only one 
version is so designated; any message that is intended to work with both has no 
special designation.
The Feature Codes used are as follows:
70 -- Data Link Maintenance
11, 12, 51, 52 -- Maid Status
13, 53 -- Message Waiting Lamp Control
15 -- Restriction Control
16 -- Check-In/Out (Model 60)
56 -- Check-In/Out (Model 90)
19 -- Wake Up/Group Announcement
20 -- Room Move/Swap/Copy (Model 60)
21, 61 -- Room Data Change
17 -- Extension Report
17 -- Room Recovery (Model 60)
57 -- Room Recovery (Model 90)
59 -- Direct Data Entry (Model 90)
62 -- Extension Connection
Data Link Maintenance
These messages are used by the NEAX and the PMS to maintain the data link 
between them. The messages are as follows:
70-0 -- Nop Test Normal Answer (Sent by NEAX)
70-2 -- Nop Test Recover Answer (Sent by NEAX)
70-3 -- Recovery Start Report (Sent by PMS)
70-4 -- Recovery End Report (Sent by PMS)
70-5 -- Data Link Release Request (Sent by PMS and NEAX)
70-6 -- Data Link Release Confirmation. (Sent by PMS and NEAX)
70-8 -- Extension Number Request (Sent by PMS)
70-F -- Nop Test (Sent by PMS) 
						

							NDA-30115  Revision 1.0Page 33
Property Management System - Communication Interface Message Formats
The format of all Data Link Maintenance messages are exactly as follows:
Figure 4-2   Data Link Maintenance Message Format
The message format breaks down as follows:
FC -- Function Codes that use this message format are: (FTC-FC)
70-0 -- Nop Test Normal Answer
70-2 -- Nop Test Recover Answer
70-3 -- Recovery Start Report
70-4 -- Recovery End Report
70-5 -- Data Link Release Request
70-6 -- Data Link Release Confirmation
70-8 -- Extension Number Request
70-F -- Nop Test
Blank -- Field consists of two space (20H) characters.
Maid Status
This message group uses multiple Feature Codes. The code pairs are as follows 
(first number is the Feature Code, second number is the Function Code):
11-1 -- Cleaning Start (Guest)
11-2 -- Cleaning End (Guest)
11-3 -- Inspection End (Guest)
11-4 -- Out of Order (Guest)
12-1 -- Cleaning Start (Administration)
12-2 -- Cleaning End (Administration)
12-3 -- Inspection End (Administration)
51-1 -- Guest Room 1 (Model 90)
51-2 -- Guest Room 2 (Model 90)
51-3 -- Guest Room 3 (Model 90)
51-4 -- Guest Room 4 (Model 90)
51-5 -- Guest Room 5 (Model 90)
51-6 -- Guest Room 6 (Model 90)
** Multiple Function Codes use this message. See below.
01234 6 89 1112
STX SA UA EI FTC MSC FC 2
‘7’‘0’‘0’‘7’**Blank02H‘1’‘!’‘L’03H xx
ETX BCC 
						

							Page 34NDA-30115  Revision 1.0
Message Formats Property Management System - Communication Interface
51-7 -- Guest Room 7 (Model 90) 
Note:
This message was not previously defined in NEAX2400 IMS Hotel System PMS 
Interface Specification.
51-8 -- Negative Answer (Model 90)
51-9 -- Positive Answer (Model 90)
52-1 -- Administration 1 (Model 90)
52-2 -- Administration 2 (Model 90)
52-3 -- Administration 3 (Model 90)
52-4 -- Administration 4 (Model 90)
All messages designated “Model 90” are used only by the Model 90 version. The 
other messages are used by either the Model 60 or the Model 90 version.
Cleaning
Figure 4-3   Cleaning (General)
Message fields are:
FTC -- Feature Codes that use this message format are: 11 and 12.
FC -- Function Codes that use this message format are: (FTC-FC)
11-1 -- Cleaning Start (Guest)
11-2 -- Cleaning End (Guest)
11-3 -- Inspection End (Guest)
11-4 -- Out of Order (Guest)
12-1 -- Cleaning Start (Administration)
12-2 -- Cleaning End (Administration)
12-3 -- Inspection End (Administration)
Extension -- Extension number. If the extension number is less than six digits, 
left justify the number and fill the remaining bytes with space (20H) characters.
Maid -- Identification number of the maid. If the maid identification number is 
less than six digits, left justify the number and fill the remaining bytes with 
space (20H) characters.
‘1’*‘1’‘7’**ExtensionMaid
** Multiple Function Codes use this message. See below.* Multiple Feature Codes use this message. See below.
01234 6 89 15 2122
STX SA UA EI FTC MSC FC 6 6
02H‘1’‘!’‘L’03H xx
ETX BCC 
						

							NDA-30115  Revision 1.0Page 35
Property Management System - Communication Interface Message Formats
Guest Room
Figure 4-4   Guest Room (General)
Message fields are:
FC -- Function Codes that use this message format are: (FTC-FC)
51-1 -- Guest Room 1 (Model 90)
51-2 -- Guest Room 2 (Model 90)
51-3 -- Guest Room 3 (Model 90)
51-4 -- Guest Room 4 (Model 90)
51-5 -- Guest Room 5 (Model 90)
51-6 -- Guest Room 6 (Model 90)
51-7 -- Guest Room 7 (Model 90) 
Note:
This message was not previously defined in NEAX2400 IMS Hotel System PMS 
Interface Specification.
Extension -- Extension number. If the extension number is less than six digits, 
left justify the number and fill the remaining bytes with space (20H) characters.
Maid -- Identification number of the maid. If the maid identification number is 
less than six digits, left justify the number and fill the remaining bytes with 
space (20H) characters.
LEN -- Line Equipment Number.
** Multiple Function Codes use this message. See below.
LEN
‘5’‘1’‘2’‘3’**Extension Maid
01234 6 89 15
STX SA UA EI FTC MSC FC 6 6
02H‘1’‘!’‘L’
03H xx
ETX BCC
21 27 28
6 
						

							Page 36NDA-30115  Revision 1.0
Message Formats Property Management System - Communication Interface
Room Answer
Figure 4-5   Room Answer (General)
Message fields are:
FC -- Function Codes that use this message format are: (FTC-FN)
51-8 -- Negative Answer (Model 90)
51-9 -- Positive Answer (Model 90)
Extension -- Extension number.   If the extension number is less than six digits, 
left justify the number and fill the remaining bytes with space (20H) characters.
LEN -- Line Equipment Number.
Request -- Room Status Change Request. The possible values are:
0 -- Room Status is not to be changed.
1 -- Room Status is to be changed.
Room Status -- Room status. This flag is used in conjunction with the cleaning 
status flag to determine the status of the room.
Cleaning Status -- Cleaning status. The possible combinations with room status 
are listed below:
LEN
** Multiple Function Codes use this message. See below.Request
Room
StatusCleaning
Status
‘5’‘1’‘2’‘0’**Extension
01234 6 89 15 21
STXSAUAEIFTCMSCFC661
02H‘1’‘!’‘L’
03H xx
ETX BCC
22 23 24 25
11
2
2
0
0
0
00
1
0
1
2
4Stay, Departure Day
Stay, Departure Day, Cleaning in progress
Out (Checked Out)
Out, Cleaning in progress
Out, Cleaning ended
Out of Order (Cannot sell) Room
0
1
1Clean
3
0
1Status of the Room
Vacant (Ready to sell)
Stay (Occupied)
Stay, Cleaning in progress
1
12
3Stay, Cleaning ended
Stay, Inspected 
						

							NDA-30115  Revision 1.0Page 37
Property Management System - Communication Interface Message Formats
Administration
Figure 4-6   Administration (General)
Message fields are:
FC -- Function Codes that use this message format are: (FTC-FC)
52-1 -- Administration 1 (Model 90)
52-2 -- Administration 2 (Model 90)
52-3 -- Administration 3 (Model 90)
52-4 -- Administration 4 (Model 90)
Extension -- Extension number.   If the extension number is less than six digits, 
left justify the number and fill the remaining bytes with space (20H) characters.
Maid -- Identification number of the maid. If the maid identification number is 
less than six digits, left justify the number and fill the remaining bytes with 
space (20H) characters.
LEN -- Line Equipment Number.
** Multiple Function Codes use this message. See below.
‘5’‘2’‘2’‘3’**Extension Maid
01234 6 89 15
STX SA UA EI FTC MSC FC 6 6
02H‘1’‘!’‘L’
03H xx
ETX BCC
21 27 28
6
LEN 
						

							Page 38NDA-30115  Revision 1.0
Message Formats Property Management System - Communication Interface
Message Waiting Lamp Control
These messages are used to control the message waiting lamps on all of the phones. 
Messages sent by the PMS are commands to turn a message waiting lamp on or off. 
Messages sent by the NEAX are notification that a message waiting lamp has been 
turned on or off. This message group uses multiple Feature Codes. The code pairs 
are as follows (first number is the Feature Code, second number is the Function 
Code):
13-1 -- MW Lamp On (Sent by PMS)
13-2 -- MW Lamp Off (Sent by PMS)
13-3 -- MW Lamp On (Sent by NEAX)
13-4 -- MW Lamp Off (Sent by NEAX)
53-1 -- MW Lamp Status (Model 90)
53-2 -- MW Lamp On - FDT (Sent by NEAX) (Model 90)
53-3 -- MW Lamp Off - FDT (Sent by NEAX) (Model 90)
All messages designated “Model 90” are used only by the Model 90 version. The 
other messages are used by either the Model 60 or the Model 90 version. All 
messages apply to text message status only.
MWL Control
Figure 4-7   MWL Control (General)
Message fields are:
FC -- Function Codes that use this message format are: (FTC-FC)
13-1 -- MWL On (Sent by PMS)
13-2 -- MWL Off (Sent by PMS)
13-3 -- MWL On (Sent by NEAX)
13-4 -- MWL Off (Sent by NEAX)
53-2 -- MWL On - FDT (Sent by NEAX) (Model 90)
53-3 -- MWL Off - FDT (Sent by NEAX) (Model 90)
Extension -- Extension number.   If the extension number is less than six digits, 
left justify the number and fill the remaining bytes with space (20H) characters.
*‘3’‘1’‘1’**Extension
** Multiple Function Codes use this message. See below.* Multiple Feature Codes use this message. See below.
01234 6 89 1516
STX SA UA EI FTC MSC FC 6
02H‘1’‘!’‘L’03H xx
ETX BCC 
						

							NDA-30115  Revision 1.0Page 39
Property Management System - Communication Interface Message Formats
MWL Status
Figure 4-8   MWL Status
Message fields are:
Extension -- Extension number.   If the extension number is less than six digits, 
left justify the number and fill the remaining bytes with space (20H) characters.
Status -- Message Waiting Lamp status. The status values are:
0 -- No messages waiting.
1 -- Message waiting set by the NEAX.
4 -- Message waiting set by the PMS.
5 -- Message waiting set by both the PMS and NEAX.
Option -- Message Waiting Lamp status option. This field must always contain 
zero (‘0’).
VMC -- This is reserved for future use. Should be filled with two space (20H) 
characters.
‘5’‘3’‘1’‘5’‘1’Extension Status
OptionVMC
01234 6 89 15
STX SA UA EI FTC MSC FC 6 1
02H‘1’‘!’‘L’
ETX BCC12
16 17 19 20
03H xx 
						

							Page 40NDA-30115  Revision 1.0
Message Formats Property Management System - Communication Interface
Restriction Control
There are two messages. They are identical, except that message 15-1 is sent from 
the PMS to the NEAX, and message 15-2 is sent by the NEAX to the PMS. These 
messages simply communicate a new restriction code for an extension. These 
messages are used by both the Model 60 and the Model 90 version.
Figure 4-9   Restriction Control
Message fields are:
FC-- There are two functions: (FTC-FC)
15-1 -- Originated from the PMS.
15-2 -- Originated from the NEAX.
Extension -- Extension number. If the extension number is less than six digits, 
left justify the number and fill the remaining bytes with space (20H) characters.
Code -- Restriction code for this extension. The possible codes are:
0 -- Do Not Disturb and Room Cut-Off are cancelled.
1 -- Room Cut-Off is set, Do Not Disturb is cancelled.
5 -- Do Not Disturb is set, Room Cut-Off is cancelled.
6 -- Do Not Disturb and Room Cut-Off are set.
Blank -- Field contains two space (20H) characters.
‘1’‘5’‘1’‘4’**Extension Code
** Multiple Function Codes use this message. See below.
01234 6 89 15
STX SA UA EI FTC MSC FC 6 1
02H‘1’‘!’‘L’
03H xx
ETX BCC2
16 18 19
Blank