Networx

From HSYCO
Jump to: navigation, search

NetworX is a multi-area security system. The integration with HSYCO can be accomplished via direct control through their serial or ethernet interfaces.

Communication

RS-232 parameters:

Baud rate same as configured on panel (default 9600)
Data bits 8
Stop bit 1
Parity none
Flow control none

Networx Configuration

The panel must be previously configured to have the serial port enabled and to use the binary control protocol. Refer to its configuration manual for more details.

HSYCO Configuration

Add a Networx I/O Server in the I/O Servers section of the Settings and set its parameters:

Communication

  • Comm ID: select the comm port connected to the panel.

High Availability

  • Shutdown when inactive: defaults to true.

Options

ID Default Values Description
pin <code> 4 or 6-digits code. Use the specified PIN code to perform operations that require user authentication. If this option is not specified it will be required to manually insert the pin every time such operations are performed
gui true true enable support for the UI object, UISET actions and USER commands
false disable UI support
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 3 n > 0 the data acquisition interval, in seconds
logsize 20 n ≥ 0 the number of log lines to display in the UI object
maxzone 168 n > 0 highest zone number among the zones used on the panel

networx.ini

The networx.ini file is a specific configuration file located in the root directory. Here you can define the names of the users so that they will be automatically added to the user interface. Add a new line for each user using this format:

<io_server_id>.user.<n> = <name>

For instance:

nx.user.1 = Bob
nx.user.2 = Alice

Datapoints

