Skip to main content
Alarm and sleep management guide

EdgeVis includes a powerful alarm management system that allows users to create alarm rules that perform actions and notify users.

Updated over 5 months ago

Introduction

EdgeVis includes a powerful alarm management system that allows users to set alarm rules that perform actions (e.g. start recording) on a desired alarm trigger and then use the server’s communication abilities to notify the appropriate users. Additionally, it is possible to apply a weekly schedule to all alarm rules that can easily arm/disarm the alarm system.

R-Series encoder can further enhance their alarming capability by utilising low-power sleep modes in order to save battery power. While both features can be used independently, for R-Series encoders the combination of both allows for long-term battery-based deployments that utilise sleep modes to conserve battery and alarm rules to waken the encoder during periods of activity.

EdgeVis has two features that allow for sophisticated alarming capabilities:

  • Sleep Modes
    Some specialist encoders (e.g. HD-R700, 4K-R800) have additional power-saving capabilities that allow users to deploy battery-powered encoders for longer periods of time by putting encoders to ‘sleep’ during periods where situational awareness is not required. While it is possible to use a specific time to wake an encoder, the normal mode of operation is to use an alarm rule (and external trigger) to detect the local conditions that should awaken the encoder, ready for operational use (e.g. an intruder has triggered a ground sensor).

  • Central Alarm Management
    EdgeVis contains a unique and sophisticated rule capability that allows users to create and manage alarm rules centrally. These rules are automatically sent to encoders. The encoder will then monitor the desired alarm triggers, match them against a set of user-definable rules and, if matched, perform alarm actions on the encoders and alert end users that a rule has been matched.

While both features can be used independently (and are both documented in the following sections) the combination of both allows for long-term battery-based deployments that utilise sleep modes to conserve battery and alarm rules to waken the encoder during periods of activity.

EdgeVis alarm management

EdgeVis Server contains a central alarm management service that monitors incoming alarm triggers from encoders, matches them against a set of user-definable rules and, if matched, performs alarm actions on the encoders and notifies end users that a rule has been matched.

These rules are stored and managed on EdgeVis Server, with a simple rule editor built into the server’s web management interface. It allows users to create rules that follow this simple logic:

Example rule

Individual encoders support different kinds of triggers and actions; the rule editor will automatically detect the encoder's capabilities and settings to ensure only valid options are shown to the user.

Note: Users with EdgeVis Server 7.2 or older utilise EdgeVis Client to edit alarm rules. This article covers EdgeVis Server 7.3 and above.

Sample use cases

The following sample rules provide examples of the different ways the alarm management rules can be utilised.

Example 1 - Sending an SMS to a security guard when a SafeZone-edge camera alerts

Example 2 - Send all team members an iPhone alert if the encoder is overheating

Example 3 - Start recording and move the camera to preset 2 if RDC ground sensor 1542 detects a vehicle

Utilising alarm management

There are a number of steps a user must perform to create alarm rules:

  1. Configure and connect the encoder to EdgeVis Server
    The encoder must be online to create rules

  2. Using the EdgeVis Server web interface, configure the encoder and enable alarm triggers/sensors as required
    This ensures that the rule editor will add each trigger/sensor to the list of available alarm triggers

  3. Using the EdgeVis Server web interface, ensure any users (who are to be notified) have the appropriate communication options and preferences set.
    This ensures
    the system knows how to contact each user when required

  4. Create alarm rules using the EdgeVis Server web interface
    Finally, create the rules that will trigger when required, and then perform the appropriate actions

The following sections explain each step in further detail.

Note: To utilise all of the communication capabilities within EdgeVis Server, the System Administrator may need to configure the appropriate settings for e-mail, SMS, and push notifications using the EdgeVis Server web interface. Refer to the article EdgeVis Server Setup Guide Chapter VI: Advanced Server Configuration -> Messaging Configuration.

Step 1 – Configure and connect the encoder to EdgeVis Server

To create an alarm rule on EdgeVis Server it is necessary to connect the encoder to the server. This is done in the normal way by:

  • creating an encoder account within EdgeVis Server

  • configuring the encoder to connect to the server using the newly created encoder account

Step 2 – Enable alarm triggers/sensors as required

Once the encoder is connected to the server it is usually necessary to enable the alarm triggers and sensors that will be used within any desired alarm rule.

Within the EdgeVis Server web interface open the encoder’s configuration page. In the Lifecycle Management section, select Alarm triggers, to present the alarm trigger options for your encoder model.

Some triggers are always on (e.g. a camera disconnected alarm), while some have options within the encoder configuration options (e.g. enabling RDC ground sensors).

For triggers with configuration options, these must be enabled for the appropriate option to appear within the Rule Builder interface

Illustration of configuration interface

Step 3 – Set communication options for users

While a user is running EdgeVis Client they will always receive a notification in-app when a rule is matched. Additionally, users can enable additional notifications methods when they are not running EdgeVis Client:

  • E-mail notifications

  • SMS text messages

  • Mobile (iOS/Android) push notifications

