Plaza BMS API

[jevkoo]

BMS DM Plaza protocol v 1.6 (19.12.2024)

legenda:

token – 10 hex chars, unique chip identifier (strip or card), room identifier (room, door)
tokenType –token type, if not specified, system default is used (EM, MIFARE)
entity – integer number, unique guest identifier
rights – collection of various settings in format NAME = value, separated by semicolon
price – code of pricelist defined in KasComp
tripod_name – name of barrier
amount – decimal number in 0.00 format
temp – decimal number in 0.00 format
tempStatus - temperature status

DMPlaza -> BMS System

Status

BMS STATUS tokenCode [tokenType] [tempStatus]
BMS STATUS_RET tokenCode OK entity [temp]
BMS STATUS_RET tokenCode ERR optional message

Entity activation

BMS ACTIVATE tokenCode [tokenType]
BMS ACTIVATE RET tokenCode OK entity
BMS ACTIVATE RET tokenCode ERR optional message

Entity deactivation

BMS DEACTIVATE entity
BMS DEACTIVATE_RET entity OK
BMS DEACTIVATE_RET entity ERR

Entity manipulation

BMS ACCESS entity rights [temp]
BMS ACCESS_RET entity OK
BMS ACCESS_RET entity ERR optional message
e.g. rights:
001 = b t //b= 1 temp on t=18.50
001 = b t //b= 0 temp off t=12.50
001 = b //b = 0 access blocked, = 1 access allowed once, = -1 access allowed unlimited
SAUNA = b //b = 0 access blocked, = 1 access allowed once, = -1 access allowed unlimited
TERMA = b //b = dtto
CREDIT = credit x 100 (final value in grosz)

Entity payment

BMS PRICE entity price
BMS PRICE_RET entity OK
BMS PRICE_RET entity ERR optional message
price: code of entry pricelist

BMS DMSALE transactionID entity Name; PLU; Quantity x 100; UnitPrice x 100
BMS DMSALE_RET transactionID OK
BMS DMSALE_RET transactionID ERR optional message

BMS GETPAYMENT entity
BMS GETPAYMENT_RET entity OK amount
BMS GETPAYMENT_RET entity ERR optional message
amount: the amount the entity must pay before exit
 
BMS PAID entity amount
BMS PAID_RET entity OK
BMS PAID_RET entity ERR
amount: the amount paid by the entity

Common areas

BMS TRIPOD tripod_name
BMS TRIPOD_RET tripod_name OK
BMS TRIPOD_RET tripod_name ERR optional message
tripod_name is internal device name in BMS system/configuration

System -> DM Plaza

BMS KCSALE transactionID entity Name; PLU; Quantity x 100; UnitPrice x 100
BMS KCSALE_RET transactionID OK
BMS KCSALE_RET transactionID ERR optional message
BMS KCTRIPOD tripod_name token [tokenType]
BMS KCTRIPOD_RET tripod_name entity price OK
BMS KCTRIPOD_RET tripod_name token ERR optional message
price: code of entry pricelist

BMS KCENTITYMOVED entity tripod_name
BMS KCENTITYMOVED_RET OK
Event is sent in moment of entity movement. If DM Plaza server is not available in this moment, notification of movement will be lost.