/************************************************************************** * * Copyright (C) 2005 Steve Karg * Copyright (C) 2011 Krzysztof Malorny * * 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 Input Objects customize for your use */ #include #include #include #include "bacdef.h" #include "bacdcode.h" #include "bacenum.h" #include "bactext.h" #include "config.h" /* the custom stuff */ #include "device.h" #include "handlers.h" #include "proplist.h" #include "timestamp.h" #include "ai.h" #ifndef MAX_ANALOG_INPUTS #define MAX_ANALOG_INPUTS 4 #endif ANALOG_INPUT_DESCR AI_Descr[MAX_ANALOG_INPUTS]; /* These arrays are used by the ReadPropertyMultiple handler */ static const int Analog_Input_Properties_Required[] = { PROP_OBJECT_IDENTIFIER, PROP_OBJECT_NAME, PROP_OBJECT_TYPE, PROP_PRESENT_VALUE, PROP_STATUS_FLAGS, PROP_EVENT_STATE, PROP_OUT_OF_SERVICE, PROP_UNITS, -1 }; static const int Analog_Input_Properties_Optional[] = { PROP_DESCRIPTION, PROP_RELIABILITY, PROP_COV_INCREMENT, #if defined(INTRINSIC_REPORTING) 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, #endif -1 }; static const int Analog_Input_Properties_Proprietary[] = { 9997, 9998, 9999, -1 }; void Analog_Input_Property_Lists( const int **pRequired, const int **pOptional, const int **pProprietary) { if (pRequired) *pRequired = Analog_Input_Properties_Required; if (pOptional) *pOptional = Analog_Input_Properties_Optional; if (pProprietary) *pProprietary = Analog_Input_Properties_Proprietary; return; } void Analog_Input_Init( void) { unsigned i; #if defined(INTRINSIC_REPORTING) unsigned j; #endif for (i = 0; i < MAX_ANALOG_INPUTS; i++) { AI_Descr[i].Present_Value = 0.0f; AI_Descr[i].Out_Of_Service = false; AI_Descr[i].Units = UNITS_PERCENT; AI_Descr[i].Reliability = RELIABILITY_NO_FAULT_DETECTED; AI_Descr[i].Prior_Value = 0.0f; AI_Descr[i].COV_Increment = 1.0f; AI_Descr[i].Changed = false; #if defined(INTRINSIC_REPORTING) AI_Descr[i].Event_State = EVENT_STATE_NORMAL; /* notification class not connected */ AI_Descr[i].Notification_Class = BACNET_MAX_INSTANCE; /* initialize Event time stamps using wildcards and set Acked_transitions */ for (j = 0; j < MAX_BACNET_EVENT_TRANSITION; j++) { datetime_wildcard_set(&AI_Descr[i].Event_Time_Stamps[j]); AI_Descr[i].Acked_Transitions[j].bIsAcked = true; } /* Set handler for GetEventInformation function */ handler_get_event_information_set(OBJECT_ANALOG_INPUT, Analog_Input_Event_Information); /* Set handler for AcknowledgeAlarm function */ handler_alarm_ack_set(OBJECT_ANALOG_INPUT, Analog_Input_Alarm_Ack); /* Set handler for GetAlarmSummary Service */ handler_get_alarm_summary_set(OBJECT_ANALOG_INPUT, Analog_Input_Alarm_Summary); #endif } } /* we simply have 0-n object instances. Yours might be */ /* more complex, and then you need validate that the */ /* given instance exists */ bool Analog_Input_Valid_Instance( uint32_t object_instance) { unsigned int index; index = Analog_Input_Instance_To_Index(object_instance); if (index < MAX_ANALOG_INPUTS) 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_Input_Count( void) { return MAX_ANALOG_INPUTS; } /* 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_Input_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_Input_Instance_To_Index( uint32_t object_instance) { unsigned index = MAX_ANALOG_INPUTS; if (object_instance < MAX_ANALOG_INPUTS) index = object_instance; return index; } float Analog_Input_Present_Value( uint32_t object_instance) { float value = 0.0; unsigned int index; index = Analog_Input_Instance_To_Index(object_instance); if (index < MAX_ANALOG_INPUTS) { value = AI_Descr[index].Present_Value; } return value; } static void Analog_Input_COV_Detect(unsigned int index, float value) { float prior_value = 0.0; float cov_increment = 0.0; float cov_delta = 0.0; if (index < MAX_ANALOG_INPUTS) { prior_value = AI_Descr[index].Prior_Value; cov_increment = AI_Descr[index].COV_Increment; if (prior_value > value) { cov_delta = prior_value - value; } else { cov_delta = value - prior_value; } if (cov_delta >= cov_increment) { AI_Descr[index].Changed = true; AI_Descr[index].Prior_Value = value; } } } void Analog_Input_Present_Value_Set( uint32_t object_instance, float value) { unsigned int index = 0; index = Analog_Input_Instance_To_Index(object_instance); if (index < MAX_ANALOG_INPUTS) { Analog_Input_COV_Detect(index, value); AI_Descr[index].Present_Value = value; } } bool Analog_Input_Object_Name( uint32_t object_instance, BACNET_CHARACTER_STRING * object_name) { static char text_string[32] = ""; /* okay for single thread */ unsigned int index; bool status = false; index = Analog_Input_Instance_To_Index(object_instance); if (index < MAX_ANALOG_INPUTS) { sprintf(text_string, "ANALOG INPUT %lu", (unsigned long) index); status = characterstring_init_ansi(object_name, text_string); } return status; } bool Analog_Input_Change_Of_Value( uint32_t object_instance) { unsigned index = 0; bool changed = false; index = Analog_Input_Instance_To_Index(object_instance); if (index < MAX_ANALOG_INPUTS) { changed = AI_Descr[index].Changed; } return changed; } void Analog_Input_Change_Of_Value_Clear( uint32_t object_instance) { unsigned index = 0; index = Analog_Input_Instance_To_Index(object_instance); if (index < MAX_ANALOG_INPUTS) { AI_Descr[index].Changed = false; } } /* returns true if value has changed */ bool Analog_Input_Encode_Value_List( uint32_t object_instance, BACNET_PROPERTY_VALUE * value_list) { bool status = false; if (value_list) { value_list->propertyIdentifier = PROP_PRESENT_VALUE; value_list->propertyArrayIndex = BACNET_ARRAY_ALL; value_list->value.context_specific = false; value_list->value.tag = BACNET_APPLICATION_TAG_REAL; value_list->value.type.Real = Analog_Input_Present_Value(object_instance); value_list->value.next = NULL; value_list->priority = BACNET_NO_PRIORITY; value_list = value_list->next; } if (value_list) { value_list->propertyIdentifier = PROP_STATUS_FLAGS; value_list->propertyArrayIndex = BACNET_ARRAY_ALL; value_list->value.context_specific = false; value_list->value.tag = BACNET_APPLICATION_TAG_BIT_STRING; bitstring_init(&value_list->value.type.Bit_String); bitstring_set_bit(&value_list->value.type.Bit_String, STATUS_FLAG_IN_ALARM, false); bitstring_set_bit(&value_list->value.type.Bit_String, STATUS_FLAG_FAULT, false); bitstring_set_bit(&value_list->value.type.Bit_String, STATUS_FLAG_OVERRIDDEN, false); if (Analog_Input_Out_Of_Service(object_instance)) { bitstring_set_bit(&value_list->value.type.Bit_String, STATUS_FLAG_OUT_OF_SERVICE, true); } else { bitstring_set_bit(&value_list->value.type.Bit_String, STATUS_FLAG_OUT_OF_SERVICE, false); } value_list->value.next = NULL; value_list->priority = BACNET_NO_PRIORITY; value_list->next = NULL; } status = Analog_Input_Change_Of_Value(object_instance); return status; } float Analog_Input_COV_Increment( uint32_t object_instance) { unsigned index = 0; float value = 0; index = Analog_Input_Instance_To_Index(object_instance); if (index < MAX_ANALOG_INPUTS) { value = AI_Descr[index].COV_Increment; } return value; } void Analog_Input_COV_Increment_Set( uint32_t object_instance, float value) { unsigned index = 0; index = Analog_Input_Instance_To_Index(object_instance); if (index < MAX_ANALOG_INPUTS) { AI_Descr[index].COV_Increment = value; Analog_Input_COV_Detect(index, AI_Descr[index].Present_Value); } } bool Analog_Input_Out_Of_Service( uint32_t object_instance) { unsigned index = 0; bool value = false; index = Analog_Input_Instance_To_Index(object_instance); if (index < MAX_ANALOG_INPUTS) { value = AI_Descr[index].Out_Of_Service; } return value; } void Analog_Input_Out_Of_Service_Set( uint32_t object_instance, bool value) { unsigned index = 0; index = Analog_Input_Instance_To_Index(object_instance); if (index < MAX_ANALOG_INPUTS) { AI_Descr[index].Out_Of_Service = value; } } /* return apdu length, or BACNET_STATUS_ERROR on error */ /* assumption - object has already exists */ int Analog_Input_Read_Property( BACNET_READ_PROPERTY_DATA * rpdata) { int apdu_len = 0; /* return value */ BACNET_BIT_STRING bit_string; BACNET_CHARACTER_STRING char_string; ANALOG_INPUT_DESCR *CurrentAI; unsigned object_index = 0; #if defined(INTRINSIC_REPORTING) unsigned i = 0; int len = 0; #endif uint8_t *apdu = NULL; if ((rpdata == NULL) || (rpdata->application_data == NULL) || (rpdata->application_data_len == 0)) { return 0; } object_index = Analog_Input_Instance_To_Index(rpdata->object_instance); if (object_index < MAX_ANALOG_INPUTS) CurrentAI = &AI_Descr[object_index]; else return BACNET_STATUS_ERROR; apdu = rpdata->application_data; switch ((int) rpdata->object_property) { case PROP_OBJECT_IDENTIFIER: apdu_len = encode_application_object_id(&apdu[0], OBJECT_ANALOG_INPUT, rpdata->object_instance); break; case PROP_OBJECT_NAME: case PROP_DESCRIPTION: Analog_Input_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_ANALOG_INPUT); break; case PROP_PRESENT_VALUE: apdu_len = encode_application_real(&apdu[0], Analog_Input_Present_Value(rpdata->object_instance)); break; case PROP_STATUS_FLAGS: bitstring_init(&bit_string); #if defined(INTRINSIC_REPORTING) bitstring_set_bit(&bit_string, STATUS_FLAG_IN_ALARM, CurrentAI->Event_State ? true : false); #else bitstring_set_bit(&bit_string, STATUS_FLAG_IN_ALARM, false); #endif 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, CurrentAI->Out_Of_Service); apdu_len = encode_application_bitstring(&apdu[0], &bit_string); break; case PROP_EVENT_STATE: #if defined(INTRINSIC_REPORTING) apdu_len = encode_application_enumerated(&apdu[0], CurrentAI->Event_State); #else apdu_len = encode_application_enumerated(&apdu[0], EVENT_STATE_NORMAL); #endif break; case PROP_RELIABILITY: apdu_len = encode_application_enumerated(&apdu[0], CurrentAI->Reliability); break; case PROP_OUT_OF_SERVICE: apdu_len = encode_application_boolean(&apdu[0], CurrentAI->Out_Of_Service); break; case PROP_UNITS: apdu_len = encode_application_enumerated(&apdu[0], CurrentAI->Units); break; case PROP_COV_INCREMENT: apdu_len = encode_application_real(&apdu[0], CurrentAI->COV_Increment); break; #if defined(INTRINSIC_REPORTING) case PROP_TIME_DELAY: apdu_len = encode_application_unsigned(&apdu[0], CurrentAI->Time_Delay); break; case PROP_NOTIFICATION_CLASS: apdu_len = encode_application_unsigned(&apdu[0], CurrentAI->Notification_Class); break; case PROP_HIGH_LIMIT: apdu_len = encode_application_real(&apdu[0], CurrentAI->High_Limit); break; case PROP_LOW_LIMIT: apdu_len = encode_application_real(&apdu[0], CurrentAI->Low_Limit); break; case PROP_DEADBAND: apdu_len = encode_application_real(&apdu[0], CurrentAI->Deadband); break; case PROP_LIMIT_ENABLE: bitstring_init(&bit_string); bitstring_set_bit(&bit_string, 0, (CurrentAI-> Limit_Enable & EVENT_LOW_LIMIT_ENABLE) ? true : false); bitstring_set_bit(&bit_string, 1, (CurrentAI-> Limit_Enable & EVENT_HIGH_LIMIT_ENABLE) ? true : false); apdu_len = encode_application_bitstring(&apdu[0], &bit_string); break; case PROP_EVENT_ENABLE: bitstring_init(&bit_string); bitstring_set_bit(&bit_string, TRANSITION_TO_OFFNORMAL, (CurrentAI-> Event_Enable & EVENT_ENABLE_TO_OFFNORMAL) ? true : false); bitstring_set_bit(&bit_string, TRANSITION_TO_FAULT, (CurrentAI-> Event_Enable & EVENT_ENABLE_TO_FAULT) ? true : false); bitstring_set_bit(&bit_string, TRANSITION_TO_NORMAL, (CurrentAI-> Event_Enable & EVENT_ENABLE_TO_NORMAL) ? true : false); apdu_len = encode_application_bitstring(&apdu[0], &bit_string); break; case PROP_ACKED_TRANSITIONS: bitstring_init(&bit_string); bitstring_set_bit(&bit_string, TRANSITION_TO_OFFNORMAL, CurrentAI->Acked_Transitions[TRANSITION_TO_OFFNORMAL]. bIsAcked); bitstring_set_bit(&bit_string, TRANSITION_TO_FAULT, CurrentAI->Acked_Transitions[TRANSITION_TO_FAULT].bIsAcked); bitstring_set_bit(&bit_string, TRANSITION_TO_NORMAL, CurrentAI->Acked_Transitions[TRANSITION_TO_NORMAL].bIsAcked); apdu_len = encode_application_bitstring(&apdu[0], &bit_string); break; case PROP_NOTIFY_TYPE: apdu_len = encode_application_enumerated(&apdu[0], CurrentAI->Notify_Type ? NOTIFY_EVENT : NOTIFY_ALARM); break; case PROP_EVENT_TIME_STAMPS: /* Array element zero is the number of elements in the array */ if (rpdata->array_index == 0) apdu_len = encode_application_unsigned(&apdu[0], MAX_BACNET_EVENT_TRANSITION); /* if no index was specified, then try to encode the entire list */ /* into one packet. */ else if (rpdata->array_index == BACNET_ARRAY_ALL) { for (i = 0; i < MAX_BACNET_EVENT_TRANSITION; i++) {; len = encode_opening_tag(&apdu[apdu_len], TIME_STAMP_DATETIME); len += encode_application_date(&apdu[apdu_len + len], &CurrentAI->Event_Time_Stamps[i].date); len += encode_application_time(&apdu[apdu_len + len], &CurrentAI->Event_Time_Stamps[i].time); len += encode_closing_tag(&apdu[apdu_len + len], TIME_STAMP_DATETIME); /* add it if we have room */ if ((apdu_len + len) < MAX_APDU) apdu_len += len; else { rpdata->error_class = ERROR_CLASS_SERVICES; rpdata->error_code = ERROR_CODE_NO_SPACE_FOR_OBJECT; apdu_len = BACNET_STATUS_ERROR; break; } } } else if (rpdata->array_index <= MAX_BACNET_EVENT_TRANSITION) { apdu_len = encode_opening_tag(&apdu[apdu_len], TIME_STAMP_DATETIME); apdu_len += encode_application_date(&apdu[apdu_len], &CurrentAI->Event_Time_Stamps[rpdata->array_index].date); apdu_len += encode_application_time(&apdu[apdu_len], &CurrentAI->Event_Time_Stamps[rpdata->array_index].time); apdu_len += encode_closing_tag(&apdu[apdu_len], TIME_STAMP_DATETIME); } else { rpdata->error_class = ERROR_CLASS_PROPERTY; rpdata->error_code = ERROR_CODE_INVALID_ARRAY_INDEX; apdu_len = BACNET_STATUS_ERROR; } break; #endif case 9997: /* test case for real encoding-decoding unsigned value correctly */ apdu_len = encode_application_real(&apdu[0], 90.510F); break; case 9998: /* test case for unsigned encoding-decoding unsigned value correctly */ apdu_len = encode_application_unsigned(&apdu[0], 90); break; case 9999: /* test case for signed encoding-decoding negative value correctly */ apdu_len = encode_application_signed(&apdu[0], -200); 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_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; } /* returns true if successful */ bool Analog_Input_Write_Property( BACNET_WRITE_PROPERTY_DATA * wp_data) { bool status = false; /* return value */ unsigned int object_index = 0; int len = 0; BACNET_APPLICATION_DATA_VALUE value; ANALOG_INPUT_DESCR *CurrentAI; /* 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; } /* only array properties can have array options */ if ((wp_data->object_property != PROP_EVENT_TIME_STAMPS) && (wp_data->array_index != BACNET_ARRAY_ALL)) { wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_PROPERTY_IS_NOT_AN_ARRAY; return false; } object_index = Analog_Input_Instance_To_Index(wp_data->object_instance); if (object_index < MAX_ANALOG_INPUTS) { CurrentAI = &AI_Descr[object_index]; } else { return false; } switch ((int) wp_data->object_property) { case PROP_PRESENT_VALUE: status = WPValidateArgType(&value, BACNET_APPLICATION_TAG_REAL, &wp_data->error_class, &wp_data->error_code); if (status) { if (CurrentAI->Out_Of_Service == true) { Analog_Input_Present_Value_Set(wp_data->object_instance, value.type.Real); } else { wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_WRITE_ACCESS_DENIED; status = false; } } break; case PROP_OUT_OF_SERVICE: status = WPValidateArgType(&value, BACNET_APPLICATION_TAG_BOOLEAN, &wp_data->error_class, &wp_data->error_code); if (status) { Analog_Input_Out_Of_Service_Set( wp_data->object_instance, value.type.Boolean); } break; case PROP_UNITS: status = WPValidateArgType(&value, BACNET_APPLICATION_TAG_ENUMERATED, &wp_data->error_class, &wp_data->error_code); if (status) { CurrentAI->Units = value.type.Enumerated; } break; case PROP_COV_INCREMENT: status = WPValidateArgType(&value, BACNET_APPLICATION_TAG_REAL, &wp_data->error_class, &wp_data->error_code); if (status) { if (value.type.Real >= 0.0) { Analog_Input_COV_Increment_Set( wp_data->object_instance, value.type.Real); } else { status = false; wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE; } } break; #if defined(INTRINSIC_REPORTING) case PROP_TIME_DELAY: status = WPValidateArgType(&value, BACNET_APPLICATION_TAG_UNSIGNED_INT, &wp_data->error_class, &wp_data->error_code); if (status) { CurrentAI->Time_Delay = value.type.Unsigned_Int; CurrentAI->Remaining_Time_Delay = CurrentAI->Time_Delay; } break; case PROP_NOTIFICATION_CLASS: status = WPValidateArgType(&value, BACNET_APPLICATION_TAG_UNSIGNED_INT, &wp_data->error_class, &wp_data->error_code); if (status) { CurrentAI->Notification_Class = value.type.Unsigned_Int; } break; case PROP_HIGH_LIMIT: status = WPValidateArgType(&value, BACNET_APPLICATION_TAG_REAL, &wp_data->error_class, &wp_data->error_code); if (status) { CurrentAI->High_Limit = value.type.Real; } break; case PROP_LOW_LIMIT: status = WPValidateArgType(&value, BACNET_APPLICATION_TAG_REAL, &wp_data->error_class, &wp_data->error_code); if (status) { CurrentAI->Low_Limit = value.type.Real; } break; case PROP_DEADBAND: status = WPValidateArgType(&value, BACNET_APPLICATION_TAG_REAL, &wp_data->error_class, &wp_data->error_code); if (status) { CurrentAI->Deadband = value.type.Real; } break; case PROP_LIMIT_ENABLE: status = WPValidateArgType(&value, BACNET_APPLICATION_TAG_BIT_STRING, &wp_data->error_class, &wp_data->error_code); if (status) { if (value.type.Bit_String.bits_used == 2) { CurrentAI->Limit_Enable = value.type.Bit_String.value[0]; } else { wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE; status = false; } } break; case PROP_EVENT_ENABLE: status = WPValidateArgType(&value, BACNET_APPLICATION_TAG_BIT_STRING, &wp_data->error_class, &wp_data->error_code); if (status) { if (value.type.Bit_String.bits_used == 3) { CurrentAI->Event_Enable = value.type.Bit_String.value[0]; } else { wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE; status = false; } } break; case PROP_NOTIFY_TYPE: status = WPValidateArgType(&value, BACNET_APPLICATION_TAG_ENUMERATED, &wp_data->error_class, &wp_data->error_code); if (status) { switch ((BACNET_NOTIFY_TYPE) value.type.Enumerated) { case NOTIFY_EVENT: CurrentAI->Notify_Type = 1; break; case NOTIFY_ALARM: CurrentAI->Notify_Type = 0; break; default: wp_data->error_class = ERROR_CLASS_PROPERTY; wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE; status = false; break; } } break; #endif case PROP_OBJECT_IDENTIFIER: case PROP_OBJECT_NAME: case PROP_OBJECT_TYPE: case PROP_STATUS_FLAGS: case PROP_EVENT_STATE: case PROP_DESCRIPTION: case PROP_RELIABILITY: #if defined(INTRINSIC_REPORTING) case PROP_ACKED_TRANSITIONS: case PROP_EVENT_TIME_STAMPS: #endif case 9997: case 9998: case 9999: 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; } void Analog_Input_Intrinsic_Reporting( uint32_t object_instance) { #if defined(INTRINSIC_REPORTING) BACNET_EVENT_NOTIFICATION_DATA event_data; BACNET_CHARACTER_STRING msgText; ANALOG_INPUT_DESCR *CurrentAI; unsigned int object_index; uint8_t FromState = 0; uint8_t ToState; float ExceededLimit = 0.0f; float PresentVal = 0.0f; bool SendNotify = false; object_index = Analog_Input_Instance_To_Index(object_instance); if (object_index < MAX_ANALOG_INPUTS) CurrentAI = &AI_Descr[object_index]; else return; /* check limits */ if (!CurrentAI->Limit_Enable) return; /* limits are not configured */ if (CurrentAI->Ack_notify_data.bSendAckNotify) { /* clean bSendAckNotify flag */ CurrentAI->Ack_notify_data.bSendAckNotify = false; /* copy toState */ ToState = CurrentAI->Ack_notify_data.EventState; #if PRINT_ENABLED fprintf(stderr, "Send Acknotification for (%s,%d).\n", bactext_object_type_name(OBJECT_ANALOG_INPUT), object_instance); #endif /* PRINT_ENABLED */ characterstring_init_ansi(&msgText, "AckNotification"); /* Notify Type */ event_data.notifyType = NOTIFY_ACK_NOTIFICATION; /* Send EventNotification. */ SendNotify = true; } else { /* actual Present_Value */ PresentVal = Analog_Input_Present_Value(object_instance); FromState = CurrentAI->Event_State; switch (CurrentAI->Event_State) { case EVENT_STATE_NORMAL: /* A TO-OFFNORMAL event is generated under these conditions: (a) the Present_Value must exceed the High_Limit for a minimum period of time, specified in the Time_Delay property, and (b) the HighLimitEnable flag must be set in the Limit_Enable property, and (c) the TO-OFFNORMAL flag must be set in the Event_Enable property. */ if ((PresentVal > CurrentAI->High_Limit) && ((CurrentAI->Limit_Enable & EVENT_HIGH_LIMIT_ENABLE) == EVENT_HIGH_LIMIT_ENABLE) && ((CurrentAI->Event_Enable & EVENT_ENABLE_TO_OFFNORMAL) == EVENT_ENABLE_TO_OFFNORMAL)) { if (!CurrentAI->Remaining_Time_Delay) CurrentAI->Event_State = EVENT_STATE_HIGH_LIMIT; else CurrentAI->Remaining_Time_Delay--; break; } /* A TO-OFFNORMAL event is generated under these conditions: (a) the Present_Value must exceed the Low_Limit plus the Deadband for a minimum period of time, specified in the Time_Delay property, and (b) the LowLimitEnable flag must be set in the Limit_Enable property, and (c) the TO-NORMAL flag must be set in the Event_Enable property. */ if ((PresentVal < CurrentAI->Low_Limit) && ((CurrentAI->Limit_Enable & EVENT_LOW_LIMIT_ENABLE) == EVENT_LOW_LIMIT_ENABLE) && ((CurrentAI->Event_Enable & EVENT_ENABLE_TO_OFFNORMAL) == EVENT_ENABLE_TO_OFFNORMAL)) { if (!CurrentAI->Remaining_Time_Delay) CurrentAI->Event_State = EVENT_STATE_LOW_LIMIT; else CurrentAI->Remaining_Time_Delay--; break; } /* value of the object is still in the same event state */ CurrentAI->Remaining_Time_Delay = CurrentAI->Time_Delay; break; case EVENT_STATE_HIGH_LIMIT: /* Once exceeded, the Present_Value must fall below the High_Limit minus the Deadband before a TO-NORMAL event is generated under these conditions: (a) the Present_Value must fall below the High_Limit minus the Deadband for a minimum period of time, specified in the Time_Delay property, and (b) the HighLimitEnable flag must be set in the Limit_Enable property, and (c) the TO-NORMAL flag must be set in the Event_Enable property. */ if ((PresentVal < CurrentAI->High_Limit - CurrentAI->Deadband) && ((CurrentAI->Limit_Enable & EVENT_HIGH_LIMIT_ENABLE) == EVENT_HIGH_LIMIT_ENABLE) && ((CurrentAI->Event_Enable & EVENT_ENABLE_TO_NORMAL) == EVENT_ENABLE_TO_NORMAL)) { if (!CurrentAI->Remaining_Time_Delay) CurrentAI->Event_State = EVENT_STATE_NORMAL; else CurrentAI->Remaining_Time_Delay--; break; } /* value of the object is still in the same event state */ CurrentAI->Remaining_Time_Delay = CurrentAI->Time_Delay; break; case EVENT_STATE_LOW_LIMIT: /* Once the Present_Value has fallen below the Low_Limit, the Present_Value must exceed the Low_Limit plus the Deadband before a TO-NORMAL event is generated under these conditions: (a) the Present_Value must exceed the Low_Limit plus the Deadband for a minimum period of time, specified in the Time_Delay property, and (b) the LowLimitEnable flag must be set in the Limit_Enable property, and (c) the TO-NORMAL flag must be set in the Event_Enable property. */ if ((PresentVal > CurrentAI->Low_Limit + CurrentAI->Deadband) && ((CurrentAI->Limit_Enable & EVENT_LOW_LIMIT_ENABLE) == EVENT_LOW_LIMIT_ENABLE) && ((CurrentAI->Event_Enable & EVENT_ENABLE_TO_NORMAL) == EVENT_ENABLE_TO_NORMAL)) { if (!CurrentAI->Remaining_Time_Delay) CurrentAI->Event_State = EVENT_STATE_NORMAL; else CurrentAI->Remaining_Time_Delay--; break; } /* value of the object is still in the same event state */ CurrentAI->Remaining_Time_Delay = CurrentAI->Time_Delay; break; default: return; /* shouldn't happen */ } /* switch (FromState) */ ToState = CurrentAI->Event_State; if (FromState != ToState) { /* Event_State has changed. Need to fill only the basic parameters of this type of event. Other parameters will be filled in common function. */ switch (ToState) { case EVENT_STATE_HIGH_LIMIT: ExceededLimit = CurrentAI->High_Limit; characterstring_init_ansi(&msgText, "Goes to high limit"); break; case EVENT_STATE_LOW_LIMIT: ExceededLimit = CurrentAI->Low_Limit; characterstring_init_ansi(&msgText, "Goes to low limit"); break; case EVENT_STATE_NORMAL: if (FromState == EVENT_STATE_HIGH_LIMIT) { ExceededLimit = CurrentAI->High_Limit; characterstring_init_ansi(&msgText, "Back to normal state from high limit"); } else { ExceededLimit = CurrentAI->Low_Limit; characterstring_init_ansi(&msgText, "Back to normal state from low limit"); } break; default: ExceededLimit = 0; break; } /* switch (ToState) */ #if PRINT_ENABLED fprintf(stderr, "Event_State for (%s,%d) goes from %s to %s.\n", bactext_object_type_name(OBJECT_ANALOG_INPUT), object_instance, bactext_event_state_name(FromState), bactext_event_state_name(ToState)); #endif /* PRINT_ENABLED */ /* Notify Type */ event_data.notifyType = CurrentAI->Notify_Type; /* Send EventNotification. */ SendNotify = true; } } if (SendNotify) { /* Event Object Identifier */ event_data.eventObjectIdentifier.type = OBJECT_ANALOG_INPUT; event_data.eventObjectIdentifier.instance = object_instance; /* Time Stamp */ event_data.timeStamp.tag = TIME_STAMP_DATETIME; Device_getCurrentDateTime(&event_data.timeStamp.value.dateTime); if (event_data.notifyType != NOTIFY_ACK_NOTIFICATION) { /* fill Event_Time_Stamps */ switch (ToState) { case EVENT_STATE_HIGH_LIMIT: case EVENT_STATE_LOW_LIMIT: CurrentAI->Event_Time_Stamps[TRANSITION_TO_OFFNORMAL] = event_data.timeStamp.value.dateTime; break; case EVENT_STATE_FAULT: CurrentAI->Event_Time_Stamps[TRANSITION_TO_FAULT] = event_data.timeStamp.value.dateTime; break; case EVENT_STATE_NORMAL: CurrentAI->Event_Time_Stamps[TRANSITION_TO_NORMAL] = event_data.timeStamp.value.dateTime; break; } } /* Notification Class */ event_data.notificationClass = CurrentAI->Notification_Class; /* Event Type */ event_data.eventType = EVENT_OUT_OF_RANGE; /* Message Text */ event_data.messageText = &msgText; /* Notify Type */ /* filled before */ /* From State */ if (event_data.notifyType != NOTIFY_ACK_NOTIFICATION) event_data.fromState = FromState; /* To State */ event_data.toState = CurrentAI->Event_State; /* Event Values */ if (event_data.notifyType != NOTIFY_ACK_NOTIFICATION) { /* Value that exceeded a limit. */ event_data.notificationParams.outOfRange.exceedingValue = PresentVal; /* Status_Flags of the referenced object. */ bitstring_init(&event_data.notificationParams.outOfRange. statusFlags); bitstring_set_bit(&event_data.notificationParams.outOfRange. statusFlags, STATUS_FLAG_IN_ALARM, CurrentAI->Event_State ? true : false); bitstring_set_bit(&event_data.notificationParams.outOfRange. statusFlags, STATUS_FLAG_FAULT, false); bitstring_set_bit(&event_data.notificationParams.outOfRange. statusFlags, STATUS_FLAG_OVERRIDDEN, false); bitstring_set_bit(&event_data.notificationParams.outOfRange. statusFlags, STATUS_FLAG_OUT_OF_SERVICE, CurrentAI->Out_Of_Service); /* Deadband used for limit checking. */ event_data.notificationParams.outOfRange.deadband = CurrentAI->Deadband; /* Limit that was exceeded. */ event_data.notificationParams.outOfRange.exceededLimit = ExceededLimit; } /* add data from notification class */ Notification_Class_common_reporting_function(&event_data); /* Ack required */ if ((event_data.notifyType != NOTIFY_ACK_NOTIFICATION) && (event_data.ackRequired == true)) { switch (event_data.toState) { case EVENT_STATE_OFFNORMAL: case EVENT_STATE_HIGH_LIMIT: case EVENT_STATE_LOW_LIMIT: CurrentAI->Acked_Transitions[TRANSITION_TO_OFFNORMAL]. bIsAcked = false; CurrentAI->Acked_Transitions[TRANSITION_TO_OFFNORMAL]. Time_Stamp = event_data.timeStamp.value.dateTime; break; case EVENT_STATE_FAULT: CurrentAI->Acked_Transitions[TRANSITION_TO_FAULT]. bIsAcked = false; CurrentAI->Acked_Transitions[TRANSITION_TO_FAULT]. Time_Stamp = event_data.timeStamp.value.dateTime; break; case EVENT_STATE_NORMAL: CurrentAI->Acked_Transitions[TRANSITION_TO_NORMAL]. bIsAcked = false; CurrentAI->Acked_Transitions[TRANSITION_TO_NORMAL]. Time_Stamp = event_data.timeStamp.value.dateTime; break; } } } #endif /* defined(INTRINSIC_REPORTING) */ } #if defined(INTRINSIC_REPORTING) int Analog_Input_Event_Information( unsigned index, BACNET_GET_EVENT_INFORMATION_DATA * getevent_data) { bool IsNotAckedTransitions; bool IsActiveEvent; int i; /* check index */ if (index < MAX_ANALOG_INPUTS) { /* Event_State not equal to NORMAL */ IsActiveEvent = (AI_Descr[index].Event_State != EVENT_STATE_NORMAL); /* Acked_Transitions property, which has at least one of the bits (TO-OFFNORMAL, TO-FAULT, TONORMAL) set to FALSE. */ IsNotAckedTransitions = (AI_Descr[index].Acked_Transitions[TRANSITION_TO_OFFNORMAL]. bIsAcked == false) | (AI_Descr[index].Acked_Transitions[TRANSITION_TO_FAULT]. bIsAcked == false) | (AI_Descr[index].Acked_Transitions[TRANSITION_TO_NORMAL]. bIsAcked == false); } else return -1; /* end of list */ if ((IsActiveEvent) || (IsNotAckedTransitions)) { /* Object Identifier */ getevent_data->objectIdentifier.type = OBJECT_ANALOG_INPUT; getevent_data->objectIdentifier.instance = Analog_Input_Index_To_Instance(index); /* Event State */ getevent_data->eventState = AI_Descr[index].Event_State; /* Acknowledged Transitions */ bitstring_init(&getevent_data->acknowledgedTransitions); bitstring_set_bit(&getevent_data->acknowledgedTransitions, TRANSITION_TO_OFFNORMAL, AI_Descr[index].Acked_Transitions[TRANSITION_TO_OFFNORMAL]. bIsAcked); bitstring_set_bit(&getevent_data->acknowledgedTransitions, TRANSITION_TO_FAULT, AI_Descr[index].Acked_Transitions[TRANSITION_TO_FAULT].bIsAcked); bitstring_set_bit(&getevent_data->acknowledgedTransitions, TRANSITION_TO_NORMAL, AI_Descr[index].Acked_Transitions[TRANSITION_TO_NORMAL].bIsAcked); /* Event Time Stamps */ for (i = 0; i < 3; i++) { getevent_data->eventTimeStamps[i].tag = TIME_STAMP_DATETIME; getevent_data->eventTimeStamps[i].value.dateTime = AI_Descr[index].Event_Time_Stamps[i]; } /* Notify Type */ getevent_data->notifyType = AI_Descr[index].Notify_Type; /* Event Enable */ bitstring_init(&getevent_data->eventEnable); bitstring_set_bit(&getevent_data->eventEnable, TRANSITION_TO_OFFNORMAL, (AI_Descr[index]. Event_Enable & EVENT_ENABLE_TO_OFFNORMAL) ? true : false); bitstring_set_bit(&getevent_data->eventEnable, TRANSITION_TO_FAULT, (AI_Descr[index]. Event_Enable & EVENT_ENABLE_TO_FAULT) ? true : false); bitstring_set_bit(&getevent_data->eventEnable, TRANSITION_TO_NORMAL, (AI_Descr[index]. Event_Enable & EVENT_ENABLE_TO_NORMAL) ? true : false); /* Event Priorities */ Notification_Class_Get_Priorities(AI_Descr[index].Notification_Class, getevent_data->eventPriorities); return 1; /* active event */ } else return 0; /* no active event at this index */ } int Analog_Input_Alarm_Ack( BACNET_ALARM_ACK_DATA * alarmack_data, BACNET_ERROR_CODE * error_code) { ANALOG_INPUT_DESCR *CurrentAI; unsigned int object_index; object_index = Analog_Input_Instance_To_Index(alarmack_data->eventObjectIdentifier. instance); if (object_index < MAX_ANALOG_INPUTS) CurrentAI = &AI_Descr[object_index]; else { *error_code = ERROR_CODE_UNKNOWN_OBJECT; return -1; } switch (alarmack_data->eventStateAcked) { case EVENT_STATE_OFFNORMAL: case EVENT_STATE_HIGH_LIMIT: case EVENT_STATE_LOW_LIMIT: if (CurrentAI->Acked_Transitions[TRANSITION_TO_OFFNORMAL]. bIsAcked == false) { if (alarmack_data->eventTimeStamp.tag != TIME_STAMP_DATETIME) { *error_code = ERROR_CODE_INVALID_TIME_STAMP; return -1; } if (datetime_compare(&CurrentAI-> Acked_Transitions[TRANSITION_TO_OFFNORMAL].Time_Stamp, &alarmack_data->eventTimeStamp.value.dateTime) > 0) { *error_code = ERROR_CODE_INVALID_TIME_STAMP; return -1; } /* FIXME: Send ack notification */ CurrentAI->Acked_Transitions[TRANSITION_TO_OFFNORMAL]. bIsAcked = true; } else { *error_code = ERROR_CODE_INVALID_EVENT_STATE; return -1; } break; case EVENT_STATE_FAULT: if (CurrentAI->Acked_Transitions[TRANSITION_TO_FAULT].bIsAcked == false) { if (alarmack_data->eventTimeStamp.tag != TIME_STAMP_DATETIME) { *error_code = ERROR_CODE_INVALID_TIME_STAMP; return -1; } if (datetime_compare(&CurrentAI-> Acked_Transitions[TRANSITION_TO_FAULT].Time_Stamp, &alarmack_data->eventTimeStamp.value.dateTime) > 0) { *error_code = ERROR_CODE_INVALID_TIME_STAMP; return -1; } /* FIXME: Send ack notification */ CurrentAI->Acked_Transitions[TRANSITION_TO_FAULT].bIsAcked = true; } else { *error_code = ERROR_CODE_INVALID_EVENT_STATE; return -1; } break; case EVENT_STATE_NORMAL: if (CurrentAI->Acked_Transitions[TRANSITION_TO_NORMAL].bIsAcked == false) { if (alarmack_data->eventTimeStamp.tag != TIME_STAMP_DATETIME) { *error_code = ERROR_CODE_INVALID_TIME_STAMP; return -1; } if (datetime_compare(&CurrentAI-> Acked_Transitions[TRANSITION_TO_NORMAL].Time_Stamp, &alarmack_data->eventTimeStamp.value.dateTime) > 0) { *error_code = ERROR_CODE_INVALID_TIME_STAMP; return -1; } /* FIXME: Send ack notification */ CurrentAI->Acked_Transitions[TRANSITION_TO_NORMAL].bIsAcked = true; } else { *error_code = ERROR_CODE_INVALID_EVENT_STATE; return -1; } break; default: return -2; } CurrentAI->Ack_notify_data.bSendAckNotify = true; CurrentAI->Ack_notify_data.EventState = alarmack_data->eventStateAcked; return 1; } int Analog_Input_Alarm_Summary( unsigned index, BACNET_GET_ALARM_SUMMARY_DATA * getalarm_data) { /* check index */ if (index < MAX_ANALOG_INPUTS) { /* Event_State is not equal to NORMAL and Notify_Type property value is ALARM */ if ((AI_Descr[index].Event_State != EVENT_STATE_NORMAL) && (AI_Descr[index].Notify_Type == NOTIFY_ALARM)) { /* Object Identifier */ getalarm_data->objectIdentifier.type = OBJECT_ANALOG_INPUT; getalarm_data->objectIdentifier.instance = Analog_Input_Index_To_Instance(index); /* Alarm State */ getalarm_data->alarmState = AI_Descr[index].Event_State; /* Acknowledged Transitions */ bitstring_init(&getalarm_data->acknowledgedTransitions); bitstring_set_bit(&getalarm_data->acknowledgedTransitions, TRANSITION_TO_OFFNORMAL, AI_Descr[index].Acked_Transitions[TRANSITION_TO_OFFNORMAL]. bIsAcked); bitstring_set_bit(&getalarm_data->acknowledgedTransitions, TRANSITION_TO_FAULT, AI_Descr[index]. Acked_Transitions[TRANSITION_TO_FAULT].bIsAcked); bitstring_set_bit(&getalarm_data->acknowledgedTransitions, TRANSITION_TO_NORMAL, AI_Descr[index]. Acked_Transitions[TRANSITION_TO_NORMAL].bIsAcked); return 1; /* active alarm */ } else return 0; /* no active alarm at this index */ } else return -1; /* end of list */ } #endif /* defined(INTRINSIC_REPORTING) */ #ifdef TEST #include #include #include "ctest.h" bool WPValidateArgType( BACNET_APPLICATION_DATA_VALUE * pValue, uint8_t ucExpectedTag, BACNET_ERROR_CLASS * pErrorClass, BACNET_ERROR_CODE * pErrorCode) { bool bResult; /* * start out assuming success and only set up error * response if validation fails. */ bResult = true; if (pValue->tag != ucExpectedTag) { bResult = false; *pErrorClass = ERROR_CLASS_PROPERTY; *pErrorCode = ERROR_CODE_INVALID_DATA_TYPE; } return (bResult); } void testAnalogInput( Test * pTest) { uint8_t apdu[MAX_APDU] = { 0 }; int len = 0; uint32_t len_value = 0; uint8_t tag_number = 0; uint32_t decoded_instance = 0; uint16_t decoded_type = 0; BACNET_READ_PROPERTY_DATA rpdata; Analog_Input_Init(); rpdata.application_data = &apdu[0]; rpdata.application_data_len = sizeof(apdu); rpdata.object_type = OBJECT_ANALOG_INPUT; rpdata.object_instance = 1; rpdata.object_property = PROP_OBJECT_IDENTIFIER; rpdata.array_index = BACNET_ARRAY_ALL; len = Analog_Input_Read_Property(&rpdata); 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], &decoded_type, &decoded_instance); ct_test(pTest, decoded_type == rpdata.object_type); ct_test(pTest, decoded_instance == rpdata.object_instance); return; } #ifdef TEST_ANALOG_INPUT int main( void) { Test *pTest; bool rc; pTest = ct_create("BACnet Analog Input", NULL); /* individual tests */ rc = ct_addTestFunction(pTest, testAnalogInput); assert(rc); ct_setStream(pTest, stdout); ct_run(pTest); (void) ct_report(pTest); ct_destroy(pTest); return 0; } #endif /* TEST_ANALOG_INPUT */ #endif /* TEST */