If enabled on the server, a user can choose to be notified using any or all of these options. Before creating a rule, it is advisable to edit the users who will receive alarm notifications to enter the appropriate contact details.

Note: Be aware that each of these services will send alarm notifications through third-party services. Digital Barriers cannot guarantee the security or speed of delivery of any notifications sent through these mechanisms.

To edit a user’s communications options:

  1. Find and select the user within the EdgeVis Server web interface. The top section of the user’s page shows three options that allow the user to customise how they receive notifications.

  2. The first option (SMS) allows the user to receive any EdgeVis notifications via an SMS text message. If desired, click the SMS icon, enable SMS, and enter a phone number that should receive the text message. These SMS are sent by the server (and not the encoder).

  3. The second option (Email) allows the user to receive notifications by e-mail. If desired, click the Email icon, enable email, and enter an email address that should receive the message. These emails are sent by the server (and not the encoder).

  4. Push Notifications operate differently and are automatically enabled on each mobile device the user logs in with. As long as the user enables push notifications for the EdgeVis Client app during installation, receipt of notifications is enabled automatically for every server the user connects to. By default, the user does not have to take any action to receive these notifications.

Illustration of configuration interface

However, sometimes it is desirable to disable notifications for a server. This can be done by modifying the list of devices from the Push Notifications page. This lists all devices the user has registered to receive alerts.

Untick the Enabled column to disable alerts for a specific device. For devices no longer in use, it is possible to tidy up this list using the Delete tick box – but be aware that if the device reconnects at a later date notifications will be automatically re-enabled.

Illustration of configuration interface

A user configured for multiple communications methods will be contacted via each method when a rule is matched.

Note: To utilise all of the communication capabilities within EdgeVis Server, the System Administrator may need to configure the appropriate settings for e-mail, SMS, and push notifications using the EdgeVis Server web interface. Refer to the article EdgeVis Server Setup Guide Chapter VI: Advanced Server Configuration -> Messaging Configuration.

Step 4 – Creating and editing rules using EdgeVis Server

Once the prerequisite steps have been carried out, a user with the appropriate role/permissions can now create alarm management rules. This user must have a role that contains the ‘Edit the encoder's alarm rules’ permission against the desired encoder.

Within the EdgeVis Server web interface open the encoder’s configuration page. In the Lifecycle Management section select Alarm rules to present the alarm rules currently assigned to the encoder (if any).

Illustration of configuration interface

Existing rules will be listed, with both a user-supplied ‘friendly’ name and an auto-generated summary of the rule.

Note: To properly add/edit rules the encoder should be online and connected to the server. This allows the server to know exactly how the encoder is configured, and to program the resultant rules on the encoder.

To create a new rule, select the Create Alarm Rule button.

Illustration of configuration interface

This presents three initial options:

  • Name
    A user-supplied ‘friendly’ name is used when listing rules. This name can also be used in later steps when creating template notification messages.

  • Enable rule
    Enabled by default, this allows users to disable rules temporarily without the need to delete them. This is useful when debugging troublesome rules, or when rules are only required during specific periods of time.

  • Add alarm trigger
    Every alarm rule requires at least one trigger.

On selecting Add alarm trigger the resultant dialog will show the various categories of trigger inputs supported by the encoder – this list will differ depending on the capabilities of the encoder:

Illustration of configuration interface

The list will contain a number of these trigger types:

  • Environmental Alarms
    A special category of alarm triggers that are sent automatically should the encoder detect an anomaly during normal operation. These include high or low temperature, high or low voltage, camera disconnects, etc. These triggers cannot be detected from a low-power state and cannot be combined with other triggers.

  • Contact triggers
    If available (e.g. the 4K-R800 has 5) contact triggers, which can be configured to act on normally open, normally closed, or any state change that is then wired up to external triggers (e.g. PIRs or pressure pads).

  • Tampers
    These are physical tampers that are either built into the encoder (e.g. the 4K-R800 has a ground sensor tamper and a lid tamper that is activated if the lid is removed) or wired up for external devices. These trigger when the encoder detects an attempt to interfere with the deployed system.

  • Ground Sensors
    The ground sensor triggers allow the system to match rules from RDC, 7-Tech (4K-R800 only), or QualTron (4K-R800 only) ground sensors. The rule can match a specific type of event such as Alarm, Tamper, Person Detect, etc., or any event type. It can also match against a specific sensor node ID or any node ID. These triggers can be matched from any power state on an SD-R500, HD-R700, and 4K-R800.

  • Analytics
    This trigger can be used to activate a rule with Safezone-2D start/end detection events. This trigger cannot be matched from a low-power state. In order to make use of this from a low-power state, a contact trigger or ground sensor would have to wake the system first to start the analytics. See the Run Analytics action for more information on how this can be achieved. The analytics must be licensed, configured, and enabled on each desired video channel before it can be used.

  • IP Camera alarms
    This trigger can detect alarms from an Axis IP camera. This trigger cannot be detected from a low-power state.

