Skip to content

BACnet Optional Environment Variables

There are a number of optional environment variables used in the docker-compose.yml to configure the BACnet device service. There are some differences in variables between IP and MSTP modes, please take note of these.

BACnet/IP Environment Variables

You can configure options for running the BACnet/IP Device Service under environment in the device-bacnet-ip entry of your docker-compose file. The following table describes the available environment variables for use with BACnet/IP:

Parameter Type Required Description Example Value
BACNET_NETWORK_ID String No BACnet instance ID of the Device Service on the network

Default: 0
0
BACNET_NETWORK_INTERFACE String No The interface name to use.

This overrides the default interface determined by the Device Service, Primary interface determined by the device service if not set
"eth1"
BACNET_PORT UInt16 No The port on which BACnet communication occurs

Default: 47808
47809
BACNET_APDU_TIMEOUT UInt32 No The timeout on a confirmed request in milliseconds

Default: 3000
2000
BACNET_APDU_RETRIES UInt8 No The maximum number of retries of a confirmed request

Default: 3
2
BACNET_MULTI_BATCH_SIZE UInt8 No Controls the maximum size of multiple reads and writes

Default: 3
20
BACNET_DISABLE_MULTI_READ Bool No Disable multiple property reads

Set to "true" to disable multiple property reads

Can be overridden on a device basis

Default: "false"
"true"
BACNET_DISABLE_MULTI_WRITE Bool No Disable multiple property writes

Set to "true" to disable multiple property writes

Can be overridden on a device bases

Default: "false"
"true"
BACNET_CANCEL_STALE_COV Bool No Any COV notifications received that are not expected will be responded to with a cancellation request.

Default: "true"
"true"
BACNET_BBMD_ADDRESS String No The IP address for BBMD "172.0.1.17"
BACNET_BBMD_PORT UInt16 No The port number for BBMD

Default: 47808
47808
BACNET_BBMD_TIME_TO_LIVE UInt16 No The time in seconds for which registration is active in the BBMD Foreign-Device-Table

The Device Service automatically re-registers before the specified time elapses

Default: 65535
60000
BACNET_DEFAULT_DISCOVERY_MODE String No Determines the range of properties that will be discovered on a device when generating a profile.

The three options are:
  • All - Will attempt PROP_ALL requests which receive all properties of an object. Upon failure of that call, it will try to read the property list of each object instance and query each property. Upon failure of that, it will attempt to read the standard and optional properties of each object instance on the device according to the BACnet specification of that particular object.
  • Mandatory - Will only query the mandatory properties of each object instance on the device according to the BACnet specification of that particular object.
  • PresentValue - Will only query present value
Default: All
All

BACnet/MSTP Environment Variables

You can configure options for running the BACnet/MSTP Device Service under environment in the device-bacnet-mstp entry of your docker-compose file. The following table describes the available environment variables for use with BACnet/MSTP:

Name Type Required Description Example Value
BACNET_NETWORK_ID String No BACnet instance ID of the Device Service on the network

Default: 0
0
BACNET_SERIAL_INTERFACE String No The path to RS-485 connection on the host. The example provided is the path for bacnet-server "/tmp/virtualport"
BACNET_APDU_TIMEOUT Uint32 No Timeout on a confirmed request in milliseconds.

Default: 60000
10000
BACNET_APDU_RETRIES Uint8 No Maximum number of retries of a confirmed request.

Default: 3
2
BACNET_MULTI_BATCH_SIZE Uint8 No Controls the maximum size of multiple reads and writes

Default: 20
25
BACNET_DISABLE_MULTI_READ Bool No Disable multiple property reads.

Default: "false"
"true"
BACNET_DISABLE_MULTI_WRITE Bool No Disable multiple property writes.

Default: "false"
"true"
BACNET_CANCEL_STALE_COV Bool No Any COV notifications received that are not expected will be responded to with a cancellation request.

Default: "true"
"true"
BACNET_DEFAULT_DISCOVERY_MODE String No Determines the range of properties that will be discovered on a device when generating a profile.

The three options are:
  • All - Will attempt PROP_ALL requests which receive all properties of an object. Upon failure of that call, it will try to read the property list of each object instance and query each property. Upon failure of that, it will attempt to read the standard and optional properties of each object instance on the device according to the BACnet specification of that particular object.
  • Mandatory - Will only query the mandatory properties of each object instance on the device according to the BACnet specification of that particular object.
  • PresentValue - Will only query present value
Default: All
All
Back to top