dali/bacnet_stack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added API for extending the basic Device object and children with proprietary properties for ReadProperty and WriteProperty services. (#1238)

Browse Source 
* Added callback API for extending the basic Device object and children with proprietary properties for ReadProperty and WriteProperty services. The callback API includes a function to get the specific proprietary property list for any specific object instance in the device, functions to handle the ReadProperty or WriteProperty of the proprietary property.

* Added a new property_list_function typedef to proplist.h for proprietary property list callbacks

* Removed the object-specific proprietary property implementation from the Loop object

* Added test coverage in the Device test validating the proprietary property API usage
This commit is contained in:
Steve Karg
2026-02-20 06:57:05 -06:00
committed by GitHub
parent f9a0386614
commit 4597dfe7ef
9 changed files with 405 additions and 173 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/bacnet/basic/object/device.c
+89 -3
View File
@@ -532,6 +532,69 @@ static object_functions_t My_Object_Table[] = {
};
/* clang-format on */
/* Proprietary property callback functions to enable proprietary
properties while reusing the basic objects as-is. */
static property_list_function Property_List_Proprietary_Callback;
static write_property_function Write_Property_Proprietary_Callback;
static read_property_function Read_Property_Proprietary_Callback;
/**
* @brief Sets a callback used when the object supports proprietary properties.
* @param cb - callback used to provide proprietary properties service handling.
*/
void Device_Property_List_Proprietary_Callback_Set(property_list_function cb)
{
Property_List_Proprietary_Callback = cb;
}
/**
* @brief Sets a callback used when the object supports proprietary properties.
* @param cb - callback used to provide proprietary properties service handling.
*/
void Device_Read_Property_Proprietary_Callback_Set(read_property_function cb)
{
Read_Property_Proprietary_Callback = cb;
}
/**
* @brief Sets a callback used when the object supports proprietary properties.
* @param cb - callback used to provide proprietary properties service handling.
*/
void Device_Write_Property_Proprietary_Callback_Set(write_property_function cb)
{
Write_Property_Proprietary_Callback = cb;
}
/**
* @brief Checks if the given property is a member of the proprietary property
* list for the given object type and instance.
* @param object_type - the type of the object.
* @param object_instance - the instance number of the object.
* @param object_property - the property to check for membership in the
* proprietary property list.
* @return true if the property is a member of the proprietary property list,
* false otherwise.
*/
bool Device_Property_Proprietary_Member(
BACNET_OBJECT_TYPE object_type,
uint32_t object_instance,
BACNET_PROPERTY_ID object_property)
{
bool status = false;
const int32_t *proprietary_property_list = NULL;
if (Property_List_Proprietary_Callback) {
status = Property_List_Proprietary_Callback(
object_type, object_instance, &proprietary_property_list);
}
if (status) {
status =
property_list_member(proprietary_property_list, object_property);
}
return status;
}
/** Glue function to let the Device object, when called by a handler,
* lookup which Object type needs to be invoked.
* @ingroup ObjHelpers
@@ -593,6 +656,7 @@ void Device_Objects_Property_List(
struct special_property_list_t *pPropertyList)
{
struct object_functions *pObject = NULL;
const int32_t *proprietary_property_list = NULL;
(void)object_instance;
pPropertyList->Required.pList = NULL;
@@ -620,6 +684,12 @@ void Device_Objects_Property_List(
? 0
: property_list_count(pPropertyList->Optional.pList);
if (Property_List_Proprietary_Callback) {
if (Property_List_Proprietary_Callback(
object_type, object_instance, &proprietary_property_list)) {
pPropertyList->Proprietary.pList = proprietary_property_list;
}
}
pPropertyList->Proprietary.count = pPropertyList->Proprietary.pList == NULL
? 0
: property_list_count(pPropertyList->Proprietary.pList);
@@ -2305,8 +2375,17 @@ static int Read_Property_Common(
rpdata, property_list.Required.pList, property_list.Optional.pList,
property_list.Proprietary.pList);
#endif
} else if (pObject->Object_Read_Property) {
apdu_len = pObject->Object_Read_Property(rpdata);
} else {
if (Read_Property_Proprietary_Callback &&
Device_Property_Proprietary_Member(
rpdata->object_type, rpdata->object_instance,
rpdata->object_property)) {
apdu_len = Read_Property_Proprietary_Callback(rpdata);
} else {
if (pObject->Object_Read_Property) {
apdu_len = pObject->Object_Read_Property(rpdata);
}
}
}
return apdu_len;
@@ -2755,7 +2834,14 @@ bool Device_Write_Property(BACNET_WRITE_PROPERTY_DATA *wp_data)
status = Device_Write_Property_Object_Name(
wp_data, pObject->Object_Write_Property);
} else {
status = pObject->Object_Write_Property(wp_data);
if (Write_Property_Proprietary_Callback &&
Device_Property_Proprietary_Member(
wp_data->object_type, wp_data->object_instance,
wp_data->object_property)) {
status = Write_Property_Proprietary_Callback(wp_data);
} else {
status = pObject->Object_Write_Property(wp_data);
}
}
if (status) {
Device_Write_Property_Store(wp_data);
src/bacnet/basic/object/device.h
+9 -1
View File
@@ -16,11 +16,12 @@
#include "bacnet/create_object.h"
#include "bacnet/delete_object.h"
#include "bacnet/list_element.h"
#include "bacnet/wp.h"
#include "bacnet/proplist.h"
#include "bacnet/rd.h"
#include "bacnet/rp.h"
#include "bacnet/rpm.h"
#include "bacnet/readrange.h"
#include "bacnet/wp.h"
/** Called so a BACnet object can perform any necessary initialization.
* @ingroup ObjHelpers
@@ -456,6 +457,13 @@ bool Device_Write_Property_Local(BACNET_WRITE_PROPERTY_DATA *wp_data);
BACNET_STACK_EXPORT
void Device_Write_Property_Store_Callback_Set(write_property_function cb);
BACNET_STACK_EXPORT
void Device_Property_List_Proprietary_Callback_Set(property_list_function cb);
BACNET_STACK_EXPORT
void Device_Read_Property_Proprietary_Callback_Set(read_property_function cb);
BACNET_STACK_EXPORT
void Device_Write_Property_Proprietary_Callback_Set(write_property_function cb);
#if defined(INTRINSIC_REPORTING)
BACNET_STACK_EXPORT
void Device_local_reporting(void);
src/bacnet/basic/object/loop.c
+6 -50
View File
@@ -120,9 +120,6 @@ static const int32_t Properties_Optional[] = {
/* handling for proprietary properties */
static const int32_t Properties_Proprietary[] = { -1 };
static const int32_t *Properties_Proprietary_Extended;
static write_property_function Write_Property_Proprietary_Callback;
static read_property_function Read_Property_Proprietary_Callback;
/* Every object shall have a Writable Property_List property
which is a BACnetARRAY of property identifiers,
@@ -177,11 +174,7 @@ void Loop_Property_Lists(
*pOptional = Properties_Optional;
}
if (pProprietary) {
if (Properties_Proprietary_Extended) {
*pProprietary = Properties_Proprietary_Extended;
} else {
*pProprietary = Properties_Proprietary;
}
*pProprietary = Properties_Proprietary;
}
return;
@@ -217,35 +210,6 @@ static bool Loop_Property_Lists_Member(int object_property)
pRequired, pOptional, pProprietary, object_property);
}
/**
* @brief Set a list of proprietary properties.
* Used by ReadProperty/WriteProperty and Multiple services.
* @param pProprietary - pointer to list of int terminated by -1, of
* BACnet proprietary properties for this object.
*/
void Loop_Proprietary_Property_List_Set(const int32_t *pProprietary)
{
Properties_Proprietary_Extended = pProprietary;
}
/**
* @brief Sets a callback used when the object supports proprietary properties.
* @param cb - callback used to provide proprietary properties service handling.
*/
void Loop_Read_Property_Proprietary_Callback_Set(read_property_function cb)
{
Read_Property_Proprietary_Callback = cb;
}
/**
* @brief Sets a callback used when the object supports proprietary properties.
* @param cb - callback used to provide proprietary properties service handling.
*/
void Loop_Write_Property_Proprietary_Callback_Set(write_property_function cb)
{
Write_Property_Proprietary_Callback = cb;
}
/**
* @brief Gets an object from the list using an instance number as the key
* @param object_instance - object-instance number of the object
@@ -1627,13 +1591,9 @@ int Loop_Read_Property(BACNET_READ_PROPERTY_DATA *rpdata)
apdu_len = encode_application_real(&apdu[0], real_value);
break;
default:
if (Read_Property_Proprietary_Callback) {
apdu_len = Read_Property_Proprietary_Callback(rpdata);
} else {
rpdata->error_class = ERROR_CLASS_PROPERTY;
rpdata->error_code = ERROR_CODE_UNKNOWN_PROPERTY;
apdu_len = BACNET_STATUS_ERROR;
}
rpdata->error_class = ERROR_CLASS_PROPERTY;
rpdata->error_code = ERROR_CODE_UNKNOWN_PROPERTY;
apdu_len = BACNET_STATUS_ERROR;
break;
}
@@ -1958,12 +1918,8 @@ bool Loop_Write_Property(BACNET_WRITE_PROPERTY_DATA *wp_data)
break;
default:
if (Loop_Property_Lists_Member(wp_data->object_property)) {
if (Write_Property_Proprietary_Callback) {
status = Write_Property_Proprietary_Callback(wp_data);
} else {
wp_data->error_class = ERROR_CLASS_PROPERTY;
wp_data->error_code = ERROR_CODE_WRITE_ACCESS_DENIED;
}
wp_data->error_class = ERROR_CLASS_PROPERTY;
wp_data->error_code = ERROR_CODE_WRITE_ACCESS_DENIED;
} else {
wp_data->error_class = ERROR_CLASS_PROPERTY;
wp_data->error_code = ERROR_CODE_UNKNOWN_PROPERTY;
src/bacnet/basic/object/loop.h
-7
View File
@@ -46,13 +46,6 @@ BACNET_STACK_EXPORT
void Loop_Writable_Property_List(
uint32_t object_instance, const int32_t **properties);
BACNET_STACK_EXPORT
void Loop_Proprietary_Property_List_Set(const int32_t *pProprietary);
BACNET_STACK_EXPORT
void Loop_Read_Property_Proprietary_Callback_Set(read_property_function cb);
BACNET_STACK_EXPORT
void Loop_Write_Property_Proprietary_Callback_Set(write_property_function cb);
BACNET_STACK_EXPORT
bool Loop_Valid_Instance(uint32_t object_instance);
BACNET_STACK_EXPORT
src/bacnet/basic/server/bacnet_device.c
+101 -4
View File
@@ -930,6 +930,69 @@ static object_functions_t My_Object_Table[] = {
}
};
/* Proprietary property callback functions to enable proprietary
properties while reusing the basic objects as-is. */
static property_list_function Property_List_Proprietary_Callback;
static write_property_function Write_Property_Proprietary_Callback;
static read_property_function Read_Property_Proprietary_Callback;
/**
* @brief Sets a callback used when the object supports proprietary properties.
* @param cb - callback used to provide proprietary properties service handling.
*/
void Device_Property_List_Proprietary_Callback_Set(property_list_function cb)
{
Property_List_Proprietary_Callback = cb;
}
/**
* @brief Sets a callback used when the object supports proprietary properties.
* @param cb - callback used to provide proprietary properties service handling.
*/
void Device_Read_Property_Proprietary_Callback_Set(read_property_function cb)
{
Read_Property_Proprietary_Callback = cb;
}
/**
* @brief Sets a callback used when the object supports proprietary properties.
* @param cb - callback used to provide proprietary properties service handling.
*/
void Device_Write_Property_Proprietary_Callback_Set(write_property_function cb)
{
Write_Property_Proprietary_Callback = cb;
}
/**
* @brief Checks if the given property is a member of the proprietary property
* list for the given object type and instance.
* @param object_type - the type of the object.
* @param object_instance - the instance number of the object.
* @param object_property - the property to check for membership in the
* proprietary property list.
* @return true if the property is a member of the proprietary property list,
* false otherwise.
*/
bool Device_Property_Proprietary_Member(
BACNET_OBJECT_TYPE object_type,
uint32_t object_instance,
BACNET_PROPERTY_ID object_property)
{
bool status = false;
const int32_t *proprietary_property_list = NULL;
if (Property_List_Proprietary_Callback) {
status = Property_List_Proprietary_Callback(
object_type, object_instance, &proprietary_property_list);
}
if (status) {
status =
property_list_member(proprietary_property_list, object_property);
}
return status;
}
/** Glue function to let the Device object, when called by a handler,
* lookup which Object type needs to be invoked.
* @ingroup ObjHelpers
@@ -991,6 +1054,7 @@ void Device_Objects_Property_List(
struct special_property_list_t *pPropertyList)
{
struct object_functions *pObject = NULL;
const int32_t *proprietary_property_list = NULL;
(void)object_instance;
pPropertyList->Required.pList = NULL;
@@ -1018,6 +1082,12 @@ void Device_Objects_Property_List(
? 0
: property_list_count(pPropertyList->Optional.pList);
if (Property_List_Proprietary_Callback) {
if (Property_List_Proprietary_Callback(
object_type, object_instance, &proprietary_property_list)) {
pPropertyList->Proprietary.pList = proprietary_property_list;
}
}
pPropertyList->Proprietary.count = pPropertyList->Proprietary.pList == NULL
? 0
: property_list_count(pPropertyList->Proprietary.pList);
@@ -1165,6 +1235,8 @@ void Device_Property_Lists(
const int32_t **pOptional,
const int32_t **pProprietary)
{
uint32_t instance;
if (pRequired) {
*pRequired = Device_Properties_Required;
}
@@ -1172,7 +1244,16 @@ void Device_Property_Lists(
*pOptional = Device_Properties_Optional;
}
if (pProprietary) {
*pProprietary = Device_Properties_Proprietary;
if (Property_List_Proprietary_Callback) {
instance = Device_Object_Instance_Number();
if (Property_List_Proprietary_Callback(
OBJECT_DEVICE, instance, pProprietary)) {
} else {
*pProprietary = Device_Properties_Proprietary;
}
} else {
*pProprietary = Device_Properties_Proprietary;
}
}
return;
@@ -2631,8 +2712,17 @@ static int Read_Property_Common(
rpdata, property_list.Required.pList, property_list.Optional.pList,
property_list.Proprietary.pList);
#endif
} else if (pObject->Object_Read_Property) {
apdu_len = pObject->Object_Read_Property(rpdata);
} else {
if (Read_Property_Proprietary_Callback &&
Device_Property_Proprietary_Member(
rpdata->object_type, rpdata->object_instance,
rpdata->object_property)) {
apdu_len = Read_Property_Proprietary_Callback(rpdata);
} else {
if (pObject->Object_Read_Property) {
apdu_len = pObject->Object_Read_Property(rpdata);
}
}
}
return apdu_len;
@@ -3083,7 +3173,14 @@ bool Device_Write_Property(BACNET_WRITE_PROPERTY_DATA *wp_data)
status = Device_Write_Property_Object_Name(
wp_data, pObject->Object_Write_Property);
} else {
status = pObject->Object_Write_Property(wp_data);
if (Write_Property_Proprietary_Callback &&
Device_Property_Proprietary_Member(
wp_data->object_type, wp_data->object_instance,
wp_data->object_property)) {
status = Write_Property_Proprietary_Callback(wp_data);
} else {
status = pObject->Object_Write_Property(wp_data);
}
}
if (status) {
Device_Write_Property_Store(wp_data);
src/bacnet/proplist.h
+18
View File
@@ -26,6 +26,24 @@ struct special_property_list_t {
struct property_list_t Proprietary;
};
/**
* @brief Callback function type for fetching a property list for a given
* object instance.
* @param object_type [in] The BACNET_OBJECT_TYPE of the object instance
* to fetch the property list for.
* @param object_instance [in] The object instance number of the object
* to fetch the property list for.
* @param pPropertyList [out] Pointer to a property list to be
* filled with the property list for this object instance.
* @return True if the object instance is valid and the property list has been
* filled in, false if the object instance is not valid or the property list
* could not be filled in.
*/
typedef bool (*property_list_function)(
BACNET_OBJECT_TYPE object_type,
uint32_t object_instance,
const int32_t **property_list);
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */