NEC NDA-30115-001 manual Message Descriptions, Data Link Maintenance

Page 29

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 with extensions, one extension per room. 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 500 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, if a database recovery for the NEAX is needed.

Nop Test Normal Answer -- Whenever a Nop Test message is sent by the 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 Test in the place of the Nop Test Normal Answer message.

NDA-30115 Revision 1.0

Page 19

Image 29
Contents NEC America, Inc Property Management SystemLiability Disclaimer Table of Contents NDA-30115 Revision Contents Contents List of Figures FIGURESProperty Management System Communication Interface Tables Title Chapter Overview This Page Left Blank Chapter Architecture Line Control CharacteristicsAsynchronous Transmission ‘1’ ‘!’ 05H Transmission ProtocolMessage Count Range Block Check Code Range 02H ‘1’ ‘!’ ‘L’ 03HTransmission Sequence Sequence From the Neax to the PMSFrom the PMS to the Neax Sender Timer TimersCabling Considerations Receiver Timer Bisynchronous BSC TransmissionEbcdic STX SYNETX ACK0Protocol TransmissionNDA-30115 Revision STX B Neutral a ACK0 NAK ENQ Waiting for ACK lastReceived Waiting for NAK ACK0/1 ETX, CRC25 sec EOT Waiting for EOT a Neutral a ENQ D Waiting for NAK EOT aTimer Values Timers Retransmission Counts CountersST2 ST1 Pin No Signal Cable 20 ER 24 ST1Cabling Considerations Message Descriptions Data Link MaintenanceNDA-30115 Revision NDA-30115 Revision Maid Status Check In/Check Out Model Message Waiting Lamp ControlRestriction Control Check In/Check Out Model Room Move/Swap/Copy Model Wake Up/Group AnnouncementExtension Report Room Data ChangeRoom Recovery Model Direct Data Entry Model Extension Connection This Page Left Blank Message Formats Data Link Maintenance Multiple Function Codes use this message. See below 02H ‘1’ ‘!’ ‘L’ ‘7’ ‘0’ ‘0’ ‘7’ Blank 03H02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ Extension Maid 03H CleaningLEN Guest Room02H ‘1’ ‘!’ ‘L’ ‘5’ ‘1’ ‘2’ ‘3’ Extension Maid Room Answer Room Status Cleaning 03H02H ‘1’ ‘!’ ‘L’ ‘5’ ‘1’ ‘2’ ‘0’ Extension Request02H ‘1’ ‘!’ ‘L’ ‘5’ ‘2’ ‘2’ ‘3’ Extension Maid Administration02H ‘1’ ‘!’ ‘L’ ‘3’ ‘1’ ‘1’ Extension 03H MWL Control02H ‘1’ ‘!’ ‘L’ ‘5’ ‘3’ ‘1’ ‘5’ ‘1’ Extension Status MWL StatusOption VMCBlank 03H 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘5’ ‘1’ ‘4’ Extension Code02H ‘1’ ‘!’ ‘L’ ‘1’ ‘6’ ‘1’ ‘1’ Extension 03H CheckCheck Out Message Report Check Out02H ‘1’ ‘!’ ‘L’ ‘1’ ‘6’ ‘1’ ‘1’ ‘2’ Extension 03H VIP Language Stay Display Name 03H 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘6’ ‘3’ ‘4’ ‘B’ Extension Group ID02H ‘1’ ‘!’ ‘L’ ‘1’ ‘6’ ‘1’ ‘1’ ‘C’ Extension 03H Check Out Outgoing Call ReportCheck Out Message Waiting Report 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘6’ ‘1’ ‘3’ ‘D’ Extension StatusLanguage Display Name Data a Data B 03H Cleaning Status KeyNDA-30115 Revision 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ ‘4’ ‘2’ Extension Room Status Cleaning Status Key 03HCheck Out Cancellation Check CancellationRoom Status Cleaning Key 03H 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ ‘1’ ‘4’ Extension 03HRoom Change Key New Extension Room Status Cleaning Status 03H02H ‘1’ ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ ‘1’ ‘7’ Extension 03H Provisional Check02H ‘1’ ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ ‘5’ ‘9’ Extension Status Provisional Check Out02H ‘1’ ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ ‘1’ ‘8’ Extension 03H Source 03H Wake Up Setting Neax02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘1’ Extension Time 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘2’ Extension Blank Wake Up Cancellation NeaxResult 03H Wake Up Execution Result02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘3’ Extension Time 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘4’ Extension Time Wake Up Setting PMS02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘5’ Extension Blank Wake Up Cancellation PMSSource Type 03H Group Announcement Setting Neax02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘7’ ‘6’ Group ID Time 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘7’ Group ID Blank Group Announcement Cancellation NeaxTime Result Type 03H Group Announcement Execution Result02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘2’ ‘3’ ‘8’ Extension Group ID 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘7’ ‘9’ Group ID Time Group Announcement Setting PMS02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘A’ Group ID Blank Group Announcement Cancellation PMS35 Room Move/Swap/Copy Message fields are02H ‘1’ ‘!’ ‘L’ ‘2’ ‘1’ ‘1’ ‘3’ ‘1’ Extension Language Room Data Change02H ‘1’ ‘!’ ‘L’ ‘2’ ‘1’ ‘1’ ‘7’ Extension Group ID 03H Group FormationReservation Cancellation Group CancellationReservation Setting 41 Guest Name Change Guest Name ChangeNDA-30115 Revision 02H ‘1’ ‘!’ ‘L’ ‘6’ ‘1’ ‘1’ ‘3’ ‘3’ Extension Room Status Cleaning Status 03HRoom Status Change 02H ‘1’ ‘!’ ‘L’ ‘6’ ‘1’ ‘1’ ‘2’ ‘4’ Extension Key 03H Room Key Status ChangeExtension Delete Report 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ ‘1’ ‘3’ ‘E’ Extension Blank 03HClass 03H Extension Assignment Report02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ ‘1’ ‘3’ ‘F’ Extension Def Room Recovery Model Status Code Blank 03H Room Image Set02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ ‘2’ ‘8’ Extension Vacancy 48 Room Image Set 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ ‘2’ ‘3’ Extension Vacancy StatusVIP 49 Room Image Set 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ ‘3’ ‘8’ Extension VacancyVIP 50 Room Data Report Room Data ReportNDA-30115 Revision Guest Room Secretary Telephone Connecting Room02H ‘1’ ‘!’ ‘L’ ‘5’ ‘7’ ‘1’ ‘7’ ‘3’ Boss Secty 03H 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘7’ ‘1’ ‘7’ ‘4’ Master Secondary 03H02H ‘1’ ‘!’ ‘L’ ‘5’ ‘7’ ‘1’ ‘5’ ‘5’ Extension Status Message Status Report02H ‘1’ ‘!’ ‘L’ ‘5’ ‘7’ ‘1’ ‘6’ ‘6’ Extension Time Wake Up02H ‘1’ ‘!’ ‘L’ ‘5’ ‘9’ ‘4’ ‘7’ ‘1’ Extension Numeric Input Direct Data EntryDirect Data Entry Answer 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘9’ ‘1’ ‘7’ Extension57 Guest Room Secretary Telephone 02H ‘1’ ‘!’ ‘L’ ‘6’ ‘2’ ‘1’ ‘7’ Boss Secty 03HConnecting Room Cancel Connecting Room Set02H ‘1’ ‘!’ ‘L’ ‘6’ ‘2’ ‘1’ ‘7’ ‘3’ Master Secondary 03H 02H ‘1’ ‘!’ ‘L’ ‘6’ ‘2’ ‘1’ ‘1’ ‘4’ Master 03HThis Page Left Blank Chapter References This Page Left Blank BCC Chapter GlossaryGlossary Property Management System Communication Interface Appendix a Room Status Dial Steps for Maid Status Updating Room Status Information in the NeaxClearing Room Data Status of Check Out Room Status and Cleaning StatusRoom Data Setting and Clearing in the Neax A-4 NDA-30115 Revision Normal Text Appendix B PMS Line Failure PrintoutsAbnormal Port Abnormal EventsPKG not Ready Line SUP. TimeoutDR OFF/TX not RDY Sinq STOP/S-120Figure B-6 I/O Port Status FC of message Message Data Current Time Transmission FailureB-6 NDA-30115 Revision Data Link Maintenance Appendix C Feature CodesC-2 NDA-30115 Revision Neax ALL Appendix D Function CodesPMS ALL PMS/NEAX ALLCheck Out Cancellation Check In CancellationRoom Image Set 1 Recovery Request Room Image Set 1 Recovery AnswerRoom Image Set 3 Recovery Answer Room Image Set 3 Recovery RequestRecovery Room Data Report Recovery Secretary TelephoneConnecting Room Cancel Connecting Room SetDirect Data Entry Positive Answer Guest Room Secretary Telephone