NEC NDA-30115-001 manual NDA-30115 Revision

Page 24

Architecture

Property Management System - Communication Interface

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. (See below.) A list is provided in Appendix C, “Feature Codes”.

•MSC -- Message Counter. This represents the length of the message. The count of characters starts at the FTC field and ends at the last character of the body of 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 specifies the individual operation and 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 value from 00 to FF (hex). These codes define the “Major

Category Codes” for service features.

Codes from 80 to FF are used as “Violation Codes”. When a specific message received from the PMS cannot be processed for some reason, 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 text of this type is returned to the PMS. Therefore, when the PMS has received a Violation Code, provisions should 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 receipt of an invalid Wake Up time (e.g. 25:00).

Page 14

NDA-30115 Revision 1.0

Image 24

Contents Property Management System NEC America, IncLiability 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 Characteristics Asynchronous TransmissionLine Control Transmission Protocol ‘1’ ‘!’ 05H02H ‘1’ ‘!’ ‘L’ 03H Message Count Range Block Check Code RangeTransmission Sequence From the Neax to the PMS SequenceFrom the PMS to the Neax Timers Sender TimerCabling Considerations Receiver Timer Bisynchronous BSC TransmissionEbcdic SYN STXETX ACK0Transmission ProtocolNDA-30115 Revision Neutral a ACK0 NAK ENQ Waiting for ACK last STX BReceived Waiting for NAK ACK0/1 ETX, CRCNeutral a ENQ D Waiting for NAK EOT a 25 sec EOT Waiting for EOT aTimers Retransmission Counts Counters Timer ValuesPin No Signal Cable 20 ER 24 ST1 Cabling ConsiderationsST2 ST1 Data Link Maintenance Message DescriptionsNDA-30115 Revision NDA-30115 Revision Maid Status Message Waiting Lamp Control Restriction ControlCheck In/Check Out Model Check In/Check Out Model Wake Up/Group Announcement Room Move/Swap/Copy ModelRoom Data Change Extension ReportRoom Recovery Model Direct Data Entry Model Extension Connection This Page Left Blank Message Formats Data Link Maintenance 02H ‘1’ ‘!’ ‘L’ ‘7’ ‘0’ ‘0’ ‘7’ Blank 03H Multiple Function Codes use this message. See belowCleaning 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ Extension Maid 03HGuest Room 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘1’ ‘2’ ‘3’ Extension MaidLEN Room Status Cleaning 03H Room Answer02H ‘1’ ‘!’ ‘L’ ‘5’ ‘1’ ‘2’ ‘0’ Extension RequestAdministration 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘2’ ‘2’ ‘3’ Extension MaidMWL Control 02H ‘1’ ‘!’ ‘L’ ‘3’ ‘1’ ‘1’ Extension 03HMWL Status 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘3’ ‘1’ ‘5’ ‘1’ Extension StatusOption VMC02H ‘1’ ‘!’ ‘L’ ‘1’ ‘5’ ‘1’ ‘4’ Extension Code Blank 03HCheck 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘6’ ‘1’ ‘1’ Extension 03HCheck Out 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘6’ ‘1’ ‘1’ ‘2’ Extension 03HCheck Out Message Report VIP 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘6’ ‘3’ ‘4’ ‘B’ Extension Group ID Language Stay Display Name 03HCheck Out Outgoing Call Report 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘6’ ‘1’ ‘1’ ‘C’ Extension 03HCheck Out Message Waiting Report 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘6’ ‘1’ ‘3’ ‘D’ Extension StatusCleaning Status Key Language Display Name Data a Data B 03HNDA-30115 Revision Cleaning Status Key 03H 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ ‘4’ ‘2’ Extension Room StatusCheck Cancellation Check Out CancellationRoom Status Cleaning Key 03H 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ ‘1’ ‘4’ Extension 03HKey New Extension Room Status Cleaning Status 03H Room ChangeProvisional Check 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ ‘1’ ‘7’ Extension 03HProvisional Check Out 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ ‘1’ ‘8’ Extension 03H02H ‘1’ ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ ‘5’ ‘9’ Extension Status Wake Up Setting Neax 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘1’ Extension TimeSource 03H Wake Up Cancellation Neax 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘2’ Extension BlankWake Up Execution Result 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘3’ Extension TimeResult 03H Wake Up Setting PMS 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘4’ Extension TimeWake Up Cancellation PMS 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘5’ Extension BlankGroup Announcement Setting Neax 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘7’ ‘6’ Group ID TimeSource Type 03H Group Announcement Cancellation Neax 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘7’ Group ID BlankGroup Announcement Execution Result 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘2’ ‘3’ ‘8’ Extension Group IDTime Result Type 03H Group Announcement Setting PMS 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘7’ ‘9’ Group ID TimeGroup Announcement Cancellation PMS 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘A’ Group ID BlankMessage fields are 35 Room Move/Swap/CopyRoom Data Change 02H ‘1’ ‘!’ ‘L’ ‘2’ ‘1’ ‘1’ ‘3’ ‘1’ Extension LanguageGroup Formation 02H ‘1’ ‘!’ ‘L’ ‘2’ ‘1’ ‘1’ ‘7’ Extension Group ID 03HGroup Cancellation Reservation SettingReservation Cancellation Guest Name Change 41 Guest Name ChangeNDA-30115 Revision Cleaning Status 03H Room Status Change02H ‘1’ ‘!’ ‘L’ ‘6’ ‘1’ ‘1’ ‘3’ ‘3’ Extension Room Status Room Key Status Change 02H ‘1’ ‘!’ ‘L’ ‘6’ ‘1’ ‘1’ ‘2’ ‘4’ Extension Key 03HExtension Delete Report 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ ‘1’ ‘3’ ‘E’ Extension Blank 03HExtension Assignment Report 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ ‘1’ ‘3’ ‘F’ Extension DefClass 03H Room Recovery Model Room Image Set 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ ‘2’ ‘8’ Extension VacancyStatus Code Blank 03H 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ ‘2’ ‘3’ Extension Vacancy Status 48 Room Image SetVIP 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ ‘3’ ‘8’ Extension Vacancy 49 Room Image SetVIP Room Data Report 50 Room Data ReportNDA-30115 Revision Connecting Room Guest Room Secretary Telephone02H ‘1’ ‘!’ ‘L’ ‘5’ ‘7’ ‘1’ ‘7’ ‘3’ Boss Secty 03H 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘7’ ‘1’ ‘7’ ‘4’ Master Secondary 03HMessage Status Report 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘7’ ‘1’ ‘5’ ‘5’ Extension StatusWake Up 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘7’ ‘1’ ‘6’ ‘6’ Extension TimeDirect Data Entry 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘9’ ‘4’ ‘7’ ‘1’ Extension Numeric InputDirect Data Entry Answer 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘9’ ‘1’ ‘7’ Extension02H ‘1’ ‘!’ ‘L’ ‘6’ ‘2’ ‘1’ ‘7’ Boss Secty 03H 57 Guest Room Secretary TelephoneConnecting Room Set Connecting Room Cancel02H ‘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 Chapter Glossary BCCGlossary Property Management System Communication Interface Appendix a Room Status Updating Room Status Information in the Neax Clearing Room DataDial Steps for Maid Status Room Status and Cleaning Status Room Data Setting and Clearing in the NeaxStatus of Check Out A-4 NDA-30115 Revision Appendix B PMS Line Failure Printouts Normal TextAbnormal Events Abnormal PortLine SUP. Timeout PKG not ReadyDR OFF/TX not RDY Sinq STOP/S-120Figure B-6 I/O Port Status Transmission Failure FC of message Message Data Current TimeB-6 NDA-30115 Revision Appendix C Feature Codes Data Link MaintenanceC-2 NDA-30115 Revision Appendix D Function Codes Neax ALLPMS ALL PMS/NEAX ALLCheck In Cancellation Check Out CancellationRoom Image Set 1 Recovery Request Room Image Set 1 Recovery AnswerRoom Image Set 3 Recovery Request Room Image Set 3 Recovery AnswerRecovery Room Data Report Recovery Secretary TelephoneConnecting Room Set Connecting Room CancelDirect Data Entry Positive Answer Guest Room Secretary Telephone