owner.bacnet

Bacnet owner

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

  • linkedDevice

The BACNet device (device.bacnet) that this output will use to communicate with.

For example root.bacnet.device1 could be the OnSphere path of the BACNet device.

Learn more about BACNET ↗️.

type

string

  • objectType

It represents the various types of objects defined in the BACnet protocol. Each type corresponds to a specific kind of data point in a building automation system. These types are used to categorize and manage different kinds of data and control points.

For example an ANALOG_INPUT represents a point such as a sensor that provides a range of values (e.g., temperature, humidity).

Learn more about BACNET ↗️.

type

string

enum

BINARY_INPUT, ANALOG_INPUT, BINARY_OUTPUT, ANALOG_OUTPUT, BINARY_VALUE, ANALOG_VALUE, MULTI_STATE_VALUE, INTEGER_VALUE, POSITIVE_INTEGER_VALUE

  • objectIndex

Used to uniquely identify an instance of a BACnet object type within a device. In BACnet, multiple objects of the same type can exist within a single device.

For example, a device might have several analog input points (e.g., different temperature sensors). For instance, you might want to read the temperature from the first sensor (ANALOG_INPUT with index 0) and humidity from the second sensor (ANALOG_INPUT with index 1).

Learn more about BACNET ↗️.

type

integer

  • property

This defines the different properties of BACnet objects that can be accessed or manipulated. Each property corresponds to a specific attribute or state of a BACnet object :

  • PRESENT_VALUE : This property represents the current value or state of the object. For example, in the case of an analog input, the PRESENT_VALUE might be the current temperature reading. In a binary output, it could represent whether a device is currently on or off.

  • EVENT_STATE : The EVENT_STATE property indicates whether an object is currently in a normal state or if it has triggered an event, such as an alarm.

  • OUT_OF_SERVICE : This property indicates whether the object is temporarily out of service. When OUT_OF_SERVICE is set to true, the object may not respond to commands or provide its typical readings, as it might be under maintenance or testing.

  • STATUS_IN_ALARM : STATUS_IN_ALARM indicates whether the object is currently in an alarm state. This is a binary property (true/false) that provides a quick check to see if the object has detected an abnormal condition.

  • STATUS_FAULT : This property indicates whether the object has encountered a fault, which usually means it is not operating correctly or cannot perform its intended function.

  • STATUS_OVERRIDDEN : STATUS_OVERRIDDEN indicates whether the normal control of the object has been overridden by a manual or automated command. When overridden, the object does not follow its standard control logic.

  • STATUS_OUT_OF_SERVICE : This property is similar to OUT_OF_SERVICE, but more specifically, it indicates that the object’s service status is currently out, meaning it is not participating in normal control activities.

Learn more about BACNET ↗️.

type

string

enum

PRESENT_VALUE, EVENT_STATE, OUT_OF_SERVICE, STATUS_IN_ALARM, STATUS_FAULT, STATUS_OVERRIDDEN, STATUS_OUT_OF_SERVICE

default

PRESENT_VALUE

  • readStrategy

The strategy used to read this value :

  • SINGLE_SUBSCRIPTION: Real-time updates for presentValue only.

  • OBJECT_SUBSCRIPTION: React on real-time updates for all parameters of the linked BACNet object but reports only presentValue.

  • MULTIPLE_POLLING: Batch polling for multiple values using the BACNet device, reducing network traffic.

  • SINGLE_POLLING: Individual polling for each value, increasing precision at the cost of higher network traffic.

Learn more about BACNET ↗️.

type

string

enum

SINGLE_SUBSCRIPTION, OBJECT_SUBSCRIPTION, MULTIPLE_POLLING, SINGLE_POLLING

  • strategyFrequency

The frequency at which the strategy is applied (polling frequency or subscription renewal depending on readStrategy).

DurationConfigurationEntity

additionalProperties

False

DurationConfigurationEntity

type

object

properties

  • value

The amount of time expressed with the unit

type

integer

  • unit

The unit of time expressed with the value

type

string

enum

NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS

additionalProperties

False