Reference Manual


Sys.SelectProtocol

This command starts a host protocol.

Depending on the reader's hardware and firmware, multiple protocols may be supported. For most reader-to-host interfaces (e.g. USB, Ethernet), an unlimited number of protocols can be used on the physical channel, but in some cases only a single protocol per physical channel can be used at a time. This is for example the case when using a serial (RS-232/UART) interface, offering two physical channels, in which case each physical channel must be shared by several protocols.

After power-up, the reader activates all protocols specified in the Device / Run / EnabledProtocols configuration value. To change the activated protocols at runtime, this command has to be used.

In case only a single protocol is allowed to run per physical channel, calling this command when a channel is already in use by another protocol will stop the currently running protocol.

Example: the protocol is currently running on a serial interface (physical channel CH0) when Sys.SelectProtocol is called with ProtocolID = 0x09 (Debug Interface). Since the Debug Interface protocol uses the same physical channel (CH0), it will be disabled.

Properties

Parameters (request frame)

Name Type/Size Description
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.

Returned values (response frame)

None