bacnet_plugin_bindings.g library

Classes

BACnet_Access_Error

BACnet_Application_Data_Value

BACnet_Bit_String

bit strings They could be as large as 256/8=32 octets

BACnet_Character_String

BACnet_COV_Data

BACnet_Create_Object_Data

CreateObject-Request ::= SEQUENCE { object-specifier 0 CHOICE { object-type 0 BACnetObjectType, object-identifier 1 BACnetObjectIdentifier }, list-of-initial-values 1 SEQUENCE OF BACnetPropertyValue OPTIONAL }

BACnet_Date

date

BACnet_DateTime

BACnet_Delete_Object_Data

DeleteObject-Request ::= SEQUENCE { object-identifier BACnetObjectIdentifier

BACnet_Device_Address

BACnet_IP_Address

BACnet IPv4 Address

BACnet_IP_Broadcast_Distribution_Mask

BACnet IPv4 Broadcast Distribution Mask

BACnet_IP_Broadcast_Distribution_Table_Entry

BACnet/IP Broadcast Distribution Table (BDT)

BACnet_IP_Foreign_Device_Table_Entry

Foreign Device Table (FDT)

BACnet_List_Element_Data

AddListElement-Request ::= SEQUENCE { object-identifier 0 BACnetObjectIdentifier, property-identifier 1 BACnetPropertyIdentifier, property-array-index 2 Unsigned OPTIONAL, -- used only with array datatype list-of-elements 3 ABSTRACT-SYNTAX.&Type } RemoveListElement-Request ::= SEQUENCE { object-identifier 0 BACnetObjectIdentifier, property-identifier 1 BACnetPropertyIdentifier, property-array-index 2 Unsigned OPTIONAL, -- used only with array datatypes list-of-elements 3 ABSTRACT-SYNTAX.&Type }

bacnet_npdu_data_t

This structure defines the NPCI (header part) of the NPDU. See Figures 5-2 and 7-1 of the BACnet standard for clarity

BACnet_Object_Id

note: with microprocessors having lots more code space than memory, it might be better to have a packed encoding with a library to easily access the data.

BACnet_Octet_String

BACnet_Property_Reference

BACnet_Property_Value

BACnet_Read_Access_Data

Forward declaration of RPM-style data structure

BACnet_Read_Property_Data

BACnet_Read_Range_Data

BACnet_Reinitialize_Device_Data

BACnet_Subscribe_COV_Data

BACnet_Time

time

BACnet_Timestamp

BACnet_TSM_Data

5.4.1 Variables And Parameters / / The following variables are defined for each instance of / / Transaction State Machine:

BACnet_Write_Access_Data

BACnet_Write_Property_Data

@note: write property can have application tagged data, or context tagged data, or even complex data types (i.e. opening and closing tag around data). It could also have more than one value or element.

BacnetBindings

Bindings for bacnet-stack (C library). Covers Core, Datalink (BIP), Services, and Basic Objects.

BACnetPropertyReference

BACnetPropertyReference ::= SEQUENCE { propertyIdentifier 0 BACnetPropertyIdentifier, propertyArrayIndex 1 Unsigned OPTIONAL -- used only with array datatype -- if omitted with an array the entire array is referenced }

commonBacObj_s

Structure to define the Object Properties common to all Objects.

devObj_s

Structure to define the Properties of Device Objects which distinguish one instance from another. This structure only defines fields for properties that are unique to a given Device object. The rest may be fixed in device.c or hard-coded into the read-property encoding. This may be useful for implementations which manage multiple Devices, eg, a Gateway.

object_functions

Defines the group of object helper functions for any supported Object. @ingroup ObjHelpers Each Object must provide some implementation of each of these helpers in order to properly support the handlers. Eg, the ReadProperty handler handler_read_property() relies on the instance of Object_Read_Property for each Object type, or configure the function as NULL. In both appearance and operation, this group of functions acts like they are member functions of a C++ Object base class.

property_list_t

rrpropertyinfo

Structure to return the type of requests a given object property can accept and the address of the function to handle the request

special_property_list_t

UnnamedUnion

UnnamedUnion$1

UnnamedUnion$2

Enums

BACnet_Confirmed_Service_Choice

BACnetConfirmedServiceChoice ::= ENUMERATED

BACNET_ERROR_CLASS

BACNET_ERROR_CODE

These are sorted in the order given in Clause 18. ERROR, REJECT AND ABORT CODES The Class and Code pairings are required to be used in accordance with Clause 18.

BACNET_MESSAGE_PRIORITY

BACNET_NETWORK_MESSAGE_TYPE

Network Layer Message Type */ /*If Bit 7 of the control octet described in 6.2.2 is 1, / / a message type octet shall be present as shown in Figure 6-1. / / The following message types are indicated:

BACNET_REINITIALIZED_STATE

BACnet_Services_Supported

BACnetServicesSupported ::= BIT STRING

BACNET_TSM_STATE

BACnet_Unconfirmed_Service_Choice

BACnetUnconfirmedServiceChoice ::= ENUMERATED

BACnetDeviceStatus

BACnetObjectType

BACnetPropertyIdentifier

BACnetSegmentation

Constants

BIP_HEADER_MAX → const int

BIP_MPDU_MAX → const int

MAX_DEV_DESC_LEN → const int

MAX_DEV_LOC_LEN → const int

MAX_DEV_MOD_LEN → const int

MAX_DEV_NAME_LEN → const int

MAX_DEV_VER_LEN → const int

MAX_MPDU → const int

Typedefs

abort_function = Pointer<NativeFunction<abort_functionFunction>>

generic abort reply function

abort_functionFunction = Void Function(Pointer<BACNET_ADDRESS> src, Uint8 invoke_id, Uint8 abort_reason, Bool server)

BACNET_ACCESS_ERROR = BACnet_Access_Error

BACNET_ADDRESS = BACnet_Device_Address

BACNET_APPLICATION_DATA_VALUE = BACnet_Application_Data_Value

BACNET_ARRAY_INDEX = Uint32

BACNET_BIT_STRING = BACnet_Bit_String

BACNET_CHARACTER_STRING = BACnet_Character_String

BACNET_CONFIRMED_SERVICE_ACK_DATA = _confirmed_service_ack_data

BACNET_CONFIRMED_SERVICE_DATA = _confirmed_service_data

BACNET_COV_DATA = BACnet_COV_Data

BACNET_CREATE_OBJECT_DATA = BACnet_Create_Object_Data

BACNET_DATE = BACnet_Date

BACNET_DATE_TIME = BACnet_DateTime

BACNET_DELETE_OBJECT_DATA = BACnet_Delete_Object_Data

BACNET_IP_ADDRESS = BACnet_IP_Address

BACNET_IP_BROADCAST_DISTRIBUTION_MASK = BACnet_IP_Broadcast_Distribution_Mask

BACNET_IP_BROADCAST_DISTRIBUTION_TABLE_ENTRY = BACnet_IP_Broadcast_Distribution_Table_Entry

BACNET_IP_FOREIGN_DEVICE_TABLE_ENTRY = BACnet_IP_Foreign_Device_Table_Entry

BACNET_LIST_ELEMENT_DATA = BACnet_List_Element_Data

BACNET_NPDU_DATA = bacnet_npdu_data_t

BACNET_OBJECT_ID = BACnet_Object_Id

BACNET_OCTET_STRING = BACnet_Octet_String

BACNET_PROPERTY_REFERENCE = BACnet_Property_Reference

BACNET_PROPERTY_VALUE = BACnet_Property_Value

BACNET_READ_ACCESS_DATA = BACnet_Read_Access_Data

BACNET_READ_PROPERTY_DATA = BACnet_Read_Property_Data

BACNET_READ_RANGE_DATA = BACnet_Read_Range_Data

BACNET_REINITIALIZE_DEVICE_DATA = BACnet_Reinitialize_Device_Data

BACNET_SUBSCRIBE_COV_DATA = BACnet_Subscribe_COV_Data

BACNET_TIME = BACnet_Time

BACNET_TIMESTAMP = BACnet_Timestamp

BACNET_TSM_DATA = BACnet_TSM_Data

BACNET_UNSIGNED_INTEGER = Uint64

BACNET_WRITE_ACCESS_DATA = BACnet_Write_Access_Data

BACNET_WRITE_PROPERTY_DATA = BACnet_Write_Property_Data

COMMON_BAC_OBJECT = commonBacObj_s

complex_error_function = Pointer<NativeFunction<complex_error_functionFunction>>

complex error reply function

complex_error_functionFunction = Void Function(Pointer<BACNET_ADDRESS> src, Uint8 invoke_id, Uint8 service_choice, Pointer<Uint8> service_request, Uint16 service_len)

confirmed_ack_function = Pointer<NativeFunction<confirmed_ack_functionFunction>>

generic confirmed ack function handler

confirmed_ack_functionFunction = Void Function(Pointer<Uint8> service_request, Uint16 service_len, Pointer<BACNET_ADDRESS> src, Pointer<BACNET_CONFIRMED_SERVICE_ACK_DATA> service_data)

confirmed_function = Pointer<NativeFunction<confirmed_functionFunction>>

generic confirmed function handler / / Suitable to handle the following services: / / Acknowledge_Alarm, Confirmed_COV_Notification, / / Confirmed_Event_Notification, Get_Alarm_Summary, / / Get_Enrollment_Summary_Handler, Get_Event_Information, / / Subscribe_COV_Handler, Subscribe_COV_Property, / / Life_Safety_Operation, Atomic_Read_File, / / Confirmed_Atomic_Write_File, Add_List_Element, / / Remove_List_Element, Create_Object_Handler, / / Delete_Object_Handler, Read_Property, / / Read_Property_Conditional, Read_Property_Multiple, Read_Range, / / Write_Property, Write_Property_Multiple, / / Device_Communication_Control, Confirmed_Private_Transfer, / / Confirmed_Text_Message, Reinitialize_Device, / / VT_Open, VT_Close, VT_Data_Handler, / / Authenticate, Request_Key

confirmed_functionFunction = Void Function(Pointer<Uint8> service_request, Uint16 service_len, Pointer<BACNET_ADDRESS> src, Pointer<BACNET_CONFIRMED_SERVICE_DATA> service_data)

confirmed_simple_ack_function = Pointer<NativeFunction<confirmed_simple_ack_functionFunction>>

generic confirmed simple ack function handler

confirmed_simple_ack_functionFunction = Void Function(Pointer<BACNET_ADDRESS> src, Uint8 invoke_id)

create_object_function = Pointer<NativeFunction<create_object_functionFunction>>

@brief CreateObject service handler for an object @ingroup ObjHelpers @param object_instance in instance number of the object to create, or BACNET_MAX_INSTANCE to create the next free object instance @return object instance number created, or BACNET_MAX_INSTANCE if not

create_object_functionFunction = Uint32 Function(Uint32 object_instance)

Dartabort_functionFunction = void Function(Pointer<BACNET_ADDRESS> src, int invoke_id, int abort_reason, bool server)

DartBACNET_ARRAY_INDEX = int

DartBACNET_UNSIGNED_INTEGER = int

Dartcomplex_error_functionFunction = void Function(Pointer<BACNET_ADDRESS> src, int invoke_id, int service_choice, Pointer<Uint8> service_request, int service_len)

Dartconfirmed_ack_functionFunction = void Function(Pointer<Uint8> service_request, int service_len, Pointer<BACNET_ADDRESS> src, Pointer<BACNET_CONFIRMED_SERVICE_ACK_DATA> service_data)

Dartconfirmed_functionFunction = void Function(Pointer<Uint8> service_request, int service_len, Pointer<BACNET_ADDRESS> src, Pointer<BACNET_CONFIRMED_SERVICE_DATA> service_data)

Dartconfirmed_simple_ack_functionFunction = void Function(Pointer<BACNET_ADDRESS> src, int invoke_id)

Dartcreate_object_functionFunction = int Function(int object_instance)

Dartdelete_object_functionFunction = bool Function(int object_instance)

Darterror_functionFunction = void Function(Pointer<BACNET_ADDRESS> src, int invoke_id, BACNET_ERROR_CLASS error_class, BACNET_ERROR_CODE error_code)

Darti_am_router_to_network_functionFunction = void Function(Pointer<BACNET_ADDRESS> src, int network)

Dartlist_element_functionFunction = int Function(Pointer<BACNET_LIST_ELEMENT_DATA> list_element)

Dartobject_count_functionFunction = int Function()

Dartobject_cov_clear_functionFunction = void Function(int object_instance)

Dartobject_cov_functionFunction = bool Function(int object_instance)

Dartobject_index_to_instance_functionFunction = int Function(int index)

Dartobject_init_functionFunction = void Function()

Dartobject_intrinsic_reporting_functionFunction = void Function(int object_instance)

Dartobject_iterate_functionFunction = int Function(int current_index)

Dartobject_name_functionFunction = bool Function(int object_instance, Pointer<BACNET_CHARACTER_STRING> object_name)

Dartobject_timer_functionFunction = void Function(int object_instance, int milliseconds)

Dartobject_valid_instance_functionFunction = bool Function(int object_instance)

Dartobject_value_list_functionFunction = bool Function(int object_instance, Pointer<BACNET_PROPERTY_VALUE> value_list)

Dartread_property_functionFunction = int Function(Pointer<BACNET_READ_PROPERTY_DATA> rp_data)

Dartreject_functionFunction = void Function(Pointer<BACNET_ADDRESS> src, int invoke_id, int reject_reason)

Dartrpm_property_lists_functionFunction = void Function(Pointer<Pointer<Int32>> pRequired, Pointer<Pointer<Int32>> pOptional, Pointer<Pointer<Int32>> pProprietary)

Dartrr_handler_functionFunction = int Function(Pointer<Uint8> apdu, Pointer<BACNET_READ_RANGE_DATA> pRequest)

Dartrr_info_functionFunction = bool Function(Pointer<BACNET_READ_RANGE_DATA> pRequest, Pointer<RR_PROP_INFO> pInfo)

Darttsm_timeout_functionFunction = void Function(int invoke_id)

DartTYPE_BACNET_TIMESTAMP_TYPE = int

Dartunconfirmed_functionFunction = void Function(Pointer<Uint8> service_request, int len, Pointer<BACNET_ADDRESS> src)

Dartwrite_property_functionFunction = bool Function(Pointer<BACNET_WRITE_PROPERTY_DATA> wp_data)

delete_object_function = Pointer<NativeFunction<delete_object_functionFunction>>

@brief DeleteObject service handler for an object @ingroup ObjHelpers @param object_instance in instance number of the object to delete @return true if the object instance is deleted

delete_object_functionFunction = Bool Function(Uint32 object_instance)

DEVICE_OBJECT_DATA = devObj_s

error_function = Pointer<NativeFunction<error_functionFunction>>

generic error reply function

error_functionFunction = Void Function(Pointer<BACNET_ADDRESS> src, Uint8 invoke_id, UnsignedInt error_class, UnsignedInt error_code)

i_am_router_to_network_function = Pointer<NativeFunction<i_am_router_to_network_functionFunction>>

I Am Router To Network function

i_am_router_to_network_functionFunction = Void Function(Pointer<BACNET_ADDRESS> src, Uint16 network)

list_element_function = Pointer<NativeFunction<list_element_functionFunction>>

@brief AddListElement or RemoveListElement from an object list property @ingroup ObjHelpers @param list_element in Pointer to the BACnet_List_Element_Data structure, which is packed with the information from the request. @return The length of the apdu encoded or #BACNET_STATUS_ERROR or #BACNET_STATUS_ABORT or #BACNET_STATUS_REJECT.

list_element_functionFunction = Int Function(Pointer<BACNET_LIST_ELEMENT_DATA> list_element)

object_count_function = Pointer<NativeFunction<object_count_functionFunction>>

Counts the number of objects of this type. @ingroup ObjHelpers @return Count of implemented objects of this type.

object_count_functionFunction = UnsignedInt Function()

object_cov_clear_function = Pointer<NativeFunction<object_cov_clear_functionFunction>>

Look in the table of objects for this instance to clear the changed flag. @ingroup ObjHelpers @param in The object instance number to be looked up.

object_cov_clear_functionFunction = Void Function(Uint32 object_instance)

object_cov_function = Pointer<NativeFunction<object_cov_functionFunction>>

Look in the table of objects for this instance to see if value changed. @ingroup ObjHelpers @param in The object instance number to be looked up. @return True if the object instance has changed.

object_cov_functionFunction = Bool Function(Uint32 object_instance)

object_functions_t = object_functions

object_index_to_instance_function = Pointer<NativeFunction<object_index_to_instance_functionFunction>>

Maps an object index position to its corresponding BACnet object instance number. @ingroup ObjHelpers @param index in The index of the object, in the array of objects of its type. @return The BACnet object instance number to be used in a BACNET_OBJECT_ID.

object_index_to_instance_functionFunction = Uint32 Function(UnsignedInt index)

object_init_function = Pointer<NativeFunction<object_init_functionFunction>>

Called so a BACnet object can perform any necessary initialization. @ingroup ObjHelpers

object_init_functionFunction = Void Function()

object_intrinsic_reporting_function = Pointer<NativeFunction<object_intrinsic_reporting_functionFunction>>

Intrinsic Reporting functionality. @ingroup ObjHelpers @param in Object instance.

object_intrinsic_reporting_functionFunction = Void Function(Uint32 object_instance)

object_iterate_function = Pointer<NativeFunction<object_iterate_functionFunction>>

Helper function to step through an array of objects and find either the first one or the next one of a given type. Used to step through an array of objects which is not necessarily contiguous for each type i.e. the index for the 'n'th object of a given type is not necessarily 'n'. @ingroup ObjHelpers @param in The index of the current object or a value of ~0 to indicate start at the beginning. @return The index of the next object of the required type or ~0 (all bits == 1) to indicate no more objects found.

object_iterate_functionFunction = UnsignedInt Function(UnsignedInt current_index)

object_name_function = Pointer<NativeFunction<object_name_functionFunction>>

Provides the BACnet Object_Name for a given object instance of this type. @ingroup ObjHelpers @param object_instance in The object instance number to be looked up. @param object_name in,out Pointer to a character_string structure that will hold a copy of the object name if this is a valid object_instance. @return True if the object_instance is valid and object_name has been filled with a copy of the Object's name.

object_name_functionFunction = Bool Function(Uint32 object_instance, Pointer<BACNET_CHARACTER_STRING> object_name)

object_timer_function = Pointer<NativeFunction<object_timer_functionFunction>>

@brief Updates the object with the elapsed milliseconds @param object_instance - object-instance number of the object @param milliseconds - number of milliseconds elapsed

object_timer_functionFunction = Void Function(Uint32 object_instance, Uint16 milliseconds)

object_valid_instance_function = Pointer<NativeFunction<object_valid_instance_functionFunction>>

Look in the table of objects of this type, and see if this is a valid instance number. @ingroup ObjHelpers @param in The object instance number to be looked up. @return True if the object instance refers to a valid object of this type.

object_valid_instance_functionFunction = Bool Function(Uint32 object_instance)

object_value_list_function = Pointer<NativeFunction<object_value_list_functionFunction>>

Look in the table of objects of this type, and get the COV Value List. @ingroup ObjHelpers @param in The object instance number to be looked up. @param out The value list @return True if the object instance supports this feature, and has changed.

object_value_list_functionFunction = Bool Function(Uint32 object_instance, Pointer<BACNET_PROPERTY_VALUE> value_list)

read_property_function = Pointer<NativeFunction<read_property_functionFunction>>

Reads one property for this object type of a given instance. A function template; @see device.c for assignment to object types. @ingroup ObjHelpers

read_property_functionFunction = Int Function(Pointer<BACNET_READ_PROPERTY_DATA> rp_data)

reject_function = Pointer<NativeFunction<reject_functionFunction>>

generic reject reply function

reject_functionFunction = Void Function(Pointer<BACNET_ADDRESS> src, Uint8 invoke_id, Uint8 reject_reason)

rpm_property_lists_function = Pointer<NativeFunction<rpm_property_lists_functionFunction>>

Fetches the lists of properties (array of BACNET_PROPERTY_ID's) for this object type, grouped by Required, Optional, and Proprietary. A function template; @see device.c for assignment to object types. @ingroup ObjHelpers

rpm_property_lists_functionFunction = Void Function(Pointer<Pointer<Int32>> pRequired, Pointer<Pointer<Int32>> pOptional, Pointer<Pointer<Int32>> pProprietary)

rr_handler_function = Pointer<NativeFunction<rr_handler_functionFunction>>

Define pointer to function type for handling ReadRange request. This function will take the following parameters:

rr_handler_functionFunction = Int Function(Pointer<Uint8> apdu, Pointer<BACNET_READ_RANGE_DATA> pRequest)

rr_info_function = Pointer<NativeFunction<rr_info_functionFunction>>

Function template for ReadRange information retrieval function. A function template; @see device.c for assignment to object types. @ingroup ObjHelpers @param pRequest in Info on the request. @param pInfo out Where to write the response to. @return True on success, False on error or failure.

rr_info_functionFunction = Bool Function(Pointer<BACNET_READ_RANGE_DATA> pRequest, Pointer<RR_PROP_INFO> pInfo)

RR_PROP_INFO = rrpropertyinfo

tsm_timeout_function = Pointer<NativeFunction<tsm_timeout_functionFunction>>

tsm_timeout_functionFunction = Void Function(Uint8 invoke_id)

TYPE_BACNET_TIMESTAMP_TYPE = Uint8

unconfirmed_function = Pointer<NativeFunction<unconfirmed_functionFunction>>

generic unconfirmed function handler / / Suitable to handle the following services: / / I_Am, Who_Is, Unconfirmed_COV_Notification, I_Have, / / Unconfirmed_Event_Notification, Unconfirmed_Private_Transfer, / / Unconfirmed_Text_Message, Time_Synchronization, Who_Has, / / UTC_Time_Synchronization

unconfirmed_functionFunction = Void Function(Pointer<Uint8> service_request, Uint16 len, Pointer<BACNET_ADDRESS> src)

write_property_function = Pointer<NativeFunction<write_property_functionFunction>>

Attempts to write a new value to one property for this object type of a given instance. A function template; @see device.c for assignment to object types. @ingroup ObjHelpers

write_property_functionFunction = Bool Function(Pointer<BACNET_WRITE_PROPERTY_DATA> wp_data)