NEC NDA-30115-001 User manual

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.

NEC America, Inc.

NDA-30115Revision 1.0 Page i

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) Transmission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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

Page ii NDA-30115 Revision 1.0

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

NDA-30115Revision 1.0 Page iii

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

Page iv NDA-30115 Revision 1.0

CONTENTS Property Management System Communication Interface

Page

NDA-30115 Revision 1.0 Page v

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 Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

2-6 Message Data Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

2-7 Direct Connection Pin Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

4-1 Base Message 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 Cancellation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

4-20 Check Out Cancellation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

4-21 Room Change. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

4-22 Provisional Check In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

4-23 Provisional 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 Announcement Setting (PMS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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

Page vi NDA-30115 Revision 1.0

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 Delete Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

4-46 Extension Assignment 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 Status Scan Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B4

B-9 Transmission Failure Printout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B5

NDA-30115 Revision 1.0 Page vii

Property Management System Communication Interface TABLES

Table Title Page

2-1 Line Control Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2-2 Control Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2-3 Base Message 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

Page viii NDA-30115 Revision 1.0

TABLES Property Management System Communication Interface

Table Title Page

NDA-30115 Revision 1.0 Page 1

Property Management System - Communication Interface Overview

Chapter 1 Overview

This document is a description of the interface between the NEC NEAX2400 IMS

(hereafter referred to as the NEAX) and the hotel’s Property Management System

(PMS). This document contains almost all (see below) of the information specified

in the NEAX2400 IMS Hotel System PMS Interface Specifications (document 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 described in the Architecture section. The descriptions of the messages

transmitted are in the Descriptions section. The formats of the messages are 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 messages 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.

Page 2 NDA-30115 Revision 1.0

Overview Property Management System - Communication Interface

This Page Left Blank.

NDA-30115 Revision 1.0 Page 3

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 data links between 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 Interactive

messages.

Hotel Processing messages, such as Check In, Check Out and Message

Waiting Lamp control, have less severe 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.

Page 4 NDA-30115 Revision 1.0

Architecture Property Management System - Communication Interface

Asynchronous Transmission

Line Control

Characteristics

The characteristics of the signals transmitted across the communications link are as

follows:

Table 2-1 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 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

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

Stop bit 1 bit or 2 bits

Error Control VRC: Even, odd or no parity.

LRC: (BCC) Exclusive OR of the message text, starting 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 Variable length, maximum of 128 characters (including 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 and 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)

NDA-30115 Revision 1.0 Page 5

Property Management System - Communication Interface Architecture

The control codes used for the message texts are:

Transmission

Protocol

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:

Figure 2-1 Start Sequence

Table 2-2 Control Codes

Control Code

Hexadecimal

Value

Function

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

data link by the sender.

ENQ 05 Used to query other party for expected response.

ACK 06 Indicates the positive acknowledgment of an information block

or start sequence.

NAK 15 Indicates the negative acknowledgment of an information

block or start sequence.

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

transmission and to release the data link.

DLE ? 10, 3F Used as the negative acknowledgment of block and indicates

that the receiver temporarily cannot receive data from the

sender.

05H

‘1’

‘!’

012

SA

UA

ENQ

Page 6 NDA-30115 Revision 1.0

Architecture Property Management System - Communication Interface

The messages (but not the control codes or start sequence) sent between the NEAX

and the PMS must have header and trailing sections as defined in the following

format:

Table 2-3 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. (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

the 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.)

• 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.)

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.

Block Check Code Range

02H ‘1’ 03H xx‘!’ ...

01234 6 89

STX SA UA EI FTC MSC FC Message ETX BCC

Message Count Range

‘L’

NDA-30115 Revision 1.0 Page 7

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 receipt of an invalid Wake Up time (e.g. 25:00).

Transmission

Sequence

The sequence of transmitting 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). Once the start sequence has been 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 sender will resend the start 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 answer 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 rights. Once that is done, both parties

may begin the process over again by bidding for the sender rights.

In the transmission sequence figures that follow, these message names are used:

Table 2-4 Message Names

Name Control Code Explanation

Start Sequence

SA, UA, ENQ Bid for sender rights

Message

STX, ..., ETX, BCC Actual message sent

Query

ENQ Query for expected answer control code

End Code

EOT Release sender rights

Accept

ACK Positive acknowledgment

Reject

NAK Negative acknowledgment

No Answer

<Nothing> Timer expired before an answer control

code was received

Contention

Start Sequence Simultaneous start sequences

Interrupt

DLE < Request to release sender rights

Abort

DLE : Demand to release sender rights

Pause

DLE ? Receiver’s queue full; please wait

Page 8 NDA-30115 Revision 1.0

Architecture Property Management System - Communication Interface

From the NEAX to the PMS

Figure 2-2 NEAX to PMS Protocol

Start

Sequence

Accept

Reject

No Answer

Contention

Interrupt

Abort

Pause

Message

Accept

Reject

No Answer

Interrupt

Abort

Pause

End

Code

Wait

1 second

Send Receive ReceiveSend Send

retry

quit

retry

quit

1

2

3

4

5

Query

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.

NDA-30115 Revision 1.0 Page 9

Property Management System - Communication Interface Architecture

From the PMS to the NEAX

Figure 2-3 PMS to NEAX protocol

Start

Sequence

Accept

Reject

Contention

Interrupt

Pause

Message

Accept

Reject

No Answer

Interrupt

Pause

End

Code

Wait

1 second

Send Receive ReceiveSend Send

retry

quit

Query

Wait

1 second

No Answer

quit

retry

continue

quit

1

2

3

4

1 - Do not respond. Immediately cease send attempt and

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.

receive message from NEAX.

Page 10 NDA-30115 Revision 1.0

Architecture Property Management System - Communication Interface

Timers

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 receiving a valid answer control code. This timer is set to

one (1) second. If a timeout occurs after the transmission of a start sequence, a start

sequence will be resent up to 15 times. If a timeout occurs during the transmission

of a message text or query, a query is sent up to 32 times.

Receiver Timer

Upon transmission of a positive acknowledgment for a start sequence or a message

text, this timer begins counting and stops counting upon receiving a message text

or an end code. This timer is set to 35 seconds. If a timeout occurs, the sender loses

send rights.

Cabling

Considerations

When the PMS is connected to the NEAX through a modem, the cables 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:

Figure 2-4 Direct Connection Pin Assignments

Bisynchronous (BSC) Transmission

Line Control

Characteristics

The characteristics of the signals transmitted across the communications link are as

follows:

1FG

SD

RD

RS

CS

DR

SG

CD

ER

2

3

4

5

6

7

8

20

FG

SD

RD

RS

CS

DR

SG

CD

ER

1

2

3

4

5

6

7

8

20

Pin No. Signal Cable

Signal Pin No.

NEAX PMS

Page is loading ...

NEC NDA-30115-001 User manual

Related papers

Other documents