mirror of
				https://github.com/stargieg/bacnet-stack
				synced 2025-10-26 23:35:52 +08:00 
			
		
		
		
	
		
			
				
	
	
		
			283 lines
		
	
	
		
			9.0 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			283 lines
		
	
	
		
			9.0 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /**************************************************************************
 | |
| *
 | |
| * Copyright (C) 2006 Steve Karg <skarg@users.sourceforge.net>
 | |
| *
 | |
| * 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.
 | |
| *
 | |
| *********************************************************************/
 | |
| 
 | |
| /* Analog Value Objects - customize for your use */
 | |
| 
 | |
| #include <stdbool.h>
 | |
| #include <stdint.h>
 | |
| #include "hardware.h"
 | |
| #include "bacdef.h"
 | |
| #include "bacdcode.h"
 | |
| #include "bacenum.h"
 | |
| #include "bacapp.h"
 | |
| #include "config.h"     /* the custom stuff */
 | |
| #include "wp.h"
 | |
| #include "av.h"
 | |
| 
 | |
| #if (MAX_ANALOG_VALUES > 10)
 | |
| #error Modify the Analog_Value_Name to handle multiple digits
 | |
| #endif
 | |
| 
 | |
| float AV_Present_Value[MAX_ANALOG_VALUES];
 | |
| 
 | |
| /* we simply have 0-n object instances.  Yours might be */
 | |
| /* more complex, and then you need validate that the */
 | |
| /* given instance exists */
 | |
| bool Analog_Value_Valid_Instance(
 | |
|     uint32_t object_instance)
 | |
| {
 | |
|     if (object_instance < MAX_ANALOG_VALUES)
 | |
|         return true;
 | |
| 
 | |
|     return false;
 | |
| }
 | |
| 
 | |
| /* we simply have 0-n object instances.  Yours might be */
 | |
| /* more complex, and then count how many you have */
 | |
| unsigned Analog_Value_Count(
 | |
|     void)
 | |
| {
 | |
|     return MAX_ANALOG_VALUES;
 | |
| }
 | |
| 
 | |
| /* we simply have 0-n object instances.  Yours might be */
 | |
| /* more complex, and then you need to return the instance */
 | |
| /* that correlates to the correct index */
 | |
| uint32_t Analog_Value_Index_To_Instance(
 | |
|     unsigned index)
 | |
| {
 | |
|     return index;
 | |
| }
 | |
| 
 | |
| /* we simply have 0-n object instances.  Yours might be */
 | |
| /* more complex, and then you need to return the index */
 | |
| /* that correlates to the correct instance number */
 | |
| unsigned Analog_Value_Instance_To_Index(
 | |
|     uint32_t object_instance)
 | |
| {
 | |
|     return object_instance;
 | |
| }
 | |
| 
 | |
| /* note: the object name must be unique within this device */
 | |
| char *Analog_Value_Name(
 | |
|     uint32_t object_instance)
 | |
| {
 | |
|     static char text_string[5] = "AV-"; /* okay for single thread */
 | |
| 
 | |
|     text_string[3] = '0' + (uint8_t) object_instance;
 | |
| 
 | |
|     return text_string;
 | |
| }
 | |
| 
 | |
| /* return apdu len, or -1 on error */
 | |
| int Analog_Value_Encode_Property_APDU(
 | |
|     uint8_t * apdu,
 | |
|     uint32_t object_instance,
 | |
|     BACNET_PROPERTY_ID property,
 | |
|     uint32_t array_index,
 | |
|     BACNET_ERROR_CLASS * error_class,
 | |
|     BACNET_ERROR_CODE * error_code)
 | |