If any of the above categories are not presented when adding a trigger then the capability is not available on the encoder. If the category is greyed out then the encoder requires the user to enable the appropriate settings (e.g. if Ground Sensors is disabled then the user must enable ground sensors in the Alarm Triggers section).

Upon selecting a category, the next section will display a list of available triggers or sub-options (again greyed out if not currently enabled). For example, selecting Tamper will display the encoder’s tamper triggers:

Illustration of configuration interface

Some options include further sub-options. For example, by selecting Ground Sensors it is possible to further customise the trigger parameters.

Illustration of configuration interface

For Ground Sensors it is possible to narrow the detection criteria to:

  • Any node, a specific node (from the automatically detected list of nodes), or manually enter a node ID.

  • Any type of seismic detection type, a specific detection event (e.g. vehicle or person detection), or an environmental event.

Adding multiple triggers to an alarm rule

It is possible to add multiple triggers to an individual rule. This allows triggers to be chained together to create what is commonly referred to as an AND rule. For example, IF (trigger 1 is activated) AND (trigger 2 is activated) then the rule should fire.

Illustration of configuration interface

By default, when adding multiple triggers, they must fire in the order they are added. In the above example, trigger 1 must fire FIRST, and then trigger 2 must fire within 5 seconds to be considered a match. Use the arrows at the side of the trigger to reorder the triggers.

It is possible to change the trigger processing behaviour by clicking the Must be triggered… message above the triggers.

Illustration of configuration interface

This allows the user to:

  • Change the triggers processing to allow multiple triggers to be matched in ANY order

  • Maximum activation period
    The maximum time in which all selected triggers must fire to be counted as a match

  • Minimum activation period (can only be set when two triggers are selected)
    A time that must elapse between both triggers being activated.

The main benefit of using a minimum activation time is to minimise false alarms, as this takes into account how quickly a person/vehicle can move from one sensor to another – two sensors triggering at the same time shouldn’t be humanly possible.

For example, when trying to detect a person approaching on a path, a combination of two ground sensors can eliminate false detections (e.g. people moving around inside the area being protected)

Detection sequence illustration

By placing a second sensor 50-100m outside the perimeter, a rule can be created that says:

Only alert if:

  • Ground sensor 1 detects a person
    AND a minimum of 10 seconds later, but no later than 30 seconds later…

  • Ground sensor 2 detects a person

This should now only alert if a person approaches the perimeter but will ignore people who are walking inside the area (as trigger 1 doesn’t alert), and people who walk past outside without approaching (as trigger 2 doesn’t alert).

For the desired rule select the trigger type and any desired options. This should then extend the rule page to include two new sections: ACTION(S) and NOTIFY:

Illustration of configuration interface

The purpose of these sections is:

  • DO ACTION(S)
    Depending on the encoder’s capabilities, there are numerous actions that an encoder can perform locally when a rule is triggered. Examples include moving the cameras to a predetermined PTZ preset, starting video recording, and switching a relay.

  • AND NOTIFY
    When an encoder alerts the server that a rule has been triggered, the server can also pass that alert on to any users configured to receive the alert. The server has a number of different mechanisms to deliver that alert including SMS text message and e-mail.

Both of these sections can contain multiple items; however, it is necessary to add at least one item in at least one of these sections – otherwise, the rule has no output!

Adding actions to an alarm rule

The following list explains the various actions that are possible to add to a rule - many of which revolve around recording. Most encoders have two recording modes (visible within the encoder’s configuration page under Recording settings):

  • Always record
    The encoder will record 24/7 and no alarm action can override this behaviour. It is important to note that this mode also has power implications if using sleep modes, as the encoder will likely use a higher power mode to ensure recording continues, even when sleeping.

  • Record on alarm action
    The encoder, in normal operation, is not recording. To start and stop recording the appropriate alarm action must be used when an alarm triggers.

The encoder must be configured appropriately to ensure the desired alarm actions behave as expected.

Action Name

Action undertaken

Notes/pre-requisites

Start recording

Start recording all enabled video channels for the duration of the action or until stopped. Note this action only has an effect if the recording is not enabled. Specify a pre-roll duration of up to 1 minute and, optionally, a recording duration of up to 12 hours.

Only has an effect if the encoder’s recording mode is configured to Record on alarm action. If this action is triggered from a sleep state the encoder will wake up, record for the desired duration and then return to a sleep state.

Stop recording

Stop recording after a previous Start recording alarm action. Specify a post-record duration of up to 1 hour.

Only required if a previous Start recording action was performed with the Until stopped option selected.

Override recording quality

Override the current recording quality setting for a fixed duration (up to 12 hours) or until cleared. Parameters are Video Channel, Duration of override, and High/Low recording quality.

