Reference Manual


UI.Toggle

This command toggles the output state of a specific port.

A single toggle consists of 2 state changes: From the initial state to the inverse state and back. The initial state is defined by the Polarity parameter. This is also the state of the port at the end of the toggling operation.

To stop the toggling, call UI.Enable or UI.Disable for this port.

Properties

Parameters (request frame)

Name Type/Size Description
Port Enumeration (8 bits) I/O pins of the reader that can be controlled by the user.
Values:
  • GreenLed (0x00)
    Enable/disable/toggle the green LED (if available).
  • RedLed (0x01)
    Enable/disable/toggle the red LED (if available).
  • Beeper (0x02)
    Enable/disable/toggle the beeper (if available).
  • Relay (0x03)
    Enable/disable/toggle the relay (if available).
  • Input0 (0x04)
    Retrieve the state of the custom input 0.
  • Input1 (0x05)
    Retrieve the state of the custom input 1.
  • BlueLed (0x06)
    Enable/disable/toggle the blue LED (if available).
  • TamperAlarm (0x07)
    Retrieve the state of the tamper alarm.
  • Gpio0 (0x08)
    Refers to a general purpose I/O. The physical pin assigned to this logical I/O port depends on the physical setup of the device.
  • Gpio1 (0x09)
    Refers to a general purpose I/O. The physical pin assigned to this logical I/O port depends on the physical setup of the device.
  • Gpio2 (0x0A)
    Refers to a general purpose I/O. The physical pin assigned to this logical I/O port depends on the physical setup of the device.
  • Gpio3 (0x0B)
    Refers to a general purpose I/O. The physical pin assigned to this logical I/O port depends on the physical setup of the device.
  • Gpio4 (0x0C)
    Refers to a general purpose I/O. The physical pin assigned to this logical I/O port depends on the physical setup of the device.
  • Gpio5 (0x0D)
    Refers to a general purpose I/O. The physical pin assigned to this logical I/O port depends on the physical setup of the device.
  • Gpio6 (0x0E)
    Refers to a general purpose I/O. The physical pin assigned to this logical I/O port depends on the physical setup of the device.
  • Gpio7 (0x0F)
    Refers to a general purpose I/O. The physical pin assigned to this logical I/O port depends on the physical setup of the device.
  • CustomVled0 (0x40)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

  • CustomVled1 (0x41)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

  • CustomVled2 (0x42)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

  • CustomVled3 (0x43)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

  • CustomVled4 (0x44)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

  • CustomVled5 (0x45)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

  • CustomVled6 (0x46)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

  • CustomVled7 (0x47)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

  • CustomVled8 (0x48)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

  • CustomVled9 (0x49)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

  • CustomVled10 (0x4A)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

  • CustomVled11 (0x4B)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

  • CustomVled12 (0x4C)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

  • CustomVled13 (0x4D)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

  • CustomVled14 (0x4E)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

  • CustomVled15 (0x4F)

    Custom Virtual LED (VLED) port. Allows RGB LEDs to be activated with a user-defined color.

ToggleCount Integer (8 bits) The number of toggles. To toggle forever, choose 0xFF.
Timespan1 Integer (16 bits) The time in ms that the port is to stay in the inverse state.
Timespan2 Integer (16 bits) The time in ms that the port is to stay in the initial state.
Polarity Enumeration (8 bits) Values:
  • Normal (0)
    The initial and final port state is disabled/inactive/low.
  • Inverted (1)
    The initial and final port state is enabled/active/high.

Returned values (response frame)

None