BACnet
Availability table
Module |
Available |
|---|---|
|
|
|
bacnet controller
This controller expose features of osp-bacnet through an object controller.
- bacnet.acknowledgeAlarm(acknowledgeDataToStr: string)
Send an alarm acknowledgement request to a BACnet device.
- Arguments:
acknowledgeDataToStr
- Returns:
Return the status of the alarm acknowledgement, indicating if it was successful or not.
- bacnet.acknowledgeAlarm(deviceId: number, objectId: number, instanceId: number, stateToAcknowledge: number, processIdentifier?: number)
Acknowledge a BACnet alarm using a simplified parameter set.
- Arguments:
deviceId – BACnet device identifier used to connect to the remote device.
objectId – BACnet object type Id to acknowledge (for example, 2 for Analog Value).
instanceId – BACnet object instance number to acknowledge.
stateToAcknowledge – State of the event or alarm being acknowledged. Corresponds to the BACnet EventState enumeration. Can be null to ackowledge all states.
processIdentifier – Process identifier of the notification which generated the alarm to acknowledge.
- Returns:
ExecutionResult indicating acknowledgement success.
- bacnet.readBooleanProperty(deviceIdentifier: number, objectIdentifier: number, instanceNumber: number, propertyIdentifier: number)
Read a text property from a BACnet device and return the resulting text.
- Arguments:
deviceIdentifier – BACnet device instance number to read from.
objectIdentifier – BACnet object type numeric code for the target object.
instanceNumber – BACnet object instance number for the target object.
propertyIdentifier – BACnet property identifier numeric code to read.
- Returns:
ExecutionResult with success flag and the read text as message.
- bacnet.readDecimalProperty(deviceIdentifier: number, objectIdentifier: number, instanceNumber: number, propertyIdentifier: number)
Read a decimal property from a BACnet device and return the resulting decimal.
- Arguments:
deviceIdentifier – BACnet device instance number to read from.
objectIdentifier – BACnet object type numeric code for the target object.
instanceNumber – BACnet object instance number for the target object.
propertyIdentifier – BACnet property identifier numeric code to read.
- Returns:
ExecutionResult with success flag and the read decimal as message.
- bacnet.readIntegerProperty(deviceIdentifier: number, objectIdentifier: number, instanceNumber: number, propertyIdentifier: number)
Read an integer property from a BACnet device and return the resulting integer.
- Arguments:
deviceIdentifier – BACnet device instance number to read from.
objectIdentifier – BACnet object type numeric code for the target object.
instanceNumber – BACnet object instance number for the target object.
propertyIdentifier – BACnet property identifier numeric code to read.
- Returns:
ExecutionResult with success flag and the read integer as message.
- bacnet.readStringProperty(deviceIdentifier: number, objectIdentifier: number, instanceNumber: number, propertyIdentifier: number)
Read a text property from a BACnet device and return the resulting text.
- Arguments:
deviceIdentifier – BACnet device instance number to read from.
objectIdentifier – BACnet object type numeric code for the target object.
instanceNumber – BACnet object instance number for the target object.
propertyIdentifier – BACnet property identifier numeric code to read.
- Returns:
ExecutionResult with success flag and the read text as message.
- bacnet.refreshDeviceConfiguration(deviceIdentifier: number)
Refreshes the cached information of the BACnet device.
- Arguments:
deviceIdentifier – BACnet device instance number to refresh.
- Returns:
ExecutionResult with success flag and message.
- bacnet.writeBooleanProperty(deviceIdentifier: number, objectIdentifier: number, instanceNumber: number, propertyIdentifier: number, arrayIndex: number, value: any, priority: number, adapter: string)
Write a boolean property to a BACnet device.
- Arguments:
deviceIdentifier – BACnet device instance number to write to.
objectIdentifier – BACnet object type numeric code for the target object.
instanceNumber – BACnet object instance number for the target object.
propertyIdentifier – BACnet property identifier numeric code to write.
arrayIndex – Optional array index for array properties. Use null to write the full property (not a specific array element).
value – Value to write. For this method it must be a boolean-compatible value. Accepted forms depend on the scripting runtime (e.g., true/false).
priority – BACnet write priority (1..16). Lower numbers indicate higher priority, typical relinquish is 16.
adapter – Adapter name used to route the request to the correct BACnet adapter.
- Returns:
ExecutionResult with success flag and message.
- bacnet.writeDecimalProperty(deviceIdentifier: number, objectIdentifier: number, instanceNumber: number, propertyIdentifier: number, arrayIndex: number, value: any, priority: number, adapter: string)
Write a decimal property to a BACnet device.
- Arguments:
deviceIdentifier – BACnet device instance number to write to.
objectIdentifier – BACnet object type numeric code for the target object.
instanceNumber – BACnet object instance number for the target object.
propertyIdentifier – BACnet property identifier numeric code to write.
arrayIndex – Optional array index for array properties. Use null to write the full property (not a specific array element).
value – Value to write. For this method it must be a boolean-compatible value. Accepted forms depend on the scripting runtime (e.g., true/false).
priority – BACnet write priority (1..16). Lower numbers indicate higher priority, typical relinquish is 16.
adapter – Adapter name used to route the request to the correct BACnet adapter.
- Returns:
ExecutionResult with success flag and message.
- bacnet.writeIntegerProperty(deviceIdentifier: number, objectIdentifier: number, instanceNumber: number, propertyIdentifier: number, arrayIndex: number, value: any, priority: number, adapter: string)
Write an integer property to a BACnet device.
- Arguments:
deviceIdentifier – BACnet device instance number to write to.
objectIdentifier – BACnet object type numeric code for the target object.
instanceNumber – BACnet object instance number for the target object.
propertyIdentifier – BACnet property identifier numeric code to write.
arrayIndex – Optional array index for array properties. Use null to write the full property (not a specific array element).
value – Value to write. For this method it must be a boolean-compatible value. Accepted forms depend on the scripting runtime (e.g., true/false).
priority – BACnet write priority (1..16). Lower numbers indicate higher priority, typical relinquish is 16.
adapter – Adapter name used to route the request to the correct BACnet adapter.
- Returns:
ExecutionResult with success flag and message.
- bacnet.writeStringProperty(deviceIdentifier: number, objectIdentifier: number, instanceNumber: number, propertyIdentifier: number, arrayIndex: number, value: any, priority: number, adapter: string)
Write a text property to a BACnet device.
- Arguments:
deviceIdentifier – BACnet device instance number to write to.
objectIdentifier – BACnet object type numeric code for the target object.
instanceNumber – BACnet object instance number for the target object.
propertyIdentifier – BACnet property identifier numeric code to write.
arrayIndex – Optional array index for array properties. Use null to write the full property (not a specific array element).
value – Value to write. For this method it must be a boolean-compatible value. Accepted forms depend on the scripting runtime (e.g., true/false).
priority – BACnet write priority (1..16). Lower numbers indicate higher priority, typical relinquish is 16.
adapter – Adapter name used to route the request to the correct BACnet adapter.
- Returns:
ExecutionResult with success flag and message.