osp-bacnet
Overview
BACnet is a communication protocol for Building Automation and Control, allowing communication of building automation and control systems.
The osp-bacnet module allows communicating with BACnet devices over IP for reading and writing values.
Warning
The osp-bacnet module can communicate with BACnet devices only if they are in the same subnet, or though a BACnet router (BBMD). It means that if no BACnet router is available, the osp-bacnet module must be run as a remote module and connected on host network.
List of configuration files
Filename |
Short description |
Format |
Documentation |
|---|---|---|---|
module.service |
Each service is defined in a separate file and then combined into a unified compose stack file. |
yml |
See the Swarm administration or Official documentation |
module.bacnet |
Defines the module configuration. |
json |
|
device.bacnet |
Defines a BACnet device configuration. |
json |
|
owner.bacnet |
Defines the configuration of a value to read on a BACnet device. |
json |
|
output.bacnet |
Defines the configuration of a value to write on a BACnet device. |
json |
|
notification.bacnet |
Defines the configuration to be notified by a Notification class on a BACnet device. |
json |
Environment Variables
All modules env variables
Variable Name |
Default Value |
Usage |
|---|---|---|
PROMETHEUS_PORT |
9100 |
The internal port used for Openmetrics exposition. |
DISPATCHER_HOST |
modules_configuration-dispatcher_main |
The hostname on which the modules can fetch the configuration. |
DISPATCHER_PORT |
10000 |
The port used by the module to listen for configuration request. |
USE_LEGACY_RESTART |
Not set |
When this flag is enabled, the container will terminate itself whenever a restart is needed (for example, after a configuration change). This is the legacy restart (before version 2.1.0). Otherwise, the system will simply restart the process running inside the container. |
CUSTOM_JVM_OPTIONS |
Not set |
Allow to inject JVM options. See Configuration changes for more information. |
ALLOW_VERSION_MISMATCH |
Not set |
Allow to disable the version check when a new configuration is published to a module. By default, a module will not be restarted if its configuration does not match its version. |
Dedicated variables
None
Hot-reload
Hot reload is supported for most elements. However, changes to the following configurations will trigger a full module reload:
Messaging configuration
BACnet network configuration
BACnet FDT configuration
Local device configuration