module.bacnet

Bacnet module

type

object

properties

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

  • isTemplateGeneratedByOspComposer

If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.

type

boolean

  • messagingConfiguration

The configuration of the Rabbit MQ used for communication

MessagingConfigurationEntity

  • loggingConfiguration

The configuration of module’s logging

default

moduleLogLevel

INFO

externalLogLevel

WARN

LoggingConfigurationEntity

  • networkConfiguration

The configuration of the Bacnet network

BacnetNetworkConfigurationFile

  • deviceIdentifier

This represents your application on the BACnet network. The constructor takes a unique device ID which is defined by this parameter.

For example 1234.

Learn more about BACNET ↗️.

type

integer

additionalProperties

False

MessagingConfigurationEntity

type

object

properties

  • clientId

The ID of the client, must be different for each module instance.

type

string

  • host

The host of the rabbit MQ provider

type

string

  • bufferSize

The size of the buffer to use when the broker is disconnected (default: 60000).

type

integer

minimum

1

default

60000

  • storeMessagesOnDisk

Flag to indicate to store the message (The path /osp/messages must be mount to a volume).

type

boolean

default

False

additionalProperties

False

LoggingConfigurationEntity

type

object

properties

  • moduleLogLevel

The log level for module’s behavior logging

type

string

enum

TRACE, DEBUG, INFO, WARN, ERROR

default

INFO

  • scriptLogLevel

The log level for module’s internal script behavior logging (if not set the moduleLogLevel will be used)

type

string

enum

TRACE, DEBUG, INFO, WARN, ERROR

  • externalLogLevel

The log level for external libraries logging

type

string

enum

TRACE, DEBUG, INFO, WARN, ERROR

default

WARN

additionalProperties

False

BacnetNetworkConfigurationFile

type

object

properties

  • subnetAddress

The address of the local subnet, NOT the subnet mask. The subnet address is required because the given local bind address could be the wildcard address, i.e. 0.0.0.0, from which the broadcast address cannot be calculated.

For example 192.168.0.0, is a valid local subnet.

Learn more about BACNET ↗️.

type

string

  • subnetMask

The number of bits in the local subnet.

For example if your IPv4 address space is 200.100.10.0/24 (which contains 256 addresses), the value to set here is 24.

Learn more about BACNET ↗️.

type

integer

  • port

To communicate with other BACNet devices the module uses a locally created device. This device get by default the port 47808 (which is the default in a lot of BACNet configurations). The problem is that if the port 47808 is already used by another service this can prove to be problematic. You can configure the port you are using on the local device here.

For example you could choose to use 47809.

Learn more about BACNET ↗️.

type

integer

default

47808

additionalProperties

False