/** * @file * @brief Base "class" for handling all BACnet objects belonging * to a BACnet device, as well as Device-specific properties. * @author Steve Karg * @date 2005,2006,2009 * @date 2021 * @copyright SPDX-License-Identifier: MIT */ #include #include #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" /* BACnet Stack API */ #include "bacnet/bacdcode.h" #include "bacnet/bacapp.h" #include "bacnet/datetime.h" #include "bacnet/apdu.h" #include "bacnet/wp.h" #include "bacnet/rp.h" #include "bacnet/dcc.h" #include "bacnet/version.h" /* some demo stuff needed */ #include "bacnet/datalink/datalink.h" #include "bacnet/basic/services.h" #include "bacnet/basic/binding/address.h" #include "bacnet/basic/object/device.h" #include "bacnet/basic/object/bi.h" #include "bacnet/basic/object/blo.h" #include "bacnet/basic/object/bo.h" #if (BACNET_PROTOCOL_REVISION >= 17) #include "bacnet/basic/object/netport.h" #endif /* may be overridden by outside table */ static object_functions_t *Object_Table; static object_functions_t My_Object_Table[] = { { OBJECT_DEVICE, NULL /* Init - don't init Device or it will recourse! */, Device_Count, Device_Index_To_Instance, Device_Valid_Object_Instance_Number, Device_Object_Name, Device_Read_Property_Local, Device_Write_Property_Local, Device_Property_Lists, DeviceGetRRInfo, NULL /* Iterator */, NULL /* Value_Lists */, NULL /* COV */, NULL /* COV Clear */, NULL /* Intrinsic Reporting */, NULL /* Add_List_Element */, NULL /* Remove_List_Element */, NULL /* Create */, NULL /* Delete */, NULL /* Timer */, Device_Writable_Property_List }, #if (BACNET_PROTOCOL_REVISION >= 17) { OBJECT_NETWORK_PORT, Network_Port_Init, Network_Port_Count, Network_Port_Index_To_Instance, Network_Port_Valid_Instance, Network_Port_Object_Name, Network_Port_Read_Property, Network_Port_Write_Property, Network_Port_Property_Lists, NULL /* ReadRangeInfo */, NULL /* Iterator */, NULL /* Value_Lists */, NULL /* COV */, NULL /* COV Clear */, NULL /* Intrinsic Reporting */, NULL /* Add_List_Element */, NULL /* Remove_List_Element */, NULL /* Create */, NULL /* Delete */, NULL /* Timer */, Network_Port_Writable_Property_List }, #endif { OBJECT_BINARY_INPUT, Binary_Input_Init, Binary_Input_Count, Binary_Input_Index_To_Instance, Binary_Input_Valid_Instance, Binary_Input_Object_Name, Binary_Input_Read_Property, Binary_Input_Write_Property, Binary_Input_Property_Lists, NULL /* ReadRangeInfo */, NULL /* Iterator */, Binary_Input_Encode_Value_List, Binary_Input_Change_Of_Value, Binary_Input_Change_Of_Value_Clear, NULL /* Intrinsic Reporting */, NULL /* Add_List_Element */, NULL /* Remove_List_Element */, NULL /* Create */, NULL /* Delete */, NULL /* Timer */, Binary_Input_Writable_Property_List }, { OBJECT_BINARY_LIGHTING_OUTPUT, Binary_Lighting_Output_Init, Binary_Lighting_Output_Count, Binary_Lighting_Output_Index_To_Instance, Binary_Lighting_Output_Valid_Instance, Binary_Lighting_Output_Object_Name, Binary_Lighting_Output_Read_Property, Binary_Lighting_Output_Write_Property, Binary_Lighting_Output_Property_Lists, NULL /* ReadRangeInfo */, NULL /* Iterator */, NULL /* Value_Lists */, NULL /* COV */, NULL /* COV Clear */, NULL /* Intrinsic Reporting */, NULL /* Add_List_Element */, NULL /* Remove_List_Element */, Binary_Lighting_Output_Create, Binary_Lighting_Output_Delete, Binary_Lighting_Output_Timer, Binary_Lighting_Output_Writable_Property_List }, { OBJECT_BINARY_OUTPUT, Binary_Output_Init, Binary_Output_Count, Binary_Output_Index_To_Instance, Binary_Output_Valid_Instance, Binary_Output_Object_Name, Binary_Output_Read_Property, Binary_Output_Write_Property, Binary_Output_Property_Lists, NULL /* ReadRangeInfo */, NULL /* Iterator */, NULL /* Value_Lists */, NULL /* COV */, NULL /* COV Clear */, NULL /* Intrinsic Reporting */, NULL /* Add_List_Element */, NULL /* Remove_List_Element */, Binary_Output_Create, Binary_Output_Delete, NULL /* Timer */, Binary_Output_Writable_Property_List }, { MAX_BACNET_OBJECT_TYPE, NULL /* Init */, NULL /* Count */, NULL /* Index_To_Instance */, NULL /* Valid_Instance */, NULL /* Object_Name */, NULL /* Read_Property */, NULL /* Write_Property */, NULL /* Property_Lists */, NULL /* ReadRangeInfo */, NULL /* Iterator */, NULL /* Value_Lists */, NULL /* COV */, NULL /* COV Clear */, NULL /* Intrinsic Reporting */, NULL /* Add_List_Element */, NULL /* Remove_List_Element */, NULL /* Create */, NULL /* Delete */, NULL /* Timer */, NULL /* Writable_Property_List */ } }; /** Glue function to let the Device object, when called by a handler, * lookup which Object type needs to be invoked. * @ingroup ObjHelpers * @param Object_Type [in] The type of BACnet Object the handler wants to * access. * @return Pointer to the group of object helper functions that implement this * type of Object. */ struct object_functions * Device_Object_Functions_Find(BACNET_OBJECT_TYPE Object_Type) { struct object_functions *pObject = NULL; pObject = Object_Table; while (pObject->Object_Type < MAX_BACNET_OBJECT_TYPE) { /* handle each object type */ if (pObject->Object_Type == Object_Type) { return (pObject); } pObject++; } return (NULL); } /** Try to find a rr_info_function helper function for the requested object * type. * @ingroup ObjIntf * * @param object_type [in] The type of BACnet Object the handler wants to * access. * @return Pointer to the object helper function that implements the * ReadRangeInfo function, Object_RR_Info, for this type of Object on * success, else a NULL pointer if the type of Object isn't supported * or doesn't have a ReadRangeInfo function. */ rr_info_function Device_Objects_RR_Info(BACNET_OBJECT_TYPE object_type) { struct object_functions *pObject = NULL; pObject = Device_Object_Functions_Find(object_type); return (pObject != NULL ? pObject->Object_RR_Info : NULL); } /** For a given object type, returns the special property list. * This function is used for ReadPropertyMultiple calls which want * just Required, just Optional, or All properties. * @ingroup ObjIntf * * @param object_type [in] The desired BACNET_OBJECT_TYPE whose properties * are to be listed. * @param pPropertyList [out] Reference to the structure which will, on return, * list, separately, the Required, Optional, and Proprietary object * properties with their counts. */ void Device_Objects_Property_List( BACNET_OBJECT_TYPE object_type, uint32_t object_instance, struct special_property_list_t *pPropertyList) { struct object_functions *pObject = NULL; (void)object_instance; pPropertyList->Required.pList = NULL; pPropertyList->Optional.pList = NULL; pPropertyList->Proprietary.pList = NULL; /* If we can find an entry for the required object type * and there is an Object_List_RPM fn ptr then call it * to populate the pointers to the individual list counters. */ pObject = Device_Object_Functions_Find(object_type); if ((pObject != NULL) && (pObject->Object_RPM_List != NULL)) { pObject->Object_RPM_List( &pPropertyList->Required.pList, &pPropertyList->Optional.pList, &pPropertyList->Proprietary.pList); } /* Fetch the counts if available otherwise zero them */ pPropertyList->Required.count = pPropertyList->Required.pList == NULL ? 0 : property_list_count(pPropertyList->Required.pList); pPropertyList->Optional.count = pPropertyList->Optional.pList == NULL ? 0 : property_list_count(pPropertyList->Optional.pList); pPropertyList->Proprietary.count = pPropertyList->Proprietary.pList == NULL ? 0 : property_list_count(pPropertyList->Proprietary.pList); return; } /** * @brief Determine if the object property is a member of this object instance * @param object_type - object type of the object * @param object_instance - object-instance number of the object * @param object_property - object-property to be checked * @return true if the property is a member of this object instance */ bool Device_Objects_Property_List_Member( BACNET_OBJECT_TYPE object_type, uint32_t object_instance, BACNET_PROPERTY_ID object_property) { bool found = false; struct special_property_list_t property_list = { 0 }; Device_Objects_Property_List(object_type, object_instance, &property_list); found = property_list_member(property_list.Required.pList, object_property); if (!found) { found = property_list_member(property_list.Optional.pList, object_property); } if (!found) { found = property_list_member( property_list.Proprietary.pList, object_property); } return found; } /* These three arrays are used by the ReadPropertyMultiple handler */ static const int Device_Properties_Required[] = { PROP_OBJECT_IDENTIFIER, PROP_OBJECT_NAME, PROP_OBJECT_TYPE, PROP_SYSTEM_STATUS, PROP_VENDOR_NAME, PROP_VENDOR_IDENTIFIER, PROP_MODEL_NAME, PROP_FIRMWARE_REVISION, PROP_APPLICATION_SOFTWARE_VERSION, PROP_PROTOCOL_VERSION, PROP_PROTOCOL_REVISION, PROP_PROTOCOL_SERVICES_SUPPORTED, PROP_PROTOCOL_OBJECT_TYPES_SUPPORTED, PROP_OBJECT_LIST, PROP_MAX_APDU_LENGTH_ACCEPTED, PROP_SEGMENTATION_SUPPORTED, PROP_APDU_TIMEOUT, PROP_NUMBER_OF_APDU_RETRIES, PROP_DEVICE_ADDRESS_BINDING, PROP_DATABASE_REVISION, -1 }; static const int Device_Properties_Optional[] = { #if defined(BACDL_MSTP) PROP_MAX_MASTER, PROP_MAX_INFO_FRAMES, #endif PROP_DESCRIPTION, PROP_LOCAL_TIME, PROP_UTC_OFFSET, PROP_LOCAL_DATE, PROP_DAYLIGHT_SAVINGS_STATUS, PROP_LOCATION, PROP_ACTIVE_COV_SUBSCRIPTIONS, #if defined(BACNET_TIME_MASTER) PROP_TIME_SYNCHRONIZATION_RECIPIENTS, PROP_TIME_SYNCHRONIZATION_INTERVAL, PROP_ALIGN_INTERVALS, PROP_INTERVAL_OFFSET, #endif -1 }; /* Every object shall have a Writable Property_List property which is a BACnetARRAY of property identifiers, one property identifier for each property within this object that is always writable. */ static const int32_t Writable_Properties[] = { /* unordered list of writable properties */ PROP_OBJECT_IDENTIFIER, PROP_NUMBER_OF_APDU_RETRIES, PROP_APDU_TIMEOUT, PROP_VENDOR_IDENTIFIER, PROP_SYSTEM_STATUS, PROP_OBJECT_NAME, PROP_LOCATION, PROP_DESCRIPTION, PROP_MODEL_NAME, #if defined(BACNET_TIME_MASTER) PROP_TIME_SYNCHRONIZATION_INTERVAL, PROP_ALIGN_INTERVALS, PROP_INTERVAL_OFFSET, #endif PROP_UTC_OFFSET, #if defined(BACDL_MSTP) PROP_MAX_INFO_FRAMES, PROP_MAX_MASTER, #endif -1 }; static const int Device_Properties_Proprietary[] = { -1 }; void Device_Property_Lists( const int **pRequired, const int **pOptional, const int **pProprietary) { if (pRequired) { *pRequired = Device_Properties_Required; } if (pOptional) { *pOptional = Device_Properties_Optional; } if (pProprietary) { *pProprietary = Device_Properties_Proprietary; } return; } /** * @brief Get the list of writable properties for a Device object * @param object_instance - object-instance number of the object * @param properties - Pointer to the pointer of writable properties. */ void Device_Writable_Property_List( uint32_t object_instance, const int32_t **properties) { (void)object_instance; if (properties) { *properties = Writable_Properties; } } /* note: you really only need to define variables for properties that are writable or that may change. The properties that are constant can be hard coded into the read-property encoding. */ static uint32_t Object_Instance_Number = 260001; static BACNET_CHARACTER_STRING My_Object_Name; static BACNET_DEVICE_STATUS System_Status = STATUS_OPERATIONAL; static char *Vendor_Name = BACNET_VENDOR_NAME; static uint16_t Vendor_Identifier = BACNET_VENDOR_ID; static char Model_Name[MAX_DEV_MOD_LEN + 1] = "PiFace Digital"; static char Application_Software_Version[MAX_DEV_VER_LEN + 1] = "1.0"; static const char *BACnet_Version = BACNET_VERSION_TEXT; static char Location[MAX_DEV_LOC_LEN + 1] = "USA"; static char Description[MAX_DEV_DESC_LEN + 1] = "Raspberry PiFace Digital Demo"; /* static uint8_t Protocol_Version = 1; - constant, not settable */ /* static uint8_t Protocol_Revision = 4; - constant, not settable */ /* Protocol_Services_Supported - dynamically generated */ /* Protocol_Object_Types_Supported - in RP encoding */ /* Object_List - dynamically generated */ /* static BACNET_SEGMENTATION Segmentation_Supported = SEGMENTATION_NONE; */ /* static uint8_t Max_Segments_Accepted = 0; */ /* VT_Classes_Supported */ /* Active_VT_Sessions */ static BACNET_TIME Local_Time; /* rely on OS, if there is one */ static BACNET_DATE Local_Date; /* rely on OS, if there is one */ /* NOTE: BACnet UTC Offset is inverse of common practice. If your UTC offset is -5hours of GMT, then BACnet UTC offset is +5hours. BACnet UTC offset is expressed in minutes. */ static int16_t UTC_Offset = 5 * 60; static bool Daylight_Savings_Status = false; /* rely on OS */ #if defined(BACNET_TIME_MASTER) static bool Align_Intervals; static uint32_t Interval_Minutes; static uint32_t Interval_Offset_Minutes; /* Time_Synchronization_Recipients */ #endif /* List_Of_Session_Keys */ /* Max_Master - rely on MS/TP subsystem, if there is one */ /* Max_Info_Frames - rely on MS/TP subsystem, if there is one */ /* Device_Address_Binding - required, but relies on binding cache */ static uint32_t Database_Revision = 0; /* Configuration_Files */ /* Last_Restore_Time */ /* Backup_Failure_Timeout */ /* Active_COV_Subscriptions */ /* Slave_Proxy_Enable */ /* Manual_Slave_Address_Binding */ /* Auto_Slave_Discovery */ /* Slave_Address_Binding */ /* Profile_Name */ static BACNET_REINITIALIZED_STATE Reinitialize_State = BACNET_REINIT_IDLE; static const char *Reinit_Password = "raspberry"; /** * @brief Sets the ReinitializeDevice password * * The password shall be a null terminated C string of up to * 20 ASCII characters for those devices that require the password. * * For those devices that do not require a password, set to NULL or * point to a zero length C string (null terminated). * * @param the ReinitializeDevice password; can be NULL or empty string */ bool Device_Reinitialize_Password_Set(const char *password) { Reinit_Password = password; return true; } /** Commands a Device re-initialization, to a given state. * The request's password must match for the operation to succeed. * This implementation provides a framework, but doesn't * actually *DO* anything. * @note You could use a mix of states and passwords to multiple outcomes. * @note You probably want to restart *after* the simple ack has been sent * from the return handler, so just set a local flag here. * @ingroup ObjIntf * * @param rd_data [in,out] The information from the RD request. * On failure, the error class and code will be set. * @return True if succeeds (password is correct), else False. */ bool Device_Reinitialize(BACNET_REINITIALIZE_DEVICE_DATA *rd_data) { bool status = false; bool password_success = false; /* From 16.4.1.1.2 Password This optional parameter shall be a CharacterString of up to 20 characters. For those devices that require the password as a protection, the service request shall be denied if the parameter is absent or if the password is incorrect. For those devices that do not require a password, this parameter shall be ignored.*/ if (Reinit_Password && strlen(Reinit_Password) > 0) { if (characterstring_length(&rd_data->password) > 20) { rd_data->error_class = ERROR_CLASS_SERVICES; rd_data->error_code = ERROR_CODE_PARAMETER_OUT_OF_RANGE; } else if (characterstring_ansi_same( &rd_data->password, Reinit_Password)) { password_success = true; } else { rd_data->error_class = ERROR_CLASS_SECURITY; rd_data->error_code = ERROR_CODE_PASSWORD_FAILURE; } } else { password_success = true; } if (password_success) { switch (rd_data->state) { case BACNET_REINIT_COLDSTART: case BACNET_REINIT_WARMSTART: dcc_set_status_duration(COMMUNICATION_ENABLE, 0); /* note: you probably want to restart *after* the simple ack has been sent from the return handler so just set a flag from here */ Reinitialize_State = rd_data->state; status = true; break; case BACNET_REINIT_STARTBACKUP: case BACNET_REINIT_ENDBACKUP: case BACNET_REINIT_STARTRESTORE: case BACNET_REINIT_ENDRESTORE: case BACNET_REINIT_ABORTRESTORE: if (dcc_communication_disabled()) { rd_data->error_class = ERROR_CLASS_SERVICES; rd_data->error_code = ERROR_CODE_COMMUNICATION_DISABLED; } else { rd_data->error_class = ERROR_CLASS_SERVICES; rd_data->error_code = ERROR_CODE_OPTIONAL_FUNCTIONALITY_NOT_SUPPORTED; } break; default: rd_data->error_class = ERROR_CLASS_SERVICES; rd_data->error_code = ERROR_CODE_PARAMETER_OUT_OF_RANGE; break; } } else { rd_data->error_class = ERROR_CLASS_SECURITY; rd_data->error_code = ERROR_CODE_PASSWORD_FAILURE; } return status; } BACNET_REINITIALIZED_STATE Device_Reinitialized_State(void) { return Reinitialize_State; } unsigned Device_Count(void) { return 1; } uint32_t Device_Index_To_Instance(unsigned index) { (void)index; return Object_Instance_Number; } /* methods to manipulate the data */ /** Return the Object Instance number for our (single) Device Object. * This is a key function, widely invoked by the handler code, since * it provides "our" (ie, local) address. * @ingroup ObjIntf * @return The Instance number used in the BACNET_OBJECT_ID for the Device. */ uint32_t Device_Object_Instance_Number(void) { return Object_Instance_Number; } bool Device_Set_Object_Instance_Number(uint32_t object_id) { bool status = true; /* return value */ if (object_id <= BACNET_MAX_INSTANCE) { /* Make the change and update the database revision */ Object_Instance_Number = object_id; Device_Inc_Database_Revision(); } else { status = false; } return status; } bool Device_Valid_Object_Instance_Number(uint32_t object_id) { return (Object_Instance_Number == object_id); } bool Device_Object_Name( uint32_t object_instance, BACNET_CHARACTER_STRING *object_name) { bool status = false; if (object_instance == Object_Instance_Number) { status = characterstring_copy(object_name, &My_Object_Name); } return status; } bool Device_Set_Object_Name(const BACNET_CHARACTER_STRING *object_name) { bool status = false; /*return value */ if (!characterstring_same(&My_Object_Name, object_name)) { /* Make the change and update the database revision */ status = characterstring_copy(&My_Object_Name, object_name); Device_Inc_Database_Revision(); } return status; } bool Device_Object_Name_ANSI_Init(const char *value) { return characterstring_init_ansi(&My_Object_Name, value); } BACNET_DEVICE_STATUS Device_System_Status(void) { return System_Status; } int Device_Set_System_Status(BACNET_DEVICE_STATUS status, bool local) { int result = 0; /*return value - 0 = ok, -1 = bad value, -2 = not allowed */ /* We limit the options available depending on whether the source is * internal or external. */ if (local) { switch (status) { case STATUS_OPERATIONAL: case STATUS_OPERATIONAL_READ_ONLY: case STATUS_DOWNLOAD_REQUIRED: case STATUS_DOWNLOAD_IN_PROGRESS: case STATUS_NON_OPERATIONAL: System_Status = status; break; /* Don't support backup at present so don't allow setting */ case STATUS_BACKUP_IN_PROGRESS: result = -2; break; default: result = -1; break; } } else { switch (status) { /* Allow these for the moment as a way to easily alter * overall device operation. The lack of password protection * or other authentication makes allowing writes to this * property a risky facility to provide. */ case STATUS_OPERATIONAL: case STATUS_OPERATIONAL_READ_ONLY: case STATUS_NON_OPERATIONAL: System_Status = status; break; /* Don't allow outsider set this - it should probably * be set if the device config is incomplete or * corrupted or perhaps after some sort of operator * wipe operation. */ case STATUS_DOWNLOAD_REQUIRED: /* Don't allow outsider set this - it should be set * internally at the start of a multi packet download * perhaps indirectly via PT or WF to a config file. */ case STATUS_DOWNLOAD_IN_PROGRESS: /* Don't support backup at present so don't allow setting */ case STATUS_BACKUP_IN_PROGRESS: result = -2; break; default: result = -1; break; } } return (result); } const char *Device_Vendor_Name(void) { return Vendor_Name; } /** Returns the Vendor ID for this Device. * See the assignments at * http://www.bacnet.org/VendorID/BACnet%20Vendor%20IDs.htm * @return The Vendor ID of this Device. */ uint16_t Device_Vendor_Identifier(void) { return Vendor_Identifier; } void Device_Set_Vendor_Identifier(uint16_t vendor_id) { Vendor_Identifier = vendor_id; } const char *Device_Model_Name(void) { return Model_Name; } bool Device_Set_Model_Name(const char *name, size_t length) { bool status = false; /*return value */ if (length < sizeof(Model_Name)) { memmove(Model_Name, name, length); Model_Name[length] = 0; status = true; } return status; } const char *Device_Firmware_Revision(void) { return BACnet_Version; } const char *Device_Application_Software_Version(void) { return Application_Software_Version; } bool Device_Set_Application_Software_Version(const char *name, size_t length) { bool status = false; /*return value */ if (length < sizeof(Application_Software_Version)) { memmove(Application_Software_Version, name, length); Application_Software_Version[length] = 0; status = true; } return status; } const char *Device_Description(void) { return Description; } bool Device_Set_Description(const char *name, size_t length) { bool status = false; /*return value */ if (length < sizeof(Description)) { memmove(Description, name, length); Description[length] = 0; status = true; } return status; } const char *Device_Location(void) { return Location; } bool Device_Set_Location(const char *name, size_t length) { bool status = false; /*return value */ if (length < sizeof(Location)) { memmove(Location, name, length); Location[length] = 0; status = true; } return status; } uint8_t Device_Protocol_Version(void) { return BACNET_PROTOCOL_VERSION; } uint8_t Device_Protocol_Revision(void) { return BACNET_PROTOCOL_REVISION; } BACNET_SEGMENTATION Device_Segmentation_Supported(void) { return SEGMENTATION_NONE; } uint32_t Device_Database_Revision(void) { return Database_Revision; } void Device_Set_Database_Revision(uint32_t revision) { Database_Revision = revision; } /* * Shortcut for incrementing database revision as this is potentially * the most common operation if changing object names and ids is * implemented. */ void Device_Inc_Database_Revision(void) { Database_Revision++; } /** Get the total count of objects supported by this Device Object. * @note Since many network clients depend on the object list * for discovery, it must be consistent! * @return The count of objects, for all supported Object types. */ unsigned Device_Object_List_Count(void) { unsigned count = 0; /* number of objects */ struct object_functions *pObject = NULL; /* initialize the default return values */ pObject = Object_Table; while (pObject->Object_Type < MAX_BACNET_OBJECT_TYPE) { if (pObject->Object_Count) { count += pObject->Object_Count(); } pObject++; } return count; } /** Lookup the Object at the given array index in the Device's Object List. * Even though we don't keep a single linear array of objects in the Device, * this method acts as though we do and works through a virtual, concatenated * array of all of our object type arrays. * * @param array_index [in] The desired array index (1 to N) * @param object_type [out] The object's type, if found. * @param instance [out] The object's instance number, if found. * @return True if found, else false. */ bool Device_Object_List_Identifier( uint32_t array_index, BACNET_OBJECT_TYPE *object_type, uint32_t *instance) { bool status = false; uint32_t count = 0; uint32_t object_index = 0; uint32_t temp_index = 0; struct object_functions *pObject = NULL; /* array index zero is length - so invalid */ if (array_index == 0) { return status; } object_index = array_index - 1; /* initialize the default return values */ pObject = Object_Table; while (pObject->Object_Type < MAX_BACNET_OBJECT_TYPE) { if (pObject->Object_Count) { object_index -= count; count = pObject->Object_Count(); if (object_index < count) { /* Use the iterator function if available otherwise * look for the index to instance to get the ID */ if (pObject->Object_Iterator) { /* First find the first object */ temp_index = pObject->Object_Iterator(~(unsigned)0); /* Then step through the objects to find the nth */ while (object_index != 0) { temp_index = pObject->Object_Iterator(temp_index); object_index--; } /* set the object_index up before falling through to next * bit */ object_index = temp_index; } if (pObject->Object_Index_To_Instance) { *object_type = pObject->Object_Type; *instance = pObject->Object_Index_To_Instance(object_index); status = true; break; } } } pObject++; } return status; } /** * @brief Encode a BACnetARRAY property element * @param object_instance [in] BACnet network port object instance number * @param array_index [in] array index requested: * 0 to N for individual array members * @param apdu [out] Buffer in which the APDU contents are built, or NULL to * return the length of buffer if it had been built * @return The length of the apdu encoded or * BACNET_STATUS_ERROR for ERROR_CODE_INVALID_ARRAY_INDEX */ int Device_Object_List_Element_Encode( uint32_t object_instance, BACNET_ARRAY_INDEX array_index, uint8_t *apdu) { int apdu_len = BACNET_STATUS_ERROR; BACNET_OBJECT_TYPE object_type; uint32_t instance; bool found; if (object_instance == Device_Object_Instance_Number()) { /* single element is zero based, add 1 for BACnetARRAY which is one * based */ array_index++; found = Device_Object_List_Identifier(array_index, &object_type, &instance); if (found) { apdu_len = encode_application_object_id(apdu, object_type, instance); } } return apdu_len; } /** Determine if we have an object with the given object_name. * If the object_type and object_instance pointers are not null, * and the lookup succeeds, they will be given the resulting values. * @param object_name [in] The desired Object Name to look for. * @param object_type [out] The BACNET_OBJECT_TYPE of the matching Object. * @param object_instance [out] The object instance number of the matching * Object. * @return True on success or else False if not found. */ bool Device_Valid_Object_Name( const BACNET_CHARACTER_STRING *object_name1, BACNET_OBJECT_TYPE *object_type, uint32_t *object_instance) { bool found = false; BACNET_OBJECT_TYPE type = OBJECT_NONE; uint32_t instance; uint32_t max_objects = 0, i = 0; bool check_id = false; BACNET_CHARACTER_STRING object_name2; struct object_functions *pObject = NULL; max_objects = Device_Object_List_Count(); for (i = 1; i <= max_objects; i++) { check_id = Device_Object_List_Identifier(i, &type, &instance); if (check_id) { pObject = Device_Object_Functions_Find(type); if ((pObject != NULL) && (pObject->Object_Name != NULL) && (pObject->Object_Name(instance, &object_name2) && characterstring_same(object_name1, &object_name2))) { found = true; if (object_type) { *object_type = type; } if (object_instance) { *object_instance = instance; } break; } } } return found; } /** Determine if we have an object of this type and instance number. * @param object_type [in] The desired BACNET_OBJECT_TYPE * @param object_instance [in] The object instance number to be looked up. * @return True if found, else False if no such Object in this device. */ bool Device_Valid_Object_Id( BACNET_OBJECT_TYPE object_type, uint32_t object_instance) { bool status = false; /* return value */ struct object_functions *pObject = NULL; pObject = Device_Object_Functions_Find(object_type); if ((pObject != NULL) && (pObject->Object_Valid_Instance != NULL)) { status = pObject->Object_Valid_Instance(object_instance); } return status; } /** Copy a child object's object_name value, given its ID. * @param object_type [in] The BACNET_OBJECT_TYPE of the child Object. * @param object_instance [in] The object instance number of the child Object. * @param object_name [out] The Object Name found for this child Object. * @return True on success or else False if not found. */ bool Device_Object_Name_Copy( BACNET_OBJECT_TYPE object_type, uint32_t object_instance, BACNET_CHARACTER_STRING *object_name) { struct object_functions *pObject = NULL; bool found = false; pObject = Device_Object_Functions_Find(object_type); if (pObject != NULL) { if (pObject->Object_Valid_Instance && pObject->Object_Valid_Instance(object_instance)) { if (pObject->Object_Name) { found = pObject->Object_Name(object_instance, object_name); } } } return found; } static void Update_Current_Time(void) { datetime_local( &Local_Date, &Local_Time, &UTC_Offset, &Daylight_Savings_Status); } void Device_getCurrentDateTime(BACNET_DATE_TIME *DateTime) { Update_Current_Time(); DateTime->date = Local_Date; DateTime->time = Local_Time; } int32_t Device_UTC_Offset(void) { Update_Current_Time(); return UTC_Offset; } void Device_UTC_Offset_Set(int16_t offset) { UTC_Offset = offset; } bool Device_Daylight_Savings_Status(void) { return Daylight_Savings_Status; } #if defined(BACNET_TIME_MASTER) /** * Sets the time sync interval in minutes * * @param flag * This property, of type BOOLEAN, specifies whether (TRUE) * or not (FALSE) clock-aligned periodic time synchronization is * enabled. If periodic time synchronization is enabled and the * time synchronization interval is a factor of (divides without * remainder) an hour or day, then the beginning of the period * specified for time synchronization shall be aligned to the hour or * day, respectively. If this property is present, it shall be writable. */ bool Device_Align_Intervals_Set(bool flag) { Align_Intervals = flag; return true; } bool Device_Align_Intervals(void) { return Align_Intervals; } /** * Sets the time sync interval in minutes * * @param minutes * This property, of type Unsigned, specifies the periodic * interval in minutes at which TimeSynchronization and * UTCTimeSynchronization requests shall be sent. If this * property has a value of zero, then periodic time synchronization is * disabled. If this property is present, it shall be writable. */ bool Device_Time_Sync_Interval_Set(uint32_t minutes) { Interval_Minutes = minutes; return true; } uint32_t Device_Time_Sync_Interval(void) { return Interval_Minutes; } /** * Sets the time sync interval offset value. * * @param minutes * This property, of type Unsigned, specifies the offset in * minutes from the beginning of the period specified for time * synchronization until the actual time synchronization requests * are sent. The offset used shall be the value of Interval_Offset * modulo the value of Time_Synchronization_Interval; * e.g., if Interval_Offset has the value 31 and * Time_Synchronization_Interval is 30, the offset used shall be 1. * Interval_Offset shall have no effect if Align_Intervals is * FALSE. If this property is present, it shall be writable. */ bool Device_Interval_Offset_Set(uint32_t minutes) { Interval_Offset_Minutes = minutes; return true; } uint32_t Device_Interval_Offset(void) { return Interval_Offset_Minutes; } #endif /* return the length of the apdu encoded or BACNET_STATUS_ERROR for error or BACNET_STATUS_ABORT for abort message */ int Device_Read_Property_Local(BACNET_READ_PROPERTY_DATA *rpdata) { int apdu_len = 0; /* return value */ BACNET_BIT_STRING bit_string = { 0 }; BACNET_CHARACTER_STRING char_string = { 0 }; uint32_t i = 0; uint32_t count = 0; uint8_t *apdu = NULL; struct object_functions *pObject = NULL; uint16_t apdu_max = 0; if ((rpdata == NULL) || (rpdata->application_data == NULL) || (rpdata->application_data_len == 0)) { return 0; } apdu = rpdata->application_data; apdu_max = rpdata->application_data_len; switch (rpdata->object_property) { case PROP_OBJECT_IDENTIFIER: apdu_len = encode_application_object_id( &apdu[0], OBJECT_DEVICE, Object_Instance_Number); break; case PROP_OBJECT_NAME: apdu_len = encode_application_character_string(&apdu[0], &My_Object_Name); break; case PROP_OBJECT_TYPE: apdu_len = encode_application_enumerated(&apdu[0], OBJECT_DEVICE); break; case PROP_DESCRIPTION: characterstring_init_ansi(&char_string, Description); apdu_len = encode_application_character_string(&apdu[0], &char_string); break; case PROP_SYSTEM_STATUS: apdu_len = encode_application_enumerated(&apdu[0], System_Status); break; case PROP_VENDOR_NAME: characterstring_init_ansi(&char_string, Vendor_Name); apdu_len = encode_application_character_string(&apdu[0], &char_string); break; case PROP_VENDOR_IDENTIFIER: apdu_len = encode_application_unsigned(&apdu[0], Vendor_Identifier); break; case PROP_MODEL_NAME: characterstring_init_ansi(&char_string, Model_Name); apdu_len = encode_application_character_string(&apdu[0], &char_string); break; case PROP_FIRMWARE_REVISION: characterstring_init_ansi(&char_string, BACnet_Version); apdu_len = encode_application_character_string(&apdu[0], &char_string); break; case PROP_APPLICATION_SOFTWARE_VERSION: characterstring_init_ansi( &char_string, Application_Software_Version); apdu_len = encode_application_character_string(&apdu[0], &char_string); break; case PROP_LOCATION: characterstring_init_ansi(&char_string, Location); apdu_len = encode_application_character_string(&apdu[0], &char_string); break; case PROP_LOCAL_TIME: Update_Current_Time(); apdu_len = encode_application_time(&apdu[0], &Local_Time); break; case PROP_UTC_OFFSET: Update_Current_Time(); apdu_len = encode_application_signed(&apdu[0], UTC_Offset); break; case PROP_LOCAL_DATE: Update_Current_Time(); apdu_len = encode_application_date(&apdu[0], &Local_Date); break; case PROP_DAYLIGHT_SAVINGS_STATUS: Update_Current_Time(); apdu_len = encode_application_boolean(&apdu[0], Daylight_Savings_Status); break; case PROP_PROTOCOL_VERSION: apdu_len = encode_application_unsigned( &apdu[0], Device_Protocol_Version()); break; case PROP_PROTOCOL_REVISION: apdu_len = encode_application_unsigned( &apdu[0], Device_Protocol_Revision()); break; case PROP_PROTOCOL_SERVICES_SUPPORTED: /* Note: list of services that are executed, not initiated. */ bitstring_init(&bit_string); for (i = 0; i < MAX_BACNET_SERVICES_SUPPORTED; i++) { /* automatic lookup based on handlers set */ bitstring_set_bit( &bit_string, (uint8_t)i, apdu_service_supported((BACNET_SERVICES_SUPPORTED)i)); } apdu_len = encode_application_bitstring(&apdu[0], &bit_string); break; case PROP_PROTOCOL_OBJECT_TYPES_SUPPORTED: /* Note: this is the list of objects that can be in this device, not a list of objects that this device can access */ bitstring_init(&bit_string); for (i = 0; i < MAX_ASHRAE_OBJECT_TYPE; i++) { /* initialize all the object types to not-supported */ bitstring_set_bit(&bit_string, (uint8_t)i, false); } /* set the object types with objects to supported */ pObject = Object_Table; while (pObject->Object_Type < MAX_BACNET_OBJECT_TYPE) { if ((pObject->Object_Count) && (pObject->Object_Count() > 0)) { bitstring_set_bit( &bit_string, (uint8_t)pObject->Object_Type, true); } pObject++; } apdu_len = encode_application_bitstring(&apdu[0], &bit_string); break; case PROP_OBJECT_LIST: count = Device_Object_List_Count(); apdu_len = bacnet_array_encode( rpdata->object_instance, rpdata->array_index, Device_Object_List_Element_Encode, count, apdu, apdu_max); if (apdu_len == BACNET_STATUS_ABORT) { rpdata->error_code = ERROR_CODE_ABORT_SEGMENTATION_NOT_SUPPORTED; } else if (apdu_len == BACNET_STATUS_ERROR) { rpdata->error_class = ERROR_CLASS_PROPERTY; rpdata->error_code = ERROR_CODE_INVALID_ARRAY_INDEX; } break; case PROP_MAX_APDU_LENGTH_ACCEPTED: apdu_len = encode_application_unsigned(&apdu[0], MAX_APDU); break; case PROP_SEGMENTATION_SUPPORTED: apdu_len = encode_application_enumerated( &apdu[0], Device_Segmentation_Supported()); break; case PROP_APDU_TIMEOUT: apdu_len = encode_application_unsigned(&apdu[0], apdu_timeout()); break; case PROP_NUMBER_OF_APDU_RETRIES: apdu_len = encode_application_unsigned(&apdu[0], apdu_retries()); break; case PROP_DEVICE_ADDRESS_BINDING: apdu_len = address_list_encode(&apdu[0], apdu_max); break; case PROP_DATABASE_REVISION: apdu_len = encode_application_unsigned(&apdu[0], Database_Revision); break; #if defined(BACDL_MSTP) case PROP_MAX_INFO_FRAMES: apdu_len = encode_application_unsigned(&apdu[0], dlmstp_max_info_frames()); break; case PROP_MAX_MASTER: apdu_len = encode_application_unsigned(&apdu[0], dlmstp_max_master()); break; #endif #if defined(BACNET_TIME_MASTER) case PROP_TIME_SYNCHRONIZATION_RECIPIENTS: apdu_len = handler_timesync_encode_recipients(&apdu[0], MAX_APDU); if (apdu_len < 0) { rpdata->error_code = ERROR_CODE_ABORT_SEGMENTATION_NOT_SUPPORTED; apdu_len = BACNET_STATUS_ABORT; } break; case PROP_TIME_SYNCHRONIZATION_INTERVAL: apdu_len = encode_application_unsigned( &apdu[0], Device_Time_Sync_Interval()); break; case PROP_ALIGN_INTERVALS: apdu_len = encode_application_boolean(&apdu[0], Device_Align_Intervals()); break; case PROP_INTERVAL_OFFSET: apdu_len = encode_application_unsigned(&apdu[0], Device_Interval_Offset()); break; #endif case PROP_ACTIVE_COV_SUBSCRIPTIONS: apdu_len = handler_cov_encode_subscriptions(&apdu[0], apdu_max); break; default: rpdata->error_class = ERROR_CLASS_PROPERTY; rpdata->error_code = ERROR_CODE_UNKNOWN_PROPERTY; apdu_len = BACNET_STATUS_ERROR; break; } return apdu_len; } /** Looks up the common Object and Property, and encodes its Value in an * APDU. Sets the error class and code if request is not appropriate. * @param pObject - object table * @param rpdata [in,out] Structure with the requested Object & Property info * on entry, and APDU message on return. * @return The length of the APDU on success, else BACNET_STATUS_ERROR */ static int Read_Property_Common( const struct object_functions *pObject, BACNET_READ_PROPERTY_DATA *rpdata) { int apdu_len = BACNET_STATUS_ERROR; BACNET_CHARACTER_STRING char_string; uint8_t *apdu = NULL; #if (BACNET_PROTOCOL_REVISION >= 14) struct special_property_list_t property_list; #endif if ((rpdata->application_data == NULL) || (rpdata->application_data_len == 0)) { return 0; } apdu = rpdata->application_data; if (property_list_common(rpdata->object_property)) { apdu_len = property_list_common_encode(rpdata, Object_Instance_Number); } else if (rpdata->object_property == PROP_OBJECT_NAME) { characterstring_init_ansi(&char_string, ""); if (pObject->Object_Name) { (void)pObject->Object_Name(rpdata->object_instance, &char_string); } apdu_len = encode_application_character_string(&apdu[0], &char_string); #if (BACNET_PROTOCOL_REVISION >= 14) } else if (rpdata->object_property == PROP_PROPERTY_LIST) { Device_Objects_Property_List( rpdata->object_type, rpdata->object_instance, &property_list); apdu_len = property_list_encode( 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); } return apdu_len; } /** Looks up the requested Object and Property, and encodes its Value in an * APDU. * @ingroup ObjIntf * If the Object or Property can't be found, sets the error class and code. * * @param rpdata [in,out] Structure with the desired Object and Property info * on entry, and APDU message on return. * @return The length of the APDU on success, else BACNET_STATUS_ERROR */ int Device_Read_Property(BACNET_READ_PROPERTY_DATA *rpdata) { int apdu_len = BACNET_STATUS_ERROR; struct object_functions *pObject = NULL; /* initialize the default return values */ rpdata->error_class = ERROR_CLASS_OBJECT; rpdata->error_code = ERROR_CODE_UNKNOWN_OBJECT; pObject = Device_Object_Functions_Find(rpdata->object_type); if (pObject != NULL) { if (pObject->Object_Valid_Instance && pObject->Object_Valid_Instance(rpdata->object_instance)) { apdu_len = Read_Property_Common(pObject, rpdata); } else { rpdata->error_class = ERROR_CLASS_OBJECT; rpdata->error_code = ERROR_CODE_UNKNOWN_OBJECT; } } else { rpdata->error_class = ERROR_CLASS_OBJECT; rpdata->error_code = ERROR_CODE_UNKNOWN_OBJECT; } return apdu_len; } /* returns true if successful */ bool Device_Write_Property_Local(BACNET_WRITE_PROPERTY_DATA *wp_data) { bool status = false; /* return value */ int len = 0; BACNET_APPLICATION_DATA_VALUE value = { 0 }; BACNET_OBJECT_TYPE object_type = OBJECT_NONE; uint32_t object_instance = 0; int result = 0; #if defined(BACNET_TIME_MASTER) uint32_t minutes = 0; #endif /* decode the some of the request */ len = bacapp_decode_application_data( wp_data->application_data, wp_data->application_data_len, &value); if (len < 0) { /* error while decoding - a value larger than we can handle */ wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE; return false; } /* FIXME: len < application_data_len: more data? */ switch (wp_data->object_property) { case PROP_OBJECT_IDENTIFIER: status = write_property_type_valid( wp_data, &value, BACNET_APPLICATION_TAG_OBJECT_ID); if (status) { if ((value.type.Object_Id.type == OBJECT_DEVICE) && (Device_Set_Object_Instance_Number( value.type.Object_Id.instance))) { /* FIXME: we could send an I-Am broadcast to let the world * know */ } else { status = false; wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE; } } break; case PROP_NUMBER_OF_APDU_RETRIES: status = write_property_type_valid( wp_data, &value, BACNET_APPLICATION_TAG_UNSIGNED_INT); if (status) { /* FIXME: bounds check? */ apdu_retries_set((uint8_t)value.type.Unsigned_Int); } break; case PROP_APDU_TIMEOUT: status = write_property_type_valid( wp_data, &value, BACNET_APPLICATION_TAG_UNSIGNED_INT); if (status) { /* FIXME: bounds check? */ apdu_timeout_set((uint16_t)value.type.Unsigned_Int); } break; case PROP_VENDOR_IDENTIFIER: status = write_property_type_valid( wp_data, &value, BACNET_APPLICATION_TAG_UNSIGNED_INT); if (status) { /* FIXME: bounds check? */ Device_Set_Vendor_Identifier((uint16_t)value.type.Unsigned_Int); } break; case PROP_SYSTEM_STATUS: status = write_property_type_valid( wp_data, &value, BACNET_APPLICATION_TAG_ENUMERATED); if (status) { result = Device_Set_System_Status( (BACNET_DEVICE_STATUS)value.type.Enumerated, false); if (result != 0) { /* result: - 0 = ok, -1 = bad value, -2 = not allowed */ status = false; wp_data->error_class = ERROR_CLASS_PROPERTY; if (result == -1) { wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE; } else { wp_data->error_code = ERROR_CODE_OPTIONAL_FUNCTIONALITY_NOT_SUPPORTED; } } } break; case PROP_OBJECT_NAME: status = write_property_string_valid( wp_data, &value, characterstring_capacity(&My_Object_Name)); if (status) { /* All the object names in a device must be unique */ if (Device_Valid_Object_Name( &value.type.Character_String, &object_type, &object_instance)) { if ((object_type == wp_data->object_type) && (object_instance == wp_data->object_instance)) { /* writing same name to same object */ status = true; } else { status = false; wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_DUPLICATE_NAME; } } else { Device_Set_Object_Name(&value.type.Character_String); } } break; case PROP_LOCATION: status = write_property_empty_string_valid( wp_data, &value, MAX_DEV_LOC_LEN); if (status) { Device_Set_Location( characterstring_value(&value.type.Character_String), characterstring_length(&value.type.Character_String)); } break; case PROP_DESCRIPTION: status = write_property_empty_string_valid( wp_data, &value, MAX_DEV_DESC_LEN); if (status) { Device_Set_Description( characterstring_value(&value.type.Character_String), characterstring_length(&value.type.Character_String)); } break; case PROP_MODEL_NAME: status = write_property_empty_string_valid( wp_data, &value, MAX_DEV_MOD_LEN); if (status) { Device_Set_Model_Name( characterstring_value(&value.type.Character_String), characterstring_length(&value.type.Character_String)); } break; #if defined(BACNET_TIME_MASTER) case PROP_TIME_SYNCHRONIZATION_INTERVAL: status = write_property_type_valid( wp_data, &value, BACNET_APPLICATION_TAG_UNSIGNED_INT); if (status) { if (value.type.Unsigned_Int < 65535) { minutes = value.type.Unsigned_Int; Device_Time_Sync_Interval_Set(minutes); status = true; } else { wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE; } } break; case PROP_ALIGN_INTERVALS: status = write_property_type_valid( wp_data, &value, BACNET_APPLICATION_TAG_BOOLEAN); if (status) { Device_Align_Intervals_Set(value.type.Boolean); status = true; } break; case PROP_INTERVAL_OFFSET: status = write_property_type_valid( wp_data, &value, BACNET_APPLICATION_TAG_UNSIGNED_INT); if (status) { if (value.type.Unsigned_Int < 65535) { minutes = value.type.Unsigned_Int; Device_Interval_Offset_Set(minutes); status = true; } else { wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE; } } break; #else case PROP_TIME_SYNCHRONIZATION_INTERVAL: case PROP_ALIGN_INTERVALS: case PROP_INTERVAL_OFFSET: wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_UNKNOWN_PROPERTY; break; #endif case PROP_UTC_OFFSET: status = write_property_type_valid( wp_data, &value, BACNET_APPLICATION_TAG_SIGNED_INT); if (status) { if ((value.type.Signed_Int < (12 * 60)) && (value.type.Signed_Int > (-12 * 60))) { Device_UTC_Offset_Set(value.type.Signed_Int); status = true; } else { wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE; } } break; #if defined(BACDL_MSTP) case PROP_MAX_INFO_FRAMES: status = write_property_type_valid( wp_data, &value, BACNET_APPLICATION_TAG_UNSIGNED_INT); if (status) { if (value.type.Unsigned_Int <= 255) { dlmstp_set_max_info_frames( (uint8_t)value.type.Unsigned_Int); } else { status = false; wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE; } } break; case PROP_MAX_MASTER: status = write_property_type_valid( wp_data, &value, BACNET_APPLICATION_TAG_UNSIGNED_INT); if (status) { if ((value.type.Unsigned_Int > 0) && (value.type.Unsigned_Int <= 127)) { dlmstp_set_max_master((uint8_t)value.type.Unsigned_Int); } else { status = false; wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE; } } break; #else case PROP_MAX_INFO_FRAMES: case PROP_MAX_MASTER: wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_UNKNOWN_PROPERTY; break; #endif case PROP_OBJECT_TYPE: case PROP_VENDOR_NAME: case PROP_FIRMWARE_REVISION: case PROP_APPLICATION_SOFTWARE_VERSION: case PROP_LOCAL_TIME: case PROP_LOCAL_DATE: case PROP_DAYLIGHT_SAVINGS_STATUS: case PROP_PROTOCOL_VERSION: case PROP_PROTOCOL_REVISION: case PROP_PROTOCOL_SERVICES_SUPPORTED: case PROP_PROTOCOL_OBJECT_TYPES_SUPPORTED: case PROP_OBJECT_LIST: case PROP_MAX_APDU_LENGTH_ACCEPTED: case PROP_SEGMENTATION_SUPPORTED: case PROP_DEVICE_ADDRESS_BINDING: case PROP_DATABASE_REVISION: case PROP_ACTIVE_COV_SUBSCRIPTIONS: #if defined(BACNET_TIME_MASTER) case PROP_TIME_SYNCHRONIZATION_RECIPIENTS: #endif wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_WRITE_ACCESS_DENIED; break; default: wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_UNKNOWN_PROPERTY; break; } return status; } /** * @brief Handles the writing of the object name property * @param wp_data [in,out] WriteProperty data structure * @param Object_Write_Property object specific function to write the property * @return True on success, else False if there is an error. */ static bool Device_Write_Property_Object_Name( BACNET_WRITE_PROPERTY_DATA *wp_data, write_property_function Object_Write_Property) { bool status = false; /* return value */ int len = 0; BACNET_CHARACTER_STRING value; BACNET_OBJECT_TYPE object_type = OBJECT_NONE; uint32_t object_instance = 0; int apdu_size = 0; uint8_t *apdu = NULL; if (!wp_data) { return false; } apdu = wp_data->application_data; apdu_size = wp_data->application_data_len; len = bacnet_character_string_application_decode(apdu, apdu_size, &value); if (len > 0) { if ((characterstring_encoding(&value) != CHARACTER_ANSI_X34) || (characterstring_length(&value) == 0) || (!characterstring_printable(&value))) { wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE; } else { status = true; } } else if (len == 0) { wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_INVALID_DATA_TYPE; } else { wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE; } if (status) { /* All the object names in a device must be unique */ if (Device_Valid_Object_Name(&value, &object_type, &object_instance)) { if ((object_type == wp_data->object_type) && (object_instance == wp_data->object_instance)) { /* writing same name to same object - but is it writable? */ status = Object_Write_Property(wp_data); } else { /* name already exists in some object */ wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_DUPLICATE_NAME; status = false; } } else { status = Object_Write_Property(wp_data); } } return status; } /** Looks up the requested Object and Property, and set the new Value in it, * if allowed. * If the Object or Property can't be found, sets the error class and code. * @ingroup ObjIntf * * @param wp_data [in,out] Structure with the desired Object and Property info * and new Value on entry, and APDU message on return. * @return True on success, else False if there is an error. */ bool Device_Write_Property(BACNET_WRITE_PROPERTY_DATA *wp_data) { bool status = false; /* Ever the pessamist! */ struct object_functions *pObject = NULL; /* initialize the default return values */ wp_data->error_class = ERROR_CLASS_OBJECT; wp_data->error_code = ERROR_CODE_UNKNOWN_OBJECT; pObject = Device_Object_Functions_Find(wp_data->object_type); if (pObject != NULL) { if (pObject->Object_Valid_Instance && pObject->Object_Valid_Instance(wp_data->object_instance)) { if (pObject->Object_Write_Property) { #if (BACNET_PROTOCOL_REVISION >= 14) if (wp_data->object_property == PROP_PROPERTY_LIST) { wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_WRITE_ACCESS_DENIED; return false; } #endif if (wp_data->object_property == PROP_OBJECT_NAME) { status = Device_Write_Property_Object_Name( wp_data, pObject->Object_Write_Property); } else { status = pObject->Object_Write_Property(wp_data); } } else { wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_WRITE_ACCESS_DENIED; } } else { wp_data->error_class = ERROR_CLASS_OBJECT; wp_data->error_code = ERROR_CODE_UNKNOWN_OBJECT; } } else { wp_data->error_class = ERROR_CLASS_OBJECT; wp_data->error_code = ERROR_CODE_UNKNOWN_OBJECT; } return (status); } /** * @brief AddListElement from an object list property * @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. */ int Device_Add_List_Element(BACNET_LIST_ELEMENT_DATA *list_element) { int status = BACNET_STATUS_ERROR; struct object_functions *pObject = NULL; pObject = Device_Object_Functions_Find(list_element->object_type); if (pObject != NULL) { if (pObject->Object_Valid_Instance && pObject->Object_Valid_Instance(list_element->object_instance)) { if (pObject->Object_Add_List_Element) { status = pObject->Object_Add_List_Element(list_element); } else { list_element->error_class = ERROR_CLASS_PROPERTY; list_element->error_code = ERROR_CODE_WRITE_ACCESS_DENIED; } } else { list_element->error_class = ERROR_CLASS_OBJECT; list_element->error_code = ERROR_CODE_UNKNOWN_OBJECT; } } else { list_element->error_class = ERROR_CLASS_OBJECT; list_element->error_code = ERROR_CODE_UNKNOWN_OBJECT; } return status; } /** * @brief RemoveListElement from an object list property * @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. */ int Device_Remove_List_Element(BACNET_LIST_ELEMENT_DATA *list_element) { int status = BACNET_STATUS_ERROR; struct object_functions *pObject = NULL; pObject = Device_Object_Functions_Find(list_element->object_type); if (pObject != NULL) { if (pObject->Object_Valid_Instance && pObject->Object_Valid_Instance(list_element->object_instance)) { if (pObject->Object_Remove_List_Element) { status = pObject->Object_Remove_List_Element(list_element); } else { list_element->error_class = ERROR_CLASS_PROPERTY; list_element->error_code = ERROR_CODE_WRITE_ACCESS_DENIED; } } else { list_element->error_class = ERROR_CLASS_OBJECT; list_element->error_code = ERROR_CODE_UNKNOWN_OBJECT; } } else { list_element->error_class = ERROR_CLASS_OBJECT; list_element->error_code = ERROR_CODE_UNKNOWN_OBJECT; } return status; } /** Looks up the requested Object, and fills the Property Value list. * If the Object or Property can't be found, returns false. * @ingroup ObjHelpers * @param [in] The object type to be looked up. * @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 value changed. */ bool Device_Encode_Value_List( BACNET_OBJECT_TYPE object_type, uint32_t object_instance, BACNET_PROPERTY_VALUE *value_list) { bool status = false; /* Ever the pessamist! */ struct object_functions *pObject = NULL; pObject = Device_Object_Functions_Find(object_type); if (pObject != NULL) { if (pObject->Object_Valid_Instance && pObject->Object_Valid_Instance(object_instance)) { if (pObject->Object_Value_List) { status = pObject->Object_Value_List(object_instance, value_list); } } } return (status); } /** Checks the COV flag in the requested Object * @ingroup ObjHelpers * @param [in] The object type to be looked up. * @param [in] The object instance to be looked up. * @return True if the COV flag is set */ bool Device_COV(BACNET_OBJECT_TYPE object_type, uint32_t object_instance) { bool status = false; /* Ever the pessamist! */ struct object_functions *pObject = NULL; pObject = Device_Object_Functions_Find(object_type); if (pObject != NULL) { if (pObject->Object_Valid_Instance && pObject->Object_Valid_Instance(object_instance)) { if (pObject->Object_COV) { status = pObject->Object_COV(object_instance); } } } return (status); } /** Clears the COV flag in the requested Object * @ingroup ObjHelpers * @param [in] The object type to be looked up. * @param [in] The object instance to be looked up. */ void Device_COV_Clear(BACNET_OBJECT_TYPE object_type, uint32_t object_instance) { struct object_functions *pObject = NULL; pObject = Device_Object_Functions_Find(object_type); if (pObject != NULL) { if (pObject->Object_Valid_Instance && pObject->Object_Valid_Instance(object_instance)) { if (pObject->Object_COV_Clear) { pObject->Object_COV_Clear(object_instance); } } } } /** * @brief Creates a child object, if supported * @ingroup ObjHelpers * @param data - CreateObject data, including error codes if failures * @return true if object has been created */ bool Device_Create_Object(BACNET_CREATE_OBJECT_DATA *data) { bool status = false; struct object_functions *pObject = NULL; bool object_exists = false; bool object_supported = false; pObject = Device_Object_Functions_Find(data->object_type); if (pObject != NULL) { if (pObject->Object_Valid_Instance && pObject->Object_Valid_Instance(data->object_instance)) { object_exists = true; } object_supported = true; status = create_object_process( data, object_supported, object_exists, pObject->Object_Create, pObject->Object_Delete, pObject->Object_Write_Property); } else { /* fill in the error values */ status = create_object_process( data, object_supported, object_exists, NULL, NULL, NULL); } if (status) { Device_Inc_Database_Revision(); } return status; } /** * @brief Deletes a child object, if supported * @ingroup ObjHelpers * @param data - DeleteObject data, including error codes if failures * @return true if object has been deleted */ bool Device_Delete_Object(BACNET_DELETE_OBJECT_DATA *data) { bool status = false; struct object_functions *pObject = NULL; pObject = Device_Object_Functions_Find(data->object_type); if (pObject != NULL) { if (!pObject->Object_Delete) { /* The device supports the object type but does not support the deletion of the object for some reason.*/ data->error_class = ERROR_CLASS_OBJECT; data->error_code = ERROR_CODE_OBJECT_DELETION_NOT_PERMITTED; } else if ( pObject->Object_Valid_Instance && pObject->Object_Valid_Instance(data->object_instance)) { /* The object being deleted must already exist */ status = pObject->Object_Delete(data->object_instance); if (status) { Device_Inc_Database_Revision(); } else { /* The object exists but cannot be deleted. */ data->error_class = ERROR_CLASS_OBJECT; data->error_code = ERROR_CODE_OBJECT_DELETION_NOT_PERMITTED; } } else { /* The object to be deleted does not exist. */ data->error_class = ERROR_CLASS_OBJECT; data->error_code = ERROR_CODE_UNKNOWN_OBJECT; } } else { /* The device does not support the specified object type. */ data->error_class = ERROR_CLASS_OBJECT; data->error_code = ERROR_CODE_UNSUPPORTED_OBJECT_TYPE; } return status; } /** Looks up the requested Object to see if the functionality is supported. * @ingroup ObjHelpers * @param [in] The object type to be looked up. * @return True if the object instance supports this feature. */ bool Device_Value_List_Supported(BACNET_OBJECT_TYPE object_type) { bool status = false; /* Ever the pessamist! */ struct object_functions *pObject = NULL; pObject = Device_Object_Functions_Find(object_type); if (pObject != NULL) { if (pObject->Object_Value_List) { status = true; } } return (status); } /** Initialize the Device Object. Initialize the group of object helper functions for any supported Object. Initialize each of the Device Object child Object instances. * @ingroup ObjIntf * @param object_table [in,out] array of structure with object functions. * Each Child Object must provide some implementation of each of these * functions in order to properly support the default handlers. */ void Device_Init(object_functions_t *object_table) { struct object_functions *pObject = NULL; characterstring_init_ansi(&My_Object_Name, "PiFace"); datetime_init(); if (object_table) { Object_Table = object_table; } else { Object_Table = &My_Object_Table[0]; } pObject = Object_Table; while (pObject->Object_Type < MAX_BACNET_OBJECT_TYPE) { if (pObject->Object_Init) { pObject->Object_Init(); } pObject++; } } bool DeviceGetRRInfo( BACNET_READ_RANGE_DATA *pRequest, /* Info on the request */ RR_PROP_INFO *pInfo) { /* Where to put the response */ bool status = false; /* return value */ switch (pRequest->object_property) { case PROP_VT_CLASSES_SUPPORTED: case PROP_ACTIVE_VT_SESSIONS: case PROP_LIST_OF_SESSION_KEYS: case PROP_TIME_SYNCHRONIZATION_RECIPIENTS: case PROP_MANUAL_SLAVE_ADDRESS_BINDING: case PROP_SLAVE_ADDRESS_BINDING: case PROP_RESTART_NOTIFICATION_RECIPIENTS: case PROP_UTC_TIME_SYNCHRONIZATION_RECIPIENTS: pInfo->RequestTypes = RR_BY_POSITION; pRequest->error_class = ERROR_CLASS_PROPERTY; pRequest->error_code = ERROR_CODE_UNKNOWN_PROPERTY; break; case PROP_DEVICE_ADDRESS_BINDING: pInfo->RequestTypes = RR_BY_POSITION; pInfo->Handler = rr_address_list_encode; status = true; break; case PROP_ACTIVE_COV_SUBSCRIPTIONS: pInfo->RequestTypes = RR_BY_POSITION; pRequest->error_class = ERROR_CLASS_PROPERTY; pRequest->error_code = ERROR_CODE_UNKNOWN_PROPERTY; break; default: pRequest->error_class = ERROR_CLASS_SERVICES; pRequest->error_code = ERROR_CODE_PROPERTY_IS_NOT_A_LIST; break; } return status; } /** * @brief Updates all the object timers with elapsed milliseconds * @param milliseconds - number of milliseconds elapsed */ void Device_Timer(uint16_t milliseconds) { struct object_functions *pObject; unsigned count = 0; uint32_t instance; pObject = Object_Table; while (pObject->Object_Type < MAX_BACNET_OBJECT_TYPE) { if (pObject->Object_Count) { count = pObject->Object_Count(); } while (count) { count--; if ((pObject->Object_Timer) && (pObject->Object_Index_To_Instance)) { instance = pObject->Object_Index_To_Instance(count); pObject->Object_Timer(instance, milliseconds); } } pObject++; } }