Does not start recording so may need to be used in conjunction with a Start Recording action if on-demand recording is being used.

Clear recording quality

Clear a previous Override recording quality action and revert this video channel to the configured recording quality. Specify a delay in clearing up to 1 hour. Parameters are Video channel and Delay before clearing the quality.

Only has an effect if a previous Override recording quality action has been used.

FTP push recordings

If configured to record (using either Always record mode or via a recording action), push recordings to a local FTP server. Specify a pre-roll time up to 1 minute before and a post-roll time up to 1 hour after the trigger. The FTP push location can be configured on the Alarm Triggers page.

This action only has an effect if recordings exist for the specified time period. This action may need to be combined with a Start recording action if the Record on alarm action recording is being used.

Erase recordings

Erase all recordings on all attached recording disks.

Switch relay

Switch a relay for a duration up to 12 hours.

Can be performed directly from the low-power management processor so does not require a full encoder wakeup to perform.

Switch power output

Switch a power rail (e.g. for an attached camera) for a duration of up to 12 hours

Can be performed directly from the low-power management processor so does not require a full encoder wakeup to perform.

Switch live input

Configure the encoder to use the specified video input for remote transmission

The setting change does not revert after a period requiring manual reconfiguration to change.

Move to PTZ preset

Issue a PTZ 'go to preset' command to the specified camera.

Performed after the system has fully started up. It may need to be combined with a Switch power output action if the camera is being powered from the encoder.

Send an SMS

Send an SMS message using the cellular modem on this encoder.

The modem must be enabled and configured in order for this action to be processed. The SIM card used must be capable of sending SMS (which is not true for many data-only SIMS).

Erase configuration

Erase all identifying configurations from this encoder, including server address, encoder name, and passwords. The encoder will no longer connect to the server.

THIS ACTION CANNOT BE UNDONE AND WILL REQUIRE PHYSICAL ACCESS TO CONFIGURE THE ENCODER'S SETTINGS.

Run Analytics

Use this action to wake the encoder and perform a period (up to 1 hour) of video analytics before returning to sleep. This allows the user to use video analytics to provide secondary verification.

See the Using Safezone-2D for secondary verification section for more details.

Ensure video analytics are enabled and configured in advance.

Use a separate rule to capture any detection triggered by the video analytics.

Has no effect if the encoder was not sleeping before the alarm was triggered.

Override wakeup time

When a notification is added to an alarm rule a sleeping encoder will stay online for 10 minutes when triggered (before returning to sleep) to allow time for a user to view the video. Use this action to override the default timeout (10 minutes) to a time between 1 second and 1 hour.

Adding notifications to an alarm rule

The final section in an alarm rule allows a user to send a notification that the rule has triggered to any number of EdgeVis users. There are four options:

Illustration of configuration interface
  • Alert system users and groups
    For most users, Alert system users and groups will be the correct option as it will use the user contact preferences stored on EdgeVis Server when alerting a user (as configured previously in Step 3). Using this option saves the user (creating the rule) from having to know every recipient’s contact details – simply tell EdgeVis to alert the required user(s)/group(s) and EdgeVis Server will send them an alert to every communications method enabled for their account. This can include either sending them a push notification, an SMS text message, or an e-mail depending on their contact preferences.

  • Send an SMS to a specific number
    Allow an SMS text message to be sent directly to a supplied phone number without needing to create an EdgeVis user account.

  • Send an e-mail to a specific address
    Allow an e-mail to be sent directly to a supplied e-mail address without needing to create an EdgeVis user account.

  • Send a message to a Webhook
    Use the Webhook standard to send the notification to a third-party web service. Please refer to the article – Sending alarm notifications using Webhooks for further details.

Select the desired notification method, and enter the desired recipients:

Illustration of configuration interface

It is then possible to enter a free-form message (and subject for e-mail), while using special tags to perform a smart activation-time replacement within the message. To insert one of these special tags into your message, select the tag below the text entry field:

Illustration of configuration interface

There are a number of aspects to be aware of when utilising notifications:

  • Any entry under the notify section requires that the encoder can initiate a communications link (if not currently active) and is able to connect to the server. The encoder will inform the server that an alarm rule has been matched and then EdgeVis Server will send any alerts/SMS/e-mails as necessary.

  • The encoder will hold onto any notification if it is unable to send it (for example it is unable to establish a communications link). As soon as the encoder manages to regain a connection to the server, it will send any unsent notification that it is currently holding. No notifications are lost, if the encoder temporarily loses its connection.

  • There are potentially three different ways to send an SMS text message – as an alarm action using the encoder’s cellular connection, to an EdgeVis user (as part of their contact preference), and using Send SMS to a specific number. Ensure that the correct method is used based on deployment requirements.

  • EdgeVis does not limit the number of e-mail and SMS messages sent. There may be additional costs associated with using these services – it is up to the System Administrator to monitor the usage of these third-party services.

