Device Enumerations

Device Enumerations

This feature was released with webeyeCMS v3.0 - View the release notes

Device Enumerations

Overview

Device enumerations are a replacement for the outdated and non functional device peripherals system. Device enumerations are configured with names and can be muted individually.

View Device Enumerations

By Site

The device enumeration page can be accessed by selecting 'Enumerations' either by a site's related devices page:



Or by the site summary found within Manage:



Once accessed, you will be able to manage enumerations for the device selected. Actions that can be performed on enumerations are: add, delete, update, mute and unmute. A brief description of the device is available, with the option to mute or unmute the device.


By Alarm

Enumerations

Device enumerations can be accessed when viewing an alarm by selecting the 'Enumerations' tab. The tab is located within the 'Devices on site' section.

Accessing the 'Enumerations' tab will list the enumerations for each device that is associated with the alarm.


Signals

Signals that are received from a configured enumeration for a device will display their name throughout webeyeCMS.

Names are recorded and associated when a signal is received, updating the name at a later date will not have any effect on previous signals.



Manage Device Enumerations

Types

Currently there are 3 types of enumeration:
  1. Blind peripheral
  2. Video peripheral
  3. Access entry
These are indicative of the type of enumeration attached to the alarm system.

For example, a camera would be a video peripheral, a door contact would be a blind peripheral and an access code would be an access entry.

Further types of enumeration may be added in future.

Reservations

Different alarm systems have different index systems. Each index system has its own set of requirements for enumerations.

Reservations are used to handle these requirements for each alarm system.

A reservation will reserve a specific index for a specific enumeration type.

An enumeration cannot be created if a reservation for the index and enumeration type exists. In other words, an enumeration cannot be created if it matches an existing reservation.

In most cases, reservations are created automatically based on the alarm system type.

Reservations can be viewed by applying the 'Display reserved' filter on the device's enumerations management page.

Add

To add a new enumeration to a device, access the device's enumerations management page and press the 'Add new enumeration' button. An enumeration form will appear.


Type

The type of enumeration to add. This will relate to the peripheral or code being recorded.

Index

The index of the enumeration will be the allocated slot where the peripheral or code is recorded on the alarm system. Usually, the index will relate to the order that peripherals or codes were added to the system.

It is important that the index is correct because a signal will be associated with an enumeration using the index provided. If an enumeration index is incorrect, signals may become incorrectly named.

For example, a Videofied system may have a keypad using index 1 (the first peripheral associated), and a door contact using index 2 (the second peripheral associated).

Where possible, we recommend obtaining a full list of peripherals along with their indexes from the alarm system prior to setting up enumerations.

The index may vary by the type of alarm system. Please consult your alarm system's manual to determine the correct indexes.

Name

The name of the enumeration will usually relate to the peripheral or code being recorded, however any name can be set.

The name will be associated with signals received from the enumeration and be displayed throughout webeyeCMS.

Reserved Index

Some types of alarm system will also require a reserved index for specific enumeration types.

This applies where the type of alarm system requires a reservation to be created, but the reservation cannot be automatically determined.

The only alarm system that currently requires this is Videofied.

Videofied has a separate enumeration index system for blind peripherals and video peripherals, while video peripherals require a reservation for a blind peripheral.

Please see the following table for an example of a Videofied system:

Enumeration Type
Enumeration Index
Enumeration Name
Is a Reservation?
Blind peripheral
1
Front Door Keypad
No
Blind peripheral
2
Front Door Contact
No
Blind peripheral
3
Kitchen Camera
Yes
Video peripheral
1
Kitchen Camera
No
Blind peripheral
4
Hallway Camera
Yes
Video peripheral
2
Hallway camera
No

As the table demonstrates, the Kitchen Camera has a video peripheral index of 1, but a blind peripheral index of 3.

In this case the video peripheral index would be entered in the 'Index' field and the blind peripheral index would be entered in the 'Reserved Index' field.

The blind peripheral index cannot be automatically determined, so must be provided as the 'Reserved Index'.



After filling in the required information for the enumeration, selecting 'Add' will save the enumeration.

Update

To update an enumeration, access the device's enumerations management page, choose an enumeration and select the 'Update' button. An update form will appear.

Only the name of the enumeration can be updated. To update the type or index, delete the enumeration and then create a new, updated enumeration.

Selecting 'Confirm' will update the enumeration.


Delete

To delete an enumeration, access the device's enumerations management page, choose an enumeration and select the 'Delete' button. A confirmation request will appear.

Selecting 'Confirm' will delete the enumeration.


Bulk Actions

Bulk actions allow a specific action be performed on multiple enumerations at the same time.

The following bulk actions are available:
  1. Delete
  2. Mute
  3. Unmute
To perform a bulk action, access the device's enumerations management page, check the boxes next to the enumerations you want to perform the action to, then select the 'Bulk actions' button. An action form will appear.

The checkbox in the table header can be used to select and deselect all enumerations, as required.





After selecting 'Confirm', the chosen action will be performed to all selected enumerations.

Permissions

Any user can view device enumerations.

To add, update and delete enumerations, the user must have the 'Device management' permission.

Audits

Each change to enumerations is audited against the device.


Mute Device Enumerations

Please note it may take up to 2 and a half minutes for an enumeration mute or unmute to take effect.

Effect

Muting a device's enumeration will prevent alarms being generated in response to signals from the enumeration.

Signals received from the muted enumeration will still be recorded and will be available to view via device reporting.

Signals received from other, non-muted enumerations will generate alarms as normal.

By Site

Mute

To an mute an enumeration via a site, access the device's enumerations management page, find the enumeration and select the 'Mute' button. A mute form will appear.

The mute length can be chosen using the a predefined option, or a custom amount of time. After selecting 'Confirm' the enumeration will become muted.


Unmute

To an mute an enumeration via a site, access the device's enumerations management page, find the enumeration and select the 'Unmute' button. A confirmation request will appear.

After selecting 'Submit', the enumeration will be unmuted.


By Alarm

Mute

To mute an enumeration in an alarm, access the enumerations by selecting the `Enumerations` tab within the `Devices on site` section. Find the enumeration and select the 'Mute' button. A mute form will appear.

The mute length can be chosen using the a predefined option, or a custom amount of time. After selecting 'Confirm' the enumeration will become muted.


Unmute

To unmute an enumeration in an alarm, access the enumerations by selecting the `Enumerations` tab within the `Devices on site` section. Find the enumeration and select the 'Unmute' button. A confirmation request will appear.

After selecting 'Submit', the enumeration will become unmuted.


Permissions

To mute or unmute a device's enumeration, a user must have the 'Mute device enumerations' permission.








    • Related Articles

    • Device Data Reports

      This feature was released with webeyeCMS v3.0 - View the release notes Device Data Reports Supported devices can now send additional data to webeyeCMS to be recorded and displayed as a report. OCULi is currently the only device that supports data ...
    • webeyeGO EZVIZ - Device Configuration Guide

      Please see attachments.
    • AJAX - Device operating time calculator

      The battery life of AJAX devices is affected by a numbers of factors. Click here to find out what affects the battery life of your devices and how to extend it.
    • Videofied Panel & Device Battery Replacement

      Please see attachments
    • webeyeCMS Platform

      Latest Release: v3.5.3 - 10th June 2021 Below you will find a list of features added in recent versions of webeyeCMS. For more information, please contact us via this support portal  v3.5 v3.5.3 Feature and Bugfix Release Release Date: 10th June 2021 ...