Fixed basic analog-value object intrinsic reporting and write property (#640)

* Fixed basic analog-value object intrinsic reporting for ack notification.
* Fixed basic analog-value object write property of present-value to priority 6.
This commit is contained in:
Steve Karg
2024-05-14 11:28:28 -05:00
committed by GitHub
parent ec98da5989
commit c21c99fef3
3 changed files with 289 additions and 223 deletions
+115 -87
View File
@@ -30,28 +30,33 @@
/* me! */
#include "bacnet/basic/object/ai.h"
#define PRINTF debug_perror
/* Key List for storing the object data sorted by instance number */
static OS_Keylist Object_List;
/* common object type */
static const BACNET_OBJECT_TYPE Object_Type = OBJECT_ANALOG_INPUT;
/* clang-format off */
/* These three arrays are used by the ReadPropertyMultiple handler */
static const int 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 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 Properties_Optional[] = { PROP_DESCRIPTION, PROP_RELIABILITY,
PROP_COV_INCREMENT,
static const int 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,
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 };
-1
};
static const int Properties_Proprietary[] = { -1 };
static const int Properties_Proprietary[] = {
-1
};
/* clang-format on */
/**
* Initialize the pointers for the required, the optional and the properitary
@@ -180,8 +185,8 @@ float Analog_Input_Present_Value(uint32_t object_instance)
* @param index Object index
* @param value Given present value.
*/
static void Analog_Input_COV_Detect(
struct analog_input_descr *pObject, float value)
static void
Analog_Input_COV_Detect(struct analog_input_descr *pObject, float value)
{
float prior_value = 0.0f;
float cov_increment = 0.0f;
@@ -243,7 +248,8 @@ bool Analog_Input_Object_Name(
status =
characterstring_init_ansi(object_name, pObject->Object_Name);
} else {
snprintf(text_string, sizeof(text_string), "ANALOG INPUT %u",
snprintf(
text_string, sizeof(text_string), "ANALOG INPUT %u",
object_instance);
status = characterstring_init_ansi(object_name, text_string);
}
@@ -340,9 +346,8 @@ bool Analog_Input_Description_Set(uint32_t object_instance, char *new_name)
* @brief For a given object instance-number, returns the reliability
* @param object_instance - object-instance number of the object
* @return reliability property value
*/
BACNET_RELIABILITY Analog_Input_Reliability(
uint32_t object_instance)
*/
BACNET_RELIABILITY Analog_Input_Reliability(uint32_t object_instance)
{
BACNET_RELIABILITY value = RELIABILITY_NO_FAULT_DETECTED;
struct analog_input_descr *pObject;
@@ -362,8 +367,7 @@ BACNET_RELIABILITY Analog_Input_Reliability(
* @return true if the reliability property value was set
*/
bool Analog_Input_Reliability_Set(
uint32_t object_instance,
BACNET_RELIABILITY value)
uint32_t object_instance, BACNET_RELIABILITY value)
{
bool status = false;
struct analog_input_descr *pObject;
@@ -375,7 +379,6 @@ bool Analog_Input_Reliability_Set(
}
return status;
}
/**
@@ -439,8 +442,9 @@ bool Analog_Input_Encode_Value_List(
}
out_of_service = pObject->Out_Of_Service;
present_value = pObject->Present_Value;
status = cov_value_list_encode_real(value_list, present_value, in_alarm,
fault, overridden, out_of_service);
status = cov_value_list_encode_real(
value_list, present_value, in_alarm, fault, overridden,
out_of_service);
}
return status;
@@ -453,7 +457,7 @@ bool Analog_Input_Encode_Value_List(
*/
float Analog_Input_COV_Increment(uint32_t object_instance)
{
float value = 0;
float value = 0.0f;
struct analog_input_descr *pObject;
pObject = Analog_Input_Object(object_instance);
@@ -542,7 +546,8 @@ bool Analog_Input_Out_Of_Service(uint32_t object_instance)
}
/**
* @brief For a given object instance-number, sets the out-of-service property value
* @brief 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
@@ -650,8 +655,7 @@ int Analog_Input_Read_Property(BACNET_READ_PROPERTY_DATA *rpdata)
encode_application_character_string(&apdu[0], &char_string);
break;
case PROP_OBJECT_TYPE:
apdu_len =
encode_application_enumerated(&apdu[0], Object_Type);
apdu_len = encode_application_enumerated(&apdu[0], Object_Type);
break;
case PROP_PRESENT_VALUE:
real_value = Analog_Input_Present_Value(rpdata->object_instance);
@@ -659,12 +663,15 @@ int Analog_Input_Read_Property(BACNET_READ_PROPERTY_DATA *rpdata)
break;
case PROP_STATUS_FLAGS:
bitstring_init(&bit_string);
bitstring_set_bit(&bit_string, STATUS_FLAG_IN_ALARM,
bitstring_set_bit(
&bit_string, STATUS_FLAG_IN_ALARM,
pObject->Event_State != EVENT_STATE_NORMAL);
bitstring_set_bit(&bit_string, STATUS_FLAG_FAULT,
bitstring_set_bit(
&bit_string, STATUS_FLAG_FAULT,
pObject->Reliability != RELIABILITY_NO_FAULT_DETECTED);
bitstring_set_bit(&bit_string, STATUS_FLAG_OVERRIDDEN, false);
bitstring_set_bit(&bit_string, STATUS_FLAG_OUT_OF_SERVICE,
bitstring_set_bit(
&bit_string, STATUS_FLAG_OUT_OF_SERVICE,
pObject->Out_Of_Service);
apdu_len = encode_application_bitstring(&apdu[0], &bit_string);
break;
@@ -684,7 +691,8 @@ int Analog_Input_Read_Property(BACNET_READ_PROPERTY_DATA *rpdata)
apdu_len = encode_application_enumerated(&apdu[0], pObject->Units);
break;
case PROP_DESCRIPTION:
characterstring_init_ansi(&char_string,
characterstring_init_ansi(
&char_string,
Analog_Input_Description(rpdata->object_instance));
apdu_len =
encode_application_character_string(&apdu[0], &char_string);
@@ -713,33 +721,41 @@ int Analog_Input_Read_Property(BACNET_READ_PROPERTY_DATA *rpdata)
break;
case PROP_LIMIT_ENABLE:
bitstring_init(&bit_string);
bitstring_set_bit(&bit_string, 0,
bitstring_set_bit(
&bit_string, 0,
(pObject->Limit_Enable & EVENT_LOW_LIMIT_ENABLE) ? true
: false);
bitstring_set_bit(&bit_string, 1,
bitstring_set_bit(
&bit_string, 1,
(pObject->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,
bitstring_set_bit(
&bit_string, TRANSITION_TO_OFFNORMAL,
(pObject->Event_Enable & EVENT_ENABLE_TO_OFFNORMAL) ? true
: false);
bitstring_set_bit(&bit_string, TRANSITION_TO_FAULT,
bitstring_set_bit(
&bit_string, TRANSITION_TO_FAULT,
(pObject->Event_Enable & EVENT_ENABLE_TO_FAULT) ? true : false);
bitstring_set_bit(&bit_string, TRANSITION_TO_NORMAL,
bitstring_set_bit(
&bit_string, TRANSITION_TO_NORMAL,
(pObject->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,
bitstring_set_bit(
&bit_string, TRANSITION_TO_OFFNORMAL,
pObject->Acked_Transitions[TRANSITION_TO_OFFNORMAL].bIsAcked);
bitstring_set_bit(&bit_string, TRANSITION_TO_FAULT,
bitstring_set_bit(
&bit_string, TRANSITION_TO_FAULT,
pObject->Acked_Transitions[TRANSITION_TO_FAULT].bIsAcked);
bitstring_set_bit(&bit_string, TRANSITION_TO_NORMAL,
bitstring_set_bit(
&bit_string, TRANSITION_TO_NORMAL,
pObject->Acked_Transitions[TRANSITION_TO_NORMAL].bIsAcked);
apdu_len = encode_application_bitstring(&apdu[0], &bit_string);
break;
@@ -748,8 +764,9 @@ int Analog_Input_Read_Property(BACNET_READ_PROPERTY_DATA *rpdata)
&apdu[0], pObject->Notify_Type ? NOTIFY_EVENT : NOTIFY_ALARM);
break;
case PROP_EVENT_TIME_STAMPS:
apdu_len = bacnet_array_encode(rpdata->object_instance,
rpdata->array_index, Analog_Input_Event_Time_Stamps_Encode,
apdu_len = bacnet_array_encode(
rpdata->object_instance, rpdata->array_index,
Analog_Input_Event_Time_Stamps_Encode,
MAX_BACNET_EVENT_TRANSITION, apdu, apdu_size);
if (apdu_len == BACNET_STATUS_ABORT) {
rpdata->error_code =
@@ -948,7 +965,8 @@ bool Analog_Input_Write_Property(BACNET_WRITE_PROPERTY_DATA *wp_data)
break;
#endif
default:
if (property_lists_member(Properties_Required, Properties_Optional,
if (property_lists_member(
Properties_Required, Properties_Optional,
Properties_Proprietary, wp_data->object_property)) {
wp_data->error_class = ERROR_CLASS_PROPERTY;
wp_data->error_code = ERROR_CODE_WRITE_ACCESS_DENIED;
@@ -991,7 +1009,8 @@ void Analog_Input_Intrinsic_Reporting(uint32_t object_instance)
CurrentAI->Ack_notify_data.bSendAckNotify = false;
/* copy toState */
ToState = CurrentAI->Ack_notify_data.EventState;
PRINTF("Analog-Input[%d]: Send AckNotification.\n", object_instance);
debug_printf(
"Analog-Input[%d]: Send AckNotification.\n", object_instance);
characterstring_init_ansi(&msgText, "AckNotification");
/* Notify Type */
event_data.notifyType = NOTIFY_ACK_NOTIFICATION;
@@ -1012,9 +1031,9 @@ void Analog_Input_Intrinsic_Reporting(uint32_t object_instance)
property. */
if ((PresentVal > CurrentAI->High_Limit) &&
((CurrentAI->Limit_Enable & EVENT_HIGH_LIMIT_ENABLE) ==
EVENT_HIGH_LIMIT_ENABLE) &&
EVENT_HIGH_LIMIT_ENABLE) &&
((CurrentAI->Event_Enable & EVENT_ENABLE_TO_OFFNORMAL) ==
EVENT_ENABLE_TO_OFFNORMAL)) {
EVENT_ENABLE_TO_OFFNORMAL)) {
if (!CurrentAI->Remaining_Time_Delay)
CurrentAI->Event_State = EVENT_STATE_HIGH_LIMIT;
else
@@ -1030,9 +1049,9 @@ void Analog_Input_Intrinsic_Reporting(uint32_t object_instance)
property. */
if ((PresentVal < CurrentAI->Low_Limit) &&
((CurrentAI->Limit_Enable & EVENT_LOW_LIMIT_ENABLE) ==
EVENT_LOW_LIMIT_ENABLE) &&
EVENT_LOW_LIMIT_ENABLE) &&
((CurrentAI->Event_Enable & EVENT_ENABLE_TO_OFFNORMAL) ==
EVENT_ENABLE_TO_OFFNORMAL)) {
EVENT_ENABLE_TO_OFFNORMAL)) {
if (!CurrentAI->Remaining_Time_Delay)
CurrentAI->Event_State = EVENT_STATE_LOW_LIMIT;
else
@@ -1052,11 +1071,11 @@ void Analog_Input_Intrinsic_Reporting(uint32_t object_instance)
property, and (c) the TO-NORMAL flag must be set in the
Event_Enable property. */
if ((PresentVal <
CurrentAI->High_Limit - CurrentAI->Deadband) &&
CurrentAI->High_Limit - CurrentAI->Deadband) &&
((CurrentAI->Limit_Enable & EVENT_HIGH_LIMIT_ENABLE) ==
EVENT_HIGH_LIMIT_ENABLE) &&
EVENT_HIGH_LIMIT_ENABLE) &&
((CurrentAI->Event_Enable & EVENT_ENABLE_TO_NORMAL) ==
EVENT_ENABLE_TO_NORMAL)) {
EVENT_ENABLE_TO_NORMAL)) {
if (!CurrentAI->Remaining_Time_Delay)
CurrentAI->Event_State = EVENT_STATE_NORMAL;
else
@@ -1078,9 +1097,9 @@ void Analog_Input_Intrinsic_Reporting(uint32_t object_instance)
property. */
if ((PresentVal > CurrentAI->Low_Limit + CurrentAI->Deadband) &&
((CurrentAI->Limit_Enable & EVENT_LOW_LIMIT_ENABLE) ==
EVENT_LOW_LIMIT_ENABLE) &&
EVENT_LOW_LIMIT_ENABLE) &&
((CurrentAI->Event_Enable & EVENT_ENABLE_TO_NORMAL) ==
EVENT_ENABLE_TO_NORMAL)) {
EVENT_ENABLE_TO_NORMAL)) {
if (!CurrentAI->Remaining_Time_Delay)
CurrentAI->Event_State = EVENT_STATE_NORMAL;
else
@@ -1125,7 +1144,8 @@ void Analog_Input_Intrinsic_Reporting(uint32_t object_instance)
ExceededLimit = 0;
break;
} /* switch (ToState) */
PRINTF("Analog-Input[%d]: Event_State goes from %s to %s.\n",
debug_printf(
"Analog-Input[%d]: Event_State goes from %s to %s.\n",
object_instance, bactext_event_state_name(FromState),
bactext_event_state_name(ToState));
/* Notify Type */
@@ -1142,7 +1162,8 @@ void Analog_Input_Intrinsic_Reporting(uint32_t object_instance)
/* Time Stamp */
event_data.timeStamp.tag = TIME_STAMP_DATETIME;
if (event_data.notifyType != NOTIFY_ACK_NOTIFICATION) {
datetime_local(&event_data.timeStamp.value.dateTime.date,
datetime_local(
&event_data.timeStamp.value.dateTime.date,
&event_data.timeStamp.value.dateTime.time, NULL, NULL);
/* fill Event_Time_Stamps */
switch (ToState) {
@@ -1170,15 +1191,18 @@ void Analog_Input_Intrinsic_Reporting(uint32_t object_instance)
switch (ToState) {
case EVENT_STATE_HIGH_LIMIT:
case EVENT_STATE_LOW_LIMIT:
datetime_copy(&event_data.timeStamp.value.dateTime,
datetime_copy(
&event_data.timeStamp.value.dateTime,
&CurrentAI->Event_Time_Stamps[TRANSITION_TO_OFFNORMAL]);
break;
case EVENT_STATE_FAULT:
datetime_copy(&event_data.timeStamp.value.dateTime,
datetime_copy(
&event_data.timeStamp.value.dateTime,
&CurrentAI->Event_Time_Stamps[TRANSITION_TO_FAULT]);
break;
case EVENT_STATE_NORMAL:
datetime_copy(&event_data.timeStamp.value.dateTime,
datetime_copy(
&event_data.timeStamp.value.dateTime,
&CurrentAI->Event_Time_Stamps[TRANSITION_TO_NORMAL]);
break;
default:
@@ -1227,8 +1251,9 @@ void Analog_Input_Intrinsic_Reporting(uint32_t object_instance)
ExceededLimit;
}
/* add data from notification class */
PRINTF("Analog-Input[%d]: Notification Class[%d]-%s "
"%u/%u/%u-%u:%u:%u.%u!\n",
debug_printf(
"Analog-Input[%d]: Notification Class[%d]-%s "
"%u/%u/%u-%u:%u:%u.%u!\n",
object_instance, event_data.notificationClass,
bactext_event_type_name(event_data.eventType),
(unsigned)event_data.timeStamp.value.dateTime.date.year,
@@ -1242,7 +1267,7 @@ void Analog_Input_Intrinsic_Reporting(uint32_t object_instance)
/* Ack required */
if ((event_data.notifyType != NOTIFY_ACK_NOTIFICATION) &&
(event_data.ackRequired == true)) {
PRINTF("Analog-Input[%d]: Ack Required!\n", object_instance);
debug_printf("Analog-Input[%d]: Ack Required!\n", object_instance);
switch (event_data.toState) {
case EVENT_STATE_OFFNORMAL:
case EVENT_STATE_HIGH_LIMIT:
@@ -1299,14 +1324,14 @@ int Analog_Input_Event_Information(
(TO-OFFNORMAL, TO-FAULT, TONORMAL) set to FALSE. */
IsNotAckedTransitions =
(pObject->Acked_Transitions[TRANSITION_TO_OFFNORMAL].bIsAcked ==
false) |
false) |
(pObject->Acked_Transitions[TRANSITION_TO_FAULT].bIsAcked ==
false) |
false) |
(pObject->Acked_Transitions[TRANSITION_TO_NORMAL].bIsAcked ==
false);
} else
false);
} else {
return -1; /* end of list */
}
if ((IsActiveEvent) || (IsNotAckedTransitions)) {
/* Object Identifier */
getevent_data->objectIdentifier.type = Object_Type;
@@ -1316,14 +1341,14 @@ int Analog_Input_Event_Information(
getevent_data->eventState = pObject->Event_State;
/* Acknowledged Transitions */
bitstring_init(&getevent_data->acknowledgedTransitions);
bitstring_set_bit(&getevent_data->acknowledgedTransitions,
TRANSITION_TO_OFFNORMAL,
bitstring_set_bit(
&getevent_data->acknowledgedTransitions, TRANSITION_TO_OFFNORMAL,
pObject->Acked_Transitions[TRANSITION_TO_OFFNORMAL].bIsAcked);
bitstring_set_bit(&getevent_data->acknowledgedTransitions,
TRANSITION_TO_FAULT,
bitstring_set_bit(
&getevent_data->acknowledgedTransitions, TRANSITION_TO_FAULT,
pObject->Acked_Transitions[TRANSITION_TO_FAULT].bIsAcked);
bitstring_set_bit(&getevent_data->acknowledgedTransitions,
TRANSITION_TO_NORMAL,
bitstring_set_bit(
&getevent_data->acknowledgedTransitions, TRANSITION_TO_NORMAL,
pObject->Acked_Transitions[TRANSITION_TO_NORMAL].bIsAcked);
/* Event Time Stamps */
for (i = 0; i < 3; i++) {
@@ -1335,11 +1360,14 @@ int Analog_Input_Event_Information(
getevent_data->notifyType = pObject->Notify_Type;
/* Event Enable */
bitstring_init(&getevent_data->eventEnable);
bitstring_set_bit(&getevent_data->eventEnable, TRANSITION_TO_OFFNORMAL,
bitstring_set_bit(
&getevent_data->eventEnable, TRANSITION_TO_OFFNORMAL,
(pObject->Event_Enable & EVENT_ENABLE_TO_OFFNORMAL) ? true : false);
bitstring_set_bit(&getevent_data->eventEnable, TRANSITION_TO_FAULT,
bitstring_set_bit(
&getevent_data->eventEnable, TRANSITION_TO_FAULT,
(pObject->Event_Enable & EVENT_ENABLE_TO_FAULT) ? true : false);
bitstring_set_bit(&getevent_data->eventEnable, TRANSITION_TO_NORMAL,
bitstring_set_bit(
&getevent_data->eventEnable, TRANSITION_TO_NORMAL,
(pObject->Event_Enable & EVENT_ENABLE_TO_NORMAL) ? true : false);
/* Event Priorities */
Notification_Class_Get_Priorities(
@@ -1390,8 +1418,8 @@ int Analog_Input_Alarm_Ack(
/* Send ack notification */
CurrentAI->Acked_Transitions[TRANSITION_TO_OFFNORMAL].bIsAcked =
true;
} else if (alarmack_data->eventStateAcked ==
CurrentAI->Event_State) {
} else if (
alarmack_data->eventStateAcked == CurrentAI->Event_State) {
/* Send ack notification */
} else {
*error_code = ERROR_CODE_INVALID_EVENT_STATE;
@@ -1416,8 +1444,8 @@ int Analog_Input_Alarm_Ack(
/* Send ack notification */
CurrentAI->Acked_Transitions[TRANSITION_TO_FAULT].bIsAcked =
true;
} else if (alarmack_data->eventStateAcked ==
CurrentAI->Event_State) {
} else if (
alarmack_data->eventStateAcked == CurrentAI->Event_State) {
/* Send ack notification */
} else {
*error_code = ERROR_CODE_INVALID_EVENT_STATE;
@@ -1442,8 +1470,8 @@ int Analog_Input_Alarm_Ack(
/* Send ack notification */
CurrentAI->Acked_Transitions[TRANSITION_TO_NORMAL].bIsAcked =
true;
} else if (alarmack_data->eventStateAcked ==
CurrentAI->Event_State) {
} else if (
alarmack_data->eventStateAcked == CurrentAI->Event_State) {
/* Send ack notification */
} else {
*error_code = ERROR_CODE_INVALID_EVENT_STATE;
@@ -1487,14 +1515,15 @@ int Analog_Input_Alarm_Summary(
getalarm_data->alarmState = pObject->Event_State;
/* Acknowledged Transitions */
bitstring_init(&getalarm_data->acknowledgedTransitions);
bitstring_set_bit(&getalarm_data->acknowledgedTransitions,
bitstring_set_bit(
&getalarm_data->acknowledgedTransitions,
TRANSITION_TO_OFFNORMAL,
pObject->Acked_Transitions[TRANSITION_TO_OFFNORMAL].bIsAcked);
bitstring_set_bit(&getalarm_data->acknowledgedTransitions,
TRANSITION_TO_FAULT,
bitstring_set_bit(
&getalarm_data->acknowledgedTransitions, TRANSITION_TO_FAULT,
pObject->Acked_Transitions[TRANSITION_TO_FAULT].bIsAcked);
bitstring_set_bit(&getalarm_data->acknowledgedTransitions,
TRANSITION_TO_NORMAL,
bitstring_set_bit(
&getalarm_data->acknowledgedTransitions, TRANSITION_TO_NORMAL,
pObject->Acked_Transitions[TRANSITION_TO_NORMAL].bIsAcked);
return 1; /* active alarm */
} else {
@@ -1620,7 +1649,6 @@ void Analog_Input_Init(void)
/* Set handler for AcknowledgeAlarm function */
handler_alarm_ack_set(Object_Type, Analog_Input_Alarm_Ack);
/* Set handler for GetAlarmSummary Service */
handler_get_alarm_summary_set(
Object_Type, Analog_Input_Alarm_Summary);
handler_get_alarm_summary_set(Object_Type, Analog_Input_Alarm_Summary);
#endif
}