diff --git a/bacnet-stack/demo/gateway/Makefile b/bacnet-stack/demo/gateway/Makefile index 3921bba2..3e27558f 100644 --- a/bacnet-stack/demo/gateway/Makefile +++ b/bacnet-stack/demo/gateway/Makefile @@ -25,6 +25,7 @@ SRCS = main.c \ $(BACNET_OBJECT)/channel.c \ $(BACNET_OBJECT)/command.c \ $(BACNET_OBJECT)/csv.c \ + $(BACNET_OBJECT)/iv.c \ $(BACNET_OBJECT)/lc.c \ $(BACNET_OBJECT)/lo.c \ $(BACNET_OBJECT)/lsp.c \ diff --git a/bacnet-stack/demo/object/device.c b/bacnet-stack/demo/object/device.c index 519e1f37..c2aaac07 100644 --- a/bacnet-stack/demo/object/device.c +++ b/bacnet-stack/demo/object/device.c @@ -57,6 +57,7 @@ #include "channel.h" #include "command.h" #include "csv.h" +#include "iv.h" #include "lc.h" #include "lsp.h" #include "ms-input.h" @@ -229,6 +230,21 @@ static object_functions_t My_Object_Table[] = { NULL /* COV */ , NULL /* COV Clear */ , NULL /* Intrinsic Reporting */ }, + {OBJECT_INTEGER_VALUE, + Integer_Value_Init, + Integer_Value_Count, + Integer_Value_Index_To_Instance, + Integer_Value_Valid_Instance, + Integer_Value_Object_Name, + Integer_Value_Read_Property, + Integer_Value_Write_Property, + Integer_Value_Property_Lists, + NULL /* ReadRangeInfo */ , + NULL /* Iterator */ , + NULL /* Value_Lists */ , + NULL /* COV */ , + NULL /* COV Clear */ , + NULL /* Intrinsic Reporting */ }, #if defined(INTRINSIC_REPORTING) {OBJECT_NOTIFICATION_CLASS, Notification_Class_Init, diff --git a/bacnet-stack/demo/object/iv.c b/bacnet-stack/demo/object/iv.c new file mode 100644 index 00000000..440d539c --- /dev/null +++ b/bacnet-stack/demo/object/iv.c @@ -0,0 +1,507 @@ +/** + * @file + * @author Steve Karg + * @date 2014 + * @brief Integer Value objects, customize for your use + * + * @section DESCRIPTION + * + * The Integer Value object is an object with a present-value that + * uses an INTEGER data type. + * + * @section LICENSE + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. + * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY + * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, + * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE + * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ + +#include +#include +#include +#include + +#include "bacdef.h" +#include "bacdcode.h" +#include "bacenum.h" +#include "bacapp.h" +#include "bactext.h" +#include "config.h" /* the custom stuff */ +#include "device.h" +#include "handlers.h" +/* me! */ +#include "iv.h" + +#ifndef MAX_INTEGER_VALUES +#define MAX_INTEGER_VALUES 1 +#endif + +struct integer_object { + bool Out_Of_Service:1; + int32_t Present_Value; + uint16_t Units; +}; +struct integer_object Integer_Value[MAX_INTEGER_VALUES]; + +/* These three arrays are used by the ReadPropertyMultiple handler */ +static const int Integer_Value_Properties_Required[] = { + PROP_OBJECT_IDENTIFIER, + PROP_OBJECT_NAME, + PROP_OBJECT_TYPE, + PROP_PRESENT_VALUE, + PROP_STATUS_FLAGS, + PROP_UNITS, + -1 +}; + +static const int Integer_Value_Properties_Optional[] = { + PROP_OUT_OF_SERVICE, + -1 +}; + +static const int Integer_Value_Properties_Proprietary[] = { + -1 +}; + +/** + * Returns the list of required, optional, and proprietary properties. + * Used by ReadPropertyMultiple service. + * + * @param pRequired - pointer to list of int terminated by -1, of + * BACnet required properties for this object. + * @param pOptional - pointer to list of int terminated by -1, of + * BACnet optkional properties for this object. + * @param pProprietary - pointer to list of int terminated by -1, of + * BACnet proprietary properties for this object. + */ +void Integer_Value_Property_Lists( + const int **pRequired, + const int **pOptional, + const int **pProprietary) +{ + if (pRequired) + *pRequired = Integer_Value_Properties_Required; + if (pOptional) + *pOptional = Integer_Value_Properties_Optional; + if (pProprietary) + *pProprietary = Integer_Value_Properties_Proprietary; + + return; +} + +/** + * Determines if a given Analog Value instance is valid + * + * @param object_instance - object-instance number of the object + * + * @return true if the instance is valid, and false if not + */ +bool Integer_Value_Valid_Instance( + uint32_t object_instance) +{ + unsigned int index; + + index = Integer_Value_Instance_To_Index(object_instance); + if (index < MAX_INTEGER_VALUES) { + return true; + } + + return false; +} + +/** + * Determines the number of Analog Value objects + * + * @return Number of Analog Value objects + */ +unsigned Integer_Value_Count( + void) +{ + return MAX_INTEGER_VALUES; +} + +/** + * Determines the object instance-number for a given 0..N index + * of Analog Value objects where N is Integer_Value_Count(). + * + * @param index - 0..MAX_INTEGER_VALUES value + * + * @return object instance-number for the given index + */ +uint32_t Integer_Value_Index_To_Instance( + unsigned index) +{ + uint32_t instance = 1; + + instance += index; + + return instance; +} + +/** + * For a given object instance-number, determines a 0..N index + * of Analog Value objects where N is Integer_Value_Count(). + * + * @param object_instance - object-instance number of the object + * + * @return index for the given instance-number, or MAX_INTEGER_VALUES + * if not valid. + */ +unsigned Integer_Value_Instance_To_Index( + uint32_t object_instance) +{ + unsigned index = MAX_INTEGER_VALUES; + + if (object_instance) { + index = object_instance - 1; + if (index > MAX_INTEGER_VALUES) { + index = MAX_INTEGER_VALUES; + } + } + + return index; +} + +/** + * For a given object instance-number, determines the present-value + * + * @param object_instance - object-instance number of the object + * + * @return present-value of the object + */ +int32_t Integer_Value_Present_Value( + uint32_t object_instance) +{ + int32_t value = 0; + unsigned int index; + + index = Integer_Value_Instance_To_Index(object_instance); + if (index < MAX_INTEGER_VALUES) { + value = Integer_Value[index].Present_Value; + } + + return value; +} + +/** + * For a given object instance-number, sets the present-value + * + * @param object_instance - object-instance number of the object + * @param value - integer value + * + * @return true if values are within range and present-value is set. + */ +bool Integer_Value_Present_Value_Set( + uint32_t object_instance, + int32_t value, + uint8_t priority) +{ + bool status = false; + unsigned int index; + + (void)priority; + index = Integer_Value_Instance_To_Index(object_instance); + if (index < MAX_INTEGER_VALUES) { + Integer_Value[index].Present_Value = value; + status = true; + } + + return status; +} + +/** + * For a given object instance-number, loads the object-name into + * a characterstring. Note that the object name must be unique + * within this device. + * + * @param object_instance - object-instance number of the object + * @param object_name - holds the object-name retrieved + * + * @return true if object-name was retrieved + */ +bool Integer_Value_Object_Name( + uint32_t object_instance, + BACNET_CHARACTER_STRING * object_name) +{ + char text_string[32] = ""; + unsigned int index; + bool status = false; + + index = Integer_Value_Instance_To_Index(object_instance); + if (index < MAX_INTEGER_VALUES) { + sprintf(text_string, "ANALOG VALUE %lu", (unsigned long) object_instance); + status = characterstring_init_ansi(object_name, text_string); + } + + return status; +} + +/** + * For a given object instance-number, returns the units property value + * + * @param object_instance - object-instance number of the object + * + * @return units property value + */ +uint16_t Integer_Value_Units( + uint32_t instance) +{ + unsigned int index; + uint16_t units = UNITS_NO_UNITS; + + index = Integer_Value_Instance_To_Index(instance); + if (index < MAX_INTEGER_VALUES) { + units = Integer_Value[index].Units; + } + + return units; +} + +/** + * For a given object instance-number, sets the units property value + * + * @param object_instance - object-instance number of the object + * @param units - units property value + * + * @return true if the units property value was set + */ +bool Integer_Value_Units_Set( + uint32_t instance, + uint16_t units) +{ + unsigned int index = 0; + bool status = false; + + index = Integer_Value_Instance_To_Index(instance); + if (index < MAX_INTEGER_VALUES) { + Integer_Value[index].Units = units; + status = true; + } + + return status; +} + +/** + * For a given object instance-number, returns the out-of-service + * property value + * + * @param object_instance - object-instance number of the object + * + * @return out-of-service property value + */ +bool Integer_Value_Out_Of_Service( + uint32_t instance) +{ + unsigned int index = 0; + bool value = false; + + index = Integer_Value_Instance_To_Index(instance); + if (index < MAX_INTEGER_VALUES) { + value= Integer_Value[index].Out_Of_Service; + } + + return value; +} + +/** + * For a given object instance-number, sets the out-of-service property value + * + * @param object_instance - object-instance number of the object + * @param value - boolean out-of-service value + * + * @return true if the out-of-service property value was set + */ +void Integer_Value_Out_Of_Service_Set( + uint32_t instance, + bool value) +{ + unsigned int index = 0; + + index = Integer_Value_Instance_To_Index(instance); + if (index < MAX_INTEGER_VALUES) { + Integer_Value[index].Out_Of_Service = value; + } +} + +/** + * ReadProperty handler for this object. For the given ReadProperty + * data, the application_data is loaded or the error flags are set. + * + * @param rpdata - BACNET_READ_PROPERTY_DATA data, including + * requested data and space for the reply, or error response. + * + * @return number of APDU bytes in the response, or + * BACNET_STATUS_ERROR on error. + */ +int Integer_Value_Read_Property( + BACNET_READ_PROPERTY_DATA * rpdata) +{ + int apdu_len = 0; /* return value */ + BACNET_BIT_STRING bit_string; + BACNET_CHARACTER_STRING char_string; + uint8_t *apdu = NULL; + uint32_t units = 0; + int32_t integer_value = 0.0; + bool state = false; + + if ((rpdata == NULL) || (rpdata->application_data == NULL) || + (rpdata->application_data_len == 0)) { + return 0; + } + + apdu = rpdata->application_data; + switch (rpdata->object_property) { + case PROP_OBJECT_IDENTIFIER: + apdu_len = + encode_application_object_id(&apdu[0], OBJECT_INTEGER_VALUE, + rpdata->object_instance); + break; + case PROP_OBJECT_NAME: + Integer_Value_Object_Name(rpdata->object_instance, &char_string); + apdu_len = + encode_application_character_string(&apdu[0], &char_string); + break; + case PROP_OBJECT_TYPE: + apdu_len = + encode_application_enumerated(&apdu[0], OBJECT_INTEGER_VALUE); + break; + case PROP_PRESENT_VALUE: + integer_value = Integer_Value_Present_Value(rpdata->object_instance); + apdu_len = encode_application_signed(&apdu[0], integer_value); + break; + case PROP_STATUS_FLAGS: + bitstring_init(&bit_string); + bitstring_set_bit(&bit_string, STATUS_FLAG_IN_ALARM, false); + bitstring_set_bit(&bit_string, STATUS_FLAG_FAULT, false); + bitstring_set_bit(&bit_string, STATUS_FLAG_OVERRIDDEN, false); + state = Integer_Value_Out_Of_Service(rpdata->object_instance); + bitstring_set_bit(&bit_string, STATUS_FLAG_OUT_OF_SERVICE, state); + apdu_len = encode_application_bitstring(&apdu[0], &bit_string); + break; + case PROP_OUT_OF_SERVICE: + state = Integer_Value_Out_Of_Service(rpdata->object_instance); + apdu_len = encode_application_boolean(&apdu[0], state); + break; + case PROP_UNITS: + units = Integer_Value_Units(rpdata->object_instance); + apdu_len = encode_application_enumerated(&apdu[0], units); + break; + default: + rpdata->error_class = ERROR_CLASS_PROPERTY; + rpdata->error_code = ERROR_CODE_UNKNOWN_PROPERTY; + apdu_len = BACNET_STATUS_ERROR; + break; + } + /* only array properties can have array options */ + if ((apdu_len >= 0) && (rpdata->object_property != PROP_PRIORITY_ARRAY) && + (rpdata->object_property != PROP_EVENT_TIME_STAMPS) && + (rpdata->array_index != BACNET_ARRAY_ALL)) { + rpdata->error_class = ERROR_CLASS_PROPERTY; + rpdata->error_code = ERROR_CODE_PROPERTY_IS_NOT_AN_ARRAY; + apdu_len = BACNET_STATUS_ERROR; + } + + return apdu_len; +} + +/** + * WriteProperty handler for this object. For the given WriteProperty + * data, the application_data is loaded or the error flags are set. + * + * @param wp_data - BACNET_WRITE_PROPERTY_DATA data, including + * requested data and space for the reply, or error response. + * + * @return false if an error is loaded, true if no errors + */ +bool Integer_Value_Write_Property( + BACNET_WRITE_PROPERTY_DATA * wp_data) +{ + bool status = false; /* return value */ + int len = 0; + BACNET_APPLICATION_DATA_VALUE value; + + /* decode the some of the request */ + len = + bacapp_decode_application_data(wp_data->application_data, + wp_data->application_data_len, &value); + /* FIXME: len < application_data_len: more data? */ + 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; + } + if ((wp_data->object_property != PROP_PRIORITY_ARRAY) && + (wp_data->object_property != PROP_EVENT_TIME_STAMPS) && + (wp_data->array_index != BACNET_ARRAY_ALL)) { + /* only array properties can have array options */ + wp_data->error_class = ERROR_CLASS_PROPERTY; + wp_data->error_code = ERROR_CODE_PROPERTY_IS_NOT_AN_ARRAY; + return false; + } + switch (wp_data->object_property) { + case PROP_PRESENT_VALUE: + status = + WPValidateArgType(&value, BACNET_APPLICATION_TAG_SIGNED_INT, + &wp_data->error_class, &wp_data->error_code); + if (status) { + Integer_Value_Present_Value_Set(wp_data->object_instance, + value.type.Signed_Int, wp_data->priority); + } + break; + case PROP_OUT_OF_SERVICE: + status = + WPValidateArgType(&value, BACNET_APPLICATION_TAG_BOOLEAN, + &wp_data->error_class, &wp_data->error_code); + if (status) { + Integer_Value_Out_Of_Service_Set( + wp_data->object_instance, + value.type.Boolean); + } + break; + case PROP_OBJECT_IDENTIFIER: + case PROP_OBJECT_NAME: + case PROP_OBJECT_TYPE: + case PROP_STATUS_FLAGS: + case PROP_UNITS: + 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; +} + +/** + * Initializes the Integer Value object data + */ +void Integer_Value_Init( + void) +{ + unsigned index = 0; + + for (index = 0; index < MAX_INTEGER_VALUES; index++) { + Integer_Value[index].Present_Value = 0; + Integer_Value[index].Out_Of_Service = false; + Integer_Value[index].Units = UNITS_NO_UNITS; + } +} diff --git a/bacnet-stack/demo/object/iv.h b/bacnet-stack/demo/object/iv.h new file mode 100644 index 00000000..85cba2d1 --- /dev/null +++ b/bacnet-stack/demo/object/iv.h @@ -0,0 +1,120 @@ +/** + * @file + * @author Steve Karg + * @date 2014 + * @brief Integer Value objects, customize for your use + * + * @section DESCRIPTION + * + * The Integer Value object is an object with a present-value that + * uses an INTEGER data type. + * + * @section LICENSE + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. + * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY + * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, + * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE + * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +#ifndef IV_H +#define IV_H + +#include +#include +#include "bacdef.h" +#include "bacerror.h" +#include "wp.h" +#include "rp.h" + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + + void Integer_Value_Property_Lists( + const int **pRequired, + const int **pOptional, + const int **pProprietary); + bool Integer_Value_Valid_Instance( + uint32_t object_instance); + unsigned Integer_Value_Count( + void); + uint32_t Integer_Value_Index_To_Instance( + unsigned index); + unsigned Integer_Value_Instance_To_Index( + uint32_t object_instance); + + bool Integer_Value_Object_Name( + uint32_t object_instance, + BACNET_CHARACTER_STRING * object_name); + + int Integer_Value_Read_Property( + BACNET_READ_PROPERTY_DATA * rpdata); + + bool Integer_Value_Write_Property( + BACNET_WRITE_PROPERTY_DATA * wp_data); + + bool Integer_Value_Present_Value_Set( + uint32_t object_instance, + int32_t value, + uint8_t priority); + int32_t Integer_Value_Present_Value( + uint32_t object_instance); + + bool Integer_Value_Change_Of_Value( + uint32_t instance); + void Integer_Value_Change_Of_Value_Clear( + uint32_t instance); + bool Integer_Value_Encode_Value_List( + uint32_t object_instance, + BACNET_PROPERTY_VALUE * value_list); + float Integer_Value_COV_Increment( + uint32_t instance); + void Integer_Value_COV_Increment_Set( + uint32_t instance, + float value); + + char *Integer_Value_Description( + uint32_t instance); + bool Integer_Value_Description_Set( + uint32_t instance, + char *new_name); + + uint16_t Integer_Value_Units( + uint32_t instance); + bool Integer_Value_Units_Set( + uint32_t instance, + uint16_t unit); + + bool Integer_Value_Out_Of_Service( + uint32_t instance); + void Integer_Value_Out_Of_Service_Set( + uint32_t instance, + bool oos_flag); + + void Integer_Value_Init( + void); + +#ifdef TEST +#include "ctest.h" + void testInteger_Value( + Test * pTest); +#endif + +#ifdef __cplusplus +} +#endif /* __cplusplus */ +#endif diff --git a/bacnet-stack/demo/server/Makefile b/bacnet-stack/demo/server/Makefile index 26361ed7..1821d680 100644 --- a/bacnet-stack/demo/server/Makefile +++ b/bacnet-stack/demo/server/Makefile @@ -22,6 +22,7 @@ OBJECT_SRC = \ $(BACNET_OBJECT)/channel.c \ $(BACNET_OBJECT)/command.c \ $(BACNET_OBJECT)/csv.c \ + $(BACNET_OBJECT)/iv.c \ $(BACNET_OBJECT)/lc.c \ $(BACNET_OBJECT)/lo.c \ $(BACNET_OBJECT)/lsp.c \ diff --git a/bacnet-stack/src/proplist.c b/bacnet-stack/src/proplist.c index 3f684a38..a544e859 100644 --- a/bacnet-stack/src/proplist.c +++ b/bacnet-stack/src/proplist.c @@ -787,6 +787,49 @@ static const int File_Properties_Optional[] = { -1 }; +/* These three arrays are used by the ReadPropertyMultiple handler */ +static const int Integer_Value_Properties_Required[] = { + PROP_OBJECT_IDENTIFIER, + PROP_OBJECT_NAME, + PROP_OBJECT_TYPE, + PROP_PRESENT_VALUE, + PROP_STATUS_FLAGS, + PROP_UNITS, + -1 +}; + +static const int Integer_Value_Properties_Optional[] = { + PROP_DESCRIPTION, + PROP_EVENT_STATE, + PROP_RELIABILITY, + PROP_OUT_OF_SERVICE, + PROP_PRIORITY_ARRAY, + PROP_RELINQUISH_DEFAULT, + PROP_COV_INCREMENT, + PROP_TIME_DELAY, + PROP_NOTIFICATION_CLASS, + PROP_HIGH_LIMIT, + PROP_LOW_LIMIT, + PROP_DEADBAND, + PROP_LIMIT_ENABLE, + PROP_EVENT_ENABLE, + PROP_ACKED_TRANSITIONS, + PROP_NOTIFY_TYPE, + PROP_EVENT_TIME_STAMPS, + PROP_EVENT_MESSAGE_TEXTS, + PROP_EVENT_MESSAGE_TEXTS_CONFIG, + PROP_EVENT_DETECTION_ENABLE, + PROP_EVENT_ALGORITHM_INHIBIT_REF, + PROP_EVENT_ALGORITHM_INHIBIT, + PROP_TIME_DELAY_NORMAL, + PROP_RELIABILITY_EVALUATION_INHIBIT, + PROP_MIN_PRES_VALUE, + PROP_MAX_PRES_VALUE, + PROP_RESOLUTION, + PROP_PROFILE_NAME, + -1 +}; + /** * Function that returns the number of BACnet object properties in a list * @@ -895,6 +938,9 @@ const int * property_list_optional( case OBJECT_FILE: pList = File_Properties_Optional; break; + case OBJECT_INTEGER_VALUE: + pList = Integer_Value_Properties_Optional; + break; default: break; } @@ -989,6 +1035,9 @@ const int * property_list_required( case OBJECT_FILE: pList = File_Properties_Required; break; + case OBJECT_INTEGER_VALUE: + pList = Integer_Value_Properties_Required; + break; default: pList = Default_Properties_Required; break;