ID Value R/W Description
connection online R connection established
offline R HSYCO can't connect to the panel
alarm 0 R no partition is alarmed
1 R at least one partition is alarmed
armed 0 R all partitions are disarmed
W disarm all partitions
1 R the system is (partially) armed
away W arm all partitions in away mode
stay W arm all partitions in stay mode
auto W initiate auto-arm for all partitions
p<n>.armed 0 R partition <n> is disarmed
W disarm partition <n>
away R partition <n> is armed in away mode
W arm partition <n> in away mode
stay R partition <n> is armed in stay mode
W arm partition <n> in stay mode
auto W initiate auto-arm on partition <n>
p<n>.alarm 0 R partition <n> is not in an alarm state
1 R partition <n> is in an alarm state
p<n>.tamper 0 R no tamper condition for partition <n>
1 R partition <n> has been tampered
p<n>.last.user <num> R last user number entered was <num>
p<n>.fire 0 R no fire on partition <n>
1 R fire on partition <n>
p<n>.fire.trouble 0 R no fire trouble on partition <n>
1 R fire trouble on partition <n>
p<n>.buzzer 0 R buzzer off on partition <n>
1 R buzzer on on partition <n>
W start buzzer on partition <n>
p<n>.tlm.fault 0 R TLM ok
1 R TLM memory fault
p<n>.instant 0 R instant flag not set on partition <n>
1 R instant flag set on partition <n>
p<n>.siren 0 R siren off on partition <n>
1 R siren on on partition <n>
p<n>.steady.siren 0 R steady siren off on partition <n>
1 R steady siren on on partition <n>
p<n>.alarm.mem 0 R alarm memory flag not set on partition <n>
1 R alarm memory flag set on partition <n>
p<n>.cancel 0 R no cancel command entered on partition <n>
1 R cancel command entered on partition <n>
W issue cancel command
p<n>.exit.silent 0 R silent exit disabled on partition <n>
1 R silent exit enabled on partition <n>
W enable silent exit for this arm cycle on partition <n>
p<n>.chime.mode 0 R chime mode off on partition <n>
1 R chime mode on on partition <n>
toggle W toggle chime mode on partition <n>
p<n>.entry 0 R entry inactive on partition <n>
1 R entry active on partition <n>
p<n>.delay.exp 0 R delay expiration warning off
1 R delay expiration warning on
p<n>.exit.1 0 R exit 1 inactive on partition <n>
1 R exit 1 active on partition <n>
p<n>.exit.2 0 R exit 2 inactive on partition <n>
1 R exit 2 active on partition <n>
p<n>.exit.error 0 R exit error not triggered on partition <n>
1 R exit error triggered on partition <n>
p<n>.night.mode 0 R night mode inactive on partition <n>
1 R night mode active on partition <n>
p<n>.reexit 0 R re-exit inactive on partition <n>
1 R re-exit active on partition <n>
p<n>.force.arm 0 R no force arm triggered on partition <n>
1 R force arm triggered by auto arm on partition <n>
p<n>.arm.ready 0 R partition <n> not ready to arm
1 R partition <n> ready to arm
p<n>.force.arm.ready 0 R partition <n> not ready to force arm
1 R partition <n> ready to force arm
p<n>.chime 0 R chime off on partition <n>
1 R chime on on partition <n>
p<n>.error.beep 0 R error beep off on partition <n>
1 R error beep on on partition <n>
p<n>.tone 0 R activation tone off on partition <n>
1 R activation tone on on partition <n>
p<n>.entry.1 0 R entry 1 inactive on partition <n>
1 R entry 1 active on partition <n>
p<n>.phone.1.alarm 0 R no alarm sent using phone number 1 on partition <n>
1 R alarm sent using phone number 1 on partition <n>
p<n>.phone.2.alarm 0 R no alarm sent using phone number 2 on partition <n>
1 R alarm sent using phone number 2 on partition <n>
p<n>.phone.3.alarm 0 R no alarm sent using phone number 3 on partition <n>
1 R alarm sent using phone number 3 on partition <n>
p<n>.keyswitch.armed 0 R keyswitch not armed on partition <n>
1 R keyswitch armed on partition <n>
z<n>.name <text> R name of zone <n> is set to <text>
z<n>.open 0 R zone <n> is closed
1 R zone <n> is open
z<n>.tamper 0 R zone <n> is not tampered
1 R zone <n> is tampered
z<n>.trouble 0 R zone <n> OK
1 R troubles on zone <n>
z<n>.bypassed 0 R zone <n> not bypassed
1 R zone <n> bypassed
toggle W toggle the bypass status on zone <n>
z<n>.inhibited 0 R zone <n> not inhibited
1 R zone <n> inhibited
z<n>.battery.low 0 R zone <n> battery OK
1 R zone <n> battery low
z<n>.supervision.loss 0 R supervision OK on zone <n>
1 R loss of supervision on zone <n>
z<n>.alarm.mem 0 R alarm memory flag not set on zone <n>
1 R alarm memory flag set on zone <n>
z<n>.bypass.mem 0 R bypass memory flag not set on zone <n>
1 R bypass memory flag set on zone <n>
user<n>.name <text> R name of user <n> is set to <text>
comm.fail 0 R communication OK
1 R communication failure
fuse.fault 0 R fuse OK
1 R fuse fault
panel.tamper 0 R panel box not tampered
1 R panel box tampered
siren.tamper 0 R siren OK
1 R siren tampered
battery.low 0 R battery OK
1 R battery low
ac.fail 0 R AC OK
1 R AC failure
expander.tamper 0 R expander box not tampered
1 R expander box tampered
expander.ac.fail 0 R expander’s AC OK
1 R expander’s AC failure
expander.battery.low 0 R expander’s battery OK
1 R expander’s battery low
expander.fault 0 R expander OK
1 R general fault for the expander
buzzer 0 R global buzzer off
1 R global buzzer on
siren 0 R global siren off
1 R global siren on
steady.siren 0 R global steady siren off
1 R global steady siren on
bus.fault 0 R bus line OK
1 R bus device had line seized
ac.power 0 R AC power off
1 R AC power on
battery.low.mem 0 R low battery memory flag not set
1 R low battery memory flag set
powerup.delay 0 R no power up delay in progress
1 R power up delay in progress
walk.test 0 R walk-test mode off
W stop walk-test mode
1 R walk-test mode active
W start walk-test mode
time.loss 0 R system time ok
1 R loss of system time
aux1
p<n>.aux1
1 W activate auxiliary function 1
aux2
p<n>.aux2
1 W activate auxiliary function 2
panic
p<n>.panic
fire W issue the fire panic command
medical W issue the medical panic command
police W issue the police panic command
smoke
p<n>.smoke
reset W smoke detector reset
test
p<n>.test
1 W perform test
command restart W restart the driver
clock read W request the reading of the panel’s clock value
<val> R the panel’s clock is set to <val>. The used format is "yyyy-mm-dd hh:mm:ss" (e.g. 2012-08-30 16:30:00). This datapoint is only updated after a request with the command "clock = read"
W set the panel’s clock to <val>. One of the following formats must be used:
  • "yyyy-mm-dd hh:mm", e.g. 2012-08-30 16:30
  • "yy/mm/dd-wd-hh:mm", where “wd” represents the day of the week (1 = Sunday, 2 = Monday, ..., 7 = Saturday), e.g. 12/08/30-5-16:30
x10.<house>.<unit> on W send the on command to the unit with the specified address in the specified house (e.g. x10.a.2 addresses unit 2 of house A)
off W send the off command to the unit with the specified address in the specified house (e.g. x10.a.2 addresses unit 2 of house A)
dim W send the dim command to the unit with the specified address in the specified house (e.g. x10.a.2 addresses unit 2 of house A)
bright W send the bright command to the unit with the specified address in the specified house (e.g. x10.a.2 addresses unit 2 of house A)
x10.<house>.all off W send the off command to the all the units in the specified house (e.g. x10.b.all)
x10.<house>.lights on W send the on command to all the light units in the specified house
off W send the off command to all the light units in the specified house

User Interface

