/** * @file * @brief Application to send a BACnet CreateObject * @author Steve Karg * @date August 2023 * * SPDX-License-Identifier: MIT */ #include #include #include #include #include #define PRINT_ENABLED 1 /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" /* BACnet Stack API */ #include "bacnet/bactext.h" #include "bacnet/bacdest.h" #include "bacnet/bacerror.h" #include "bacnet/iam.h" #include "bacnet/arf.h" #include "bacnet/npdu.h" #include "bacnet/apdu.h" #include "bacnet/abort.h" #include "bacnet/create_object.h" #include "bacnet/reject.h" #include "bacnet/whois.h" #include "bacnet/version.h" /* some demo stuff needed */ #include "bacnet/basic/binding/address.h" #include "bacnet/basic/object/device.h" #include "bacnet/basic/sys/filename.h" #include "bacnet/basic/sys/mstimer.h" #include "bacnet/basic/services.h" #include "bacnet/basic/tsm/tsm.h" #include "bacnet/datalink/datalink.h" #include "bacnet/datalink/dlenv.h" #if BACNET_SVC_SERVER #error "App requires server-only features disabled! Set BACNET_SVC_SERVER=0" #endif /* buffer used for receive */ static uint8_t Rx_Buf[MAX_MPDU] = { 0 }; /* target device data for the request */ 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; /* needed for return value of main application */ static bool Error_Detected = false; /* Used for verbose */ static bool Verbose = false; static void MyPrintHandler( BACNET_OBJECT_TYPE object_type, uint32_t object_instance, BACNET_ERROR_CLASS error_class, BACNET_ERROR_CODE error_code, uint32_t first_failed_element_number) { printf( "[{\n \"%s\": {\n" " \"object-type\": \"%s\",\n \"object-instance\": %lu,\n" " \"error-class\": \"%s\",\n \"error-code\": \"%s\"", bactext_confirmed_service_name(SERVICE_CONFIRMED_CREATE_OBJECT), bactext_object_type_name(object_type), (unsigned long)object_instance, bactext_error_class_name((int)error_class), bactext_error_code_name((int)error_code)); if (first_failed_element_number > 0) { printf( ",\n \"first-failed-element-number\": %lu", (unsigned long)first_failed_element_number); } printf("\n }\n}]\n"); } static void MyCreateObjectErrorHandler( BACNET_ADDRESS *src, uint8_t invoke_id, uint8_t service_choice, uint8_t *service_request, uint16_t service_len) { int len = 0; BACNET_CREATE_OBJECT_DATA data = { 0 }; (void)service_choice; if (address_match(&Target_Address, src) && (invoke_id == Request_Invoke_ID)) { len = create_object_error_ack_service_decode( service_request, service_len, &data); if (len > 0) { MyPrintHandler( Target_Object_Type, Target_Object_Instance, data.error_class, data.error_code, data.first_failed_element_number); } Error_Detected = true; } } static void MyCreateObjectAckHandler( uint8_t *service_request, uint16_t service_len, BACNET_ADDRESS *src, BACNET_CONFIRMED_SERVICE_ACK_DATA *service_data) { BACNET_CREATE_OBJECT_DATA data = { 0 }; int len = 0; if (address_match(&Target_Address, src) && (service_data->invoke_id == Request_Invoke_ID)) { len = create_object_ack_service_decode( service_request, service_len, &data); if (len < 0) { MyPrintHandler( Target_Object_Type, Target_Object_Instance, ERROR_CLASS_SERVICES, ERROR_CODE_REJECT_OTHER, 0); } else { MyPrintHandler( data.object_type, data.object_instance, ERROR_CLASS_SERVICES, ERROR_CODE_SUCCESS, 0); } } else { if (Verbose) { printf("CreateObjectACK - not matched\n"); } } } static void MyAbortHandler( BACNET_ADDRESS *src, uint8_t invoke_id, uint8_t abort_reason, bool server) { (void)server; if (address_match(&Target_Address, src) && (invoke_id == Request_Invoke_ID)) { MyPrintHandler( Target_Object_Type, Target_Object_Instance, ERROR_CLASS_SERVICES, abort_convert_to_error_code(abort_reason), 0); Error_Detected = true; } } static void MyRejectHandler(BACNET_ADDRESS *src, uint8_t invoke_id, uint8_t reject_reason) { /* FIXME: verify src and invoke id */ if (address_match(&Target_Address, src) && (invoke_id == Request_Invoke_ID)) { MyPrintHandler( Target_Object_Type, Target_Object_Instance, ERROR_CLASS_SERVICES, reject_convert_to_error_code(reject_reason), 0); Error_Detected = true; } } static void Init_Service_Handlers(void) { Device_Init(NULL); /* we need to handle who-is to support dynamic device binding to us */ apdu_set_unconfirmed_handler(SERVICE_UNCONFIRMED_WHO_IS, handler_who_is); /* handle i-am to support binding to other devices */ apdu_set_unconfirmed_handler(SERVICE_UNCONFIRMED_I_AM, handler_i_am_bind); /* set the handler for all the services we don't implement It is required to send the proper reject message... */ apdu_set_unrecognized_service_handler_handler(handler_unrecognized_service); /* we must implement read property - it's required! */ apdu_set_confirmed_handler( SERVICE_CONFIRMED_READ_PROPERTY, handler_read_property); /* handle the ack or error coming back from confirmed request */ apdu_set_confirmed_ack_handler( SERVICE_CONFIRMED_CREATE_OBJECT, MyCreateObjectAckHandler); apdu_set_complex_error_handler( SERVICE_CONFIRMED_CREATE_OBJECT, MyCreateObjectErrorHandler); apdu_set_abort_handler(MyAbortHandler); apdu_set_reject_handler(MyRejectHandler); } static void print_usage(const char *filename) { printf( "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"); } static void print_help(const char *filename) { printf("Create an object in a BACnet device.\n"); printf("\n"); printf("device-instance:\n" "BACnet Device Object Instance number that you are\n" "trying to communicate to. This number will be used\n" "to try and bind with the device using Who-Is and\n" "I-Am services. For example, if you were writing\n" "Device Object 123, the device-instance would be 123.\n"); printf("\n"); printf("object-type:\n" "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. 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:\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 create Analog Input 1 in device 123,\n" "send the following command:\n" "%s 123 analog-input 1\n", filename); } int main(int argc, char *argv[]) { BACNET_ADDRESS src = { 0 }; /* address where message came from */ uint16_t pdu_len = 0; unsigned timeout = 100; /* milliseconds */ unsigned max_apdu = 0; struct mstimer apdu_timer; struct mstimer maintenance_timer; bool found = false; 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; filename = filename_remove_path(argv[0]); for (argi = 1; argi < argc; argi++) { if (strcmp(argv[argi], "--help") == 0) { print_usage(filename); print_help(filename); return 0; } if (strcmp(argv[argi], "--version") == 0) { printf("%s %s\n", filename, BACNET_VERSION_TEXT); printf("Copyright (C) 2023 by Steve Karg and others.\n" "This is free software; see the source for copying " "conditions.\n" "There is NO warranty; not even for MERCHANTABILITY or\n" "FITNESS FOR A PARTICULAR PURPOSE.\n"); return 0; } if (strcmp(argv[argi], "--mac") == 0) { if (++argi < argc) { if (bacnet_address_mac_from_ascii(&mac, argv[argi])) { specific_address = true; } } } else if (strcmp(argv[argi], "--dnet") == 0) { if (++argi < argc) { if (!bacnet_strtol(argv[argi], &dnet)) { fprintf(stderr, "dnet=%s invalid\n", argv[argi]); return 1; } if ((dnet >= 0) && (dnet <= UINT16_MAX)) { specific_address = true; } } } else if (strcmp(argv[argi], "--dadr") == 0) { if (++argi < argc) { if (bacnet_address_mac_from_ascii(&adr, argv[argi])) { specific_address = true; } } } else if (strcmp(argv[argi], "--verbose") == 0) { Verbose = true; } else { if (target_args == 0) { if (!bacnet_strtoul(argv[argi], &object_instance)) { fprintf(stderr, "device-instance=%s invalid\n", argv[argi]); return 1; } if (object_instance > BACNET_MAX_INSTANCE) { fprintf( stderr, "device-instance=%lu - not greater than %u\n", object_instance, BACNET_MAX_INSTANCE); return 1; } Target_Device_Object_Instance = object_instance; target_args++; } else if (target_args == 1) { if (!bactext_object_type_strtol(argv[argi], &object_type)) { fprintf(stderr, "object-type=%s invalid\n", argv[argi]); return 1; } Target_Object_Type = object_type; target_args++; } else if (target_args == 2) { if (!bacnet_strtoul(argv[argi], &object_instance)) { fprintf(stderr, "object-instance=%s invalid\n", argv[argi]); return 1; } if (object_instance > BACNET_MAX_INSTANCE) { fprintf( stderr, "object-instance=%u - not greater than %u\n", Target_Device_Object_Instance, BACNET_MAX_INSTANCE); return 1; } Target_Object_Instance = object_instance; if (Verbose) { 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; } } } } if (target_args < 2) { print_usage(filename); return 0; } /* setup my info */ address_init(); if (specific_address) { bacnet_address_init(&dest, &mac, dnet, &adr); address_add(Target_Device_Object_Instance, MAX_APDU, &dest); } Device_Set_Object_Instance_Number(BACNET_MAX_INSTANCE); Init_Service_Handlers(); dlenv_init(); atexit(datalink_cleanup); mstimer_init(); mstimer_set(&apdu_timer, apdu_timeout()); mstimer_set(&maintenance_timer, 1000); /* try to bind with the device */ found = address_bind_request( Target_Device_Object_Instance, &max_apdu, &Target_Address); if (found) { if (Verbose) { printf( "Found Device %u in address_cache.\n", Target_Device_Object_Instance); } } else { Send_WhoIs( Target_Device_Object_Instance, Target_Device_Object_Instance); } /* loop forever */ for (;;) { if (found) { /* device is bound! */ if (Request_Invoke_ID == 0) { if (Verbose) { printf( "Sending CreateObject to Device %u.\n", Target_Device_Object_Instance); } Request_Invoke_ID = Send_Create_Object_Request_Data( Target_Device_Object_Instance, Target_Object_Type, 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)) { MyPrintHandler( Target_Object_Type, Target_Object_Instance, ERROR_CLASS_COMMUNICATION, ERROR_CODE_ABORT_TSM_TIMEOUT, 0); tsm_free_invoke_id(Request_Invoke_ID); Error_Detected = true; /* abort */ break; } } else { found = address_bind_request( Target_Device_Object_Instance, &max_apdu, &Target_Address); } /* returns 0 bytes on timeout */ pdu_len = datalink_receive(&src, &Rx_Buf[0], MAX_MPDU, timeout); /* process */ if (pdu_len) { npdu_handler(&src, &Rx_Buf[0], pdu_len); } if (mstimer_expired(&maintenance_timer)) { mstimer_reset(&maintenance_timer); tsm_timer_milliseconds(mstimer_interval(&maintenance_timer)); datalink_maintenance_timer( mstimer_interval(&maintenance_timer) / 1000L); } if (mstimer_expired(&apdu_timer)) { MyPrintHandler( Target_Object_Type, Target_Object_Instance, ERROR_CLASS_COMMUNICATION, ERROR_CODE_ABORT_APPLICATION_EXCEEDED_REPLY_TIME, 0); Error_Detected = true; } if (Error_Detected) { break; } } if (Error_Detected) { return 1; } return 0; }