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

Fixed CreateObject service list-of-initial-values encoding and decoding. (#1199)

Browse Source 
Fixes the CreateObject service list-of-initial-values encoding and decoding by refactoring the data structure to be similar to WriteProperty. The implementation changes from using a linked list of property values to using a flat buffer approach with delayed decoding.

Changes:

* Refactored BACNET_CREATE_OBJECT_DATA structure to use an application_data buffer instead of a linked list for initial values
* Added a new create_object_process() and create_object_initializer_list_process() functions to centralize object creation logic and error reporting
* Updated all device implementations to use the new centralized creation functions
* Enhanced the create-object example application to support command-line specification of initial property values
* Added comprehensive test coverage for the new encoding/decoding and processing functions
This commit is contained in:
Steve Karg
2026-01-15 14:50:59 -06:00
committed by GitHub
parent 21daea9eb4
commit 5802bd0ecc
18 changed files with 921 additions and 212 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/create-object/main.c
+245 -17
View File
@@ -47,6 +47,7 @@ static uint8_t Rx_Buf[MAX_MPDU] = { 0 };
static uint32_t Target_Device_Object_Instance = BACNET_MAX_INSTANCE;
static BACNET_OBJECT_TYPE Target_Object_Type;
static uint32_t Target_Object_Instance = BACNET_MAX_INSTANCE;
static BACNET_PROPERTY_VALUE *Target_Initial_Values;
/* needed to filter incoming messages */
static uint8_t Request_Invoke_ID = 0;
static BACNET_ADDRESS Target_Address;
@@ -86,7 +87,7 @@ static void MyCreateObjectErrorHandler(
uint16_t service_len)
{
int len = 0;
BACNET_CREATE_OBJECT_DATA data;
BACNET_CREATE_OBJECT_DATA data = { 0 };
(void)service_choice;
if (address_match(&Target_Address, src) &&
@@ -95,7 +96,7 @@ static void MyCreateObjectErrorHandler(
service_request, service_len, &data);
if (len > 0) {
MyPrintHandler(
data.object_type, data.object_instance, data.error_class,
Target_Object_Type, Target_Object_Instance, data.error_class,
data.error_code, data.first_failed_element_number);
}
Error_Detected = true;
@@ -108,7 +109,7 @@ static void MyCreateObjectAckHandler(
BACNET_ADDRESS *src,
BACNET_CONFIRMED_SERVICE_ACK_DATA *service_data)
{
BACNET_CREATE_OBJECT_DATA data;
BACNET_CREATE_OBJECT_DATA data = { 0 };
int len = 0;
if (address_match(&Target_Address, src) &&
@@ -183,7 +184,10 @@ static void Init_Service_Handlers(void)
static void print_usage(const char *filename)
{
printf(
"Usage: %s device-instance object-type [object-instance]\n", filename);
"Usage: %s device-instance object-type [object-instance]\n"
"[property[index] priority tag value\n"
"[property[index] priority tag value ...]]\n",
filename);
printf(" [--dnet][--dadr][--mac]\n");
printf(" [--version][--help][--verbose]\n");
}
@@ -203,20 +207,72 @@ static void print_help(const char *filename)
"The object type is object that you are creating. It\n"
"can be defined either as the object-type name string\n"
"as defined in the BACnet specification, or as the\n"
"integer value of the enumeration BACNET_OBJECT_TYPE\n"
"in bacenum.h. For example if you were reading Analog\n"
"Output 2, the object-type would be analog-output or 1.\n");
"integer value of the enumeration. For example if \n"
"you were reading Analog Output 2, the object-type\n"
"would be analog-output or 1.\n");
printf("\n");
printf("object-instance (optional):\n"
"This is the object instance number of the object that\n"
"you are creating. For example, if you were writing\n"
"Analog Output 2, the object-instance would be 2.\n");
printf(
"object-instance:\n"
"This is the object instance number of the object that\n"
"you are creating. For example, if you were creating\n"
"Analog Output 2, the object-instance would be 2.\n"
"To create the next available instance number, use\n"
"the instance number %u\n",
BACNET_MAX_INSTANCE);
printf("\n");
printf("property[index]:\n"
"The property is an integer value or name of the\n"
"Property Identifier enumeration as defined in the\n"
"BACnet specification. It is the property you are initializing.\n"
"For example, if you were initializing the Present Value\n"
"property, use present-value or 85 as the property.\n");
printf("[index]: optional\n"
"This integer parameter is the index number of an array.\n"
"If the property is an array, individual elements can be\n"
"initialized if supported.\n");
printf("\n");
printf("priority:\n"
"This parameter is used for setting the priority of the\n"
"initialization. If Priority 0 is given, no priority is used.\n"
"The BACnet specification states that the value is written at the\n"
"lowest priority (16) if the object property supports priorities\n"
"when no priority is sent.\n");
printf("\n");
printf(
"tag:\n"
"Tag is an integer value representing the data type of the value.\n"
"0=NULL, 1=BOOLEAN, 2=UNSIGNED INTEGER, 3=SIGNED INTEGER, 4=REAL,\n"
"5=DOUBLE, 6=OCTET STRING, 7=CHARACTER STRING, 8=BIT STRING,\n"
"9=ENUMERATED, 10=DATE, 11=TIME, 12=OBJECT IDENTIFIER.\n"
"Context tags are created using two tags in a row. The context tag\n"
"is preceded by a C: Ctag tag. C2 4 creates a context 2 tagged "
"REAL.\n");
printf("Complex data use the property argument and a tag number -1 to\n"
"lookup the appropriate internal application tag for the value.\n"
"The complex data value argument varies in its construction.\n");
printf("\n");
printf(
"value:\n"
"The value is an ASCII representation of some type of data that you\n"
"are initializing. It is encoded using the tag information provided.\n"
"For example, if you were writing a REAL value of 100.0, you would\n"
"use 100.0 as the value.\n");
printf("\n");
printf(
"Here is a brief overview of BACnet property and tags:\n"
"Certain properties are expected to be written with certain \n"
"application tags, so you probably need to know which ones to use\n"
"with each property of each object. It is almost safe to say that\n"
"given a property and an object and a table, the tag could be looked\n"
"up automatically. There may be a few exceptions to this, such as\n"
"the Any property type in the schedule object and the Present Value\n"
"accepting REAL, BOOLEAN, NULL, etc.\n");
printf("\n");
printf(
"Example:\n"
"If you want to CreateObject of an Analog Input 1\n"
"If you want to create Analog Input 1 in device 123,\n"
"send the following command:\n"
"%s 123 0 1\n",
"%s 123 analog-input 1\n",
filename);
}
@@ -229,13 +285,22 @@ int main(int argc, char *argv[])
struct mstimer apdu_timer;
struct mstimer maintenance_timer;
bool found = false;
unsigned long object_type = 0;
uint32_t object_type = 0;
unsigned long object_instance = 0;
long dnet = -1;
BACNET_MAC_ADDRESS mac = { 0 };
BACNET_MAC_ADDRESS adr = { 0 };
BACNET_ADDRESS dest = { 0 };
bool specific_address = false;
BACNET_PROPERTY_VALUE *initial_value = NULL;
int scan_count = 0;
char name[80] = { 0 };
unsigned array_value = 0;
unsigned long unsigned_value = 0;
uint32_t found_index = 0;
long property_tag = 0, context_tag = 0;
long priority = 0;
char *value_string = NULL;
unsigned int target_args = 0;
int argi = 0;
const char *filename = NULL;
@@ -295,7 +360,7 @@ int main(int argc, char *argv[])
Target_Device_Object_Instance = object_instance;
target_args++;
} else if (target_args == 1) {
if (!bacnet_strtoul(argv[argi], &object_type)) {
if (!bactext_object_type_strtol(argv[argi], &object_type)) {
fprintf(stderr, "object-type=%s invalid\n", argv[argi]);
return 1;
}
@@ -317,6 +382,169 @@ int main(int argc, char *argv[])
printf("Instance=%lu=%s\n", object_instance, argv[argi]);
}
target_args++;
} else {
/* list of initial values */
/* expecting tuple: property[index] priority [Ctag] tag value
index is optional, priority=0 when optional,
value can be NULL */
if (!Target_Initial_Values) {
Target_Initial_Values =
calloc(1, sizeof(BACNET_PROPERTY_VALUE));
initial_value = Target_Initial_Values;
} else {
initial_value->next =
calloc(1, sizeof(BACNET_PROPERTY_VALUE));
initial_value = initial_value->next;
}
if (!initial_value) {
fprintf(
stderr, "out of memory initializing initial values\n");
return 1;
}
/* Property */
initial_value->propertyArrayIndex = BACNET_ARRAY_ALL;
if (isalpha(argv[argi][0])) {
/* choose a property by name with optional [] to denote
* array */
scan_count =
sscanf(argv[argi], "%79[^[][%u]", name, &array_value);
if (scan_count < 1) {
fprintf(
stderr, "parse: missing property: %s.", argv[argi]);
return 1;
}
if (scan_count == 2) {
initial_value->propertyArrayIndex = array_value;
}
if (!bactext_property_strtol(name, &found_index)) {
fprintf(
stderr, "parse: invalid property name: %s.",
argv[argi]);
return 1;
}
initial_value->propertyIdentifier = found_index;
} else {
/* choose a property by number */
scan_count = sscanf(
argv[argi], "%lu[%u]", &unsigned_value, &array_value);
if (scan_count < 1) {
fprintf(
stderr, "parse: missing property: %s.", argv[argi]);
return 1;
}
if (unsigned_value > MAX_BACNET_PROPERTY_ID) {
fprintf(
stderr,
"parse: Invalid property: %s. Must be 0-%d.",
argv[argi], MAX_BACNET_PROPERTY_ID);
return 1;
}
if (scan_count == 2) {
initial_value->propertyArrayIndex = array_value;
}
initial_value->propertyIdentifier =
(BACNET_PROPERTY_ID)unsigned_value;
}
if (++argi >= argc) {
fprintf(stderr, "Error: missing tag-value pair\n");
return 1;
}
/* Priority */
if (!bacnet_strtol(argv[argi], &priority)) {
fprintf(stderr, "Error: priority=%s invalid\n", argv[argi]);
return 1;
}
if (priority < 0 || priority > BACNET_MAX_PRIORITY) {
fprintf(
stderr, "Error: priority=%ld must be within 0 and %u\n",
priority, BACNET_MAX_PRIORITY);
return 1;
}
initial_value->priority = (uint8_t)priority;
if (++argi >= argc) {
fprintf(
stderr, "Error: missing value for tag-value pair\n");
return 1;
}
/* Tag */
if (toupper(argv[argi][0]) == 'C') {
/* special case for context tag: [Ctag] tag */
if (!bacnet_strtol(&argv[argi][1], &context_tag)) {
fprintf(
stderr, "Error: context tag=%s invalid\n",
&argv[argi][1]);
return 1;
}
if (context_tag < 0 || context_tag > UINT8_MAX) {
fprintf(
stderr,
"Error: context tag=%ld must be within 0 and %u\n",
context_tag, UINT8_MAX);
return 1;
}
if (++argi >= argc) {
fprintf(
stderr,
"Error: missing tag-value pair after context "
"tag\n");
return 1;
}
if (!bacnet_strtol(argv[argi], &property_tag)) {
fprintf(stderr, "Error: tag=%s invalid\n", argv[argi]);
return 1;
}
if (property_tag < 0 ||
property_tag > MAX_BACNET_APPLICATION_TAG) {
fprintf(
stderr, "Error: tag=%ld must be within 0 and %d\n",
property_tag, MAX_BACNET_APPLICATION_TAG);
return 1;
}
initial_value->value.context_tag = (uint8_t)property_tag;
initial_value->value.context_specific = true;
} else {
initial_value->value.context_specific = false;
property_tag = strtol(argv[argi], NULL, 0);
if (property_tag < 0) {
/* use -1 to lookup a known context tag */
property_tag = bacapp_known_property_tag(
Target_Object_Type,
initial_value->propertyIdentifier);
if (property_tag < 0 || property_tag > UINT8_MAX) {
fprintf(
stderr, "Error: tag for property=%lu unknown\n",
(unsigned long)
initial_value->propertyIdentifier);
return 1;
}
} else if (property_tag >= MAX_BACNET_APPLICATION_TAG) {
fprintf(
stderr,
"Error: tag=%ld - it must be less than %u\n",
property_tag, MAX_BACNET_APPLICATION_TAG);
return 1;
}
initial_value->value.tag = (uint8_t)property_tag;
}
if (++argi >= argc) {
fprintf(
stderr, "Error: missing value for tag-value pair\n");
return 1;
}
/* Value */
value_string = argv[argi];
if (Verbose) {
printf("tag=%ld value=%s\n", property_tag, value_string);
}
if (!bacapp_parse_application_data(
property_tag, value_string, &initial_value->value)) {
/* FIXME: show the expected entry format for the tag */
fprintf(
stderr, "Error: parser for %s is not implemented\n",
bactext_property_name(
initial_value->propertyIdentifier));
return 1;
}
}
}
}
@@ -360,9 +588,9 @@ int main(int argc, char *argv[])
"Sending CreateObject to Device %u.\n",
Target_Device_Object_Instance);
}
Request_Invoke_ID = Send_Create_Object_Request(
Request_Invoke_ID = Send_Create_Object_Request_Data(
Target_Device_Object_Instance, Target_Object_Type,
Target_Object_Instance);
Target_Object_Instance, Target_Initial_Values);
} else if (tsm_invoke_id_free(Request_Invoke_ID)) {
break;
} else if (tsm_invoke_id_failed(Request_Invoke_ID)) {