Leosac  0.7.0
OpenSourceAccessControl
Module: Doorman

Table of Contents

Module that reacts to authentication event.

Doorman Module Documentation

Introduction

The Doorman module is very important to Leosac's usability. It is the module responsible for reacting to messages sent by authentication / authorization modules.

If an access is granted (or denied) one (or more) actions can be taken by this module:

  • Open the door.
  • Raise an alarm.
  • ...

The main goal of this module is to trigger action on others components in the system. This is done by sending message to them.

Configuration Options

Options Options Options Options Options Description Mandatory
instances Multiples (unrelated) doorman instance are allowed YES
—> instance Configuration information for 1 instance YES
—> —> name Name of this doorman instance YES
—> —> auth_contexts Message from multiple contexts can lead to the same action YES
—> —> —> auth_context Information for an Auth Context YES
—> —> —> —> name Name of the auth context we are using YES
—> —> actions Configure the actions to take when something happens YES
—> —> —> action Configuration information for one action YES
—> —> —> —> on When should the action be taken (DENIED / GRANTED) YES
—> —> —> —> target Name of the targeted object that will receive the action command YES
—> —> —> —> cmd Description for the command that will be sent YES
doors Optionally declares the doors NO
—> door Declare one door YES
—> —> name A name for the door YES
—> —> gpio The GPIO to turn on/off based on the door's state YES
—> —> on Some schedules for when the door is in "always open" mode NO
—> —> —> schedules See here to learn how to declare schedules YES
—> —> off Some schedules for when the door is in "always closed" mode NO
—> —> —> schedules See here to learn how to declare schedules YES
Note
The <cmd> tag is quite simple. It looks like this:
<cmd>
<f1>GREEN_LED</f1>
<f2>ON</f2>
<f3>1500</f3>
</cmd>
For each frame you want in the command message, use <fX> where X is growing for each frame you want.
Note
instances.instance.actions.action.target is the name of an object that has been defined in the system. It could be the name of a GPIO you defined before ("my_super_gpio") or some reader object ("my_wiegand1"), etc.
Note
Declaring doors is optional, and is only ever useful if you make use of the "always open" or "always close" feature.

Example 0

This is a very simple example that requires a component named "gpio_door" to open for 2.5 seconds when an successful authentication happens. If the authentication fails, it would ask the "led_failure" to turns on to 2.5s.

<module>
<name>DOORMAN</name>
<file>libdoorman.so</file>
<level>50</level>
<module_config>
<instances>
<instance>
<name>DOORMAN_JARVIS_1</name>
<auth_contexts>
<auth_context>
<name>AUTH_CONTEXT_1</name>
</auth_context>
</auth_contexts>
<actions>
<action>
<on>DENIED</on>
<target>led_failure</target>
<cmd>
<f1>ON</f1>
<f2>2500</f2>
</cmd>
</action>
<action>
<on>GRANTED</on>
<target>gpio_door</target>
<cmd>
<f1>ON</f1>
<f2>2500</f2>
</cmd>
</action>
</actions>
</instance>
</instances>
</module_config>
</module>

Example 1

The following example file defines the following:

  • The door is always open on wednesday, between 13:13 and 13:15.
  • The door is always closed on wednesday, between 13:15 and 15:16.
  • On successful authentication (except when always open/close) we send the GREEN_LED (with ON and 1500 as parameters) command to the MY_WIEGAND_1 device. This will light the green led of the reader for 1.5second.
  • On failure (again, except when always open/close) we send the ON command (with 500 as parameter) to the wiegand_buzzer GPIO, causing the device to beep for 0.5 second.
<module>
<name>DOORMAN</name>
<file>libdoorman.so</file>
<level>50</level>
<module_config>
<doors>
<door>
<name>MyDoor</name>
<gpio>gpio_door</gpio>
<on>
<schedules>
<schedule>
<name>we_do_not_care</name>
<wednesday>
<start>13:13</start>
<end>13:15</end>
</wednesday>
</schedule>
</schedules>
</on>
<off>
<schedules>
<schedule>
<name>we_still_dont_care</name>
<wednesday>
<start>13:15</start>
<end>15:16</end>
</wednesday>
</schedule>
</schedules>
</off>
</door>
</doors>
<instances>
<instance>
<name>DOORMAN_JARVIS_1</name>
<auth_contexts>
<auth_context>
<name>AUTH_CONTEXT_1</name>
</auth_context>
</auth_contexts>
<actions>
<action>
<on>DENIED</on>
<target>wiegand_buzzer</target>
<cmd>
<f1>ON</f1>
<f2>500</f2>
</cmd>
</action>
<action>
<on>GRANTED</on>
<target>MY_WIEGAND_1</target>
<cmd>
<f1>GREEN_LED</f1>
<f2>ON</f2>
<f3>1500</f3>
</cmd>
</action>
</actions>
</instance>
</instances>
</module_config>
</module>