Jeff.Command.BuzzerSettings (jeff v0.3.0) View Source

Reader Buzzer Control Command

OSDP v2.2 Specification Reference: 6.11

Link to this section Summary

Types

The number of times to repeat the ON/OFF cycle. 0 = tone continues until another tone command is received.

The OFF duration of the sound, in units of 100ms.

The ON duration of the sound, in units of 100ms. Must be nonzero unless the tone code is 0x01 (off).

t()

Requested tone state

Link to this section Types

Specs

count() :: 0..255

The number of times to repeat the ON/OFF cycle. 0 = tone continues until another tone command is received.

Specs

off_time() :: 0..255

The OFF duration of the sound, in units of 100ms.

Specs

on_time() :: 0..255

The ON duration of the sound, in units of 100ms. Must be nonzero unless the tone code is 0x01 (off).

Specs

param() ::
  {:reader, integer()}
  | {:tone, tone_code()}
  | {:on_time, on_time()}
  | {:off_time, off_time()}
  | {:count, count()}

Specs

params() :: t() | [param()]

Specs

t() :: %Jeff.Command.BuzzerSettings{
  count: count(),
  off_time: off_time(),
  on_time: on_time(),
  reader: integer(),
  tone: tone_code()
}

Specs

tone_code() :: 0..255

Requested tone state

0x00 = no tone (off) – use of this value is deprecated. 0x01 = off 0x02 = default tone 0x03-0xff = Reserved for future use

Link to this section Functions

Specs

encode(params()) :: binary()

Specs

new(params()) :: t()