Access Restricted

This page contains internal documentation that is not publicly available.


Protocols / HttpsClient / HeartbeatDelay Value

Specifies the interval at which Ethernet Converter sends a heartbeat to the server, so the server can detect a device it no longer hears from. Every Seconds seconds, Ethernet Converter sends "POST <AuthUrl>/reader-<serial>/heartbeat" to the server specified in AuthUrl, authenticated with the reader-specific authentication token, just like the requests transmitting card reads.

Before each heartbeat, Ethernet Converter queries the boot status of the attached reader (see Sys.GetBootStatus) and only sends the heartbeat if the boot status is 0. A missing heartbeat therefore means that Ethernet Converter, the reader, or the network connection is gone - or that the reader is in a faulty boot state.

If this value is 0 or not set, no heartbeat is sent.

Note: The Ethernet Converter middleware (the PC software that converts Shark-E Ethernet readers to the HttpsClient protocol) does not send heartbeats; this value has no effect there.

Properties

  • Value ID: 0x0128/0x0A
  • Default value: 0

Format

Name Type/Size Description
Seconds Integer (32 bits) Number of seconds until the next heartbeat. 0 disables the heartbeat.