Difference between revisions of "Alert5"
(20 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | Felma's Alert5 is a supervisor system that can control anti-intrusion, fire prevention, access control and TVCC systems. The communication with | + | Felma's Alert5 is a supervisor system that can control anti-intrusion, fire prevention, access control and TVCC systems. The communication with HSYCO is via HTTP protocol. |
== HSYCO Configuration == | == HSYCO Configuration == | ||
Line 49: | Line 49: | ||
== Datapoints == | == Datapoints == | ||
+ | |||
+ | The hierarchical structure is: System > Area > Device (every system can contain multiple areas and every area can contain multiple devices) | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 112: | Line 114: | ||
|rowspan="3"|sys.<sys_id>.status.connection | |rowspan="3"|sys.<sys_id>.status.connection | ||
− | |-1 | + | |–1 |
+ | |R | ||
+ | |undefined state | ||
+ | |- | ||
+ | |0 | ||
+ | |R | ||
+ | |sys_id not online (logical state) | ||
+ | |- | ||
+ | |1 | ||
+ | |R | ||
+ | |sys_id online (logical state) | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="3"|sys.<sys_id>.status.system | ||
+ | |–1 | ||
+ | |R | ||
+ | |undefined state | ||
+ | |- | ||
+ | |0 | ||
+ | |R | ||
+ | |sys_id not online (physical state) | ||
+ | |- | ||
+ | |1 | ||
+ | |R | ||
+ | |sys_id online (physical state) | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="3"|sys.<sys_id>.status.alarm | ||
+ | |–1 | ||
+ | |R | ||
+ | |undefined state | ||
+ | |- | ||
+ | |0 | ||
+ | |R | ||
+ | |sys_id not in alarm | ||
+ | |- | ||
+ | |1 | ||
+ | |R | ||
+ | |sys_id in alarm | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="3"|sys.<sys_id>.status.fault | ||
+ | |–1 | ||
+ | |R | ||
+ | |undefined state | ||
+ | |- | ||
+ | |0 | ||
+ | |R | ||
+ | |sys_id ok | ||
+ | |- | ||
+ | |1 | ||
+ | |R | ||
+ | |sys_id fault | ||
+ | |||
+ | |- | ||
+ | |||
+ | |sys.<sys_id>.command.<command_id>.desc | ||
+ | |<text> | ||
+ | |R | ||
+ | |description of command_id associated to sys_id | ||
+ | |||
+ | |- | ||
+ | |||
+ | |sys.<sys_id>.area.<area_id>.desc | ||
+ | |<text> | ||
+ | |R | ||
+ | |description of area_id | ||
+ | |||
+ | |- | ||
+ | |||
+ | |sys.<sys_id>.area.<area_id>.code | ||
+ | |<num> | ||
+ | |R | ||
+ | |code of area_id | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="3"|sys.<sys_id>.area.<area_id>.status.connection | ||
+ | |–1 | ||
|R | |R | ||
|undefined state | |undefined state | ||
Line 118: | Line 201: | ||
|0 | |0 | ||
|R | |R | ||
− | | | + | |area_id disarmed (logical state) |
|- | |- | ||
|1 | |1 | ||
|R | |R | ||
− | | | + | |area_id armed (logical state) |
+ | |- | ||
+ | |||
+ | |rowspan="3"|sys.<sys_id>.area.<area_id>.status.area | ||
+ | |–1 | ||
+ | |R | ||
+ | |undefined state | ||
+ | |- | ||
+ | |0 | ||
+ | |R | ||
+ | |area_id disarmed (physical state) | ||
+ | |- | ||
+ | |1 | ||
+ | |R | ||
+ | |area_id armed (physical state) | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="3"|sys.<sys_id>.area.<area_id>.status.alarm | ||
+ | |–1 | ||
+ | |R | ||
+ | |undefined state | ||
+ | |- | ||
+ | |0 | ||
+ | |R | ||
+ | |area_id not in alarm | ||
+ | |- | ||
+ | |1 | ||
+ | |R | ||
+ | |area_id in alarm | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="3"|sys.<sys_id>.area.<area_id>.status.fault | ||
+ | |–1 | ||
+ | |R | ||
+ | |undefined state | ||
+ | |- | ||
+ | |0 | ||
+ | |R | ||
+ | |area_id ok | ||
+ | |- | ||
+ | |1 | ||
+ | |R | ||
+ | |area_id fault | ||
+ | |||
+ | |- | ||
+ | |||
+ | |area.<area_id>.command.<command_id>.desc | ||
+ | |<text> | ||
+ | |R | ||
+ | |description of command_id associated to area_id | ||
+ | |||
+ | |- | ||
+ | |||
+ | |sys.<sys_id>.area.<area_id>.dev.<dev_id>.desc | ||
+ | |<text> | ||
+ | |R | ||
+ | |description of dev_id | ||
+ | |||
+ | |- | ||
+ | |||
+ | |sys.<sys_id>.area.<area_id>.dev.<dev_id>.code | ||
+ | |<num> | ||
+ | |R | ||
+ | |code of dev_id | ||
+ | |- | ||
+ | |||
+ | |rowspan="3"|sys.<sys_id>.area.<areaId>.dev.<dev_id>.status.bypass | ||
+ | |–1 | ||
+ | |R | ||
+ | |undefined state | ||
+ | |- | ||
+ | |0 | ||
+ | |R | ||
+ | |dev_id is bypassed | ||
+ | |- | ||
+ | |1 | ||
+ | |R | ||
+ | |area_id armed | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="3"|sys.<sys_id>.area.<areaId>.dev.<dev_id>.status.open | ||
+ | |–1 | ||
+ | |R | ||
+ | |undefined state | ||
+ | |- | ||
+ | |0 | ||
+ | |R | ||
+ | |dev_id is closed (or is not active) | ||
+ | |- | ||
+ | |1 | ||
+ | |R | ||
+ | |dev_id is open (or is active) | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="3"|sys.<sys_id>.area.<area_id>.dev.<dev_id>.status.alarm | ||
+ | |–1 | ||
+ | |R | ||
+ | |undefined state | ||
+ | |- | ||
+ | |0 | ||
+ | |R | ||
+ | |dev_id not in alarm | ||
+ | |- | ||
+ | |1 | ||
+ | |R | ||
+ | |dev_id in alarm | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="3"|sys.<sys_id>.area.<area_id>.dev.<dev_id>.status.fault | ||
+ | |–1 | ||
+ | |R | ||
+ | |undefined state | ||
+ | |- | ||
+ | |0 | ||
+ | |R | ||
+ | |dev_id ok | ||
+ | |- | ||
+ | |1 | ||
+ | |R | ||
+ | |dev_id fault | ||
+ | |||
+ | |- | ||
+ | |||
+ | |dev.<dev_id>.command.<command_id>.desc | ||
+ | |<text> | ||
+ | |R | ||
+ | |description of command_id associated to dev_id | ||
+ | |||
+ | |- | ||
+ | |||
+ | |sys.<sys_id>.command.<command_id> | ||
+ | |1 | ||
+ | |W | ||
+ | |exec command_id for sys_id | ||
+ | |||
+ | |- | ||
+ | |||
+ | |area.<area_id>.command.<command_id> | ||
+ | |1 | ||
+ | |W | ||
+ | |exec command_id for area_id | ||
+ | |||
+ | |- | ||
+ | |||
+ | |dev.<dev_id>.command.<command_id> | ||
+ | |1 | ||
+ | |W | ||
+ | |exec command_id for dev_id | ||
|} | |} | ||
+ | |||
+ | == User Interface == | ||
+ | |||
+ | === Alert5 Object === | ||
+ | |||
+ | {{:Alert5_(I/O Server Object)}} | ||
+ | |||
+ | === UISET Actions === | ||
+ | |||
+ | {| class="wikitable" | ||
+ | !ID | ||
+ | !Attribute | ||
+ | !colspan="2"|Set to | ||
+ | |||
+ | |- | ||
+ | |||
+ | |log | ||
+ | |value | ||
+ | |colspan="2"|latest security log lines (as many as specified by the 'logsize' option) | ||
+ | |||
+ | |- | ||
+ | |||
+ | |log0 | ||
+ | |value | ||
+ | |colspan="2"|latest security log (it will vanish after 5 seconds) | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="2"|dev.<dev_id>.status.bypass | ||
+ | |rowspan="2"|visible | ||
+ | |true | ||
+ | |dev_id bypassed | ||
+ | |- | ||
+ | |false | ||
+ | |dev_id not not bypassed | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="2"|dev.<dev_id>.status.open | ||
+ | |rowspan="2"|visible | ||
+ | |true | ||
+ | |dev_id active | ||
+ | |- | ||
+ | |false | ||
+ | |dev_id not not active | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="2"|dev.<dev_id>.status.alarm | ||
+ | |rowspan="2"|visible | ||
+ | |true | ||
+ | |dev_id in alarm | ||
+ | |- | ||
+ | |false | ||
+ | |dev_id not not in alarm | ||
+ | |||
+ | |- | ||
+ | |||
+ | |sys.<system_id>.desc | ||
+ | |value | ||
+ | |colspan="2"|description of system_id | ||
+ | |||
+ | |- | ||
+ | |||
+ | |sys.<system_id>.area.<area_id>.desc | ||
+ | |value | ||
+ | |colspan="2"|description of area_id included in system_id | ||
+ | |||
+ | |- | ||
+ | |||
+ | |sys.<system_id>.area.<area_id>.dev.<dev_id>.desc | ||
+ | |value | ||
+ | |colspan="2"|description of dev_id included in area_id included in system_id | ||
+ | |||
+ | |- | ||
+ | |||
+ | |sys.<system_id>.command.<command_id>.desc | ||
+ | |value | ||
+ | |colspan="2"|description of command_id of system_id | ||
+ | |||
+ | |- | ||
+ | |||
+ | |area.<area_id>.command.<command_id>.desc | ||
+ | |value | ||
+ | |colspan="2"|description of command_id of area_id | ||
+ | |||
+ | |- | ||
+ | |||
+ | |dev.<dev_id>.command.<command_id>.desc | ||
+ | |value | ||
+ | |colspan="2"|description of command_id of dev_id | ||
+ | |||
+ | |} | ||
+ | |||
+ | == Log Files == | ||
+ | If a ALERT5 I/O Server is connected to HSYCO, the security.log file will be written in the same directories as the daily log files. | ||
+ | |||
+ | This file is never overwritten or deleted from HSYCO SERVER. | ||
+ | |||
+ | <pre> | ||
+ | 2021.09.10 11:02:17.357 - alert5 - HSYCO ONLINE | ||
+ | 2021.09.10 11:44:08.740 - alert5 - 10-09-2021 11:44:07 | Evento: Transazione valida in ingresso, Apparato: GESTIONE ACCESSI CED, Area: RETRO FELMA, Dispositivo: RETRO FELMA, Anagrafica: FRIGERIO GIANNI | ||
+ | 2021.09.10 11:44:25.923 - alert5 - 10-09-2021 11:44:25 | Evento: Transazione valida in ingresso, Apparato: GESTIONE ACCESSI CED, Area: PORTONE SCORREVOLE, Dispositivo: PORTONE SCORREVOLE, Anagrafica: CIONI MATTEO | ||
+ | </pre> | ||
+ | |||
+ | Other information about the ALERT5 driver are stored in the message.log daily file. | ||
+ | |||
+ | == Release Notes == | ||
+ | |||
+ | === 3.8.0 === | ||
+ | *initial release | ||
+ | |||
+ | ---- | ||
+ | |||
+ | |||
+ | ''Alert5 is a registered trademark of Felma S.r.l.'' |
Latest revision as of 16:52, 24 March 2022
Felma's Alert5 is a supervisor system that can control anti-intrusion, fire prevention, access control and TVCC systems. The communication with HSYCO is via HTTP protocol.
Contents
HSYCO Configuration
Add the ALERT5 I/O Server in the I/O Servers section of the Settings and set its parameters:
Communication
- IP Address: host name or IP address of the supervisor
- IP Port: TCP/IP port assigned to the supervisor
Authentication
- User: username to access the supervisor
- Password: password to access the supervisor
Options
ID | Default | Values | Description |
---|---|---|---|
startupevents | false | true | generate IO events also during the driver’s start-up phase |
false | start generating events only after HSYCO is aligned with the current status of the system | ||
pollinterval | 1000 | n > 1000 | the data acquisition interval, in milliseconds |
logsize | 300 | n ≥ 0 | the number of log lines to display in the UI object |
Datapoints
The hierarchical structure is: System > Area > Device (every system can contain multiple areas and every area can contain multiple devices)
ID | Value | R/W | Description |
---|---|---|---|
connection | online | R | the driver started correctly |
offline | R | the driver didn't start correctly or loop cycle failed | |
global.error | <num> | R | error code, 0 means no error |
global.desc | <text> | R | error description, OK means no error |
global.api.name | <text> | R | current API name |
global.api.version | <val> | R | current API version |
sys.<sys_id>.desc | <text> | R | description of sys_id |
sys.<sys_id>.type | <text> | R | type of sys_id |
sys.<sys_id>.status.connection | –1 | R | undefined state |
0 | R | sys_id not online (logical state) | |
1 | R | sys_id online (logical state) | |
sys.<sys_id>.status.system | –1 | R | undefined state |
0 | R | sys_id not online (physical state) | |
1 | R | sys_id online (physical state) | |
sys.<sys_id>.status.alarm | –1 | R | undefined state |
0 | R | sys_id not in alarm | |
1 | R | sys_id in alarm | |
sys.<sys_id>.status.fault | –1 | R | undefined state |
0 | R | sys_id ok | |
1 | R | sys_id fault | |
sys.<sys_id>.command.<command_id>.desc | <text> | R | description of command_id associated to sys_id |
sys.<sys_id>.area.<area_id>.desc | <text> | R | description of area_id |
sys.<sys_id>.area.<area_id>.code | <num> | R | code of area_id |
sys.<sys_id>.area.<area_id>.status.connection | –1 | R | undefined state |
0 | R | area_id disarmed (logical state) | |
1 | R | area_id armed (logical state) | |
sys.<sys_id>.area.<area_id>.status.area | –1 | R | undefined state |
0 | R | area_id disarmed (physical state) | |
1 | R | area_id armed (physical state) | |
sys.<sys_id>.area.<area_id>.status.alarm | –1 | R | undefined state |
0 | R | area_id not in alarm | |
1 | R | area_id in alarm | |
sys.<sys_id>.area.<area_id>.status.fault | –1 | R | undefined state |
0 | R | area_id ok | |
1 | R | area_id fault | |
area.<area_id>.command.<command_id>.desc | <text> | R | description of command_id associated to area_id |
sys.<sys_id>.area.<area_id>.dev.<dev_id>.desc | <text> | R | description of dev_id |
sys.<sys_id>.area.<area_id>.dev.<dev_id>.code | <num> | R | code of dev_id |
sys.<sys_id>.area.<areaId>.dev.<dev_id>.status.bypass | –1 | R | undefined state |
0 | R | dev_id is bypassed | |
1 | R | area_id armed | |
sys.<sys_id>.area.<areaId>.dev.<dev_id>.status.open | –1 | R | undefined state |
0 | R | dev_id is closed (or is not active) | |
1 | R | dev_id is open (or is active) | |
sys.<sys_id>.area.<area_id>.dev.<dev_id>.status.alarm | –1 | R | undefined state |
0 | R | dev_id not in alarm | |
1 | R | dev_id in alarm | |
sys.<sys_id>.area.<area_id>.dev.<dev_id>.status.fault | –1 | R | undefined state |
0 | R | dev_id ok | |
1 | R | dev_id fault | |
dev.<dev_id>.command.<command_id>.desc | <text> | R | description of command_id associated to dev_id |
sys.<sys_id>.command.<command_id> | 1 | W | exec command_id for sys_id |
area.<area_id>.command.<command_id> | 1 | W | exec command_id for area_id |
dev.<dev_id>.command.<command_id> | 1 | W | exec command_id for dev_id |
User Interface
Alert5 Object
The user interface for the Alert5 system:
The first image shows the list of configured systems, you can reset the alarm for every single system.
The second image shows all areas associated to the selected system, you can arm/disarm every single area. You can also arm/disarm alla areas of the selected system together.
The third image shows all devices associated to the selected system and area, you can activate or bypass/unbypass the device. The four icons inside device popup represents in order: state(open/closed or active/inactive), alarm, fault, bypass.
The fourth image shows the most recent logs of Alert5 system.
The icon on top of the page will turn white when an area is in alarm.
The (alert5) object is listed in the Project Editor’s new object list only when at least one Alert5 I/O Server is defined
Parameters
- server id: the server ID. Supports Redirect variables
- position: the object's position. Use the pixels or rows and columns coordinates format
Syntax
(alert5 <server id>; <position>)
E.g.
(alert5 xgen; x10y20)
UISET Actions
ID | Attribute | Set to | |
---|---|---|---|
log | value | latest security log lines (as many as specified by the 'logsize' option) | |
log0 | value | latest security log (it will vanish after 5 seconds) | |
dev.<dev_id>.status.bypass | visible | true | dev_id bypassed |
false | dev_id not not bypassed | ||
dev.<dev_id>.status.open | visible | true | dev_id active |
false | dev_id not not active | ||
dev.<dev_id>.status.alarm | visible | true | dev_id in alarm |
false | dev_id not not in alarm | ||
sys.<system_id>.desc | value | description of system_id | |
sys.<system_id>.area.<area_id>.desc | value | description of area_id included in system_id | |
sys.<system_id>.area.<area_id>.dev.<dev_id>.desc | value | description of dev_id included in area_id included in system_id | |
sys.<system_id>.command.<command_id>.desc | value | description of command_id of system_id | |
area.<area_id>.command.<command_id>.desc | value | description of command_id of area_id | |
dev.<dev_id>.command.<command_id>.desc | value | description of command_id of dev_id |
Log Files
If a ALERT5 I/O Server is connected to HSYCO, the security.log file will be written in the same directories as the daily log files.
This file is never overwritten or deleted from HSYCO SERVER.
2021.09.10 11:02:17.357 - alert5 - HSYCO ONLINE 2021.09.10 11:44:08.740 - alert5 - 10-09-2021 11:44:07 | Evento: Transazione valida in ingresso, Apparato: GESTIONE ACCESSI CED, Area: RETRO FELMA, Dispositivo: RETRO FELMA, Anagrafica: FRIGERIO GIANNI 2021.09.10 11:44:25.923 - alert5 - 10-09-2021 11:44:25 | Evento: Transazione valida in ingresso, Apparato: GESTIONE ACCESSI CED, Area: PORTONE SCORREVOLE, Dispositivo: PORTONE SCORREVOLE, Anagrafica: CIONI MATTEO
Other information about the ALERT5 driver are stored in the message.log daily file.
Release Notes
3.8.0
- initial release
Alert5 is a registered trademark of Felma S.r.l.