Notifications and battery/sleep users

Users who normally put their encoders to sleep can use a notification to keep the encoder awake for a short period of time (default - 10 minutes), to allow time for a user to:

  • Receive the notification

  • Start EdgeVis Client

  • Connect to the encoder remotely and review any necessary live video/recordings.

After 10 minutes the encoder will return to sleep – this can be overridden by any EdgeVis Client viewer (currently viewing the video stream), who can utilise an on-screen prompt to extend the sleep timeout by another 10 minutes.

On supported encoders/firmware, the Override wakeup time action can be added to a rule, in order to change the initial 10-minute timeout to any value between 1 second and 1 hour.

Using the same triggers/actions in multiple rules

Be aware that the alarm management system will allow users to create rules that contain triggers, actions, or notifications that are already referenced in other rules.

Additionally, should the same trigger be reused in multiple rules it will match with every rule – it does not stop processing rules on a first match.

This can create circumstances where two users can create competing rules – e.g. have two rules that fire on the same trigger but set the camera to different PTZ preset positions. It is up to the user to review existing rules and actions to ensure that the system behaves as expected.

Using Safezone-2D for secondary verification

On encoders with Safezone-2D capabilities, it is possible to use a combination of two different triggers to help eliminate false positives.

For example, a user who has deployed ground sensors may find that they are unable to place the sensors in a location that only captures the desired intrusion and will occasionally trigger incorrectly - generating a false positive alert. In this scenario using a combination of triggers can help. For example, in this ground sensor scenario, both of the following alarm rules would be useful in determining if an intruder is approaching:

  • Alert when the ground sensor detects a person 200m away from the perimeter

  • Alert when a perimeter camera (using Safezone-2D) detects a person approaching the entrance

Used individually, both rules could be fooled - by people passing by the ground sensors, or if someone steps outside the entrance. The combination of both rules would help eliminate false positives, by only alerting if the ground sensors detect a person, followed by the Safezone-2D alert of a person near the entrance.

On a mains-powered deployment, it is possible to add both of the triggers into one rule, by setting a minimum/maximum activation time to ensure the Safezone-2D detection happens at an appropriate time after the initial ground sensor trigger.

However, on a battery deployment, the encoder is normally asleep, making it impossible to use Safezone-2D unless the encoder is powered (and using a significant amount of power). The next section describes how to achieve the same effect.

Using Safezone-2D on a battery deployment

In a normal battery deployment, it is usual that the encoder is put to sleep to conserve battery, and is preconfigured with a set of rules that:

  • Wake the encoder on an appropriate trigger (e.g. ground sensor)

  • Perform some actions (e.g. record a video clip, move to a PTZ camera position)

  • Alert the user

  • Return to sleep

This assumes that most triggers are external to the encoder and use minimal power. However, using the Safezone-2D video analytics is quite power-hungry, as it requires the cameras to be powered and the encoder to be performing computationally expensive analysis – potentially using many Watts.

For this reason, it is not possible to use Safezone-2D when the encoder is sleeping. To do so requires using another trigger, such as a ground sensor, to wake the encoder up first. To utilise Safezone-2D on a battery deployment we recommend the following steps:

  • Create alarm rule 1

    • Add the ground sensor (or another physical trigger) as the only trigger

    • Add the Run Analytics alarm action, with a desired duration. This duration is the time to allow the encoder to perform video analytics, before returning to sleep.

  • Create alarm rule 2

    • Add Safezone-2D as the only trigger

    • Add any desired actions (e.g. record video, move to PTZ position) and user notifications

In this scenario rule 1’s only purpose is to keep the encoder awake for the period required to perform video analytics, before returning to sleep. Rule 2 is the rule that should be used to perform ‘actions’.

Scheduled actions

While alarm rules require an external event to trigger the rule, it is also possible to create a list of actions/notifications that happens to a specific schedule. To view a list of an encoder’s scheduled actions, select the Scheduled actions item from the encoder configuration page in EdgeVis Server.

Illustration of configuration interface

Creating scheduled actions is very similar to creating alarm rules, and swapping alarm triggers for scheduled timers. The action and notification options are identical to the options described in the previous sections, and it is possible to have multiple alarm rules and scheduled actions assigned to an encoder.

Scheduled actions can be set to occur:

  • Every hour (at a specified minute)

  • Every day (at a specified time)

  • Every week (on a specific day, at a specific time)

Note: It is possible that the user and encoder are in different time zones. On each page within Scheduled actions, the user should check which time zone the encoder is located within. Any times set are all relative to the encoder’s time zone, so any offset from the user’s local time zone is displayed when editing rules.

Scheduled actions are more commonly used to perform maintenance tasks (like sending a confidence SMS or resetting a camera PTZ position). They will also temporarily waken a sleeping encoder if necessary; perform any configured actions, before returning to sleep.

Monitoring alarm alerts

