Feature/refactor-apps-string-parsing (#1152)

* Added bacnet_str functions for parsing various numeric strings.

* Renamed BACnet string API to be clearer when no stdlib function exists.

* Fixed  incompatible types - from 'BACNET_UNSIGNED_INTEGER *' to 'unsigned long *'  warning

* Changed bacnet-str-to functions to use ERANGE for error detection.

* Refactored some apps to use common string parsing for BACnet data types.

* Refactor bacapp_parse_application_data to use bacnet_string_to_unsigned for better clarity

* Added strtol for BACnetEventType.
This commit is contained in:
Steve Karg
2025-12-02 11:27:19 -06:00
committed by GitHub
parent 73fbb400cb
commit cef68dc079
26 changed files with 904 additions and 662 deletions
+27 -255
View File
@@ -232,9 +232,7 @@ static void print_help(const char *filename)
int main(int argc, char *argv[])
{
BACNET_EVENT_NOTIFICATION_DATA event_data = { 0 };
BACNET_BIT_STRING *pBitString;
BACNET_CHARACTER_STRING bcstring;
BACNET_PROPERTY_STATES tag = PROP_STATE_BOOLEAN_VALUE;
unsigned long long_value = 0;
BACNET_ADDRESS src = { 0 }; /* address where message came from */
unsigned timeout = 100; /* milliseconds */
uint16_t pdu_len = 0;
@@ -252,7 +250,6 @@ int main(int argc, char *argv[])
int argi = 0;
unsigned int target_args = 0;
const char *filename = NULL;
unsigned found_index = 0;
filename = filename_remove_path(argv[0]);
for (argi = 1; argi < argc; argi++) {
@@ -278,7 +275,10 @@ int main(int argc, char *argv[])
}
} else if (strcmp(argv[argi], "--dnet") == 0) {
if (++argi < argc) {
dnet = strtol(argv[argi], NULL, 0);
if (!bacnet_strtol(argv[argi], &dnet)) {
fprintf(stderr, "dnet=%s invalid\n", argv[argi]);
return 1;
}
if ((dnet >= 0) && (dnet <= BACNET_BROADCAST_NETWORK)) {
specific_address = true;
}
@@ -292,226 +292,28 @@ int main(int argc, char *argv[])
} else {
if (target_args == 0) {
/* device-id */
Target_Device_Object_Instance = strtol(argv[argi], NULL, 0);
target_args++;
} else if (target_args == 1) {
/* process-id */
event_data.processIdentifier = strtol(argv[argi], NULL, 0);
target_args++;
} else if (target_args == 2) {
/* initiating-device-id */
event_data.initiatingObjectIdentifier.type = OBJECT_DEVICE;
event_data.initiatingObjectIdentifier.instance =
strtol(argv[argi], NULL, 0);
target_args++;
} else if (target_args == 3) {
/* event-object-type */
event_data.eventObjectIdentifier.type =
strtol(argv[argi], NULL, 0);
target_args++;
} else if (target_args == 4) {
/* event-object-instance */
event_data.eventObjectIdentifier.instance =
strtol(argv[argi], NULL, 0);
target_args++;
} else if (target_args == 5) {
/* sequence-number */
event_data.timeStamp.tag = TIME_STAMP_SEQUENCE;
event_data.timeStamp.value.sequenceNum =
strtol(argv[argi], NULL, 0);
target_args++;
} else if (target_args == 6) {
/* notification-class */
event_data.notificationClass = strtol(argv[argi], NULL, 0);
target_args++;
} else if (target_args == 7) {
/* priority */
event_data.priority = strtol(argv[argi], NULL, 0);
target_args++;
} else if (target_args == 8) {
/* message-text */
characterstring_init_ansi(&bcstring, argv[argi]);
event_data.messageText = &bcstring;
target_args++;
} else if (target_args == 9) {
/* notify-type */
if (bactext_notify_type_index(argv[argi], &found_index)) {
event_data.notifyType = found_index;
} else {
event_data.notifyType = strtol(argv[argi], NULL, 0);
}
target_args++;
} else if (target_args == 10) {
/* ack-required */
event_data.ackRequired = strtol(argv[argi], NULL, 0);
target_args++;
} else if (target_args == 11) {
/* from-state */
if (bactext_event_state_index(argv[argi], &found_index)) {
event_data.fromState = found_index;
} else {
event_data.fromState = strtol(argv[argi], NULL, 0);
}
target_args++;
} else if (target_args == 12) {
/* to-state */
if (bactext_event_state_index(argv[argi], &found_index)) {
event_data.toState = found_index;
} else {
event_data.toState = strtol(argv[argi], NULL, 0);
}
target_args++;
} else if (target_args == 13) {
/* event-type - see BACNET_EVENT_TYPE */
if (bactext_event_type_index(argv[argi], &found_index)) {
event_data.eventType = found_index;
} else {
event_data.eventType = strtol(argv[argi], NULL, 0);
}
target_args++;
} else {
if (event_data.eventType == EVENT_CHANGE_OF_BITSTRING) {
if (target_args == 14) {
pBitString =
&event_data.notificationParams.changeOfBitstring
.referencedBitString;
bitstring_init_ascii(pBitString, argv[argi]);
target_args++;
} else if (target_args == 15) {
pBitString = &event_data.notificationParams
.changeOfBitstring.statusFlags;
bitstring_init_ascii(pBitString, argv[argi]);
target_args++;
} else {
print_usage(filename);
return 1;
}
} else if (event_data.eventType == EVENT_CHANGE_OF_STATE) {
if (target_args == 14) {
tag = strtol(argv[argi], NULL, 0);
event_data.notificationParams.changeOfState.newState
.tag = tag;
target_args++;
} else if (target_args == 15) {
if (tag == PROP_STATE_BOOLEAN_VALUE) {
event_data.notificationParams.changeOfState.newState
.state.booleanValue =
strtol(argv[argi], NULL, 0);
} else if (tag == PROP_STATE_BINARY_VALUE) {
event_data.notificationParams.changeOfState.newState
.state.binaryValue =
strtol(argv[argi], NULL, 0);
} else if (tag == PROP_STATE_EVENT_TYPE) {
event_data.notificationParams.changeOfState.newState
.state.eventType = strtol(argv[argi], NULL, 0);
} else if (tag == PROP_STATE_POLARITY) {
event_data.notificationParams.changeOfState.newState
.state.polarity = strtol(argv[argi], NULL, 0);
} else if (tag == PROP_STATE_PROGRAM_CHANGE) {
event_data.notificationParams.changeOfState.newState
.state.programChange =
strtol(argv[argi], NULL, 0);
} else if (tag == PROP_STATE_PROGRAM_STATE) {
event_data.notificationParams.changeOfState.newState
.state.programState =
strtol(argv[argi], NULL, 0);
} else if (tag == PROP_STATE_REASON_FOR_HALT) {
event_data.notificationParams.changeOfState.newState
.state.programError =
strtol(argv[argi], NULL, 0);
} else if (tag == PROP_STATE_RELIABILITY) {
event_data.notificationParams.changeOfState.newState
.state.reliability =
strtol(argv[argi], NULL, 0);
} else if (tag == PROP_STATE_EVENT_STATE) {
event_data.notificationParams.changeOfState.newState
.state.state = strtol(argv[argi], NULL, 0);
} else if (tag == PROP_STATE_SYSTEM_STATUS) {
event_data.notificationParams.changeOfState.newState
.state.systemStatus =
strtol(argv[argi], NULL, 0);
} else if (tag == PROP_STATE_UNITS) {
event_data.notificationParams.changeOfState.newState
.state.units = strtol(argv[argi], NULL, 0);
} else if (tag == PROP_STATE_UNSIGNED_VALUE) {
event_data.notificationParams.changeOfState.newState
.state.unsignedValue =
strtol(argv[argi], NULL, 0);
} else if (tag == PROP_STATE_LIFE_SAFETY_MODE) {
event_data.notificationParams.changeOfState.newState
.state.lifeSafetyMode =
strtol(argv[argi], NULL, 0);
} else if (tag == PROP_STATE_LIFE_SAFETY_STATE) {
event_data.notificationParams.changeOfState.newState
.state.lifeSafetyState =
strtol(argv[argi], NULL, 0);
} else {
printf("Invalid Change-Of-State Tag\n");
return 1;
}
target_args++;
} else if (target_args == 16) {
pBitString = &event_data.notificationParams
.changeOfBitstring.statusFlags;
bitstring_init_ascii(pBitString, argv[argi]);
target_args++;
} else {
print_usage(filename);
return 1;
}
} else if (event_data.eventType == EVENT_CHANGE_OF_VALUE) {
/* FIXME: add event type parameters */
} else if (event_data.eventType == EVENT_COMMAND_FAILURE) {
/* FIXME: add event type parameters */
} else if (event_data.eventType == EVENT_FLOATING_LIMIT) {
/* FIXME: add event type parameters */
} else if (event_data.eventType == EVENT_OUT_OF_RANGE) {
/* FIXME: add event type parameters */
} else if (
event_data.eventType == EVENT_CHANGE_OF_LIFE_SAFETY) {
/* FIXME: add event type parameters */
} else if (event_data.eventType == EVENT_EXTENDED) {
/* FIXME: add event type parameters */
} else if (event_data.eventType == EVENT_BUFFER_READY) {
/* FIXME: add event type parameters */
} else if (event_data.eventType == EVENT_UNSIGNED_RANGE) {
/* FIXME: add event type parameters */
} else if (event_data.eventType == EVENT_ACCESS_EVENT) {
/* FIXME: add event type parameters */
} else if (event_data.eventType == EVENT_DOUBLE_OUT_OF_RANGE) {
/* FIXME: add event type parameters */
} else if (event_data.eventType == EVENT_SIGNED_OUT_OF_RANGE) {
/* FIXME: add event type parameters */
} else if (
event_data.eventType == EVENT_UNSIGNED_OUT_OF_RANGE) {
/* FIXME: add event type parameters */
} else if (
event_data.eventType == EVENT_CHANGE_OF_CHARACTERSTRING) {
/* FIXME: add event type parameters */
} else if (
event_data.eventType == EVENT_CHANGE_OF_STATUS_FLAGS) {
/* FIXME: add event type parameters */
} else if (
event_data.eventType == EVENT_CHANGE_OF_RELIABILITY) {
/* FIXME: add event type parameters */
} else if (event_data.eventType == EVENT_NONE) {
/* FIXME: add event type parameters */
} else if (
event_data.eventType == EVENT_CHANGE_OF_DISCRETE_VALUE) {
/* FIXME: add event type parameters */
} else if (event_data.eventType == EVENT_CHANGE_OF_TIMER) {
/* FIXME: add event type parameters */
} else if (
(event_data.eventType >= EVENT_PROPRIETARY_MIN) &&
(event_data.eventType <= EVENT_PROPRIETARY_MAX)) {
/* Enumerated values 64-65535 may
be used by others subject to
the procedures and constraints
described in Clause 23. */
} else {
print_usage(filename);
if (!bacnet_strtoul(argv[argi], &long_value)) {
fprintf(stderr, "device-id=%s invalid\n", argv[argi]);
return 1;
}
if (long_value > BACNET_MAX_INSTANCE) {
fprintf(
stderr, "device-id=%lu - exceeds %u\n", long_value,
BACNET_MAX_INSTANCE);
return 1;
}
Target_Device_Object_Instance = (uint32_t)long_value;
target_args++;
} else if (target_args == 1) {
if (!event_notify_parse(
&event_data, argc - argi, &argv[argi])) {
fprintf(stderr, "event=%s invalid\n", argv[argi]);
} else {
target_args++;
}
} else {
print_usage(filename);
return 1;
}
}
}
@@ -519,42 +321,12 @@ int main(int argc, char *argv[])
print_usage(filename);
return 0;
}
/* setup my info */
address_init();
if (specific_address) {
if (adr.len && mac.len) {
memcpy(&dest.mac[0], &mac.adr[0], mac.len);
dest.mac_len = mac.len;
memcpy(&dest.adr[0], &adr.adr[0], adr.len);
dest.len = adr.len;
if ((dnet >= 0) && (dnet <= BACNET_BROADCAST_NETWORK)) {
dest.net = dnet;
} else {
dest.net = BACNET_BROADCAST_NETWORK;
}
} else if (mac.len) {
memcpy(&dest.mac[0], &mac.adr[0], mac.len);
dest.mac_len = mac.len;
dest.len = 0;
if ((dnet >= 0) && (dnet <= BACNET_BROADCAST_NETWORK)) {
dest.net = dnet;
} else {
dest.net = 0;
}
} else {
if ((dnet >= 0) && (dnet <= BACNET_BROADCAST_NETWORK)) {
dest.net = dnet;
} else {
dest.net = BACNET_BROADCAST_NETWORK;
}
dest.mac_len = 0;
dest.len = 0;
}
bacnet_address_init(&dest, &mac, dnet, &adr);
address_add(Target_Device_Object_Instance, MAX_APDU, &dest);
printf(
"Added Device %u to address cache\n",
Target_Device_Object_Instance);
}
/* setup my info */
Device_Set_Object_Instance_Number(BACNET_MAX_INSTANCE);
Init_Service_Handlers();
dlenv_init();