Difference between revisions of "Boschmap"

From HSYCO
Jump to navigation Jump to search
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
The Bosch MPA panels are multi-area intrusion detection systems.
+
The Bosch MAP panels are multi-area intrusion detection systems.
  
 
The integration with HSYCO can be accomplished via Ethernet connection.
 
The integration with HSYCO can be accomplished via Ethernet connection.
Line 6: Line 6:
  
 
== HSYCO Configuration ==
 
== HSYCO Configuration ==
−
Add a BOSCHMPA I/O Server in the [[Settings#I/O Servers|I/O Servers section of the Settings]] and set its parameters:
+
Add a BOSCHMAP I/O Server in the [[Settings#I/O Servers|I/O Servers section of the Settings]] and set its parameters:
  
 
=== Communication ===
 
=== Communication ===
Line 36: Line 36:
 
|false
 
|false
 
|start generating events only after HSYCO is aligned with the current status of the system
 
|start generating events only after HSYCO is aligned with the current status of the system
 +
 +
 +
|-
 +
 +
|pollinterval
 +
|30
 +
|n > 0
 +
|number of seconds between consecutive requests of the open status of points. A low value can overload the panel
  
 
|}
 
|}
  
−
=== galaxy.ini ===
+
=== boschmap.ini ===
  
−
The boschmpa.ini file is a specific configuration file located in the root directory.
+
The boschmap.ini file is a specific configuration file located in the root directory.
−
This file is required to specify which areas and zones are configured on the panel and to assign them a name.
+
This file is required to specify which areas and points are configured on the panel and to assign them a name.
  
−
Add a new line for each area followed by a new line for each zone belonging to that area, using the following format:
+
Add a new line for each area followed by a new line for each point belonging to that area, using the following format:
  
 
<pre>
 
<pre>
−
<io_server_id>.<siid> = <name>
+
<io_server_id>.<area_siid> = <name>
 +
<io_server_id>.<point_siid> = <name>
 
</pre>
 
</pre>
  
−
where <siid> is the security identifier of the area/zone as specified in the configuration software of the panel.
+
where <area_siid>/<point_siid> is the security identifier of the area/point as specified in the configuration software of the panel.
  
 
For instance:
 
For instance:
Line 65: Line 74:
 
</pre>
 
</pre>
  
−
specifies three areas: the Control Panel area with no zones, an internal area with two zones and an external area with one zone.
+
specifies three areas: the Control Panel area with no points, an internal area with two points and an external area with one point.
  
 
== Datapoints ==
 
== Datapoints ==
Line 87: Line 96:
  
 
|-
 
|-
 +
 +
|rowspan="2" |alarm<sup>[[#note1|[Note 1]]]</sup>
 +
|0
 +
|R
 +
|no alarm
 +
|-
 +
|1
 +
|R
 +
|alarm active
 +
 +
|-
 +
 +
|rowspan="2" |trouble<sup>[[#note1|[Note 1]]]</sup>
 +
|0
 +
|R
 +
|no trouble
 +
|-
 +
|1
 +
|R
 +
|trouble active
 +
 +
|-
 +
 +
|rowspan="2" |tamper<sup>[[#note1|[Note 1]]]</sup>
 +
|0
 +
|R
 +
|no tamper
 +
|-
 +
|1
 +
|R
 +
|tamper active
 +
 +
|-
 +
 +
|rowspan="2" |user.tamper<sup>[[#note1|[Note 1]]]</sup>
 +
|0
 +
|R
 +
|no user tamper
 +
|-
 +
|1
 +
|R
 +
|user tamper active
 +
 +
|-
 +
 +
|<siid>.name
 +
|<name>
 +
|R
 +
|the name of the area/point is set to <name>
 +
 +
|-
 +
 +
|rowspan="23" |<area_siid>.armed
 +
|rowspan="2" |0
 +
|R
 +
|area disarmed
 +
|-
 +
|W
 +
|disarm the area
 +
|-
 +
|rowspan="2" |1
 +
|R
 +
|area all armed, delayed
 +
|-
 +
|W
 +
|arm all the area, delayed
 +
|-
 +
|rowspan="2" |2
 +
|R
 +
|area all armed, delayed with bypass
 +
|-
 +
|W
 +
|arm all the area, instant
 +
|-
 +
|rowspan="2" |3
 +
|R
 +
|area all armed, instant
 +
|-
 +
|W
 +
|arm the area partially, delayed
 +
|-
 +
|rowspan="2" |4
 +
|R
 +
|area al armed, instant with bypass
 +
|-
 +
|W
 +
|arm the area partially, instant
 +
|-
 +
|rowspan="2" |5
 +
|R
 +
|area partially armed, delayed
 +
|-
 +
|W
 +
|custom-arm the area, delayed
 +
|-
 +
|rowspan="2" |6
 +
|R
 +
|area partially armed, delayed with bypass
 +
|-
 +
|W
 +
|custom-arm the area, instant
 +
|-
 +
|rowspan="2" |7
 +
|R
 +
|area partially armed, instant
 +
|-
 +
|W
 +
|arm all the area, delay zero
 +
|-
 +
|rowspan="2" |8
 +
|R
 +
|area partially armed, instant with bypass
 +
|-
 +
|W
 +
|arm the area partially, delay zero
 +
|-
 +
|rowspan="2" |9
 +
|R
 +
|area custom armed, delayed
 +
|-
 +
|W
 +
|custom-arm the area, delay zero
 +
|-
 +
|10
 +
|R
 +
|area custom armed, delayed with bypass
 +
|-
 +
|11
 +
|R
 +
|area custom armed, instant
 +
|-
 +
|12
 +
|R
 +
|area custom armed, instant with bypass
 +
 +
|-
 +
 +
|rowspan="2" |<area_siid>.ready.arm.instant
 +
|0
 +
|R
 +
|the area is not ready to be armed instantly
 +
|-
 +
|1
 +
|R
 +
|the area is ready to be armed instantly
 +
 +
|-
 +
 +
|rowspan="2" |<area_siid>.ready.arm.delay
 +
|0
 +
|R
 +
|the area is not ready to be armed with delay
 +
|-
 +
|1
 +
|R
 +
|the area is ready to be armed with delay
 +
 +
|-
 +
 +
|rowspan="2" |<area_siid>.ready.disarm
 +
|0
 +
|R
 +
|the area is not ready to be disarmed
 +
|-
 +
|1
 +
|R
 +
|the area is ready to be disarmed
 +
 +
|-
 +
 +
|rowspan="2" |<area_siid>.force.instant
 +
|0
 +
|R
 +
|the area is not ready to be force armed instantly
 +
|-
 +
|1
 +
|R
 +
|the area is ready to be force armed instantly
 +
 +
|-
 +
 +
|rowspan="2" |<area_siid>.force.delay
 +
|0
 +
|R
 +
|the area is not ready to be force armed with delay
 +
|-
 +
|1
 +
|R
 +
|the area is ready to be force armed with delay
 +
 +
|-
 +
 +
|rowspan="2" |<area_siid>.bypassed
 +
|0
 +
|R
 +
|no bypassed devices in this area
 +
|-
 +
|1
 +
|R
 +
|there are bypassed devices in this area
 +
 +
|-
 +
 +
|rowspan="2" |<area_siid>.alarm
 +
|0
 +
|R
 +
|no active alarm
 +
|-
 +
|1
 +
|R
 +
|alarm active
 +
 +
|-
 +
 +
|rowspan="2" |<area_siid>.trouble
 +
|0
 +
|R
 +
|no trouble
 +
|-
 +
|1
 +
|R
 +
|trouble active
 +
 +
|-
 +
 +
|rowspan="2" |<area_siid>.tamper
 +
|0
 +
|R
 +
|no tamper
 +
|-
 +
|1
 +
|R
 +
|tamper active
 +
 +
|-
 +
 +
|rowspan="2" |<point_siid>.blocked
 +
|0
 +
|R
 +
|point not blocked
 +
|-
 +
|1
 +
|R
 +
|point blocked
 +
 +
|-
 +
 +
|rowspan="7" |<point_siid>.bypassed
 +
|rowspan="2" |0
 +
|R
 +
|point not bypassed
 +
|-
 +
|W
 +
|unbypass point
 +
|-
 +
|rowspan="2"|1
 +
|R
 +
|point bypassed swinger
 +
|-
 +
|W
 +
|bypass point
 +
|-
 +
|2
 +
|R
 +
|point bypassed auto
 +
|-
 +
|3
 +
|R
 +
|point bypassed force
 +
|-
 +
|4
 +
|R
 +
|point bypassed manual
 +
 +
|-
 +
 +
|rowspan="3" |<point_siid>.open
 +
|0
 +
|R
 +
|point closed
 +
|-
 +
|1
 +
|R
 +
|point open
 +
|-
 +
|read
 +
|W
 +
|request the reading of the point's open state
 +
 +
|-
 +
 +
<!--
 +
 +
|<point_siid>.reset
 +
|1
 +
|W
 +
|reset the point
 +
 +
|-
 +
 +
-->
 +
 +
|rowspan="2" |<point_siid>.alarm<sup>[[#note2|[Note 2]]]</sup>
 +
|0
 +
|R
 +
|no alarm
 +
|-
 +
|1
 +
|R
 +
|alarm
 +
 +
|-
 +
 +
|rowspan="2" |<point_siid>.holdup<sup>[[#note2|[Note 2]]]</sup>
 +
|0
 +
|R
 +
|no holdup alarm
 +
|-
 +
|1
 +
|R
 +
|holdup alarm
 +
 +
|-
 +
 +
|rowspan="2" |<point_siid>.duress<sup>[[#note2|[Note 2]]]</sup>
 +
|0
 +
|R
 +
|no duress alarm
 +
|-
 +
|1
 +
|R
 +
|duress alarm
 +
 +
|-
 +
 +
|rowspan="2" |<point_siid>.tamper<sup>[[#note2|[Note 2]]]</sup>
 +
|0
 +
|R
 +
|no tamper alarm
 +
|-
 +
|1
 +
|R
 +
|tamper alarm
 +
 +
|-
 +
 +
|rowspan="2" |<device_siid>.tamper<sup>[[#note2|[Note 2]]]</sup>
 +
|0
 +
|R
 +
|no tamper alarm
 +
|-
 +
|1
 +
|R
 +
|device tampered
 +
 +
|-
 +
 +
|rowspan="2" |<device_siid>.trouble<sup>[[#note2|[Note 2]]]</sup>
 +
|0
 +
|R
 +
|no trouble
 +
|-
 +
|1
 +
|R
 +
|trouble on device
 +
 +
|-
 +
 +
|rowspan="2" |<device_siid>.alarm<sup>[[#note2|[Note 2]]]</sup>
 +
|0
 +
|R
 +
|no alarm
 +
|-
 +
|1
 +
|R
 +
|alarm on device
 +
 +
|-
 +
 +
|rowspan="2" |<device_siid>.active<sup>[[#note2|[Note 2]]]</sup>
 +
|0
 +
|R
 +
|device deactivated
 +
|-
 +
|1
 +
|R
 +
|device active
  
 
|}
 
|}
 +
 +
<span id="note1">
 +
;Note 1 : These datapoints are only updated after the startup phase, i.e. events are generated only for events occurring after the driver is online.
 +
</span>
 +
 +
<span id="note2">
 +
;Note 2 : These datapoints, if their value is 1, generate events at startup even if the startupevents option is set to false.
 +
</span>
 +
 +
== Release Notes ==
 +
 +
=== 3.4.0 ===
 +
*initial version release
 +
 +
 +
----
 +
 +
 +
''Bosch is a registered trademark of Bosch Security Systems.''

Latest revision as of 09:19, 16 April 2015

The Bosch MAP panels are multi-area intrusion detection systems.

The integration with HSYCO can be accomplished via Ethernet connection.

HSYCO Configuration

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

Communication

  • IP Address: IP address of the panel
  • IP Port: TCP/IP port to use, leave blank to use default port 6793.

Authentication

  • Password: password set on for the BIS user. Leave blank to use the default password.

High Availability

  • Shutdown when inactive: defaults to true.

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 30 n > 0 number of seconds between consecutive requests of the open status of points. A low value can overload the panel

boschmap.ini

The boschmap.ini file is a specific configuration file located in the root directory. This file is required to specify which areas and points are configured on the panel and to assign them a name.

Add a new line for each area followed by a new line for each point belonging to that area, using the following format: 

<io_server_id>.<area_siid> = <name>
<io_server_id>.<point_siid> = <name>

where <area_siid>/<point_siid> is the security identifier of the area/point as specified in the configuration software of the panel.

For instance: 

bsc.1.1.ControlPanelArea.1.1 = Control Panel

bsc.1.1.Area.2.4 = Internal area
	bsc.1.1.Point.01001.006 = Front door
	bsc.1.1.Point.01001.007 = Back door

bsc.1.1.Area.2.5 = External area
	bsc.1.1.Point.01001.008 = Gate

specifies three areas: the Control Panel area with no points, an internal area with two points and an external area with one point.

Datapoints

ID Value R/W Description
connection online R connection established
offline R HSYCO can't connect to the panel
alarm[Note 1] 0 R no alarm
1 R alarm active
trouble[Note 1] 0 R no trouble
1 R trouble active
tamper[Note 1] 0 R no tamper
1 R tamper active
user.tamper[Note 1] 0 R no user tamper
1 R user tamper active
<siid>.name <name> R the name of the area/point is set to <name>
<area_siid>.armed 0 R area disarmed
W disarm the area
1 R area all armed, delayed
W arm all the area, delayed
2 R area all armed, delayed with bypass
W arm all the area, instant
3 R area all armed, instant
W arm the area partially, delayed
4 R area al armed, instant with bypass
W arm the area partially, instant
5 R area partially armed, delayed
W custom-arm the area, delayed
6 R area partially armed, delayed with bypass
W custom-arm the area, instant
7 R area partially armed, instant
W arm all the area, delay zero
8 R area partially armed, instant with bypass
W arm the area partially, delay zero
9 R area custom armed, delayed
W custom-arm the area, delay zero
10 R area custom armed, delayed with bypass
11 R area custom armed, instant
12 R area custom armed, instant with bypass
<area_siid>.ready.arm.instant 0 R the area is not ready to be armed instantly
1 R the area is ready to be armed instantly
<area_siid>.ready.arm.delay 0 R the area is not ready to be armed with delay
1 R the area is ready to be armed with delay
<area_siid>.ready.disarm 0 R the area is not ready to be disarmed
1 R the area is ready to be disarmed
<area_siid>.force.instant 0 R the area is not ready to be force armed instantly
1 R the area is ready to be force armed instantly
<area_siid>.force.delay 0 R the area is not ready to be force armed with delay
1 R the area is ready to be force armed with delay
<area_siid>.bypassed 0 R no bypassed devices in this area
1 R there are bypassed devices in this area
<area_siid>.alarm 0 R no active alarm
1 R alarm active
<area_siid>.trouble 0 R no trouble
1 R trouble active
<area_siid>.tamper 0 R no tamper
1 R tamper active
<point_siid>.blocked 0 R point not blocked
1 R point blocked
<point_siid>.bypassed 0 R point not bypassed
W unbypass point
1 R point bypassed swinger
W bypass point
2 R point bypassed auto
3 R point bypassed force
4 R point bypassed manual
<point_siid>.open 0 R point closed
1 R point open
read W request the reading of the point's open state
<point_siid>.alarm[Note 2] 0 R no alarm
1 R alarm
<point_siid>.holdup[Note 2] 0 R no holdup alarm
1 R holdup alarm
<point_siid>.duress[Note 2] 0 R no duress alarm
1 R duress alarm
<point_siid>.tamper[Note 2] 0 R no tamper alarm
1 R tamper alarm
<device_siid>.tamper[Note 2] 0 R no tamper alarm
1 R device tampered
<device_siid>.trouble[Note 2] 0 R no trouble
1 R trouble on device
<device_siid>.alarm[Note 2] 0 R no alarm
1 R alarm on device
<device_siid>.active[Note 2] 0 R device deactivated
1 R device active

Note 1 
These datapoints are only updated after the startup phase, i.e. events are generated only for events occurring after the driver is online.

Note 2 
These datapoints, if their value is 1, generate events at startup even if the startupevents option is set to false.

Release Notes

3.4.0

  • initial version release



Bosch is a registered trademark of Bosch Security Systems.

Retrieved from "http://wiki.hsyco.com/3.4.0/index.php?title=Boschmap&oldid=5480"