Once the desired alarm rules have been created the next step is to monitor the encoder for alarm alerts. Once the alarm event conditions for a rule have been matched EdgeVis Server will send alerts in accordance with the instructions within the rule.

For example, a user who has SMS enabled in their contact details will receive an SMS containing the message set by the creator of the rule:

Illustration of configuration interface

Alerts within EdgeVis Client

A user who is running EdgeVis Client will be aware of any incoming alarm alerts by monitoring the Alerts pane. This is available on both the EdgeVis Client home page or by selecting a layout with an Alert pane.

Illustration of configuration interface

The Alert pane will display both historical alerts and any new alerts. If there are more than 30 historical alerts, then the first 30 are displayed. Alerts have three different states:

  • New

  • Acknowledged

  • Closed

By default, the Alert pane only displays New and Acknowledged alerts (this can be changed from the Settings cog at the top-left of the pane).

When an alert is added to the list only a summary is displayed, showing the subject entered when the rule was created. For fuller details on the alert, including what event triggered the event click the small down arrow on the right of the alert – this will expand the alert:

Illustration of configuration interface

Changing an alert state

When a user receives an alert, they can signal to other users that they are dealing with the alert by changing the state from New to Acknowledged. Click on each alert to be acknowledged then select the Change to Acknowledged button. This will change the state of every selected alert – EdgeVis Server will then update all other running EdgeVis Client users with the live state of the alert.

Similarly, the user can then signify that the alert has been dealt with by changing the alert from Acknowledged to Closed.

Bulk changing alert states

It is possible to quickly clear multiple alerts using the bulk change tool. Ensure no alerts are selected, then click the Change All button. This will present a dialog offering the option to bulk change either:

  • All downloaded alerts – EdgeVis Client by default only downloads the last 30 historical events.

  • All historical alerts – even those still on the server.

Illustration of configuration interface

To clear all alerts, it is recommended to perform two steps – firstly convert all New alerts to Acknowledged, and then convert all Acknowledged alerts to Closed.

Bulk changing large numbers of alerts can take some time. The server will work in the background to perform the bulk update and notify the client when complete – any alerts in the Alert Pane will then be updated with the new state.

Auto-playing video based on an incoming notification

It is possible to configure EdgeVis Client for Windows to automatically open a video pane showing the appropriate encoder (and optionally with a map and/or alert panel) when an alarm notification arrives.

This feature is disabled by default and can be enabled from within the Settings menu -> Open video on alert.

Push notifications

iOS and Android users will also receive push notifications to alert users who are not currently running EdgeVis Client. Opening the notification will open EdgeVis Client, automatically selecting the correct encoder video stream to view.

Using schedules to arm/disarm alarm rules

Note: Alarm scheduling is only available on IP Series, 4K-R800, and HD-Q800 encoders running version 8+ firmware.

To allow the use of alarms in environments where the area being protected is not normally quiet/sterile it is possible to set a schedule of when all alarm rules should be armed/disarmed on an encoder. Common examples include warehouses or schools where alarms should not be used during standard opening hours.

It is possible to create two types of schedules within a domain:

  • Weekly recurring schedule
    You define a day/time (to the nearest 5 minutes) when the alarm rules should be armed/disarmed.

  • Exception list
    You define a list of specific dates where the system should override any selected weekly schedule with a whole-day arm/disarmed setting. The primary use case is to ensure that ‘special’ days (such as bank holidays, public holidays, and religious holidays) are treated differently from a standard schedule.

When schedules are applied to encoders in different time zones they will automatically use the local time zone of the encoder. For example, a command to arm the system at 09:00 will always be enacted at 09:00 in the encoder’s time zone - and not the time zone of the server, or the user who created the schedule.

The default setting for all encoders is Always armed with no exceptions, but you can set a new default weekly and exception schedule on a domain-wide basis, and/or specify a specific schedule on an encoder-by-encoder basis.

What does arming/disarming the alarms mean in practice?

From the previous chapter, when creating a rule you will see it is possible to enable/disable any rule individually. Alarm scheduling is an additional feature that arms/disarms an encoder’s alarm rules to a timed schedule. In practice, any alarm rule will only be active when:

  • The alarm rule is individually enabled AND

  • The current time is within the ‘armed’ window of an alarm schedule

If either of these conditions isn’t true then the alarm rule will have no effect. No actions will be performed, and no users will be notified.

Viewing all available weekly recurring schedules within a domain

All schedules are located in the Alarm Scheduling section of the Encoder settings page that is available from a domain’s homepage. This page presents two options - select Weekly schedules to view a list of schedules.

In a new domain, there will be no schedules, and the default setting will be that all encoders will have all their alarm rules armed at all times.

Illustration of configuration interface

Create a new weekly recurring schedule

Use the Create one now link to start creating your first schedule, and then enter a name for your schedule.

The weekly recurring schedule page then allows you to add a day and time (to the nearest 5 minutes) the alarm system on an encoder should be armed/disarmed.

