Escolar Documentos
Profissional Documentos
Cultura Documentos
BMS Gateway
APPLICATION HANDBOOK
Table of Contents
INTRODUCTION.............................................................................................................................................. 3
GENERAL ........................................................................................................................................................... 3
COMPATIBILITY ................................................................................................................................................... 3
TERMS AND ABBREVIATIONS ................................................................................................................................ 3
REFERENCES ..................................................................................................................................................... 3
FUNCTIONAL DESCRIPTION......................................................................................................................... 4
INTRODUCTION ................................................................................................................................................... 4
BMS PROTOCOL ................................................................................................................................................ 5
BMS RS232 PROTOCOL IMPLEMENTATION ........................................................................................................... 7
BMS TCP PROTOCOL IMPLEMENTATION .............................................................................................................. 8
BMS MESSAGE DEFINITION ....................................................................................................................... 10
MESSAGE FIELD STRUCTURE ............................................................................................................................. 10
BMS CONTROL MESSAGES ............................................................................................................................... 11
Connection Request ................................................................................................................................... 11
Alive Check ................................................................................................................................................ 11
Disconnect ................................................................................................................................................. 11
Bad Message ............................................................................................................................................. 12
Not Allowed Message................................................................................................................................. 12
BMS STATUS MESSAGES .................................................................................................................................. 13
General Status ........................................................................................................................................... 13
Elevator Status........................................................................................................................................... 14
Escalator Status ......................................................................................................................................... 22
Free Input Status........................................................................................................................................ 23
BMS EVENT MESSAGES ................................................................................................................................... 24
General Events .......................................................................................................................................... 24
Elevator Events .......................................................................................................................................... 25
Escalator Events ........................................................................................................................................ 37
Free Input Events ....................................................................................................................................... 39
BMS COMMAND MESSAGES .............................................................................................................................. 40
General Commands ................................................................................................................................... 40
Elevator Commands ................................................................................................................................... 41
Escalator Commands ................................................................................................................................. 47
Free Input Commands................................................................................................................................ 48
CONFIGURATION ......................................................................................................................................... 49
BMS_GW.CFG HARDWARE CONFIGURATION FILE .............................................................................................. 49
BMS GATEWAY TRACE FACILITY........................................................................................................................ 50
„C“ HEADERFILE REFERENCES................................................................................................................. 51
FEATURE NAMES, ABBREVIATIONS AND TYPES AS DEFINED IN LICDEF.H................................................................. 51
Elevator group features .............................................................................................................................. 51
Elevator Features ....................................................................................................................................... 52
Escalator Features ..................................................................................................................................... 53
TCP/IP INSTALLATION AND CONFIGURATION ......................................................................................... 54
TCP/IP INSTALLATION AS PART OF THE OS/2 W ARP CONNECT INSTALLATION ........................................................ 54
CHANGING THE IP ADDRESS .............................................................................................................................. 56
Introduction
General
This document describes the design of the BMS Gateway Interface for LobbyVision. It shows the
functionality and the protocols.
The BMS Gateway is a piece of software on the LobbyVision computer, which controls the
appropriate HW communication channels (RS232 and / or Ethernet).
Connecting BMS systems to the BMS Gateway enables them to receive state and event information
from the installation through LobbyVision. Furthermore, BMS systems may send state change
requests to the installation through LobbyVision.
Additionally, the design of a special BMS system called BMS Lobby Client is described within this
document. The BMS Gateway together with this BMS Lobby Client allow multiple LobbyVisions to be
connected to one installation.
Compatibility
This document is valid for all LobbyVision with version greater than 4.03.00.
References
[1] TCP/IP Programmer’s Reference Manual of the OS/2 Operating System
[2] Internetworking With TCP/IP Volume I, by Douglas E. Comer, ISBN 0-13-216987-8
Functional Description
Introduction
To connect BMS systems and/or Lobby Clients to the BMS Gateway, RS232 or Ethernet transparent
channels are required. Multiple BMS systems may connect to the BMS Gateway through one
Ethernet channel at the same time. To connect BMS systems through RS232 to the BMS Gateway,
each connection requires it’s own RS232 channel.
Figure 1: Overview
BMS Protocol
The basic functionality of the BMS protocol does not depend on the underlying channels.
BMS Gateway (Server) responses to BMS System (Client) actions:
Following are the state / event diagrams for the BMS-Gateway (server) and the BMS-System
(client).
The BMS-MessageType field divides the BMS messages into the following types.
BMSMessageType Comment
BMS_CONTROL_MSG communication control messages
BMS_GET_MSG status get messages (client --> server)
BMS_RESPONSE_MSG status messages (server --> client)
BMS_REQUEST_MSG event request messages (client --> server)
BMS_EVENT_MSG event messages (server --> client)
BMS_COMMAND_MSG command messages (client --> server)
The DataLen field holds a value in the range 1..80, which specifies the number of bytes within the
Data field.
The Data field consists of 1 to 80 consecutive bytes of data as specified in DataLen. The structure
depends on the BMSMessageType. For details see chapter 4.
The not-BMSMessageType field holds the 1’s complement of the BMSMessageType field.
The not-DataLen field holds the 1’s complement of the DataLen field.
The DataChecksum field holds the 2’s complement checksum of the Data Field.
Following are the state/event diagrams for the RS232 transmitter and receiver.
Protocol restrictions:
• Software encoded line parameters (8 databits, 1 stopbit, nonparity).
• No data flow control support.
• Illegal messages will not be processed (unknown BMSMessageType, illegal DataLen, bad
DataChecksum).
They only are shown within the Rx trace window.
The socket interface is used to access the TCP layer. A socket must be created for the PF_INET
domain and its type must be SOCK_STREAM. For more details about the socket interface see the
TCP/IP Programmer’s Reference manual of the OS/2 operating system [3].
Following are the state / event diagrams to handle a single TCP connection between the server
(BMS-Gateway) and a client (BMS-System).
The networking part of the operating system must be installed and operational to get access to the
TCP/IP services. For details see chapter 8.
The BMS TCP Protocol transmitter and receiver itself are equal for the BMS Gateway and the BMS
Systems.
The following are the state/event diagrams for the TCP transmitter and receiver.
Protocol restrictions:
• No data flow control support.
• No OutOfBand message support.
• Illegal messages will not be processed (unknown BMSMessageType, illegal DataLen, bad
DataChecksum).
They only are shown within the Rx trace window.
Connection Request
This message is sent by a BMS system to connect to the BMS Gateway.
Message Field Content Description
BMSMessageType BMS_CONTROL_MSG Connection control message
BMSDataLen 2 + Data[1]
Data[0]:Byte BMS_CONNECT_REQUEST Connection request
Data[1]:Byte Strlen(Application name) Length of the Application name
Data[2]:String Application name Name of the BMS system application
Alive Check
This message is sent by a BMS system to the BMS Gateway to request an alive answer.
Message Field Content Description
BMSMessageType BMS_CONTROL_MSG Connection control message
BMSDataLen 1
Data[0]:Byte BMS_ALIVE_REQUEST Alive answer request
Disconnect
This message is sent by a BMS system to the BMS Gateway to close a connection.
Message Field Content Description
BMSMessageType BMS_CONTROL_MSG Connection control message
BMSDataLen 1
Data[0]:Byte BMS_DISCONNECT Close connection
Bad Message
This message is sent by the BMS Gateway to respond to an illegal message.
Message Field Content Description
BMSMessageType BMS_CONTROL_MSG Connection control message
BMSDataLen 3 + Data[2]
Data[0]:Byte BMS_BAD_MSG Unknown or illegal message
Data[1]:Byte BMSMessageType Message type of illegal message
Data[2]:Byte BMSDataLen Length of illegal message
Data[3.(Data[2]+3)]:Byte Data Data of illegal message
General Status
Login
This message is sent by a BMS system to the BMS Gateway to get the current logged in user
information.
Message Field Content Description
BMSMessageType BMS_GET_MSG Status get message
BMSDataLen 2
Data[0]:Byte BMS_STA_MSG LobbyVision
Data[1]:Byte BMS_ICC_CURRENT_LOGIN Login Information of current user
This message is sent by the BMS Gateway to respond to the user login information get request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 7 + Data[7]
Data[0]:Byte BMS_STA_MSG LobbyVision
Data[1]:Byte BMS_ICC_CURRENT_LOGIN Login Information
Data[2]:Byte Not used
Data[3]:Byte Not used
Data[4..6]:Char UserShort Short name of the user (3 characters)
Data[7]:Byte Strlen(UserName) Length of the user full name
Data[8]:String UserName Full name of the user
Elevator Status
This message is sent by the BMS Gateway to respond to an elevator group summary status
request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 11
Data[0]:Byte BMS_STA_MSG Elevator
Data[1]:Byte BMS_ELE_GROUP_SUMMARY Group summary status
Data[2]:Byte Group Id LobbyVision group Id number
Data[3]:Byte Not used
Data[4]:Bitset (32 bit) GroupStatusSet Group status Bitarray
Data[8]:Byte BlockOperationMode Group block operation mode
Data[9]:Byte NbrOfUnits Number of units within this group
Data[10]:Byte NbrOfNormalUnits Number of units in normal state
This message is sent by the BMS Gateway to respond to an elevator unit summary status request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 18 (19) Value 19 only for double decker
Data[0]:Byte BMS_STA_MSG Elevator
Data[1]:Byte BMS_ELE_LIFT_SUMMARY Unit summary status
Data[2]:Byte Group Id LobbyVision group Id number
Data[3]:Byte Unit Id LobbyVision unit Id number
Data[4..11]:Bitset UnitStatusSet Unit status Bitarray
(64 bit) (LICLiftStateType)
Data[12]:Byte CabinPosition 1 is the lowest floor of the group
Data[13]:Byte ExpressZonePosition value between 0..9.
0 means cabin is on floor
1..9 mean the percentage, which is
passed.
Data[14]:Byte LICDoorStateType Door state rear
Data[15]:Byte LICDoorStateType Door state front
Data[16]:Byte LICDirType Service direction (up, down, none)
Data[17]:Byte CabinLoad % of full load (more than 100%
( lower deck for DD ) possible)
Data[18]:Byte CabinLoad upper deck for DD only (not present otherwise).
This message is sent by the BMS Gateway to respond to an elevator unit lock mask request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 7 + ((Data[5] - 1) / 8)
Data[0]:Byte BMS_STA_MSG Elevator
Data[1]:Byte BMS_ELE_LOCK_MASK Lock mask
Data[2]:Byte Group Id LobbyVision group Id number
Data[3]:Byte Unit Id LobbyVision unit Id number
Data[4]:Byte IMSLockCallType Type of locked call
Data[5]:Byte NbrOfFloors Number of valid bits in the following
mask
Data[6]:Byte BitMask Lock mask for floor 8 <- 1
Data[7]:Byte BitMask Lock mask for floor 16 <- 9
Data[8]:Byte ... ...
Floor Call
This message is sent by a BMS system to the BMS Gateway to get a Floor Call information.
Message Field Content Description
BMSMessageType BMS_GET_MSG Status get message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_FLOOR_CALL Floor call
Data[2]:Byte Group Id LobbyVision group Id Number
This message is sent by the BMS Gateway to respond to a Floor Call information request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 7
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_FLOOR_CALL Floor call
Data[2]:Byte Group Id LobbyVision group Id Number
Data[2]:Byte Unit Id If !0, it indicates the riser number of
the call
Data[3]:Byte LICSideType Entry side
Data[4]:Byte LICDirType Direction
Data[5]:Byte FloorNumber 0 means each floor
Data[6]:Byte LICStateType On or off
Cabin Call
This message is sent by a BMS system to the BMS Gateway to get a Cabin Call information.
Message Field Content Description
BMSMessageType BMS_GET_MSG Status get message
BMSDataLen 4
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_CABIN_CALL Cabin call
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
This message is sent by the BMS Gateway to respond to a Cabin Call information request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 7
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_CABIN_CALL Cabin call
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Data[4]:Byte LICSideType Entry side
Data[5]:Byte FloorNumber 0 means each floor of this lift
Data[6]:Byte LICStateType On or off
This message is sent by the BMS Gateway to respond to an Allocated Floor Call information
request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 8
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_ALLOC_FLOOR_CALL Allocated floor call
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Data[4]:Byte LICSideType Entry side of the allocated floor call
Data[5]:Byte LICDirType Direction of the allocated floor call
Data[6]:Byte FloorNumber 0: each floor
1: lowest floor of the group
Data[7]:Byte LICStateType On or off. For off, usually floor 0 is
used
Drive State
This message is sent by a BMS system to the BMS Gateway to get a Drive State information.
Message Field Content Description
BMSMessageType BMS_GET_MSG Status get message
BMSDataLen 4
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_DRIVE_STATE Drive state
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
This message is sent by the BMS Gateway to respond to a Drive State information request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 5
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_DRIVE_STATE Drive state
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Data[4]:Byte LICDriveStateType Drive state
Drive Direction
This message is sent by a BMS system to the BMS Gateway to get a Drive Direction information.
Message Field Content Description
BMSMessageType BMS_GET_MSG Status get message
BMSDataLen 4
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_DRIVE_DIRECTION Drive direction
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
This message is sent by the BMS Gateway to respond to a Drive Direction information request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 5
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_DRIVE_DIRECTION Drive direction
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Data[4]:Byte LICDirType Drive direction (up, down, none)
Cabin Position
This message is sent by a BMS system to the BMS Gateway to get a Cabin Position information.
Message Field Content Description
BMSMessageType BMS_GET_MSG Status get message
BMSDataLen 4
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_CABIN_POSITION Cabin position
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
This message is sent by the BMS Gateway to respond to a Cabin Position information request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 6
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_CABIN_POSITION Cabin position
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Data[4]:Byte Position 1 is the lowest floor of the group
Data[5]:Byte ExpressZonePosition value between 0..9.
0 means cabin is on floor
1..9 mean the percentage, which is
passed.
Cabin Load
This message is sent by a BMS system to the BMS Gateway to get a Cabin Load information.
Message Field Content Description
BMSMessageType BMS_GET_MSG Status get message
BMSDataLen 4
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_CABIN_LOAD Cabin load
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
This message is sent by the BMS Gateway to respond to a Cabin Load information request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 5 (6)
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_CABIN_LOAD Cabin load
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Data[4]:Byte Load (lower deck for DD) % of full load (more than 100% is
possible).
Data[5]:Byte LoadUpperDeck For DD only (not present otherwise)
Door State
This message is sent by a BMS system to the BMS Gateway to get a Door State information.
Message Field Content Description
BMSMessageType BMS_GET_MSG Status get message
BMSDataLen 4
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_DOOR_STATE Door state
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
This message is sent by the BMS Gateway to respond to a Door State information request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 6
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_DOOR_STATE Door state
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Data[4]:Byte LICSideType Entry side
Data[5]:Byte LICDoorStateType Door state
Lock Trip
This message is sent by a BMS system to the BMS Gateway to get Lock Trip information (Miconic10
only).
Message Field Content Description
BMSMessageType BMS_GET_MSG Status get message
BMSDataLen 4
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_LOCK_TRIP Lock trip
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
This message is sent by the BMS Gateway to respond to a Lock Trip information request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 9
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_LOCK_TRIP Lock trip
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Data[4]:Byte FloorNumber From floor
Data[5]:Byte LICSideType From entry side
Data[6]:Byte FloorNumber To floor
Data[7]:Byte LICSideType To entry side
Data[8]:Byte LICStateType On/Off
Escalator Status
This message is sent by the BMS Gateway to respond to an escalator unit summary status request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 8
Data[0]:Byte BMS_STA_MSG Escalator
Data[1]:Byte BMS_ESC_SUMMARY Unit summary status
Data[2]:Byte Group Id LobbyVision group Id number
Data[3]:Byte Unit Id LobbyVision unit Id number
Data[4]:Word LICEscalatorStateType Unit status
Data[6]:Byte LICMotorStateType Motor status
Data[77]:Byte LICDirType Service direction
Motor State
This message is sent by a BMS system to the BMS Gateway to get an escalator motor status.
Message Field Content Description
BMSMessageType BMS_GET_MSG Status get message
BMSDataLen 4
Data[0]:Byte IMS_ESC_MSG Escalator
Data[1]:Byte IMS_E_ESC_MOTOR Motor status
Data[2]:Byte Group Id LobbyVision group Id number
Data[3]:Byte Unit Id LobbyVision unit Id number
This message is sent by the BMS Gateway to respond to an escalator motor status request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 5
Data[0]:Byte IMS_ESC_MSG Escalator
Data[1]:Byte IMS_E_ESC_MOTOR Motor status
Data[2]:Byte Group Id LobbyVision group Id number
Data[3]:Byte Unit Id LobbyVision unit Id number
Data[4]:Byte LICMotorStateType Motor status
This message is sent by the BMS Gateway to respond to a free input unit status request.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 5
Data[0]:Byte BMS_FINP_MSG Free input
Data[1]:Byte BMS_E_FINP_STATE Unit status
Data[2]:Byte Group Id LobbyVision group Id number
Data[3]:Byte Unit Id LobbyVision unit Id number
Data[4]:Byte LICFInpStateType Unit status
General Events
Login
This message is sent by a BMS system to the BMS Gateway to request the user login events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 2
Data[0]:Byte IMS_ICC_MSG LobbyVision
Data[1]:Byte IMS_LOGIN Login Information
Elevator Events
Floor Call
This message is sent by a BMS system to the BMS Gateway to request Floor Call events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_FLOOR_CALL Floor call
Data[2]:Byte Group Id LobbyVision group Id Number
Cabin Call
This message is sent by a BMS system to the BMS Gateway to request Cabin Call events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_CABIN_CALL Cabin call
Data[2]:Byte Group Id LobbyVision group Id Number
This message is sent by the BMS Gateway on Allocated Floor Call events.
Message Field Content Description
BMSMessageType BMS_EVENT_MSG Event message
BMSDataLen 8
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_ALLOC_FLOOR_CALL Allocated floor call
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Data[4]:Byte LICSideType Entry side of the allocated floor call
Data[5]:Byte LICDirType Direction of the allocated floor call
Data[6]:Byte FloorNumber 0: each floor
1: lowest floor of the group
Data[7]:Byte LICStateType On or off. For off, usually floor 0 is
used
This message is sent by the BMS Gateway on Lock Floor Call events.
Message Field Content Description
BMSMessageType BMS_EVENT_MSG Event message
BMSDataLen 8
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_LOCK_FLOOR_CALL Lock floor call
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Data[4]:Byte LICSideType Entry side of the allocated floor call
Data[5]:Byte LICDirType Direction of the allocated floor call
Data[6]:Byte FloorNumber 0: each floor
1: lowest floor of the group
Data[7]:Byte LICStateType On or off. For off, usually floor 0 is
used
This message is sent by the BMS Gateway on Lock Cabin Call events.
Message Field Content Description
BMSMessageType BMS_EVENT_MSG Event message
BMSDataLen 7
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_LOCK_CABIN_CALL Lock cabin call
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Data[4]:Byte LICSideType Entry side of the allocated floor call
Data[5]:Byte FloorNumber 0 means each floor on this lift
Data[6]:Byte LICStateType On or off. For off, usually floor 0 is used
Group Status
This message is sent by a BMS system to the BMS Gateway to request Group State events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_GROUP_STATE Group status
Data[2]:Byte Group Id LobbyVision group Id Number
Elevator Status
This message is sent by a BMS system to the BMS Gateway to request Elevator State events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_LIFT_STATE Elevator status
Data[2]:Byte Group Id LobbyVision group Id Number
Drive State
This message is sent by a BMS system to the BMS Gateway to request Drive State events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_DRIVE_STATE Drive state
Data[2]:Byte Group Id LobbyVision group Id Number
Drive Direction
This message is sent by a BMS system to the BMS Gateway to request Drive Direction events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_DRIVE_DIRECTION Drive direction
Data[2]:Byte Group Id LobbyVision group Id Number
Cabin Position
This message is sent by a BMS system to the BMS Gateway to request Cabin Position events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_CABIN_POSITION Cabin position
Data[2]:Byte Group Id LobbyVision group Id Number
Cabin Load
This message is sent by a BMS system to the BMS Gateway to request Cabin Load events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_CABIN_LOAD Cabin load
Data[2]:Byte Group Id LobbyVision group Id Number
Door State
This message is sent by a BMS system to the BMS Gateway to request Door State events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_DOOR_STATE Door state
Data[2]:Byte Group Id LobbyVision group Id Number
Final Timer
This message is sent by a BMS system to the BMS Gateway to request Final Timer events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_DOOR_FINAL_TIMER Final timer
Data[2]:Byte Group Id LobbyVision group Id Number
Bypassed Floors
This message is sent by a BMS system to the BMS Gateway to request Bypassed Floors events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_BYPASSED_FLOORS Bypassed Floors
Data[2]:Byte Group Id LobbyVision group Id Number
Passenger Allocation
This message is sent by a BMS system to the BMS Gateway to request Passenger Allocation event-
s
(Miconic 10 only).
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_PAX_ALLOCATION Passenger allocation
Data[2]:Byte Group Id LobbyVision group Id Number
This message is sent by the BMS Gateway on Passenger Allocation events (Miconic 10 only).
Message Field Content Description
BMSMessageType BMS_EVENT_MSG Event message
BMSDataLen 9
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_PAX_ALLOCATION Passenger allocation
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Data[4]:Byte FloorNumber Boarding floor
Data[5]:Byte LICSideType Boarding entry side
Data[6]:Byte FloorNumber Destination floor
Data[7]:Byte LICSideType Destination entry side
Data[8]:Byte HalfRound (1..5) Half round the request will be
served
Passenger Boarded
This message is sent by a BMS system to the BMS Gateway to request Passenger Boarded events
(Miconic 10 only).
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_PAX_BOARDED Passenger boarded
Data[2]:Byte Group Id LobbyVision group Id Number
This message is sent by the BMS Gateway on Passenger Boarded events (Miconic 10 only).
Message Field Content Description
BMSMessageType BMS_EVENT_MSG Event message
BMSDataLen 6
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_PAX_BOARDED Passenger boarded
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Data[4]:Byte FloorNumber Boarding floor
Data[5]:Byte LICSideType Boarding entry side
This message is sent by the BMS Gateway on Passenger Boarded events (Miconic 10 only).
Message Field Content Description
BMSMessageType BMS_EVENT_MSG Event message
BMSDataLen 4
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_NEXT_HALF_ROUND Next half round started
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Display Destination
This message is sent by a BMS system to the BMS Gateway to request Display Destination events
(Miconic 10 only).
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_DISPLAY_EXIT Display exit sign
Data[2]:Byte Group Id LobbyVision group Id Number
This message is sent by the BMS Gateway on Display Destination events (Miconic 10 only).
Message Field Content Description
BMSMessageType BMS_EVENT_MSG Event message
BMSDataLen 6
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_DISPLAY_EXIT Display exit sign
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Data[4]:Byte FloorNumber Floor (0 means all floors)
Data[5]:Byte LICStateType On/Off
Lock Trip
This message is sent by a BMS system to the BMS Gateway to request Lock Trip events (Miconic
10 only).
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_LOCK_TRIP Lock trip
Data[2]:Byte Group Id LobbyVision group Id Number
This message is sent by the BMS Gateway on Lock Trip events (Miconic 10 only).
Message Field Content Description
BMSMessageType BMS_EVENT_MSG Event message
BMSDataLen 9
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_LOCK_TRIP Lock trip
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Unit Id LobbyVision unit Id Number
Data[4]:Byte FloorNumber From floor
Data[5]:Byte LICSideType From entry side
Data[6]:Byte FloorNumber To floor
Data[7]:Byte LICSideType To entry side
Data[8]:Byte LICStateType On/Off
This message is sent by the BMS Gateway on Virtual Terminal Text events (Miconic 10 only).
Message Field Content Description
BMSMessageType BMS_EVENT_MSG Event message
BMSDataLen 4 + strlen(text)
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_TERMINAL_TEXT Text to display on the terminal
Data[2]:Byte GroupId LobbyVision GroupId Number
Data[3]:Byte Not used
Data[4..3+strlen(text)]: Text[0..strlen(text)-1] ASCII text to display
char
Statistic Record
This message is sent by a BMS system to the BMS Gateway to request Statistic Record events -
(Miconic 10 only).
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_STATISTIC_RECORD Passenger statistic
Data[2]:Byte GroupId LobbyVision GroupId Number
This message is sent by the BMS Gateway on Statistic Record events (Miconic 10 only).
Message Field Content Description
BMSMessageType BMS_EVENT_MSG Event message
BMSDataLen 21
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_STATISTIC_RECORD Passenger statistic
Data[2]:Byte GroupId LobbyVision GroupId Number
Data[3]:Byte UnitId LobbyVision UnitId Number
Data[4]:ULONG Time_t Allocation time
Data[8]:Byte FloorNumber Boarding floor
Data[9]:Byte LIC_SideType Boarding entry side
Data[10]:Byte Seconds Time for approach
Data[11]:ULONG Time_t Boarding time
Data[15]:Byte FloorNumber Exit floor
Data[16]:Byte LICSideType Exit entry side
Data[17]:ULONG Time_t Exit time
This message is sent by the BMS Gateway on Cumulated Trip Time events.
Message Field Content Description
BMSMessageType BMS_RESPONSE_MSG Status response message
BMSDataLen 8
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_E_CUM_TRIP_TIME Cumulated trip time
Data[2]:Byte GroupId LobbyVision GroupId Number
Data[3]:Byte UnitId LobbyVision UnitId Number
Data[4]: ULONG Cumulated trip time [sec] in seconds
Escalator Events
Escalator State
This message is sent by a BMS system to the BMS Gateway to request escalator status events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ESC_MSG Escalator
Data[1]:Byte IMS_E_ESC_STATE Escalator state
Data[2]:Byte group Id LobbyVision group Id number
Motor State
This message is sent by a BMS system to the BMS Gateway to request escalator motor status
events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ESC_MSG Escalator
Data[1]:Byte IMS_E_ESC_MOTOR Motor status
Data[2]:Byte group Id LobbyVision group Id number
This message is sent by the BMS Gateway on escalator motor status events.
Message Field Content Description
BMSMessageType BMS_EVENT_MSG Event message
BMSDataLen 5
Data[0]:Byte IMS_ESC_MSG Escalator
Data[1]:Byte IMS_E_ESC_MOTOR Motor status
Data[2]:Byte group Id LobbyVision group Id number
Direction
This message is sent by a BMS system to the BMS Gateway to request escalator direction status
events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_ESC_MSG Escalator
Data[1]:Byte IMS_E_ESC_DIR Direction
Data[2]:Byte group Id LobbyVision group Id number
This message is sent by the BMS Gateway on escalator direction status events.
Message Field Content Description
BMSMessageType BMS_EVENT_MSG Event message
BMSDataLen 5
Data[0]:Byte IMS_ESC_MSG Escalator
Data[1]:Byte IMS_E_ESC_DIR Direction
Data[2]:Byte group Id LobbyVision group Id number
Data[3]:Byte unit Id LobbyVision unit Id number
Data[4]:Byte LICDirType Direction
This message is sent by the BMS Gateway on Command Request Acknowledge events.
Message Field Content Description
BMSMessageType BMS_EVENT_MSG Event message
BMSDataLen 5
Data[0]:Byte IMS_ESC_MSG Escalator
Data[1]:Byte IMS_ESC_CMD_ACKNOWLEDGE Escalator state of request
Data[2]:Byte group Id LobbyVision group Id number
Data[3]:Byte unit Id LobbyVision unit Id number
Data[4]:Byte LICStateType Request state
State Change
This message is sent by a BMS system to the BMS Gateway to request Free Input Status events.
Message Field Content Description
BMSMessageType BMS_REQUEST_MSG Event request message
BMSDataLen 3
Data[0]:Byte IMS_FINP_MSG Free input
Data[1]:Byte IMS_E_FINP_STATE Free input state change
Data[2]:Byte group Id LobbyVision group Id number
This message is sent by the BMS Gateway on Free Input Status events.
Message Field Content Description
BMSMessageType BMS_EVENT_MSG Event message
BMSDataLen 5
Data[0]:Byte IMS_FINP_MSG Free input
Data[1]:Byte IMS_E_FINP_STATE Free input state
Data[2]:Byte group Id LobbyVision group Id number
Data[3]:Byte unit Id LobbyVision unit Id number
Data[4]:Byte LICFInputStateType Unit status
Data[5]:Byte LICErrorPlaceType none, top, middle, button, controller,
warning
General Commands
Elevator Commands
Floor Call
This message is sent by a BMS system to the BMS Gateway to request a Floor Call command.
Message Field Content Description
BMSMessageType BMS_COMMAND_MSG Command message
BMSDataLen 8
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_C_FLOOR_CALL Floor call
Data[2]:Byte Group Id LobbyVision group Id Number
Data[3]:Byte Not used
Data[4]:Byte LICSideType Entry side
Data[5]:Byte LICDirType Direction
Data[6]:Byte FloorNumber 1 is the lowest floor of the group
Data[7]:Byte LICStateType On or off
Cabin Call
This message is sent by a BMS system to the BMS Gateway to request a Cabin Call command.
Message Field Content Description
BMSMessageType BMS_COMMAND_MSG Command message
BMSDataLen 7
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_C_CABIN_CALL Cabin call
Data[2]:Byte group Id LobbyVision group Id Number
Data[3]:Byte unit Id LobbyVision unit Id Number
Data[4]:Byte LICSideType Entry side
Data[5]:Byte FloorNumber 1 is the lowest floor of the group
Data[6]:Byte LICStateType On or off
Group Status
This message is sent by a BMS system to the BMS Gateway to request a Group State change.
Message Field Content Description
BMSMessageType BMS_COMMAND_MSG Command message
BMSDataLen 6 (7) [8] {10}
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_C_GROUP_STATE Group state
Data[2]:Byte group Id LobbyVision group Id Number
Data[3]:Byte not used
Data[4]:Byte LICGroupStateType Group feature/service
Data[5]:Byte LICStateType Turn on or off
Data[6]: Byte (Block operation mode) [floor] Block operation mode or origin floor
Data[7]: Byte [LICSideType] Origin side
Data[8]: Byte {floor} Destination floor
Data[9]: Byte {LICSideType} Destination side
The group state GS_BO ‘Block operation’ has an additional parameter: the mode. Its value is
between 0 and 7.
The following group features must contain as data origin floor and origin side (àBMSDataLen = 8):
• GS_RES10 Reserve
• GS_RES11 Reserve
• GS_RES12 Reserve
• GS_RES13 Reserve
The following group features must contain as data an origin floor, origin side, destination floor and
destination side (àBMSDataLen = 10):
• GS_VIPG10 VIPG Miconic 10
Elevator Status
This message is sent by a BMS system to the BMS Gateway to request an Elevator State change.
Message Field Content Description
BMSMessageType BMS_COMMAND_MSG Command message
BMSDataLen 6 (8) [10]
Data[0]:Byte IMS_ELE_MSG Elevator
Data[1]:Byte IMS_C_LIFT_STATE Elevator state
Data[2]:Byte group Id LobbyVision group Id Number
Data[3]:Byte unit Id LobbyVision unit Id Number
Data[4]:Byte LICLiftStateType Car feature / service
Data[5]:Byte LICStateType On or off
Data[6]: Byte (floor) Origin floor
Data[7]: Byte (LICSideType) Origin side
Data[8]: Byte [floor] Destination floor
Data[9]: Byte [LICSideType] Destination side
The following elevator features must contain as data origin floor and origin side (àBMSDataLen =
8):
• LS_ET1 Emergency Trip 1
• LS_VIP VIP Trip
• LS_CTL Car to Lobby Trip
• LS_IND_M10 Independent Service Miconic 10
• LS_CLEAN_M10 Cleaner Control Miconic 10
• LS_RES13 Reserve
• LS_RES14 Reserve
• LS_RES15 Reserve
• LS_RES16 Reserve
• LS_RES17 Reserve
The following group features must contain as data an origin floor, origin side, destination floor and
destination side (àBMSDataLen = 10):
• LS_ET1_M10 Emergency Trip 1 Miconic 10
• LS_VIP_M10 VIP Trip Miconic 10
Escalator Commands
Service Switching
This message is sent by a BMS system to the BMS Gateway to request a Command Request.
Message Field Content Description
BMSMessageType BMS_COMMAND_MSG Command message
BMSDataLen 5
Data[0]:Byte IMS_ESC_MSG Escalator
Data[1]:Byte IMS_ESC_CMD_REQUEST Escalator start / stop request
Data[2]:Byte group Id LobbyVision group Id number
Data[3]:Byte unit Id LobbyVision unit Id number
Data[4]:Byte LICRequestType Start or stop request
This message is sent by a BMS system to the BMS Gateway to request a Command.
Message Field Content Description
BMSMessageType BMS_COMMAND_MSG Command message
BMSDataLen 5
Data[0]:Byte IMS_ESC_MSG Escalator
Data[1]:Byte IMS_ESC_CMD Escalator command
Data[2]:Byte group Id LobbyVision group Id number
Data[3]:Byte unit Id LobbyVision unit Id number
Data[4]:Byte LICEscalatorCommandType Command
State Change
This message is sent by a BMS system to the BMS Gateway to request a Free Input Status change.
Message Field Content Description
BMSMessageType BMS_COMMAND_MSG Command message
BMSDataLen 5
Data[0]:Byte IMS_FINP_MSG Free input
Data[1]:Byte IMS_C_FINP_STATE Free input state change command
Data[2]:Byte group Id LobbyVision group Id number
Data[3]:Byte unit Id LobbyVision unit Id number
Data[4]:Byte LICStateType New state: on or off
Configuration
//
// BMS-Gateway Configuration File
// -------------------------------------------
// ETHERNET server :
tcpipServer.port 2000
tcpipServer.addr "136.238.3.48"
// Node1 (ETHERNET) :
node1.subscriberAddr "136.238.3.49"
// Node2 (ETHERNET) :
node2.subscriberAddr "136.238.3.50"
// Node3 (RS232) :
node3.comPortNbr 2
node3.comBaudrate 38400
Select the desired participant (node) and tracer (receive [Rx] or transmit [Tx]). Tracer list box(es) will
appear:
Elevator Features
Feature Abbr. Type
Normal Operation N LIC_LS_N = 1
Switch Off OFF LIC_LS_OFF
Independent Service IND LIC_LS_IND
Priority Trip PT LIC_LS_PT
Attended Service ATT LIC_LS_ATT
Fire Emergency FIRE LIC_LS_FIRE
Fire Emergency Service FIFIT LIC_LS_FIFIT
Emergency Power EP LIC_LS_EP
Inspection Travel INS LIC_LS_INS
Overload LX LIC_LS_LX
Disable Door DD LIC_LS_DD
Emergency Power Evacuation EPE LIC_LS_EPE
Status not available SNA LIC_LS_SNA
Bed Trip BED LIC_LS_BED
Error ERR LIC_LS_ERR
Test Travel TT LIC_LS_TT
Banker's Trip BAT LIC_LS_BAT
Button Emergency Trip ET LIC_LS_ET
Restricted Service RES LIC_LS_RES
Guest Control GUEST LIC_LS_GUEST
Cleaner Control CLEAN LIC_LS_CLEAN
Strong Wind WIND LIC_LS_WIND
VIP Trip VIP LIC_LS_VIP
Thermo Contact Driver HEAT LIC_LS_HEAT
Servitel Out of Order SOO LIC_LS_SOO
Hospital Emergency Trip HET LIC_LS_HET
Earthquake QUAKE LIC_LS_QUAKE
Car To Lobby CTL LIC_LS_CTL
Code Blue BLUE LIC_LS_BLUE
Bypass BY LIC_LS_BY
Next Car Operation NEXT LIC_LS_NEXT
Stop Button pressed STOP LIC_LS_STOP
Alarm Button pressed ALARM LIC_LS_ALARM
Communication Problem COM LIC_LS_COM
Cabin Call CC LIC_LS_CC
Floor Call FC LIC_LS_FC
Lock Cabin Call LCC LIC_LS_LCC
Lock Floor Call LFC LIC_LS_LFC
Security Service SEC LIC_LS_SEC
Independent Service Miconic 10 IND_M10 LIC_LS_IND_M10
Cleaner Control Miconic 10 CLEAN_M1 0 LIC_LS_CLEAN_M10
Indicator Fault INF LIC_LS_POST
COP Fault COP LIC_LS_INF
Post Distribution POST LIC_LS_COP
Escalator Features
Feature Abbr. Type
Automatic Operation AUTO LIC_ES_AUTO
Continuos Operation CONT LIC_ES_CONT
Switched Off OFF LIC_ES_OFF
Emergency Stop STOP LIC_ES_STOP
Operator Interaction Needed OIN LIC_ES_OIN
Inspection INS LIC_ES_INS
Error ERR LIC_ES_ERR
Status not available SNA LIC_ES_SNA
Check IBM TCP/IP for Warp within the following page and confirm it with „OK“:
The IP address is the only required entry within the IBM TCP/IP setup pages. This address is
requested to be unique for the whole network your workstation will be connected to.