View Source Jeff (jeff v0.5.0)
Control an Access Control Unit (ACU) and send commands to a Peripheral Device (PD)
Link to this section Summary
Functions
Register a peripheral device on the ACU communication bus.
Requests the PD to return a list of its functional capabilities, such as the type and number of input points, outputs points, reader ports, etc.
Requests the return of the PD ID Report.
Instructs the PD to reply with an input status report.
Instructs the PD to reply with a local status report.
Sends a manufacturer-specific command to the PD.
Instructs the PD to reply with an output status report.
Remove a peripheral device from the ACU communication bus.
Defines commands to a single, monotone audible annunciator (beeper or buzzer) that may be associated with a reader.
Sets the PD's communication parameters.
Controls the LEDs associated with one or more readers.
Start an ACU process.
Link to this section Types
@type acu() :: GenServer.server()
@type cmd_err() :: {:error, :timeout | Jeff.Reply.ErrorCode.t()}
@type device_opt() :: Jeff.ACU.device_opt()
@type osdp_address() :: 0..127
@type vendor_code() :: 0..16_777_215
Link to this section Functions
@spec add_pd(acu(), osdp_address(), [device_opt()]) :: Jeff.Device.t()
Register a peripheral device on the ACU communication bus.
@spec capabilities(acu(), osdp_address()) :: Jeff.Reply.Capabilities.t() | cmd_err()
Requests the PD to return a list of its functional capabilities, such as the type and number of input points, outputs points, reader ports, etc.
@spec id_report(acu(), osdp_address()) :: Jeff.Reply.IdReport.t() | cmd_err()
Requests the return of the PD ID Report.
@spec input_status(acu(), osdp_address()) :: Jeff.Reply.InputStatus.t() | cmd_err()
Instructs the PD to reply with an input status report.
@spec local_status(acu(), osdp_address()) :: Jeff.Reply.LocalStatus.t() | cmd_err()
Instructs the PD to reply with a local status report.
@spec mfg(acu(), osdp_address(), Jeff.MFG.Encoder.t() | [Jeff.Command.Mfg.param()]) :: Jeff.Reply.MfgReply.t() | cmd_err()
Sends a manufacturer-specific command to the PD.
@spec output_status(acu(), osdp_address()) :: Jeff.Reply.OutputStatus.t() | cmd_err()
Instructs the PD to reply with an output status report.
@spec remove_pd(acu(), osdp_address()) :: Jeff.Device.t()
Remove a peripheral device from the ACU communication bus.
@spec set_buzzer(acu(), osdp_address(), [Jeff.Command.BuzzerSettings.param()]) :: Jeff.Reply.ACK | cmd_err()
Defines commands to a single, monotone audible annunciator (beeper or buzzer) that may be associated with a reader.
@spec set_com(acu(), osdp_address(), [Jeff.Command.ComSettings.param()]) :: Jeff.Reply.ComData.t() | cmd_err()
Sets the PD's communication parameters.
@spec set_led(acu(), osdp_address(), [Jeff.Command.LedSettings.param()]) :: Jeff.Reply.ACK | cmd_err()
Controls the LEDs associated with one or more readers.
@spec start_acu([Jeff.ACU.start_opt()]) :: GenServer.on_start()
Start an ACU process.