Select the day, time, and the new armed/disarmed state for each point during the week you want to change the arming state.

Illustration of configuration interface

For example, the screenshot above demonstrates how to disarm the alarm during office hours between 09:00 and 18:00. Add an entry at 09:00 on Monday to disarm the system when the office opens, and another entry at 18:00 on Monday to arm it when the office closes. This should then be repeated for the remaining days of the week.

A useful tool to visualise a schedule is the Preview button which will show the list of arm/disarm entries on a weekly calendar grid:

Illustration of configuration interface

Once you have finished editing your schedule, select the Save button – this will add the new schedule to the list of available schedules.

Editing/deleting a schedule

To review the details of a schedule, select the schedule from the list. This will present the details of the schedule that can also be edited. There will also be two additional options:

  • Delete this schedule: remove this schedule from the server if it is not in use. To help with this use…

  • See where this schedule is used: this will show which encoders are using this schedule, split into those using it through the use of the domain’s default schedule, and those that are assigned to it individually.

Viewing all available exception schedules within a domain

All schedules are located in the Alarm Scheduling section of the Encoder settings page that is available from a domain’s homepage. This page presents two options - select Exception lists to view a list of available exception lists.

Illustration of configuration interface

In a new domain, there will be no exception list, and the default setting will be that all encoders will have all their alarm rules armed at all times.

Use the Create one now link to start creating your first exception list.

Creating a new exception list

Use the Create one now link to start creating your first exception list, and then enter a name for your list.

Illustration of configuration interface

There are only two fields per entry. A specific date, and whether to arm/disarm for the entirety of this day. The date is fixed and will not automatically update annually – it is recommended to set an annual reminder to update any exception lists as required.

Any entry will take effect at midnight (encoder local time) and will use the same setting for the entire day, regardless of the setting in the main schedule.

Editing/deleting an exception list

To review the details of an exception list, select it from the list. This will present the list of dates within the list, where you can edit and save any desired changes. There will also be two additional options:

  • Delete this exception list: remove this exception list from the server if it is not in use. To help with this use…

  • See where this exception list is used: this will show which encoders are using this list, split into those using it through the use of the domain’s default exception list, and those that are in use by encoders individually.

Applying a schedule or exception list to an encoder

There are two ways to apply schedules/exception lists:

  • By setting a default schedule/exception list to use for all encoders in the domain.

  • By selecting a specific schedule/exception list for an individual encoder.

Setting a domain default

On the Weekly schedules page there is a Choose default for this domain menu button. This will present a list of weekly schedules which also includes a special Always armed option (which is selected by default).

Illustration of configuration interface

Select the desired default schedule and select Save. This takes immediate effect (and so may change the current arming state of all encoders in a domain). It will not override any individually set schedule on an encoder.

On the Exception lists page there is also a Choose default for this domain menu button. This will present a list of exception lists which also includes a special No exceptions option (which is selected by default). Changing this setting also takes immediate effect on all encoders in the domain that do not have an individually set exception list.

Individually setting the scheduling settings on an encoder

The top of the Alarm rules page (when configuring an encoder) will show the current status of the encoder’s arming state. It will also list the schedule/exception list in use.

Illustration of configuration interface

To change the settings (or to override the domain default) use the Edit button.

Illustration of configuration interface

This page lists both the current schedule and exception list in use, and whether they are the domain defaults.

To override the domain default, change the first option from Inherit domain default to Encoder-specific setting then select the desired item from the second list.

Again saving these options will take immediate effect and may change the alarm state of the encoder.

Saving power using encoder Sleep Modes

Note: Sleep mode is only supported on hardware encoders, but excludes all IP Series encoders.

The power consumption of a typical encoder, cellular modem, PTZ camera, and recording disk is often between 20-50W (and can be even higher). This is not a concern when the deployment is mains powered, however remote deployments usually require batteries to be used to power all equipment.

The challenge is that high-capacity batteries are big and heavy – the size of the battery required to power an encoder 24/7 for months could easily be heavier than two people can carry.

It is unlikely, in most scenarios, that the user is monitoring the video 24/7, meaning that much of the power would be wasted when there is no video of interest to view.

Specialist encoders (such as the HD-R700, 4K-R800), include special ‘Sleep’ states that allow the encoder to operate for extended periods using considerably smaller batteries. It achieves this by following a battery-based deployment strategy:

  • Put the encoder to ‘sleep’ when there is nothing of interest to view/record

  • Utilise external sensors (e.g. ground sensors, PIRs) to wake the encoder when someone approaches

  • The encoder will power, begin recording, bring up its communications bearer, and connection to the server

  • Within a minute or two the end user is able to view live or recorded footage of the incident

  • The encoder will then return to sleep automatically once the requested actions have been undertaken

Low-power management processor

