bacnet_stack/src/bacnet/basic/object/av.h

/**
 * @file
 * @author Steve Karg
 * @date 2006
 * @brief Analog Value object is an input object with a present-value that
 * uses an single precision floating point data type.
 * @section LICENSE
 * Copyright (C) 2006 Steve Karg <skarg@users.sourceforge.net>
 * Copyright (C) 2011 Krzysztof Malorny <malornykrzysztof@gmail.com>
 * SPDX-License-Identifier: MIT
 */
#ifndef BACNET_ANALOG_VALUE_OBJECT_H
#define BACNET_ANALOG_VALUE_OBJECT_H

#include <stdbool.h>
#include <stdint.h>
/* BACnet Stack defines - first */
#include "bacnet/bacdef.h"
/* BACnet Stack API */
#include "bacnet/bacerror.h"
#include "bacnet/wp.h"
#include "bacnet/rp.h"
#if defined(INTRINSIC_REPORTING)
#include "bacnet/basic/object/nc.h"
#include "bacnet/alarm_ack.h"
#include "bacnet/getevent.h"
#include "bacnet/get_alarm_sum.h"
#endif

typedef struct analog_value_descr {
    unsigned Event_State:3;
    bool Out_Of_Service;
    uint16_t Units;
    float Present_Value;
    float Prior_Value;
    float COV_Increment;
    bool Changed;
    char* Object_Name;
    char* Description;
    BACNET_RELIABILITY Reliability;
#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 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_VALUE_DESCR;

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
    BACNET_STACK_EXPORT
    void Analog_Value_Property_Lists(
        const int **pRequired,
        const int **pOptional,
        const int **pProprietary);
    BACNET_STACK_EXPORT
    bool Analog_Value_Valid_Instance(
        uint32_t object_instance);
    BACNET_STACK_EXPORT
    unsigned Analog_Value_Count(
        void);
    BACNET_STACK_EXPORT
    uint32_t Analog_Value_Index_To_Instance(
        unsigned index);
    BACNET_STACK_EXPORT
    unsigned Analog_Value_Instance_To_Index(
        uint32_t object_instance);

    BACNET_STACK_EXPORT
    bool Analog_Value_Object_Name(
        uint32_t object_instance,
        BACNET_CHARACTER_STRING * object_name);
    BACNET_STACK_EXPORT
    bool Analog_Value_Name_Set(
        uint32_t object_instance,
        char *new_name);
    char *Analog_Value_Name(
        uint32_t object_instance);

    BACNET_STACK_EXPORT
    int Analog_Value_Read_Property(
        BACNET_READ_PROPERTY_DATA * rpdata);

    BACNET_STACK_EXPORT
    bool Analog_Value_Write_Property(
        BACNET_WRITE_PROPERTY_DATA * wp_data);

    BACNET_STACK_EXPORT
    bool Analog_Value_Present_Value_Set(
        uint32_t object_instance,
        float value,
        uint8_t priority);
    BACNET_STACK_EXPORT
    float Analog_Value_Present_Value(
        uint32_t object_instance);

    BACNET_STACK_EXPORT
    unsigned Analog_Value_Event_State(
        uint32_t object_instance);
    BACNET_STACK_EXPORT
    bool Analog_Value_Event_State_Set(
        uint32_t object_instance,
        unsigned state);

    BACNET_STACK_EXPORT
    bool Analog_Value_Change_Of_Value(
        uint32_t instance);
    BACNET_STACK_EXPORT
    void Analog_Value_Change_Of_Value_Clear(
        uint32_t instance);
    BACNET_STACK_EXPORT
    bool Analog_Value_Encode_Value_List(
        uint32_t object_instance,
        BACNET_PROPERTY_VALUE * value_list);
    BACNET_STACK_EXPORT
    float Analog_Value_COV_Increment(
        uint32_t instance);
    BACNET_STACK_EXPORT
    void Analog_Value_COV_Increment_Set(
        uint32_t instance,
        float value);

    BACNET_STACK_EXPORT
    char *Analog_Value_Description(
        uint32_t instance);
    BACNET_STACK_EXPORT
    bool Analog_Value_Description_Set(
        uint32_t instance,
        char *new_name);

    BACNET_STACK_EXPORT
    BACNET_RELIABILITY Analog_Value_Reliability(
        uint32_t object_instance);
    BACNET_STACK_EXPORT
    bool Analog_Value_Reliability_Set(
        uint32_t object_instance,
        BACNET_RELIABILITY value);

    BACNET_STACK_EXPORT
    uint16_t Analog_Value_Units(
        uint32_t instance);
    BACNET_STACK_EXPORT
    bool Analog_Value_Units_Set(
        uint32_t instance,
        uint16_t unit);

    BACNET_STACK_EXPORT
    bool Analog_Value_Out_Of_Service(
        uint32_t instance);
    BACNET_STACK_EXPORT
    void Analog_Value_Out_Of_Service_Set(
        uint32_t instance,
        bool oos_flag);

    /* note: header of Intrinsic_Reporting function is required
       even when INTRINSIC_REPORTING is not defined */
    BACNET_STACK_EXPORT
    void Analog_Value_Intrinsic_Reporting(
        uint32_t object_instance);

#if defined(INTRINSIC_REPORTING)
    BACNET_STACK_EXPORT
    int Analog_Value_Event_Information(
        unsigned index,
        BACNET_GET_EVENT_INFORMATION_DATA * getevent_data);

    BACNET_STACK_EXPORT
    int Analog_Value_Alarm_Ack(
        BACNET_ALARM_ACK_DATA * alarmack_data,
        BACNET_ERROR_CODE * error_code);

    BACNET_STACK_EXPORT
    int Analog_Value_Alarm_Summary(
        unsigned index,
        BACNET_GET_ALARM_SUMMARY_DATA * getalarm_data);
#endif

    BACNET_STACK_EXPORT
    uint32_t Analog_Value_Create(
        uint32_t object_instance);
    BACNET_STACK_EXPORT
    bool Analog_Value_Delete(
        uint32_t object_instance);
    BACNET_STACK_EXPORT
    void Analog_Value_Cleanup(
        void);
    BACNET_STACK_EXPORT
    void Analog_Value_Init(
        void);

#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif