OIS Tools Web supports the debugging of OIS data points files. You can find all attributes that are available for FS20 Cu-Handler and their default values. If an attribute has not been configured, the default value applies.
FS20 Cu-Handler Unit Attributes
The following attributes can be configured for the FS20 Cu-Handler unit:
- apdu_segment_timeout
- apdu_timeout
- bbmd_fd_conf
- bbs_bbmd
- bbs_fd_bbmd
- bbs_fd_lifetime
- bbs_fd_timeout
- bbs_fdt
- bbs_interface
- callpath
- configfile
- contextsensitivecommands
- eventsbeforeupdate
- import
- max_segments_accepted
- my_device_instance
- no_reset_inspection
- notifyallfieldpoints
- number_of_apdu_retries
- port
- process_identifier
- proxycallpath
- proxyhostname
- proxyusername
- segmentation_supported
- supervision
- use_physical_channel
- vu_neighbours
- with_lfmd10
- no_cmd_test_area_and_section
Configuring FS20 Cu-Handler Attributes
Attributes that are in bold type are always configured. Attributes that are in italic type are set to the default value and may be omitted.
Attribute | Description | Default | Disable | Enable | Remark |
|---|---|---|---|---|---|
proxyhostname | Remote Cu proxy for proxy protocol port forwarding. [username]@[hostname]:[port]/[local port]:[remote port] Example: user01@127.0.0.1/10024:20048 | - | - | - |
|
configfile | Name of the SiB-X file exported by the FS20 configuration program. If the configuration is split into several data points files, a file-name mask can be used. You need to define a relative sub-path to the FS20 path. Example: etc/import/FS20_system_1_sibx.xml | etc/import/*sibx.xml | - | - | Name of the SiB-X file |
use_physical_channel | True: The FS20 data points of the element category "CHANNEL_PHYS" are assigned to data points. False: The FS20 data points of the element category "CHANNEL_PHYS" are not visible at the management system. | False | False | True | Mapping of physical data points |
vu_neighbours | List of the unit names of the Vu-Handlers that are connected to the Cu-Handler. Multiple unit names are separated by comma. Example: Vu_1, Vu_2 | List of all configured Vu-Handlers | - | - | List of the connected Vu-Handlers |
no_cmd_test_area_and_section | True: The Revision mode on and Revision mode off orders / commands for an area and section is not performed if the attribute is set to true. False: The Revision mode on and Revision mode off orders / commands set for an area and section is performed if the attribute is set to false. You need to ensure the FS20 fire panel supports these orders / commands.
| False | False | True |
|
no_reset_inspection | True: Revision messages are not reset automatically. False: Revision messages are reset automatically. | True | False | True |
|
Specific FS20 Attributes
Attributes for Configuring the BACnet Stack
In general, the default values are used for these attributes. We recommend that only BACnet experts change these values. Usually, configuring the apdu_timeout, apdu_segement_timeout and number_of_apdu_retries attributes is not necessary. The values of these attributes are read from the SiB-X file.
Attribute | Default | Type | Description | Required |
|---|---|---|---|---|
apdu_timeout | sus SiB-X file | int | Timeout of a BACnet transmission in milliseconds The FS20 APDU timeout time in SintesoWorks FXS2002 needs to be set to the same value. The FS20 will then receive a sign of life twice within the client timeout time. Minimum 2000 | No |
number_of_apdu_retries | sus SiB-X file | int | Number of repetitions when transmitting BACnet telegrams (0 for no repetition) | No |
segmentation_supported | 0 | int | Support of segmented data transmission 0 = segmented_both 1 = segmented_transmit 2 = segmented_receive 3 = no_segmentation This attribute always needs to be 0. Otherwise the update process will slow down considerably (error in the BBS stack of FS20). | No |
apdu_segment_timeout | sus SiB-X file | int | Timeout of the segmented BACnet data transmission in milliseconds. This value needs to be smaller than apdu_timeout. Minimum 2000 | No |
max_segments_accepted | 128 | int | Maximum number of segments in a BACnet transmission. This value needs to be high enough to ensure that long object lists and event information can be read. | No |
Attributes for Configuring the BACnet Stack Interface
In general, only the bbs_interface attribute needs to be configured.
Attribute | Default | Type | Description | Required |
|---|---|---|---|---|
bbs_interface | - | int | BBS interface [nic]:[udp], for example ens160:47808 | No |
bbmd_fd_conf | autoconfig | str | Defines the BBMD and FD (foreign device) functionality.
However, unless you are specialized in the BACnet configuration, do not change the default value autoconfig. |
|
bbs_bbmd | sus SiB-X file | str | This attribute only needs to be configured if the bbmd_fd_conf attribute is configured with the value config_bbs_bbmd. This attribute defines the list of IP addresses of all those FS20 for which BBMD is enabled. List of BBMD entries "[ip]:[port]:[mask],..." The mask value is generally not used. Example: 192.168.1.2:47809,192.168.2.3:47809 If the bbmd_fd_conf attribute is configured with the value autoconf, then the content of the SiB-X file determines the configuration as follows:
| No |
Attributes for Configuring the Foreign Device
Foreign devices are BACnet devices. The IP subnet address of the foreign device differs from the IP subnet addresses of all the devices in the BACnet or IP network the foreign device attempts to communicate with. With the foreign device procedure, remote devices can dynamically link with a BACnet configuration. Specific BACnet services are available for creating an entry in the Foreign Device Table (FDT). In order to use the foreign-device functionality, the FDT functionality needs to be enabled for FS20.
The foreign device functionality is used in the following cases:
- For the redundant configuration of Cu-Handlers that connect to the same FS20. The redundant functionality is not possible with a BBMD if the redundant Cu-Handler is located in the same network segment.
- If the Cu-Handler and the FS20 are in different network segments.
- To avoid broadcast messages between the Cu-Handler and the FS20 in the network.
Example of a Configuration
In a system with FDT functionality, an FS20 assumes the functionality of the BBMD. The Cu-Handlers register periodically at this FS20 as foreign devices.
In case of a BACnet broadcast these UDP packets are sent to the BBMD defined with bbs_fd_bbmd using a unicast. The BBMD forwards the UDP packets to the appropriate recipient using a unicast (or broadcast).
Attribute | Default | Type | Description | Required |
|---|---|---|---|---|
bbs_fd_bbmd | from the SiB-X file | str | This attribute only needs to be configured if the bbmd_fd_conf attribute is configured with the value config_bbs_fd_bbmd. The IP address of the BBMD where this Cu-Handler registers with the lifetime configured using the bbs_fd_lifetime attribute. The FD functionality is activated by this attribute. The BBMD functionality of this Cu-Handler is then inactive. The bbs_bbmd attribute does not need to be configured in this case. If the bbmd_fd_conf attribute is configured with the value autoconf, then the content of the SiB-X file determines the configuration. If the activate FDT check box is marked in the configuration of an FS20 device, then the BBMD functionality is disabled. The bbmd_fd_conf attribute is set to the IP address of the first FS20 for which the FD functionality is enabled (activate FDT check box marked). | No |
bbs_fd_lifetime | 900 seconds = 15 minutes |
| Lifetime of the registration of a Foreign Device in seconds. Registration at the FS20 defined by the bbs_fd_bbmd attribute takes place periodically. | No |
Attributes for Configuring the BACnet Client (Cu-Handler)
Attribute | Default | Type | Description | Required |
|---|---|---|---|---|
supervision | Calculated minimum value | int | The supervision time (in seconds) determines the delay after which a line failure is reported. The value needs to be at least be 2 * apdu_timeout * number_of_apdu_retries - 1. Otherwise a connection error will be detected before all repetitions of a message have been sent by the BACnet stack. If the value set is too small, it will be corrected automatically. Short monitoring times increase the base load in the network. It has to be taken into account that every server (BACnet device) is monitored individually. The BACnet server monitoring time is calculated internally ((supervision-2)/2 seconds) and cannot be set separately. The BACnet client monitoring time of the FS20 needs to be at least as long as the supervision time. Default: 2 * apdu_timeout * number_of_apdu_retries - 1 | No |
my_device_instance | - | int | Instance number of the BACnet device ID of the Cu-Handler The Cu-Handler needs to be configured as a proper FS20 client. | Yes |
port | 1 | int | BBS port ID This is the port ID of the BACnet stack. | No |
process_identifier | 1 | int | Process identifier for the following BACnet requests from the Cu-Handler to the FS20:
| No |
Attributes for Configuring the BACnet Device
The attributes of a BACnet device are listed in the table below. All these attributes are set automatically by the data channel. Keep in mind to never configure these values. The data channel reads these values from the SiB-X file.
Attribute | Default | Type | Description | Required |
|---|---|---|---|---|
peer_device_instance | sus SiB-X file | int | Instance number of the BACnet device of the FS20 The data channel reads this value from the SiB-X file. | peer_device_instance |
peer_device_address | sus SiB-X file | str | IP address of the FS20 The data channel reads this value from the SiB-X file. | peer_device_address |
time_server | sus SiB-X file | bool | True: Activation of time synchronization with the FS20 This FS20 panel needs to act as a time server for the other FS20 systems. Time synchronization takes place as follows:
Correct time synchronization is mandatory; otherwise events that occurred prior to the update may be lost to the management system. If the Cu-Handler is running on a separate computer, the time of this computer needs to be synchronized using the NTP service (Linux service). The data channel reads this value from the SiB-X file. | time_server |