Commands: Difference between revisions

From Telcred documentation
Jump to navigation Jump to search
 
(45 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Overview ==
== Overview ==


A ''command'' is one or more predefined actions that can either be performed by an administrator or as a result of a predefined [[Triggers|trigger]].
A ''command'' is one or more predefined actions that can either be performed by an administrator or as a result of a [[Triggers|trigger]] being activated.


Some use cases for commands include:
Some use cases for commands include:
Line 8: Line 8:
* Allow end users to perform an action normally only available to administrators (e.g. unlock a door or return it to schedule).
* Allow end users to perform an action normally only available to administrators (e.g. unlock a door or return it to schedule).


== Independent vs. origin dependent commands ==
=== Origin dependency for commands and relevance for triggers ===

⚫
=== Origin and triggers ===


With ''origin'' is meant a door or a controller that forms the context for executing a command. [[Triggers]] of the type 'Remote action from overview’ do not provide one, and may therefore only execute commands that are origin independent.
With ''origin'' is meant a door or a controller that forms the context for executing a command. [[Triggers]] of the type 'Remote action from overview’ do not provide one, and may therefore only execute commands that are origin independent.
Line 16: Line 14:
All other types of triggers provide an origin and may thus execute both origin independent and origin dependent commands.
All other types of triggers provide an origin and may thus execute both origin independent and origin dependent commands.


=== Origin independent commands ===
== Origin independent commands ==


Origin independent commands always operate on the same door(s) / controller(s) / external target(s) regardless of how or from where the command is triggered. An example of an origin independent command could be to always unlock the same two doors.
Origin independent commands always operate on the same door(s) / controller(s) / external target(s) regardless of how or from where the command is triggered. An example of an origin independent command could be to always unlock the same two doors.


==== Perform: On doors ====
=== Perform: On doors ===


Choose the command to be executed and the door(s) to operate on.
Choose the command to be executed and the door(s) to operate on.
Line 31: Line 29:
* Override to unlocked
* Override to unlocked
* Release override
* Release override


[[File:command-independent-doors.png|Independent command on doors]]



If ''All doors'' is selected the command will be performed on all of the doors in the [[Delegation|organization]].
If ''All doors'' is selected the command will be performed on all of the doors in the [[Delegation|organization]].


==== Perform: On controllers ====
=== Perform: On controllers ===


Choose the command to be executed and the controller(s) to operate on.
Choose the command to be executed and the controller(s) to operate on.


The available commands are the ones that have been defined for an ''Origin output port'' (see the section on Origin dependent commands below).
The available commands are the ones that have been defined for ''Origin port output'' (see the section on Origin dependent commands below).


[[File:command-independent-controllers.png|Independent command on controllers]]



If ''All controllers'' is selected the command will be performed on all of the controllers in the [[Delegation|organization]].
If ''All controllers'' is selected the command will be performed on all of the controllers in the [[Delegation|organization]].


==== Perform: Externally ====
=== Perform: Externally ===


Construct the API call to be performed by choosing the http method (GET/PUT/POST) and the body of the message.
Construct the API call to be performed by choosing the http method (GET/PUT/POST) and the body of the message.



⚫
==== Perform: Independent sequence ====
[[File:command-independent-externally.png|Independent command externally]]

⚫
=== Perform: Independent sequence ===


A list of origin independent commands to be executed in a given order. Note that if one command fails, the sequence will be terminated.
A list of origin independent commands to be executed in a given order. Note that if one command fails, the sequence will be terminated.



⚫
=== Origin dependent commands ===
[[File:command-independent-sequence.png|Independent command sequence]]

⚫
== Origin dependent commands ==


For origin dependent commands, it matters ''from where'' the command is triggered. The door or controller on which the command operates is dependent on the ''origin'' of the trigger.
For origin dependent commands, it matters ''from where'' the command is triggered. The door or controller on which the command operates is dependent on the ''origin'' of the trigger.
Line 58: Line 70:
An origin is either a door or a controller. Given a door origin, a command that requires a controller, when executed, will be applied on the controller of the door. Given a controller origin, a command that requires a door, when executed, will be applied on each of the doors of the controller.
An origin is either a door or a controller. Given a door origin, a command that requires a controller, when executed, will be applied on the controller of the door. Given a controller origin, a command that requires a door, when executed, will be applied on each of the doors of the controller.


==== Perform: Native door command ====
=== Perform: Native door command ===


Door commands are "native", i.e. are already available in the system, so there is no need to define them before they can be invoked by a trigger.
Door commands are "native", i.e. are already available in the system, so there is no need to define them before they can be invoked by a trigger or included in other commands.


The native door commands are:
The native door commands are:
Line 70: Line 82:
* Release override
* Release override


==== Perform: Origin port output ====
=== Perform: Origin port output ===


Select the target output port and the action that should be performed.
Select the target output port and the action that should be performed.
Line 83: Line 95:
For Pulse, it is possible to set the pulse length in seconds.
For Pulse, it is possible to set the pulse length in seconds.


⚫
==== Perform: Sequence applied on origin ====


[[File:command-dependent-port.png|Dependent command port output]]
⚫
A list of commands of any type to be executed in a given order. The origin will be used for any origin dependent commands in the list. Note that if one command fails, the sequence will be terminated.


=== Performing commands from the administrator GUI ===
=== Perform: Sequence applied on origin ===


⚫
A list of commands of any type to be executed in a given order. The origin will be used for any origin dependent commands in the list.
In most cases, it is possible to perform (or "run") the command straight from its detail page:




[[File:perform-command.png|Perform command]]
[[File:command-dependent-sequence.png|Dependent command sequence]]




Note that if one command fails, the sequence will be terminated.
The exception to this rule is ouput port commands, which need to be started from a controller detail page (see below).

== Performing commands from the administrator GUI ==

=== Origin independent commands ===

Origin independent commands can be performed from their detail page:


=== Commands targeting output ports ===


[[File:perform-command-independent.png|border|Perform independent command]]
Configuring commands that target the output port(s) on one or more controllers is a little complicated. First, it is necessary to configure the command(s) with target ''Output port''. It is necessary to specify which output port the command should act on and what the action should be (''activate'', ''deactivate'', or ''pulse'').


=== Native door commands ===


Native door commands can be performed from a door detail page, where they are called ''Actions''.
[[File:activate-output-port.png|Activate output port]]




[[File:perform-door-actions.png|border|Perform door actions]]


⚫
=== Origin port commands ===


Command(s) with target ''output port'' cannot be performed directly from the command detail page (as it has not been defined which controller(s) they should target). Instead, they can be performed from a controller detail page if the controller has a matching output port configured. The command button(s) will show up under the ''Actions'' section for the controller.
Origin port output commands can be performed from a controller detail page (if the controller has a matching output port configured).


[[File:perform-origin-port-commands.png|border|Perform origin port commands]]


⚫
=== Sequence applied on origin ===
[[File:output-port-buttons.png|Output port buttons]]


A sequence of commands of which at least one is origin dependent can be launched from either a door detail page or a controller detail page.




[[File:perform-sequence-on-origin.png|border|Perform sequence applied on origin commands]]
Another way to perform an output port command is to specify it as the action of a command with target ''Controllers'' and then tie the command to a ''trigger'' (see further below). One example where this could be relevant is if the output port of a specific controller has been directly connected to e.g. an alarm panel and it should be possible to arm or disarm the alarm from any of a number of readers.




Given a door origin, a command that requires a controller, when executed, will be applied on the controller of the door. Given a controller origin, a command that requires a door, when executed, will be applied on each of the doors of the controller.
[[File:controller-command.png|Controller command]]

Latest revision as of 16:41, 13 October 2021

Overview

A command is one or more predefined actions that can either be performed by an administrator or as a result of a trigger being activated.

Some use cases for commands include:

  • Perform an action simultaneously on a set of doors, e.g. block all doors in a section of the building to achieve a "lockdown".
  • Interact with an external system (e.g. arm or disarm an intrusion detection system or turn on the lights).
  • Allow end users to perform an action normally only available to administrators (e.g. unlock a door or return it to schedule).

Origin dependency for commands and relevance for triggers

With origin is meant a door or a controller that forms the context for executing a command. Triggers of the type 'Remote action from overview’ do not provide one, and may therefore only execute commands that are origin independent.

All other types of triggers provide an origin and may thus execute both origin independent and origin dependent commands.

Origin independent commands

Origin independent commands always operate on the same door(s) / controller(s) / external target(s) regardless of how or from where the command is triggered. An example of an origin independent command could be to always unlock the same two doors.

Perform: On doors

Choose the command to be executed and the door(s) to operate on.

The available commands are:

  • Grant access
  • Override to blocked
  • Override to double locked
  • Override to locked
  • Override to unlocked
  • Release override


Independent command on doors


If All doors is selected the command will be performed on all of the doors in the organization.

Perform: On controllers

Choose the command to be executed and the controller(s) to operate on.

The available commands are the ones that have been defined for Origin port output (see the section on Origin dependent commands below).


Independent command on controllers


If All controllers is selected the command will be performed on all of the controllers in the organization.

Perform: Externally

Construct the API call to be performed by choosing the http method (GET/PUT/POST) and the body of the message.


Independent command externally

Perform: Independent sequence

A list of origin independent commands to be executed in a given order. Note that if one command fails, the sequence will be terminated.


Independent command sequence

Origin dependent commands

For origin dependent commands, it matters from where the command is triggered. The door or controller on which the command operates is dependent on the origin of the trigger.

One example of an origin dependent command is to unlock a door by entering a special code on its associated reader.

An origin is either a door or a controller. Given a door origin, a command that requires a controller, when executed, will be applied on the controller of the door. Given a controller origin, a command that requires a door, when executed, will be applied on each of the doors of the controller.

Perform: Native door command

Door commands are "native", i.e. are already available in the system, so there is no need to define them before they can be invoked by a trigger or included in other commands.

The native door commands are:

  • Grant access
  • Override to blocked
  • Override to double locked
  • Override to locked
  • Override to unlocked
  • Release override

Perform: Origin port output

Select the target output port and the action that should be performed.

Note that not all controllers have all IO ports (e.g. Axis A1001 only has IO1 and IO2) so it is necessary to know which type of controller that will be used when specifying the output port of the command. It is also necessary to configure the IO ports of the controller.

The available actions are:

  • Activate
  • Deactivate
  • Pulse

For Pulse, it is possible to set the pulse length in seconds.


Dependent command port output

Perform: Sequence applied on origin

A list of commands of any type to be executed in a given order. The origin will be used for any origin dependent commands in the list.


Dependent command sequence


Note that if one command fails, the sequence will be terminated.

Performing commands from the administrator GUI

Origin independent commands

Origin independent commands can be performed from their detail page:


Perform independent command

Native door commands

Native door commands can be performed from a door detail page, where they are called Actions.


Perform door actions

Origin port commands

Origin port output commands can be performed from a controller detail page (if the controller has a matching output port configured).

Perform origin port commands

Sequence applied on origin

A sequence of commands of which at least one is origin dependent can be launched from either a door detail page or a controller detail page.


Perform sequence applied on origin commands


Given a door origin, a command that requires a controller, when executed, will be applied on the controller of the door. Given a controller origin, a command that requires a door, when executed, will be applied on each of the doors of the controller.

Retrieved from "https://support.telcred.com/documentation/index.php?title=Commands&oldid=1329"