| {
 | |
|     int apdu_len = 0;   /* return value */
 | |
|     BACNET_BIT_STRING bit_string;
 | |
|     BACNET_CHARACTER_STRING char_string;
 | |
|     unsigned object_index;
 | |
| 
 | |
|     switch (property) {
 | |
|         case PROP_OBJECT_IDENTIFIER:
 | |
|             apdu_len =
 | |
|                 encode_application_object_id(&apdu[0], OBJECT_ANALOG_VALUE,
 | |
|                 object_instance);
 | |
|             break;
 | |
|         case PROP_OBJECT_NAME:
 | |
|             characterstring_init_ansi(&char_string,
 | |
|                 Analog_Value_Name(object_instance));
 | |
|             apdu_len =
 | |
|                 encode_application_character_string(&apdu[0], &char_string);
 | |
|             break;
 | |
|         case PROP_OBJECT_TYPE:
 | |
|             apdu_len =
 | |
|                 encode_application_enumerated(&apdu[0], OBJECT_ANALOG_VALUE);
 | |
|             break;
 | |
|         case PROP_PRESENT_VALUE:
 | |
|             object_index = Analog_Value_Instance_To_Index(object_instance);
 | |
|             apdu_len =
 | |
|                 encode_application_real(&apdu[0],
 | |
|                 AV_Present_Value[object_index]);
 | |
|             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);
 | |
|             bitstring_set_bit(&bit_string, STATUS_FLAG_OUT_OF_SERVICE, false);
 | |
|             apdu_len = encode_application_bitstring(&apdu[0], &bit_string);
 | |
|             break;
 | |
|         case PROP_EVENT_STATE:
 | |
|             apdu_len =
 | |
|                 encode_application_enumerated(&apdu[0], EVENT_STATE_NORMAL);
 | |
|             break;
 | |
|         case PROP_OUT_OF_SERVICE:
 | |
|             apdu_len = encode_application_boolean(&apdu[0], false);
 | |
|             break;
 | |
|         case PROP_UNITS:
 | |
|             apdu_len = encode_application_enumerated(&apdu[0], UNITS_PERCENT);
 | |
|             break;
 | |
|         default:
 | |
|             *error_class = ERROR_CLASS_PROPERTY;
 | |
|             *error_code = ERROR_CODE_UNKNOWN_PROPERTY;
 | |
|             apdu_len = -1;
 | |
|             break;
 | |
|     }
 | |
|     /*  only array properties can have array options */
 | |
|     if ((apdu_len >= 0) && (array_index != BACNET_ARRAY_ALL)) {
 | |
|         *error_class = ERROR_CLASS_PROPERTY;
 | |
|         *error_code = ERROR_CODE_PROPERTY_IS_NOT_AN_ARRAY;
 | |
|         apdu_len = -1;
 | |
|     }
 | |
| 
 | |
|     return apdu_len;
 | |
| }
 | |
| 
 | |
| /* returns true if successful */
 | |
| bool Analog_Value_Write_Property(
 | |
|     BACNET_WRITE_PROPERTY_DATA * wp_data,
 | |
|     BACNET_ERROR_CLASS * error_class,
 | |
|     BACNET_ERROR_CODE * error_code)
 | |
| {
 | |
|     bool status = false;        /* return value */
 | |
|     unsigned int object_index = 0;
 | |
|     int len = 0;
 | |
|     BACNET_APPLICATION_DATA_VALUE value;
 | |
| 
 | |
|     if (!Analog_Value_Valid_Instance(wp_data->object_instance)) {
 | |
|         *error_class = ERROR_CLASS_OBJECT;
 | |
|         *error_code = ERROR_CODE_UNKNOWN_OBJECT;
 | |
|         return false;
 | |
|     }
 | |
|     /* 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 */
 | |
|         *error_class = ERROR_CLASS_PROPERTY;
 | |
|         *error_code = ERROR_CODE_VALUE_OUT_OF_RANGE;
 | |
|         return false;
 | |
|     }
 | |
|     if ((wp_data->object_property != PROP_PRIORITY_ARRAY) &&
 | |
|         (wp_data->array_index != BACNET_ARRAY_ALL)) {
 | |
|         /*  only array properties can have array options */
 | |
|         *error_class = ERROR_CLASS_PROPERTY;
 | |
|         *error_code = ERROR_CODE_PROPERTY_IS_NOT_AN_ARRAY;
 | |
|         return false;
 | |
|     }
 | |
