BACnetEd
003073b71e
Co-authored-by: Ed <edward@connect-ex.com> Co-authored-by: Steve Karg <skarg@users.sourceforge.net>
229 lines
6.9 KiB
C
229 lines
6.9 KiB
C
/**
|
|
* @file
|
|
* @brief API for basic BACnet Analog Input Object implementation.
|
|
* @author Steve Karg <skarg@users.sourceforge.net>
|
|
* @author Krzysztof Malorny <malornykrzysztof@gmail.com>
|
|
* @date 2005, 2011
|
|
* @copyright SPDX-License-Identifier: MIT
|
|
*/
|
|
#ifndef BACNET_BASIC_OBJECT_ANALOG_INPUT_H
|
|
#define BACNET_BASIC_OBJECT_ANALOG_INPUT_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
/* BACnet Stack defines - first */
|
|
#include "bacnet/bacdef.h"
|
|
/* BACnet Stack API */
|
|
#include "bacnet/rp.h"
|
|
#include "bacnet/wp.h"
|
|
#if defined(INTRINSIC_REPORTING)
|
|
#include "bacnet/basic/object/nc.h"
|
|
#include "bacnet/getevent.h"
|
|
#include "bacnet/alarm_ack.h"
|
|
#include "bacnet/get_alarm_sum.h"
|
|
#endif
|
|
|
|
typedef struct analog_input_descr {
|
|
unsigned Event_State : 3;
|
|
float Present_Value;
|
|
BACNET_RELIABILITY Reliability;
|
|
bool Out_Of_Service;
|
|
uint16_t Units;
|
|
float Prior_Value;
|
|
float COV_Increment;
|
|
bool Changed;
|
|
const char *Object_Name;
|
|
const char *Description;
|
|
void *Context;
|
|
#if defined(INTRINSIC_REPORTING)
|
|
uint32_t Time_Delay;
|
|
uint32_t Notification_Class;
|
|
float High_Limit;
|
|
float Low_Limit;
|
|
float Deadband;
|
|
unsigned Limit_Enable : 2;
|
|
unsigned Event_Enable : 3;
|
|
unsigned Event_Detection_Enable : 1;
|
|
unsigned Notify_Type : 1;
|
|
ACKED_INFO Acked_Transitions[MAX_BACNET_EVENT_TRANSITION];
|
|
BACNET_DATE_TIME Event_Time_Stamps[MAX_BACNET_EVENT_TRANSITION];
|
|
/* time to generate event notification */
|
|
uint32_t Remaining_Time_Delay;
|
|
/* AckNotification information */
|
|
ACK_NOTIFICATION Ack_notify_data;
|
|
#endif
|
|
} ANALOG_INPUT_DESCR;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
BACNET_STACK_EXPORT
|
|
void Analog_Input_Property_Lists(
|
|
const int32_t **pRequired,
|
|
const int32_t **pOptional,
|
|
const int32_t **pProprietary);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Valid_Instance(uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
unsigned Analog_Input_Count(void);
|
|
BACNET_STACK_EXPORT
|
|
uint32_t Analog_Input_Index_To_Instance(unsigned index);
|
|
BACNET_STACK_EXPORT
|
|
unsigned Analog_Input_Instance_To_Index(uint32_t instance);
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Object_Instance_Add(uint32_t instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Object_Name(
|
|
uint32_t object_instance, BACNET_CHARACTER_STRING *object_name);
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Name_Set(uint32_t object_instance, const char *new_name);
|
|
BACNET_STACK_EXPORT
|
|
const char *Analog_Input_Name_ASCII(uint32_t object_instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *Analog_Input_Description(uint32_t instance);
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Description_Set(uint32_t instance, const char *new_name);
|
|
|
|
BACNET_STACK_EXPORT
|
|
BACNET_RELIABILITY Analog_Input_Reliability(uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Reliability_Set(
|
|
uint32_t object_instance, BACNET_RELIABILITY value);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Units_Set(uint32_t instance, BACNET_ENGINEERING_UNITS units);
|
|
BACNET_STACK_EXPORT
|
|
BACNET_ENGINEERING_UNITS Analog_Input_Units(uint32_t instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
int Analog_Input_Read_Property(BACNET_READ_PROPERTY_DATA *rpdata);
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Write_Property(BACNET_WRITE_PROPERTY_DATA *wp_data);
|
|
|
|
BACNET_STACK_EXPORT
|
|
float Analog_Input_Present_Value(uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
void Analog_Input_Present_Value_Set(uint32_t object_instance, float value);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Out_Of_Service(uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
void Analog_Input_Out_Of_Service_Set(uint32_t object_instance, bool oos_flag);
|
|
|
|
BACNET_STACK_EXPORT
|
|
unsigned Analog_Input_Event_State(uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Event_State_Set(uint32_t object_instance, unsigned state);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Change_Of_Value(uint32_t instance);
|
|
BACNET_STACK_EXPORT
|
|
void Analog_Input_Change_Of_Value_Clear(uint32_t instance);
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Encode_Value_List(
|
|
uint32_t object_instance, BACNET_PROPERTY_VALUE *value_list);
|
|
float Analog_Input_COV_Increment(uint32_t instance);
|
|
BACNET_STACK_EXPORT
|
|
void Analog_Input_COV_Increment_Set(uint32_t instance, float value);
|
|
|
|
/* note: header of Intrinsic_Reporting function is required
|
|
even when INTRINSIC_REPORTING is not defined */
|
|
BACNET_STACK_EXPORT
|
|
void Analog_Input_Intrinsic_Reporting(uint32_t object_instance);
|
|
|
|
#if defined(INTRINSIC_REPORTING)
|
|
BACNET_STACK_EXPORT
|
|
uint32_t Analog_Input_Time_Delay(uint32_t object_instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Time_Delay_Set(uint32_t object_instance, uint32_t time_delay);
|
|
|
|
BACNET_STACK_EXPORT
|
|
uint32_t Analog_Input_Notification_Class(uint32_t object_instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Notification_Class_Set(
|
|
uint32_t object_instance, uint32_t notification_class);
|
|
|
|
BACNET_STACK_EXPORT
|
|
float Analog_Input_High_Limit(uint32_t object_instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_High_Limit_Set(uint32_t object_instance, float high_limit);
|
|
|
|
BACNET_STACK_EXPORT
|
|
float Analog_Input_Low_Limit(uint32_t object_instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Low_Limit_Set(uint32_t object_instance, float low_limit);
|
|
|
|
BACNET_STACK_EXPORT
|
|
float Analog_Input_Deadband(uint32_t object_instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Deadband_Set(uint32_t object_instance, float deadband);
|
|
|
|
BACNET_STACK_EXPORT
|
|
BACNET_LIMIT_ENABLE Analog_Input_Limit_Enable(uint32_t object_instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Limit_Enable_Set(
|
|
uint32_t object_instance, BACNET_LIMIT_ENABLE limit_enable);
|
|
|
|
BACNET_STACK_EXPORT
|
|
BACNET_EVENT_ENABLE Analog_Input_Event_Enable(uint32_t object_instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Event_Detection_Enable(uint32_t object_instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Event_Detection_Enable_Set(
|
|
uint32_t object_instance, bool value);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Event_Enable_Set(
|
|
uint32_t object_instance, BACNET_EVENT_ENABLE event_enable);
|
|
|
|
BACNET_STACK_EXPORT
|
|
BACNET_NOTIFY_TYPE Analog_Input_Notify_Type(uint32_t object_instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Notify_Type_Set(
|
|
uint32_t object_instance, BACNET_NOTIFY_TYPE notify_type);
|
|
|
|
BACNET_STACK_EXPORT
|
|
int Analog_Input_Event_Information(
|
|
unsigned index, BACNET_GET_EVENT_INFORMATION_DATA *getevent_data);
|
|
|
|
BACNET_STACK_EXPORT
|
|
int Analog_Input_Alarm_Ack(
|
|
BACNET_ALARM_ACK_DATA *alarmack_data, BACNET_ERROR_CODE *error_code);
|
|
|
|
BACNET_STACK_EXPORT
|
|
int Analog_Input_Alarm_Summary(
|
|
unsigned index, BACNET_GET_ALARM_SUMMARY_DATA *getalarm_data);
|
|
#endif
|
|
|
|
BACNET_STACK_EXPORT
|
|
void *Analog_Input_Context_Get(uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
void Analog_Input_Context_Set(uint32_t object_instance, void *context);
|
|
|
|
BACNET_STACK_EXPORT
|
|
uint32_t Analog_Input_Create(uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
bool Analog_Input_Delete(uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
void Analog_Input_Cleanup(void);
|
|
BACNET_STACK_EXPORT
|
|
void Analog_Input_Init(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
#endif
|