To achieve a ‘sleep’ state, supported encoders include a low-power management processor. It is the only component that is powered when an encoder is put to sleep. Its responsibilities include listening for incoming alarm triggers (including ground sensors), powering the encoder if necessary, and performing simple alarm actions (e.g. switching a relay) without the need to fully power the system.

Encoder power usage levels

There are three different power usage levels an encoder can operate at, depending on how it is configured:

  • Online (standard behaviour) e.g. 4K-R800 ~ 20W + cameras
    Full power, all configured communications enabled, video streaming, recording, and all other features available.

  • Sleep e.g. 4K-R800 ~ 144mW
    Lowest possible power mode. Only the low-power management processor is powered. This can respond to contact triggers and serial triggers to wake the rest of the system.

  • Always Record’ Sleep e.g. 4K-R800 ~ 15W + cameras
    When the encoder is set to Always record mode then this takes precedence when requesting an encoder goes to sleep. The encoder will still accept the request; however, the encoder will power down any configured communications methods but keep any necessary recording component powered (including camera power). This mode can still use a considerable amount of power.

The user only has the menu option to put the encoder to ‘sleep’ and the encoder will select the correct low-power mode automatically – it is the user’s responsibility to ensure the correct recording mode is set to ensure that either Sleep or ‘Always Record’ Sleep is utilised.

Putting an encoder to sleep

It is possible to use either the EdgeVis Server web management interface or EdgeVis Client to control an encoder’s sleep mode..

Within EdgeVis Client, open the video stream, and from the Settings menu, select Change sleep state…, or from EdgeVis Server, open the encoder’s configuration page and select Sleep configuration. EdgeVis Client only offers the ability to set the encoder’s sleep mode, while EdgeVis Server offers some additional configuration options to customise the encoder’s behaviour.

Illustration of configuration interface

Within EdgeVis Server use the Put to sleep menu option to change the encoder’s sleep mode:

Illustration of configuration interface

By default, the encoder will sleep forever, only waking up to deal with any alarm triggers/rules, before returning to sleep. This is the default mode for sleep (Wake on alarm) and cannot be disabled.

An additional option is available for battery deployments where 24/7 operation is required - but only after a certain point in time: Wake after set time

This allows the user to wake the encoder permanently after a certain time and date – this will cancel sleep mode entirely. This is useful to save battery in the period between deployment, and the time it will be required.

Using alarms rules to wake an encoder

While putting an encoder to sleep will save power, the other important step to properly utilise a battery-powered deployed encoder is to create alarm rules that wakes the encoder when required.

This will require the use of deployment-appropriate alarm triggers and sensors including:

  • Ground sensors

  • Trigger inputs (including PIRs, pressure mats, and magnetic switches)

The next chapter outlines the steps required to create alarm rules within EdgeVis – for deployments utilising sleep it is a requirement to create the necessary rules, using the above sensors, to waken the encoder.

Note: It takes approximately 60 seconds for an encoder to wake from sleep. Please ensure the placement of sensors is far enough away from the camera to ensure the person of interest is still within the camera’s field of view once the encoder is powered.

Cancelling sleep manually, and encoder nap time

It is possible to cancel Sleep mode. Within EdgeVis Server the menu option to Put to sleep changes to Wake at the next check-in for sleeping encoders (with similar options within EdgeVis Client’s Change Sleep settings… page). Selecting this option will cancel any sleep mode and return the encoder to an Online state.

However, this will not happen instantly - as described earlier, the encoder has powered down most of its systems and has no means to receive this cancellation. In order to allow sleep to be cancelled, the encoder only sleeps for short durations (naps), before waking up and periodically checking in with the server to check:

  • if sleep should be cancelled

  • if there are configuration changes (e.g. have the alarm rules changed).

It is only during a check-in that a sleep can be cancelled. The Sleep configuration page will display the next check-in time for a sleeping encoder.

Illustration of configuration interface

Additional sleep options

Within the Sleep configuration page, there are two additional options available which can be employed:

  • Check-in overdue threshold
    Should the encoder fail to connect to the server when expected, it will send a maintenance alert to the configured administrators/users that the encoder is overdue. By default, the server will wait 60 minutes before alerting; this can be configured to any time between 1 and 60 minutes.

  • Nap time
    This is the length of time that the encoder will periodically power up and check in with the server. This option can be programmed up to a maximum of 24 hours.

These settings can be configured at three different levels:

  • Server level (Home page -> Advanced server settings -> Encoder settings -> Encoder sleep settings)
    These apply to all encoders on the server unless overridden at the domain or encoder level

  • Domain level (Domain home page -> Encoder settings -> Encoder sleep settings)
    Setting at this level allows for domain-specific settings that can override the server defaults, while still allowing individual encoder configuration.

  • Encoder level (Encoder configuration page -> Sleep configuration)
    Setting at this level will override any server or domain-level setting

Once configured at a lower level any changes made further up have no effect on the encoder.


Did this answer your question?