Networx Object

The user interface for the Networx multi-area security system.

CSx75 UI Object 1.png CSx75 UI Object 2.png CSx75 UI Object 3.png

The Networx object is listed in the Project Editor’s new object list only when at least one Networx I/O Server is defined.

Parameters

  • server id: the server ID
  • partition: partition number of the Networx multi-area security system
  • position: the object's position. Use the pixels or rows and columns coordinates format

Syntax

(networx <server id>; <partition>; <position>)

E.g.

(networx serverid; partition; x10y20)

UISET Actions

ID Attribute Set to
log value latest security log lines (as many as specified by the 'logsize' option)
log0 value latest line of the security log when a new entry is added, set back to blank after a short period
z<n>.name value name assigned to zone <n> (base or double) or its number if no name is defined
p<n>.last.user value ID of the last user who logged in on partition <n>
user<n>.name value name assigned to user <n>
connection.label visible true when datapoint connection = offline
false when datapoint connection = online
p<n>.armed.0.label visible true when partition <n> is disarmed
false when partition <n> is armed
p<n>.armed.away.label visible true when partition <n> is armed in "away" mode
false when partition <n> is not armed in "away" mode
p<n>.armed.stay.label visible true when partition <n> is armed in "stay" mode
false when partition <n> is not armed in "stay" mode
<datapoint_id>.1.label visible true when datapoint with ID <datapoint_id> has value '1'
false when datapoint with ID <datapoint_id> has value '0'
<datapoint_id>.0.label visible true when datapoint with ID <datapoint_id> has value '0'
false when datapoint with ID <datapoint_id> has value '1'

USER Commands

Name Param Action
armed[Note] 0 disarm all partitions
stay arm all partitions in "stay" mode
away arm all partitions in "away" mode
auto initiate auto-arm on all partitions
p<n>.armed[Note] 0 disarm partition <n>
stay arm partition <n> in "stay" mode
away arm partition <n> in "away" mode
auto initiate auto-arm on partition <n>
p<n>.cancel[Note] 1 issue cancel command on partition <n>
p<n>.buzzer 1 start buzzer on partition <n>
p<n>.exit.silent 1 enable silent exit for this arm cycle on partition <n>
Z<n>.bypassed toggle toggle the bypass status of zone <n>
p<n>.chime.mode toggle toggle chime mode on partition <n>
walk.test[Note] 0 stop walk-test mode
1 start walk-test mode
aux1
p<n>.aux1
1 activate auxiliary function 1
aux2
p<n>.aux2
1 activate auxiliary function 2
panic
p<n>.panic
fire issue the fire panic command
medical issue the medical panic command
police issue the police panic command


smoke
p<n>.smoke
reset smoke detector reset
test
p<n>.test
1 perform test
command restart restarts the driver

Note
To perform this operation it is necessary to enter the user code first. To enter the user code through the user interface use user buttons to create a virtual keypad and assign them name and param values according to this table:

Name Param Action
digit {0 ... 9} append the specified digit to the entered user code
c delete the last entered digit

To visualize the number of entered digits use 4 or 6 text objects (depending on the number of digits used for user codes) and set their IDs to:

ID Description
pin.<n>
(0 ≤ <n> ≤ 5)
shows the character '*' when the corresponding digit has been entered, shows '_' otherwise

The entered code will be cleared after a short period of inactivity.

Log Files

A permanent record of all the log messages, also shown in the log page, is saved in a file called security.log in the logs/YYYY directory for the current year.

This file is never overwritten or deleted by HSYCO.

2014.03.21 14:50:40.010 - nx - Disarmed - Partition 1
2014.03.21 14:52:01.322 - nx - Walk test mode on
2014.03.21 14:53:17.687 - nx - Walk test mode off
2014.03.21 14:53:28.852 - nx - Bypass - [2] Zona 2 n        
2014.03.21 14:53:29.998 - nx - Armed (stay) - Partition 1
2014.03.21 14:53:32.557 - nx - Bypass restore - [2] Zona 2 n        
2014.03.21 14:53:33.698 - nx - Disarmed - Partition 1
2014.03.21 17:17:03.364 - nx - Online
2014.03.21 17:40:42.664 - nx - Bypass - [2] Zona 2 n        
2014.03.21 17:40:43.859 - nx - Armed (stay) - Partition 1
2014.03.21 17:40:48.772 - nx - Bypass restore - [2] Zona 2 n        
2014.03.21 17:40:50.067 - nx - Disarmed - Partition 1
2014.03.21 17:48:25.277 - nx - Bypass - [1] Zona 1 n        
2014.03.21 17:48:26.729 - nx - Bypass restore - [1] Zona 1 n 

Other information related to the driver are saved in the daily message.log files

Release Notes

3.6.0

  • initial version release


Networx is a registered trademark of United Technologies Corporation.