rename ms-input to msi

demo/object/msi.h

@@ -0,0 +1,173 @@
+/**************************************************************************
+*
+* Copyright (C) 2012 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.
+*
+*********************************************************************/
+#ifndef MULTI_STATE_INPUT_H
+#define MULTI_STATE_INPUT_H
+
+#include <stdbool.h>
+#include <stdint.h>
+#include "bacdef.h"
+#include "bacerror.h"
+#include "rp.h"
+#include "wp.h"
+#if defined(INTRINSIC_REPORTING)
+#include "nc.h"
+#include "alarm_ack.h"
+#include "getevent.h"
+#include "get_alarm_sum.h"
+#endif /* INTRINSIC_REPORTING */
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+int max_multi_state_inputs;
+
+    typedef struct multistate_input_descr {
+        char Object_Name[64];
+        char Object_Description[64];
+        uint8_t Present_Value;
+        unsigned Event_State:3;
+        bool Out_Of_Service;
+        bool Disable;
+        uint8_t Units;
+        char State_Text[254][64];
+        int number_of_states;
+        int number_of_alarmstates;
+        /* Here is our Priority Array.  They are supposed to be Real, but */
+        /* we don't have that kind of memory, so we will use a single byte */
+        /* and load a Real for returning the value when asked. */
+        uint8_t Priority_Array[BACNET_MAX_PRIORITY];
+        unsigned Relinquish_Default;
+#if defined(INTRINSIC_REPORTING)
+        uint32_t Time_Delay;
+        uint32_t Notification_Class;
+        uint8_t Alarm_Values[254];
+        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 informations */
+        ACK_NOTIFICATION Ack_notify_data;
+#endif /* INTRINSIC_REPORTING */
+    } MULTI_STATE_INPUT_DESCR;
+
+
+    void Multistate_Input_Property_Lists(
+        const int **pRequired,
+        const int **pOptional,
+        const int **pProprietary);
+
+    bool Multistate_Input_Valid_Instance(
+        uint32_t object_instance);
+
+    unsigned Multistate_Input_Count(
+        void);
+
+    uint32_t Multistate_Input_Index_To_Instance(
+        unsigned index);
+
+    unsigned Multistate_Input_Instance_To_Index(
+        uint32_t object_instance);
+
+    int Multistate_Input_Read_Property(
+        BACNET_READ_PROPERTY_DATA * rpdata);
+
+    bool Multistate_Input_Write_Property(
+        BACNET_WRITE_PROPERTY_DATA * wp_data);
+
+    /* optional API */
+    bool Multistate_Input_Object_Instance_Add(
+        uint32_t instance);
+
+    bool Multistate_Input_Object_Name(
+        uint32_t object_instance,
+        BACNET_CHARACTER_STRING * object_name);
+
+    bool Multistate_Input_Name_Set(
+        uint32_t object_instance,
+        char *new_name);
+
+    bool Multistate_Input_Present_Value_Set(
+        uint32_t object_instance,
+        uint32_t value,
+        uint8_t priority);
+
+    uint32_t Multistate_Input_Present_Value(
+        uint32_t object_instance);
+
+    bool Multistate_Input_Out_Of_Service(
+        uint32_t object_instance);
+
+    void Multistate_Input_Out_Of_Service_Set(
+        uint32_t object_instance,
+        bool value);
+
+    bool Multistate_Input_Description_Set(
+        uint32_t object_instance,
+        char *text_string);
+
+    bool Multistate_Input_State_Text_Set(
+        uint32_t object_instance,
+        uint32_t state_index,
+        char *new_name);
+
+    bool Multistate_Input_Max_States_Set(
+        uint32_t instance,
+        uint32_t max_states_requested);
+
+    /* note: header of Intrinsic_Reporting function is required
+       even when INTRINSIC_REPORTING is not defined */
+    void Multistate_Input_Intrinsic_Reporting(
+        uint32_t object_instance);
+
+#if defined(INTRINSIC_REPORTING)
+    int Multistate_Input_Event_Information(
+        unsigned index,
+        BACNET_GET_EVENT_INFORMATION_DATA * getevent_data);
+
+    int Multistate_Input_Alarm_Ack(
+        BACNET_ALARM_ACK_DATA * alarmack_data,
+        BACNET_ERROR_CODE * error_code);
+
+    int Multistate_Input_Alarm_Summary(
+        unsigned index,
+        BACNET_GET_ALARM_SUMMARY_DATA * getalarm_data);
+#endif
+
+    void Multistate_Input_Init(
+        void);
+
+#ifdef TEST
+#include "ctest.h"
+    void testMultistateValue(
+        Test * pTest);
+#endif
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+#endif