|     switch (wp_data->object_property) {
 | |
|         case PROP_PRESENT_VALUE:
 | |
|             if (value.tag == BACNET_APPLICATION_TAG_REAL) {
 | |
|                 object_index =
 | |
|                     Analog_Value_Instance_To_Index(wp_data->object_instance);
 | |
|                 AV_Present_Value[object_index] = value.type.Real;
 | |
|                 status = true;
 | |
|             } else {
 | |
|                 *error_class = ERROR_CLASS_PROPERTY;
 | |
|                 *error_code = ERROR_CODE_INVALID_DATA_TYPE;
 | |
|             }
 | |
|             break;
 | |
|         case PROP_OBJECT_IDENTIFIER:
 | |
|         case PROP_OBJECT_NAME:
 | |
|         case PROP_OBJECT_TYPE:
 | |
|         case PROP_STATUS_FLAGS:
 | |
|         case PROP_EVENT_STATE:
 | |
|         case PROP_OUT_OF_SERVICE:
 | |
|         case PROP_DESCRIPTION:
 | |
|         case PROP_PRIORITY_ARRAY:
 | |
|             *error_class = ERROR_CLASS_PROPERTY;
 | |
|             *error_code = ERROR_CODE_WRITE_ACCESS_DENIED;
 | |
|             break;
 | |
|         default:
 | |
|             *error_class = ERROR_CLASS_PROPERTY;
 | |
|             *error_code = ERROR_CODE_UNKNOWN_PROPERTY;
 | |
|             break;
 | |
|     }
 | |
| 
 | |
|     return status;
 | |
| }
 | |
| 
 | |
| #ifdef TEST
 | |
| #include <assert.h>
 | |
| #include <string.h>
 | |
| #include "ctest.h"
 | |
| 
 | |
| void testAnalog_Value(
 | |
|     Test * pTest)
 | |
| {
 | |
|     uint8_t apdu[MAX_APDU] = { 0 };
 | |
|     int len = 0;
 | |
|     uint32_t len_value = 0;
 | |
|     uint8_t tag_number = 0;
 | |
|     BACNET_OBJECT_TYPE decoded_type = OBJECT_ANALOG_VALUE;
 | |
|     uint32_t decoded_instance = 0;
 | |
|     uint32_t instance = 123;
 | |
|     BACNET_ERROR_CLASS error_class;
 | |
|     BACNET_ERROR_CODE error_code;
 | |
| 
 | |
|     len =
 | |
|         Analog_Value_Encode_Property_APDU(&apdu[0], instance,
 | |
|         PROP_OBJECT_IDENTIFIER, BACNET_ARRAY_ALL, &error_class, &error_code);
 | |
|     ct_test(pTest, len != 0);
 | |
|     len = decode_tag_number_and_value(&apdu[0], &tag_number, &len_value);
 | |
|     ct_test(pTest, tag_number == BACNET_APPLICATION_TAG_OBJECT_ID);
 | |
|     len =
 | |
|         decode_object_id(&apdu[len], (int *) &decoded_type, &decoded_instance);
 | |
|     ct_test(pTest, decoded_type == OBJECT_ANALOG_VALUE);
 | |
|     ct_test(pTest, decoded_instance == instance);
 | |
| 
 | |
|     return;
 | |
| }
 | |
| 
 | |
| #ifdef TEST_ANALOG_VALUE
 | |
| int main(
 | |
|     void)
 | |
| {
 | |
|     Test *pTest;
 | |
|     bool rc;
 | |
| 
 | |
|     pTest = ct_create("BACnet Analog Value", NULL);
 | |
|     /* individual tests */
 | |
|     rc = ct_addTestFunction(pTest, testAnalog_Value);
 | |
|     assert(rc);
 | |
| 
 | |
|     ct_setStream(pTest, stdout);
 | |
|     ct_run(pTest);
 | |
|     (void) ct_report(pTest);
 | |
|     ct_destroy(pTest);
 | |
| 
 | |
|     return 0;
 | |
| }
 | |
| #endif /* TEST_ANALOG_VALUE */
 | |
| #endif /* TEST */
 | 
