bacnet_stack/bacnet-stack/include/event.h

/*####COPYRIGHTBEGIN####
 -------------------------------------------
 Copyright (C) 2008 John Minack

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
 of the License, or (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to:
 The Free Software Foundation, Inc.
 59 Temple Place - Suite 330
 Boston, MA  02111-1307, USA.

 As a special exception, if other files instantiate templates or
 use macros or inline functions from this file, or you compile
 this file and link it with other works to produce a work based
 on this file, this file does not by itself cause the resulting
 work to be covered by the GNU General Public License. However
 the source code for this file must still be made available in
 accordance with section (3) of the GNU General Public License.

 This exception does not invalidate any other reasons why a work
 based on this file might be covered by the GNU General Public
 License.
 -------------------------------------------
####COPYRIGHTEND####*/

#ifndef BACNET_EVENT_H_
#define BACNET_EVENT_H_

#include "bacenum.h"
#include <stdint.h>
#include <stdbool.h>
#include "bacapp.h"
#include "timestamp.h"
#include "bacpropstates.h"
#include "bacdevobjpropref.h"

typedef enum {
	CHANGE_OF_VALUE_BITS,
	CHANGE_OF_VALUE_REAL
} CHANGE_OF_VALUE_TYPE;

/*
** Based on UnconfirmedEventNotification-Request
*/

typedef struct BACnet_Event_Notification_Data {
	uint32_t 					processIdentifier;
	BACNET_OBJECT_ID 			initiatingObjectIdentifier;
	BACNET_OBJECT_ID 			eventObjectIdentifier;
	BACNET_TIMESTAMP			timeStamp;
	uint32_t					notificationClass;
	uint8_t						priority;
	BACNET_EVENT_TYPE			eventType;
	BACNET_CHARACTER_STRING*	messageText; /* OPTIONAL - Set to NULL if not being used */
	BACNET_NOTIFY_TYPE			notifyType;
	bool						ackRequired;
	BACNET_EVENT_STATE			fromState;
	BACNET_EVENT_STATE			toState;
	/*
	** Each of these structures in the union maps to a particular eventtype
	** Based on BACnetNotificationParameters
	*/

	union {
		/*
		** EVENT_CHANGE_OF_BITSTRING
		*/
		struct {
			BACNET_BIT_STRING    	referencedBitString;
			BACNET_BIT_STRING	 	statusFlags;
		} changeOfBitstring;
		/*
		** EVENT_CHANGE_OF_STATE
		*/
		struct {
			BACNET_PROPERTY_STATE	newState;
			BACNET_BIT_STRING		statusFlags;
		} changeOfState;
		/*
		** EVENT_CHANGE_OF_VALUE
		*/
		struct {
			union {
				BACNET_BIT_STRING 	changedBits;
				float				changeValue;
			} newValue;
			CHANGE_OF_VALUE_TYPE    tag;
			BACNET_BIT_STRING		statusFlags;
		} changeOfValue;
		/*
		** EVENT_COMMAND_FAILURE
		**
		** Not Supported!
		*/
		/*
		** EVENT_FLOATING_LIMIT
		*/
		struct {
			float					referenceValue;
			BACNET_BIT_STRING		statusFlags;
			float					setPointValue;
			float					errorLimit;
		} floatingLimit;
		/*
		** EVENT_OUT_OF_RANGE
		*/
		struct {
			float					exceedingValue;
			BACNET_BIT_STRING		statusFlags;
			float					deadband;
			float					exceededLimit;
		} outOfRange;
		/*
		** EVENT_CHANGE_OF_LIFE_SAFETY
		*/
		struct {
			BACNET_LIFE_SAFETY_STATE	 newState;
			BACNET_LIFE_SAFETY_MODE		 newMode;
			BACNET_BIT_STRING			 statusFlags;
			BACNET_LIFE_SAFETY_OPERATION operationExpected;
		} changeOfLifeSafety;
		/*
		** EVENT_EXTENDED
		**
		** Not Supported!
		*/
		/*
		** EVENT_BUFFER_READY
		*/
		struct {
			BACNET_DEVICE_OBJECT_PROPERTY_REFERENCE bufferProperty;
			uint32_t								previousNotification;
			uint32_t								currentNotification;
		} bufferReady;
		/*
		** EVENT_UNSIGNED_RANGE
		*/
		struct {
			uint32_t				exceedingValue;
			BACNET_BIT_STRING		statusFlags;
			uint32_t				exceededLimit;
		} unsignedRange;
	} notificationParams;
} BACNET_EVENT_NOTIFICATION_DATA;


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/***************************************************
**
** Creates a Confirmed Event Notification APDU
**
****************************************************/
int cevent_notify_encode_apdu(
    uint8_t * apdu,
    uint8_t invoke_id,
    BACNET_EVENT_NOTIFICATION_DATA * data);

/***************************************************
**
** Creates an Unconfirmed Event Notification APDU
**
****************************************************/
int uevent_notify_encode_apdu(
    uint8_t * apdu,
    BACNET_EVENT_NOTIFICATION_DATA * data);

/***************************************************
**
** Encodes the service data part of Event Notification
**
****************************************************/
int event_notify_encode_service_request(
    uint8_t * apdu,
    BACNET_EVENT_NOTIFICATION_DATA * data);

/***************************************************
**
** Decodes the service data part of Event Notification
**
****************************************************/
int event_notify_decode_service_request(
    uint8_t * apdu,
    unsigned apdu_len,
    BACNET_EVENT_NOTIFICATION_DATA * data);

/***************************************************
**
** Sends an Unconfirmed Event Notifcation to a dest
**
****************************************************/
int uevent_notify_send(
    uint8_t * buffer,
    BACNET_EVENT_NOTIFICATION_DATA * data,
    BACNET_ADDRESS *dest);


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