NEC PROPERTY MANAGEMENT SYSTEM SPECIFICATION
PROPERTY MANAGEMENT SYSTEM
COMMUNICATION INTERFACE SPECIFICATION
NEC America, Inc.
NDA-30115-001
Revision 1.0
June, 1998
Stock # 241727
LIABILITY DISCLAIMER
NEC America reserves the right to change the specifications, functions,
or features in this document at any time without notice. NEC America
has prepared this document for use by its employees and customers. The
information contained herein is the property of NEC America and shall
not be reproduced without prior written approval from NEC America.
Copyright 1999
NEC America, Inc.
Property Management System Communication Interface CONTENTS
TABLE OF CONTENTS
Page
Chapter 1 - Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Chapter 2 - Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Asynchronous Transmission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Line Control Characteristics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Transmission Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Transmission Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
From the NEAX to the PMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
From the PMS to the NEAX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Sender Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Receiver Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Cabling Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Bisynchronous (BSC) Transmiss ion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Line Control Characteristics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Transmission Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Transmission Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Timers and Counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Retransmission Counts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Timer Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Cabling Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Chapter 3 - Message Descriptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Data Link Maintenance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Data Link Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Release for Maintenance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
NEAX Operations During Loss of Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Recovery from Loss of Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Maid Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Message Waiting Lamp Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Restriction Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Check In/Check Out (Model 60) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Check In/Check Out (Model 90) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Wake Up/Group Announcement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Room Move/Swap/Copy (Model 60). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Room Data Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Extension Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Room Recovery (Model 60) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Room Recovery (Model 90) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Direct Data Entry (Model 90) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Extension Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Chapter 4 - Message Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Data Link Maintenance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Maid Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Cleaning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Guest Room. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Room Answer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
NDA-30115Revision 1.0 Page i
CONTENTS Property Management System Communication Interface
Page
Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Message Waiting Lamp Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
MWL Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
MWL Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Restriction Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Check In/Check Out (Model 60) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Check In 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Check Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Check Out Message Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Check In 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Check In 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Check Out Outgoing Call Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Check Out Message Waiting Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Check In/Check Out (Model 90) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Check In. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Check Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Check In Cancellation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Check Out Cancellation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Room Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Provisional Check In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Provisional Check Out. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Check Out Message Waiting Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Wake Up/Group Announcement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Wake Up Setting (NEAX). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Wake Up Cancellation (NEAX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Wake Up Execution Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Wake Up Setting (PMS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Wake Up Cancellation (PMS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Group Announcement Setting (NEAX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Group Announcement Cancellation (NEAX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Group Announcement Execution Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Group Announcement Setting (PMS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Group Announcement Cancellation (PMS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Room Move/Swap/Copy (Model 60). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Room Data Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Room Data Change 60 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Group Formation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Group Cancellation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Reservation Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Reservation Cancellation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Guest Name Change. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Room Data Change 90 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Room Status Change. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Room Key Status Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Extension Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Extension Delete Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Extension Assignment Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Room Recovery (Model 60) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Room Image Set 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Room Image Set 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Room Image Set 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Page ii NDA-30115 Revision 1.0
Property Management System Communication Interface CONTENTS
Page
Room Recovery (Model 90) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Room Data Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Guest Room Secretary Telephone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Connecting Room . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Message Status Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Wake Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Direct Data Entry (Model 90) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Direct Data Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Direct Data Entry Answer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Extension Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Guest Room Secretary Telephone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Connecting Room Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Connecting Room Cancel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Chapter 5 - References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Chapter 6 - Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Appendix A - Room Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A1
Updating Room Status Information in the NEAX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A2
Clearing Room Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A2
Dial Steps for Maid Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A2
Room Status and Cleaning Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A3
Status of Check Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A3
Room Data Setting and Clearing in the NEAX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A3
Appendix B - PMS Line Failure Printouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B1
Normal Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B1
Abnormal Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B2
Abnormal Port. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B2
Transmission Failure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B5
Appendix C - Feature Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C1
Appendix D - Function Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D1
NDA-30115Revision 1.0 Page iii
CONTENTS Property Management System Communication Interface
Page
Page iv NDA-30115 Revision 1.0
Property Management System Communication Interface FIGURES
LIST OF FIGURES
Figure Title Page
2-1 Start Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2-2 NEAX to PMS Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2-3 PMS to NEAX protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2-4 Direct Connection Pin Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2-5 Base Me s sage Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2-6 Messag e D a ta Fo r m a t. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2-7 Direct Connection Pin Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4-1 Base Me s sage Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
4-2 Data Link Maintenance Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
4-3 Cleaning (General) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
4-4 Guest Room (General) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
4-5 Room Answer (General) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
4-6 Administration (General) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
4-7 MWL Control (General). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
4-8 MWL Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
4-9 Restriction Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
4-10 Check In 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
4-11 Check Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
4-12 Check Out Message Waiting Lamp Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
4-13 Check In 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
4-14 Check In 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
4-15 Check Out Outgoing Call Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
4-16 Check Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
4-17 Check In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
4-18 Check Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
4-19 Check In Cance l l a tio n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
4-20 Check Out Can ce l la tion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
4-21 Room Change. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
4-22 Provisional Check In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
4-23 Provisi onal Check out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
4-24 Check Out Message Waiting Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
4-25 Wake Up Setting (NEAX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
4-26 Wake Up Cancellation (NEAX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
4-27 Wake Up Execution Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
4-28 Wake Up Setting (PMS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
4-29 Wake Up Cancellation (PMS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
4-30 Group Announcement Setting (NEAX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
4-31 Group Announcement Cancellation (NEAX). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
4-32 Group Announcement Execution Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
4-33 Group Announ c e m e n t S e tt in g (P M S ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
4-34 Group Announcement Cancellation (PMS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
4-35 Room Move/Swap/Copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
4-36 Room Data Change 60 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
4-37 Group Formation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
4-38 Group Cancellation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
4-39 Reservation Setting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
NDA-30115 Revision 1.0 Page v
FIGURES Property Management System Communication Interface
Figure Title Page
4-40 Reservation Cancellation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
4-41 Guest Name Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
4-42 Room Data Change 90. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
4-43 Room Status Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
4-44 Room Key Status Change. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
4-45 Extension Delet e Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
4-46 Extension Assi gnment Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
4-47 Room Image Set 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
4-48 Room Image Set 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
4-49 Room Image Set 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
4-50 Room Data Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
4-51 Guest Room Secretary Telephone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
4-52 Connecting Room. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
4-53 Message Status Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
4-54 Wake Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
4-55 Direct Data Entry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
4-56 Direct Data Entry Answer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
4-57 Guest Room Secretary Telephone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
4-58 Connecting Room Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
4-59 Connecting Room Cancel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
A-1 Room Status in the NEAX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A1
B-1 Forcible Change Printout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B1
B-2 Assisted Wake Up Printout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B1
B-3 Abnormal Events Printout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B2
B-4 Abnormal Port Printout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B2
B-5 Port State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B3
B-6 I/O Port Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B4
B-7 FIFO Status Scan Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B4
B-8 I/O Port S ta t u s S c a n Da ta. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B4
B-9 Transmission Failure Printout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B5
Page vi NDA-30115 Revision 1.0
Property Management System Communication Interface TABLES
Table Title Page
2-1 Line Control Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2-2 Control Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2-3 Base Me s sage Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2-4 Message Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2-5 Line Control Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2-6 Control Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2-7 Data Transmission Sequence (1 of 2). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2-8 Data Transmission Sequence (2 of 2). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2-9 Retransmission Counts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2-10 Timer Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
B-1 Process Name List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B1
B-2 Wake Up Results. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B2
B-3 Types of Failure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B3
NDA-30115 Revision 1.0 Page vii
TABLES Property Management System Communication Interface
Table Title Page
Page viii NDA-30115 Revision 1.0
Property Management System - Communication Interface Overview
Chapter 1 Overv iew
This document is a descr iption of th e interf ace betwee n the NEC NEAX2400 IMS
(hereafter referred to as the NEAX) and the hotel’s Property Management System
(PMS). This docume nt contains almost all (see below) of the informat ion specified
in the NEAX2400 IMS Hotel System PMS Interface Specifications (docu ment ND-
90265 (E) Issue 2), and is intended to replace it.
The PMS and NEAX may communicate using either an asynchronous or
bisynchronous (BSC) method over a serial line. The transmission protocols are
thoroughly descri bed in the Architectur e section. Th e descripti ons of the messages
transmitted are in the Descrip tions sectio n. The forma ts of th e mess ages ar e in the
Formats section. For a complete list of all messages, please see Appendix C,
“Feature Codes” and Appendix D, “Function Codes”.
Information specified in the NEAX2400 IMS Hotel System PMS Interface
Specifications document, but not included in this document are the messages
specific to Model 120. Those messa ges are 56- 3, 61- 2, 58- 1, 58-2, 58-3, 58-4 and
58-5. These messages are for the Directory Assistance Interface [D-88] feature,
which is not used in the United States.
NDA-30115 Revision 1.0 Page 1
Overview Property Management System - Communication Interface
This Page Left Blank.
Page 2 NDA-30115 Revision 1.0
Property Management System - Communication Interface Architecture
Chapter 2 Architecture
The PMS communicates with the NEAX over one or more serial cables. A
maximum of three lines can be provided as dat a li nks betwe en the NEAX and the
PMS.
The three lines are designated as Line 1, Line 2 and Line 3. Line 1 is used for
Hotel Processing messages; Line 2 and Line 3 are used for I nteractive
messages.
Hotel Processing messages, such as Check In, Check Out and Message
Waiting Lamp control, have less seve re real-time requirements than
interactive messages. Line 1 is only utilized for these messages and they will
never be sent over Line 2 or Line 3.
Interactive messages are the Direct Data Entry messages and Maid Status
Answerback messages. These messages require real-time interaction
between the PMS and the NEAX and can therefore be isolated from the
Hotel Processing messages. If Line 2 is installed, these messages will be
transmitted over that line. If Line 2 and Line 3 are installed, these messages
will load share over both lines. If only Line 1 is installed, these messages
will be transmitted over Line 1.
The use of Line 1 is mandatory. If only Line 1 is installed, all messages are
transmitted over it. Also, if Model 60 is being used, only Line 1 is necessary ,
as all of the Interactive messages are exclusive to Model 90.
It is very rare for Line 2 or Line 3 to be required. They are only needed if the
traffic between the PMS and the NEAX is to be exceptionally heavy. And
even the heavy traffic should only require Line 2.
The PMS may communicate with the NEAX through either an
asynchronous transmission protocol or a bisynchronous transmission (BSC)
protocol.
NDA-30115 Revision 1.0 Page 3
Architecture Property Management System - Communication Interface
Asynchronous Transmission
Line Control Characteristics
Control Method Contention method (point to point)
Operating Mode Half duplex (if modems are used, set to full duplex)
Synchronization Start-stop system
Data Rate 1200, 2400 or 4800 bits/second (bps)
Frame Contents ASCII (7bits)
Error Control Method VRC: Parity, LRC: BCC
Bit Transmission Order Priority is given to low order bits.
Transmission Intervals At each data generation. When a stream of information is
Priority Sequence Primary office: NEAX
Stop bit 1 bit or 2 bits
The characteristic s of the signals t ransmitted across t he communications lin k are as
follows:
Table 2-1 Line Control Characteristics
Item Conditions
transmitted to the NEAX continuously, an interval of 0.5
seconds or more should be given between messages. Each
message must be delimited by the EOT code.
Secondary Office: PMS
Error Control VRC: Even, odd or no parity.
LRC: (BCC) Exclusiv e OR of the message text, st arting after the
STX, and ending with (and including) the ETX.
Message Composition One message constitutes one record; SOH, TTB and ETB are not
used.
Message Length V aria ble length, maximum of 12 8 characters (includi ng STX and
ETX).
Electrical Interface EIA RS-232C electrical standard interface
Signal Form EIA RS-404
Interface Distance Maximum of 50 feet between the NEAX an d the PMS when not
using a modem.
Word Framing 10 bits (1 start, 7 data, 1 parity, 1 stop) or 11 bits (1 start, 7 data,
1 parity, 2 stop)
Page 4 NDA-30115 Revision 1.0
Property Management System - Communication Interface Architecture
05H
‘1’
‘!’
SAUAENQ
The control codes used for the message texts are:
Table 2-2 Control Codes
Control Code
STX 02 Indicates the start of a block.
ETX 03 Indicates the end of a block.
EOT 04 Indicates the end of transmission of a block or release of the
ENQ 05 Used to query other party for expected response.
ACK 06 Indicates the p ositive acknowledgmen t of an informat ion block
NAK 15 Indicates the negative acknowledgment of an information
DLE < 10, 3C Indicates the receiver interrupting to ask for sending rights.
DLE : 10, 7C Indicates the receiver interrupting to ask the sender to stop
DLE ? 10, 3F Used as the negative acknowledgment of block and indicates
Transmission Protocol
Hexadecimal
Value
Function
data link by the sender.
or start sequence.
block or start sequence.
transmission and to release the data link.
that the receiver temporarily cannot receive data from the
sender.
Before a message can be sent, a start sequence (also called a selecting sequence)
must be sent to urge the receiver to receive the data. Every transmission sequence
will begin with the sender sending a start sequence.
The start sequence is a three byte sequence:
012
Figure 2-1 Start Sequence
NDA-30115 Revision 1.0 Page 5
Architecture Property Management System - Communication Interface
The messages (but not t he control code s or start seq uence) sent betw een the NEAX
and the PMS must have header and trailing sections as defined in the following
format:
01234 6 89
02H ‘1’ 03H xx‘!’ ...
STX SA UA EI FTC MSC FC Message ETX BCC
‘L’
Message Count Range
Block Check Code Range
Table 2-3 Base Message Format
The message format breaks down as follows:
• STX -- Start of text block. (One byte - 02H.)
• SA -- System Address. (O ne byte - ‘1’ [31H].)
• UA -- I/O Unit Address. (One byte - ‘!’ [21H].)
• EI -- Entry Index. (One byte - ‘L’ [4CH].)
• FTC -- Feature Code. (See below.) A list is provided in Appendix C, “Feature
Codes”.
• MSC -- Message Counter . This re presents the l ength of the message. The cou nt
of characters st arts at the FTC f ield an d ends at t he last ch aracter of the body o f
the message, not i ncluding the ETX. If t he ETX character doe s not immediatel y
follow the charac ter specified by the message counter, an invalid message is
assumed.
• FC -- Function Code. This sp ecifi es the indi vidua l operation a nd processing for
the feature designated by the Feature Code (FTC). A list is provided in
Appendix D, “Function Codes”.
• ETX -- End of text block. (One byte - 03H.)
• BCC -- Block Check Code. This is computed by an exclusive OR of the
message fr om 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.)
Feature Codes range in valu e fr om 00 to FF (hex). These codes define th e “Major
Category Codes” for service features.
Codes from 80 to FF are used as “Violation Codes”. When a specific message
received from the PMS can not be processed for some re aso n, 80 (hex) is added to
the received Feature Code so that it will be handled as a Violation Code. If the
NEAX regards a text as a Violation Code, the system data of the NEAX may be
assigned so that a tex t of this type is re turned to the PMS. There fore, when the PMS
has received a Violation Code, provisions shoul d be made for the PMS to print out
this violation.
Page 6 NDA-30115 Revision 1.0
Property Management System - Communication Interface Architecture
A Violation Code message will be sent to the PMS in the following cases:
• When the message counter does not match the number of characters received.
• When a station number not existing in the NEAX is specified in the message
data from the PMS.
• Upon rece ipt of an invalid Wake Up time (e.g. 25: 00).
Transmission Sequence
The sequence of transmit ting a message is slightly different for the PMS and
NEAX. However, both sequences follow the same outline.
The party which desires to send must first bid for sender rights. This is done by
sending the start sequence (see Figure 2- 1). On ce t he start sequence h as b een sent
and acknowledged, that party is now the “sender” and the other party is the
“receiver”. (Unless both parties have simultaneously sent a start sequence. If this
occurs, the PMS must relinquish sending rights to the NEAX.) The receiver must
then respond with an answer control code (ACK, NAK, DLE <, DLE :, DLE ?)
before the Sender Timer (see “Sender Timer” on page 10) expires.
If no answer control code is received, the sende r will resend the st art sequence and
again wait for an answer control code.
When an answer control code is received, the sender must respond before the
Receiver Timer (see “Receiver Timer” on page 10) expires. If the answ er control
code is an ACK, the sender must send the message. Again, the receiver must
respond with an answer control code before the Sender Timer expires.
To finish the transmission sequence (regardless of its success), the sender must
send an End Code (EOT) to release sending ri ght s. Once that is done, both parties
may begin the process over again by bidding for the sender rights.
In the trans mission sequence figures that follow, these m essage names are used:
Table 2-4 Message Names
Name Control Code Explanation
Start Sequence
Message
Query
End Code
Accept
Reject
No Answer
SA, UA, ENQ Bid for sender rights
STX, ..., ETX, BCC Actual message sent
ENQ Query for expected answer control code
EOT Release sender rights
ACK Positive acknowledgment
NAK Negative acknowledgment
<Nothing> Timer expired before an answer control
code was received
Contention
Interrupt
Abort
Pause
NDA-30115 Revision 1.0 Page 7
Start Sequence Simultaneous start sequences
DLE < Request to release sender rights
DLE : Demand to release sender rights
DLE ? Receiver’s queue full; please wait
Architecture Property Management System - Communication Interface
From the NEAX to the PMS
Send Receive ReceiveSend Send
Start
Sequence
Accept
Reject
No Answer
Contention
Interrupt
Abort
Pause
1
quit
quit
retry
retry
2
Message
Query
Accept
Reject
No Answer
Interrupt
Abort
Pause
Wait
1 second
retry
3
quit
4
retry
quit
retry
5
quit
End
Code
1 - Retry is 3 times; quit on 4th Reject.
2 - Retry is 15 times; quit on 16th No Answer.
3 - Retry is 3 times; quit on 4th Reject.
4 - Retry is 32 times; quit on 33rd No Answer.
5 - Retry is 3 times; quit on 4th Pause.
Figure 2-2 NEAX to PMS Protocol
Page 8 NDA-30115 Revision 1.0
Property Management System - Communication Interface Architecture
From the PMS to the NEAX
Send Receive ReceiveSend Send
Start
Sequence
Accept
Reject
No Answer
Contention
Interrupt
Pause
1
continue
2
quit
Message
Query
Accept
Reject
No Answer
Interrupt
Pause
Wait
1 second
retry
3
4
retry
quit
quit
Wait
1 second
End
1 - Do not respond. Immediately cease send attempt and
Code
receive message from NEAX.
2 - Ignore Interrupt and send message if 8 messages in queue.
3 - Retry is 3 times; quit on 4th Reject.
4 - Retry is 32 times; quit on 33rd No Answer.
Figure 2-3 PMS to NEAX protocol
NDA-30115 Revision 1.0 Page 9
Architecture Property Management System - Communication Interface
Timers
Cabling Considerations
The following timers are used to maintain data transmission:
Sender Timer
Upon sending a start sequence, message text or query, this timer begins counting
and stops counting upon rece iving a vali d answer contro l code. This timer is set to
one (1) second. If a ti meout occurs af ter the transmis sion of a start s equence, a start
sequence will be r esent up t o 1 5 time s. If a t imeout occurs duri ng the t ransmi ssion
of a message text or query, a query is sent up to 32 times.
Receiver Timer
Upon transmission of a positive acknowl edgment for a sta rt sequence or a messag e
text, this timer begins counting and stops counting upon receiving a message text
or an end code. This timer is se t to 35 seco nds. If a ti meout occurs, t he sender l oses
send rights.
When the PMS is connected to the NEAX through a modem, the cab les should just
be “straight through” cables. There should be no crossing.
When the PMS is directly connected to the NEAX, use the following pin
assignments:
NEAX PMS
Pin No. Signal Cable
1FG
2
3
4
5
6
7
8
20
SD
RD
RS
CS
DR
SG
CD
ER
Figure 2-4 Direct Connection Pin Assignments
Bisynchronous (BSC) Transmi ssion
Line Control Characteristics
The characteristic s of the signals t ransmitted across t he communications lin k are as
follows:
Signal Pin No.
FG
SD
RD
RS
CS
DR
SG
CD
ER
1
2
3
4
5
6
7
8
20
Page 10 NDA-30115 Revision 1.0
Property Management System - Communication Interface Architecture
Table 2-5 Line Control Characteristics
Item Conditions
Control Method Contention method (point to point)
Operating Mode Half duplex (if modems are used, set to full duplex)
Synchronization Synchronous
Data Rate 4800 or 9600 bits/second (bps)
Frame Contents EBCDIC
Error Control Method CRC-16 (X16 + X15 + X2 + 1)
Bit Transmission Order Priority is given to low order bits
Transmission Intervals At each data generation. When a stream of information is
transmitted to the NEAX continuously, an interval of 0.5
seconds or more should be given between messages. Each
message must be delimited by the EOT code.
Priority Sequence Primary office: NEAX
Secondary Office: PMS
Transfer Mode Non-transparent mode
Message Composition One message constitutes one record; SOH, ITB and ETB
are not used. Only the non-transparent mode is used.
Message Length Variable length, maximum of 128 characters (including
STX and ETX).
Electrical Interface RS-232C electrical standard interface
Signal Form RS-404
Interface Distance 50 feet
Word Framing 10 bits or 11 bits
NDA-30115 Revision 1.0 Page 11
Architecture Property Management System - Communication Interface
The control codes used for the message texts are:
Table 2-6 Control Codes
Control Code
Hexadecimal
Value
Function
SYN 32 Synchronization code.
STX 02 Indicates the start of a block.
ETX 03 Indicates the end of a block.
ENQ 2D Used as the start sequence code. It indicates a reception
request to the other side and a request to answer an information block just sent.
EOT 04 Indicates the end of transmission of a block or release of
the data link by the sender.
ACK0 10, 70 Used alternately, these indicate the positive acknowledgACK1 10, 61
ment of an information block or a start sequence.
NAK 3D Indicates the negative acknowledgment of an informa-
tion block or a start sequence.
WACK 10, 6B Used as the positive acknowledgment of an information
block or start sequence and indicates that the receiver
temporarily cannot receive data from the sender.
TTD 02, 2D Indicates that the sender cannot transmit the next infor-
mation block after the receipt of the answer to the previ-
ous information block sent from the receiver.
R VI 10, 7C Indicates the positive acknowledgment of an information
block and asks the sender for sending rights.
PAD-L 55 Indicates the absolute beginning of the entire informa-
tion block.
PAD-T FF Indicates the absolute ending of the entire information
block.
Page 12 NDA-30115 Revision 1.0
Property Management System - Communication Interface Architecture
Transmission Protocol
The messages sent between t he NEAX and the P MS must ha ve header and tra iling
sections as defined in the following format:
PAD-LSYN SYN SYN
Figure 2-5 Base Message Format
The elements of the message is as follows:
• PAD-L -- The leading pad character. (One byte - 55H.)
• SYN -- Synchronizatio n character . At least thr ee of these shoul d be transmitt ed.
(One byte each - 32H.)
02H 03H xx
STX Data ETX CRC PAD-T
FFH32H55H 32H 32H
Cyclic Redundancy Check Area
• STX -- Start of text block. (One byte - 02H.)
• Data -- The message data is describe below in Figure 2-6.
• ETX -- End of text block. (One byte - 03H.)
• CRC-- Cyclic Redundanc y Che ck. Thi s is compute d b y an e xclusive OR of the
message fr om 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.)
• PAD-T -- The trailing pad character. (One byte - FFH.)
The message data is defined as follow:
02H ‘1’ 03H‘!’ ...
STX SA UA EI FTC MSC FC Message ETX
‘L’
Message Count Range
Figure 2-6 Message Data Format
NDA-30115 Revision 1.0 Page 13
Architecture Property Management System - Communication Interface
The message format breaks down as follows:
• STX -- Start of text block. (One byte - 02H.)
• SA -- System Address. (O ne byte - ‘1’ [31H].)
• UA -- I/O Unit Address. (One byte - ‘!’ [21H].)
• EI -- Entry Index. (One byte - ‘L’ [4CH].)
• FTC -- Feature Code. (See below.) A list is provided in Appendix C, “Feature
Codes”.
• MSC -- Message Counter . This re presents the l ength of the message. The cou nt
of characters st arts at the FTC f ield an d ends at t he last ch aracter of the body o f
them message, not including the ETX. If the ETX character does not
immediately follow the character specified by the message counter, an invalid
message is assumed.
• FC -- Function Code. This sp ecifi es the indi vidua l operation a nd processing for
the feature designated by the Feature Code (FTC). A list is provided in
Appendix D, “Function Codes”.
• ETX -- End of text block. (One byte - 03H.)
Feature Codes range in valu e fr om 00 to FF (hex). These codes define th e “Major
Category Codes” for service features.
Codes from 80 to FF are used as “Violation Codes”. When a specific message
received from the PMS can not be processed for some re aso n, 80 (hex) is added to
the received Feature Code so that it will be handled as a Violation Code. If the
NEAX regards a text as a Violation Code, the system data of the NEAX may be
assigned so that a tex t of this type is re turned to the PMS. There fore, when the PMS
has received a Violation Code, provisions shoul d be made for the PMS to print out
this violation.
A Violation Code message will be sent to the PMS in the following cases:
• When the message counter does not match the number of characters received.
• When a station number not existing in the NEAX is specified in the message
data from the PMS.
• Upon rece ipt of an invalid Wake Up time (e.g. 25: 00).
Page 14 NDA-30115 Revision 1.0
Property Management System - Communication Interface Architecture
Transmission Sequence
Table 2-7 Data Transmission Sequence (1 of 2)
Status ENQ STX
Neutral (A) a: ACK0 ->
(B)
b: NAK ->
(A)
c: ENQ ->
(D)
Waiting for
STX (B)
(ACK last
received) ->
-> (C)
(B)
Waiting for
ETX, CRC
(C)
f: NAK ->
(B)
g: EOT ->
(A)
Waiting for
ACK after
start
sequence
f: ENQ ->
(D)
g: EOT ->
(A)
d: ENQ ->
(D)
e: EOT ->
(A)
(D)
ETX,
CRC
h: ACK0/1
i: NAK
c: RVI
j: EOT
-> (A)
d: ENQ ->
(D)
e: EOT ->
(A)
ACK0/
ACK1
Message ->
(E)
j: EOT ->
(A)
NAK
f: ENQ ->
(D)
g: EOT ->
(A)
Waiting for
ACK after
message (E)
NDA-30115 Revision 1.0 Page 15
d: ENQ ->
(D)
e: EOT ->
(A)
d: ENQ ->
(D)
e: EOT ->
(A)
d: ENQ ->
(D)
e: EOT ->
(A)
k: Message
-> (E)
l: EOT ->
(A)
m: Message -> (E)
j: EOT ->
(A)
Architecture Property Management System - Communication Interface
Table 2-8 Data Transmission Sequence (2 of 2)
Status EOT TTD WACK (Timeouts)
(Transmis-
sion Request)
Neutral (A) ENQ -> (D)
Waiting for
STX (B)
-> (A) d: NAK ->
(B)
EOT -> (A)
(25 sec)
e: EOT ->
(A)
Waiting for
ETX, CRC
-> (A) EOT -> (A)
(25 sec)
(C)
Waiting for
ACK after
start
sequence
-> (A) d: ENQ ->
(D)
e: EOT ->
(A)
d: ENQ ->
(D)
e: EOT ->
(A)
f: ENQ ->
(D)
g: EOT ->
(A)
(D)
Waiting for
ACK after
message (E)
-> (A) d: ENQ ->
(D)
e: EOT ->
(A)
d: ENQ ->
(D)
e: EOT ->
(A)
f: ENQ ->
(D)
g: EOT ->
(A)
(3 sec)
Notes:
• a: Preparation for reception complete.
• b: Reception impossible.
• c: Requests for preparation for reception (the PMS should not request this).
• d: Transmitted up to 21 times.
• e: Aborted at 22nd time.
• f: Transmitted up to 7 times.
• g: Aborted on the 8th time.
• h: Message is received normally and preparation for ne xt rece ption is complete.
• i: Error found in message.
• j: Interruption.
• k: Information to be transmitted is present.
• l: Information to be transmitted is absent.
• m: Retransmission of message.
Page 16 NDA-30115 Revision 1.0
Property Management System - Communication Interface Architecture
Timers and Counters
Retransmission Counts
Table 2-9 Retransmission Counts
Meaning Count
The number of retransmissions of the start sequence when there is no
answer after transmitting the start sequence.
The number of retransmissions of the start sequence when NAK is
received after transmitting the start sequence.
The number of transmitting ENQs when WACK is received after the
transmission of an information block
The number of transmitting ENQs when there is no answer after the
transmission of an information block. (3 second intervals)
Timer Values
Table 2-10 Timer Values
Party Starting Condition
7
7
15
7
Timer value
(seconds)
NEAX Waiting for a start sequence answer. 1
Waiting for STX after transmitting the start sequence ACK. 20
Waiting for data reception complete (waiting for ETX, CRC). 20
Waiting for an answer after the transmission of a message. 1
PMS Waiting for a start sequence answer. 3
Waiting for STX after transmitting the start sequence ACK. 25
Waiting for data reception complete (waiting for ETX, CRC). 25
Waiting for an answer after the transmission of a message. 3
NDA-30115 Revision 1.0 Page 17
Architecture Property Management System - Communication Interface
Cabling Considerations
When the PMS is connected to the NEAX through a modem, the cab les should just
be “straight through” cables. There should be no crossing.
When the PMS is directly connected to the NEAX, use the following pin
assignments:
NEAX PMS
Pin No. Signal Cable
Signal Pin No.
1FG
2
3
4
5
6
7
8
15
17
SD
RD
RS
CS
DR
SG
CD
ST
RT
2
FG
SD
RD
RS
CS
DR
SG
CD
ST
RT
1
2
3
4
5
6
7
8
2
15
17
20
24
ER
ST
1
Figure 2-7 Direct Connection Pin Assignments
ER
ST
20
1
24
Page 18 NDA-30115 Revision 1.0
Property Management System - Communication Interface Message Descriptions
Chapter 3 Message Descriptions
There are several message groups:
• Data Link Maintenance Messages
• Maid Status
• Message Waiting Lamp Control
• Restriction Control
• Check In/Check Out (Model 60)
• Check In/Check Out (Model 90)
• Wake Up/Group Announcement
• Room Move/Swap/Copy (Model 60)
• Room Data Change
• Extension Report
• Room Recovery (Model 60)
• Room Recovery (Model 90)
• Direct Data Entry (Model 90)
• Extension Connection
Each message group will be described briefly in the following sections.
The NEAX equates rooms wit h extensions, one e xtension per ro om. The exception
to this is the suite room feature. When this feature is activated in the NEAX, a
primary extension represents a group of extensions in one or more rooms. For a
suite room, the PMS should reference only the primary extension in its messages
to the NEAX. All associated extensions will inherit the attributes of the primary
extension and should effectively be ignored by the PMS.
Data Link Maintenance
These are the messages used by the PMS and NEAX to maintain communication.
The PMS must regularly send Nop Test messages with an interval of no more than
60 seconds, and no less than 50 0 milliseconds, between each message . The NEAX
will immediately respond with either a Nop Test Normal Answer, under normal
conditions, or a Nop Test Recover Answer, i f a database reco very for the NEAX i s
needed.
• Nop T es t Normal An swer -- Whene v er a Nop Test message is sent by th e PMS,
the NEAX responds by sending this message, unless the NEAX has just
finished an error recovery.
• Nop Test Recover Answer -- If the NEAX has been performing an error
recovery , this message is sent in response to the Nop T est in the place of the Nop
Test Normal Answer message.
NDA-30115 Revision 1.0 Page 19
Message Descriptions Property Management System - Communication Interface
• Recovery Start Report -- After r eceiving the Nop Test Recover Answer
message, the PMS must download NEAX database informat ion (see “Room
Recovery (Model 60)” on page 27 and “Room Recovery (Model 90)” on page
28). This message notifies the NEAX of the incoming download.
• Recovery End Report -- Repo rts to the NEAX that the PMS database do wnload
is complete.
• Data Link Release Request -- Used by either system to request a temporary
release of the data link.
• Data Link Release Conf irmation -- Reply to t he above message to ackno wledge
data link release request.
• Extension Number Request - - Used by the PMS to request the current status of
extension numbers.
• Nop Test -- Under the standard protocol the PMS must send this message at
least every 60 seconds, but not less than 500 milliseconds, to demonstrate that
communication has been maintained.
Data Link Failure
Either system may recognize a loss of communication by one or more of the
following events:
• Lack of system traffic for a 60 second interval: the Nop Test message from the
PMS and the Nop Test Answer message (either Normal or Recover) from the
NEAX insure that at least one message should be received less than every 60
seconds.
• Detection of hardware problems within the physical data. Note that the NEAX
will put EIA pin number 6 (Data Set Ready) into the off state, indicating data
set not ready, when the data link has been effectively turned off in the NEAX,
either for maintenance or because of repeated, excessive errors.
• Excessive protocol errors (NAK’ed transmission, ENQ’s with no ACK/ NAK
response).
• Other conditions, su ch as una v ailab ility of buf f ers or queui ng capabil ity, which
result in an implied status change message which cannot be communicated to
the other system.
• Release of the data link requested and confirmed.
A data link failure will necessitate a database room exchange recovery procedure
only if any impl ied stat us change cannot b e communicat ed to t he other system and
cannot be queued for later transmission. If no messages have been lost, and can
instead be retransmitted, no database recovery is necessary.
Page 20 NDA-30115 Revision 1.0
Loading...