Reference Manual


BaltechScript / SendMsg Protocol Frame

Sends the message which is stored in Scripts / StaticMessages / SendMsg with Value ID MsgId to the host(s). The message is handled like an event of kind MsgType.

The MsgId parameter starts counting from 3. I.e., to send SendMsg[2], MsgId has to be 5.

If Protocol is 0, the message is sent to all active protocols. Furthermore it will be transformed by the corresponding PostConvertTemplates.

If Protocol is a protocol id, the message will be sent to this protocol only and no (PostConvertTemplate-) conversion will be initiated.

Properties

Format

Name Type/Size Description
MsgType Enumeration (8 bits) Event that triggered the message. It allows the host application to interpret the message content correctly.
Values:
  • Card (0x00)
    A card or a phone with an active Mobile ID app was presented to the reader. The Autoread subsytem has read and converted the number based on the RFID interface component in the reader configuration. The result is returned in the message content.
  • AlarmOn (0x01)
    The tamper alarm was activated. By default, the message content is empty.
  • AlarmOff (0x02)
    The tamper alarm was deactivated. By default, the message content is empty.
  • Keyboard (0x03)
    A PIN was entered via the reader's keyboard. The entered digits are returned in the message content.
  • CardRemoval (0x04)

    A previously presented card has been removed. By default, the message content is empty.

    This message type is only generated if the reader is configured to scan for card removals (Device.Run.AutoreadWaitForCardRemoval).
  • FunctionKey (0x05)
    The user has pressed a certain function key, e.g. the hash (#), star (*), or ENTER (E) key. The code of the entered key is returned in the message content.
  • Logs (0x06)

    The reader returned a log message.

    When you request support, please forward these log messages to us to help us investigate the underlying issue. Please collect log messages from all readers in your project. Only then will they provide meaningful insights.
MsgId Integer (8 bits) -
Protocol Enumeration (8 bits)

A list of all protocols.

Not all protocols are available on all Firmware variants.
Values:
  • All (0x00)
    Selects all available protocols. Only applicable for BaltechScript.SendMsg
  • BrpSerial (0x03)
    BRP protocol over RS-232/UART. This protocol has also to be used if the USB-virtual-comport-emulation is used.
  • BrpRs485 (0x04)
    BRP protocol over RS485 connection. Is used for long distances or when needing multiple devices on a single host.
  • BrpHid (0x05)
    BRP protocol over HID (Human Interface Device) Protocol. This is a standard USB Protocol with drivers for all OSes.
  • BrpTcp (0x86)
    BRP protocol over TCP/IP.
  • DebugInterface (0x09)
    The debug interface may be used to look into the readers internals via a Terminal. Works over RS-232/UART or virtual-comport-emulation.
  • RawSerial (0x23)
    This is a autoread protocol that sends the ID read by autoread mode without any protocol overhead. Works over RS-232/UART or virtual-comport-emulation.
  • Wiegand (0x20)
    This is a autoread protocol that sends the ID read by autoread mode via Wiegand protocol.
  • KeyboardEmulation (0x2B)
    USB devices will register as keyboard if this value is active. When the autoread mode detected an ID it will be send by emulating keypresses.
  • LowLevelIoPorts (0x24)

    configures the pins which are usually used by the Wiegand / RawSerial /... protocol as I/O Ports that can be controlled via scripts.

    I/O Port physical pin
    Gpio5 TX of RawSerial protocol
    Gpio6 direction line on RS485 protocols
    Gpio7 RX pin of RawSerial protocol
  • ClkData (0x22)
  • Omron (0x21)
  • Snet (0x10)
  • Bpa9 (0x11)
  • LBus (0x32)
    LBus protocol. Only supported by customer-specific firmware.
  • Ccid (0x36)
    Chip Card Interface Device (CCID). USB protocol that allows a smartcard to be connected to a computer via a card reader using a standard USB interface.
  • RawSerial2 (0x37)
    This is a second Autoread protocol that sends the ID read by Autoread mode without any protocol overhead.
  • Osdp (0x38)
    Open Supervised Standard Protocol. New Protocol Standard used for long distances or when needing multiple devices on a single host.
  • BleHci (0x3B)
    BLE HCI Protocol. USB protocol that allows the BLE component to be controlled via Host Controller Interface (HCI) as specified in the Bluetooth Core Specification.
  • HttpsClient (0x28)
    Indicates that the reader is connected to an IF Converter that connects to a server via Ethernet as HTTPS client.