Jeff (jeff v0.3.0) View Source
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 a local status report.
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
Specs
acu() :: GenServer.server()
Specs
device_opt() :: Jeff.ACU.device_opt()
Specs
osdp_address() :: 0..127
Link to this section Functions
Specs
add_pd(acu(), osdp_address(), [device_opt()]) :: Jeff.Device.t()
Register a peripheral device on the ACU communication bus.
Specs
capabilities(acu(), osdp_address()) :: [Jeff.Reply.Capability.t()] | Jeff.Reply.ErrorCode.t()
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.
Specs
id_report(acu(), osdp_address()) :: Jeff.Reply.IdReport.t() | Jeff.Reply.ErrorCode.t()
Requests the return of the PD ID Report.
Specs
local_status(acu(), osdp_address()) :: Jeff.Reply.LocalStatus.t() | Jeff.Reply.ErrorCode.t()
Instructs the PD to reply with a local status report.
Specs
set_buzzer(acu(), osdp_address(), Jeff.Command.BuzzerSettings.params()) :: Jeff.Reply.ACK | Jeff.Reply.ErrorCode.t()
Defines commands to a single, monotone audible annunciator (beeper or buzzer) that may be associated with a reader.
Specs
set_com(acu(), osdp_address(), Jeff.Command.ComSettings.params()) :: Jeff.Reply.ComData.t() | Jeff.Reply.ErrorCode.t()
Sets the PD's communication parameters.
Specs
set_led(acu(), osdp_address(), Jeff.Command.LedSettings.params()) :: Jeff.Reply.ACK | Jeff.Reply.ErrorCode.t()
Controls the LEDs associated with one or more readers.
Specs
start_acu([Jeff.ACU.start_opt()]) :: GenServer.on_start()
Start an ACU process.