New code for alarms and events: new functions get_alarm_summary_encode_apdu, Send_Get_Alarm_Summary_Address, Send_Get_Alarm_Summary, Send_Get_Event_Information_Address, Send_Get_Event_Information, get_event_ack_handler. Thank you Daniel Blazevic!

This commit is contained in:
skarg
2014-01-14 19:49:39 +00:00
parent 92559791ba
commit bfa26b769f
8 changed files with 390 additions and 0 deletions
+87
View File
@@ -0,0 +1,87 @@
/**
* @file
* @author Daniel Blazevic <daniel.blazevic@gmail.com>
* @date 2014
* @brief GetEvent ACK service handling
*
* @section LICENSE
*
* Copyright (C) 2014 Daniel Blazevic <daniel.blazevic@gmail.com>
*
* 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.
*
* @section DESCRIPTION
*
* The GetEventInformation service ACK service handler is used by a client
* BACnet-user to obtain a summary of all "active event states". The term
* "active event states" refers to all event-initiating objects that have an
* Event_State property whose value is not equal to NORMAL, or have an
* Acked_Transitions property, which has at least one of the bits
* (TO-OFFNORMAL, TO-FAULT, TONORMAL) set to FALSE.
*/
#include <assert.h>
#include "config.h"
#include "txbuf.h"
#include "bacdef.h"
#include "bacdcode.h"
#include "bacerror.h"
#include "apdu.h"
#include "npdu.h"
#include "abort.h"
#include "handlers.h"
#include "getevent.h"
/* 40 = min size of get event data in APDU */
#define MAX_NUMBER_OF_EVENTS ((MAX_APDU / 40) + 1)
/** Example function to handle a GetEvent ACK.
*
* @param service_request [in] The contents of the service request.
* @param service_len [in] The length of the service_request.
* @param src [in] BACNET_ADDRESS of the source of the message
* @param service_data [in] The BACNET_CONFIRMED_SERVICE_ACK_DATA information
* decoded from the APDU header of this message.
*/
void get_event_ack_handler(
uint8_t *service_request,
uint16_t service_len,
BACNET_ADDRESS *src,
BACNET_CONFIRMED_SERVICE_ACK_DATA *service_data)
{
uint8_t i = 0;
uint16_t apdu_len = 0;
bool more_events = false;
/* initialize array big enough to accommodate
multiple get event data in APDU */
BACNET_GET_EVENT_INFORMATION_DATA get_event_data[MAX_NUMBER_OF_EVENTS];
for (i = 1; i < MAX_NUMBER_OF_EVENTS; i++) {
/* Create linked list */
get_event_data[i - 1].next = &get_event_data[i];
}
apdu_len =
getevent_ack_decode_service_request(&service_request[0],
service_len, &get_event_data[0], &more_events);
if (apdu_len > 0) {
/* FIXME: Add code to process get_event_data */
}
}
+128
View File
@@ -0,0 +1,128 @@
/**
* @file
* @author Daniel Blazevic <daniel.blazevic@gmail.com>
* @date 2014
* @brief Get Alarm Summary Request
*
* @section LICENSE
*
* Copyright (C) 2014 Daniel Blazevic <daniel.blazevic@gmail.com>
*
* 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.
*
* @section DESCRIPTION
*
* The Get Alarm Summary Request is used by a client BACnet-user to
* obtain a summary of "active alarms." The term "active alarm" refers to
* BACnet standard objects that have an Event_State property whose value is
* not equal to NORMAL and a Notify_Type property whose value is ALARM.
*/
#include <stddef.h>
#include <stdint.h>
#include <errno.h>
#include <string.h>
#include "config.h"
#include "txbuf.h"
#include "bacdef.h"
#include "bacdcode.h"
#include "address.h"
#include "tsm.h"
#include "npdu.h"
#include "apdu.h"
#include "device.h"
#include "datalink.h"
#include "handlers.h"
#include "client.h"
#include "get_alarm_sum.h"
uint8_t Send_Get_Alarm_Summary_Address(
BACNET_ADDRESS *dest,
uint16_t max_apdu)
{
int len = 0;
int pdu_len = 0;
uint8_t invoke_id = 0;
BACNET_NPDU_DATA npdu_data;
BACNET_ADDRESS my_address;
#if PRINT_ENABLED
int bytes_sent = 0;
#endif
/* is there a tsm available? */
invoke_id = tsm_next_free_invokeID();
if (invoke_id) {
datalink_get_my_address(&my_address);
/* encode the NPDU portion of the packet */
npdu_encode_npdu_data(&npdu_data, true, MESSAGE_PRIORITY_NORMAL);
pdu_len =
npdu_encode_pdu(&Handler_Transmit_Buffer[0], dest,
&my_address, &npdu_data);
/* encode the APDU portion of the packet */
len = get_alarm_summary_encode_apdu(&Handler_Transmit_Buffer[pdu_len],
invoke_id);
pdu_len += len;
if ((uint16_t) pdu_len < max_apdu) {
tsm_set_confirmed_unsegmented_transaction(invoke_id, dest,
&npdu_data, &Handler_Transmit_Buffer[0],
(uint16_t) pdu_len);
#if PRINT_ENABLED
bytes_sent =
#endif
datalink_send_pdu(dest, &npdu_data,
&Handler_Transmit_Buffer[0], pdu_len);
#if PRINT_ENABLED
if (bytes_sent <= 0)
fprintf(stderr,
"Failed to Send Get Alarm Summary Request (%s)!\n",
strerror(errno));
#endif
} else {
tsm_free_invoke_id(invoke_id);
invoke_id = 0;
#if PRINT_ENABLED
fprintf(stderr,
"Failed to Send Get Alarm Summary Request "
"(exceeds destination maximum APDU)!\n");
#endif
}
}
return invoke_id;
}
uint8_t Send_Get_Alarm_Summary(
uint32_t device_id)
{
BACNET_ADDRESS dest;
unsigned max_apdu = 0;
uint8_t invoke_id = 0;
bool status = false;
/* is the device bound? */
status = address_get_by_device(device_id, &max_apdu, &dest);
if (status) {
invoke_id = Send_Get_Alarm_Summary_Address(
&dest, max_apdu);
}
return invoke_id;
}
+129
View File
@@ -0,0 +1,129 @@
/**
* @file
* @author Daniel Blazevic <daniel.blazevic@gmail.com>
* @date 2014
* @brief Get Event Request
*
* @section LICENSE
*
* Copyright (C) 2014 Daniel Blazevic <daniel.blazevic@gmail.com>
*
* 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.
*
* @section DESCRIPTION
*
* The GetEventInformation service is used by a client BACnet-user to obtain
* a summary of all "active event states". The term "active event states"
* refers to all event-initiating objects that have an Event_State property
* whose value is not equal to NORMAL, or have an Acked_Transitions property,
* which has at least one of the bits (TO-OFFNORMAL, TO-FAULT, TONORMAL)
* set to FALSE.
*/
#include <stddef.h>
#include <stdint.h>
#include <errno.h>
#include <string.h>
#include "config.h"
#include "txbuf.h"
#include "bacdef.h"
#include "bacdcode.h"
#include "address.h"
#include "tsm.h"
#include "npdu.h"
#include "apdu.h"
#include "device.h"
#include "datalink.h"
#include "handlers.h"
#include "client.h"
#include "getevent.h"
uint8_t Send_Get_Event_Information_Address(
BACNET_ADDRESS *dest,
uint16_t max_apdu,
BACNET_OBJECT_ID * lastReceivedObjectIdentifier)
{
int len = 0;
int pdu_len = 0;
uint8_t invoke_id = 0;
BACNET_NPDU_DATA npdu_data;
BACNET_ADDRESS my_address;
#if PRINT_ENABLED
int bytes_sent = 0;
#endif
/* is there a tsm available? */
invoke_id = tsm_next_free_invokeID();
if (invoke_id) {
datalink_get_my_address(&my_address);
/* encode the NPDU portion of the packet */
npdu_encode_npdu_data(&npdu_data, true, MESSAGE_PRIORITY_NORMAL);
pdu_len =
npdu_encode_pdu(&Handler_Transmit_Buffer[0], dest,
&my_address, &npdu_data);
/* encode the APDU portion of the packet */
len = getevent_encode_apdu(&Handler_Transmit_Buffer[pdu_len],
invoke_id, lastReceivedObjectIdentifier);
pdu_len += len;
if ((uint16_t) pdu_len < max_apdu) {
tsm_set_confirmed_unsegmented_transaction(invoke_id, dest,
&npdu_data, &Handler_Transmit_Buffer[0], (uint16_t) pdu_len);
#if PRINT_ENABLED
bytes_sent =
#endif
datalink_send_pdu(dest, &npdu_data,
&Handler_Transmit_Buffer[0], pdu_len);
#if PRINT_ENABLED
if (bytes_sent <= 0)
fprintf(stderr, "Failed to Send Get Event Information Request (%s)!\n",
strerror(errno));
#endif
} else {
tsm_free_invoke_id(invoke_id);
invoke_id = 0;
#if PRINT_ENABLED
fprintf(stderr,
"Failed to Send Get Event Information Request "
"(exceeds destination maximum APDU)!\n");
#endif
}
}
return invoke_id;
}
uint8_t Send_Get_Event_Information(
uint32_t device_id,
BACNET_OBJECT_ID * lastReceivedObjectIdentifier)
{
BACNET_ADDRESS dest = {0};
unsigned max_apdu = 0;
uint8_t invoke_id = 0;
bool status = false;
/* is the device bound? */
status = address_get_by_device(device_id, &max_apdu, &dest);
if (status) {
invoke_id = Send_Get_Event_Information_Address(
&dest, max_apdu, lastReceivedObjectIdentifier);
}
return invoke_id;
}
+16
View File
@@ -231,6 +231,22 @@ extern "C" {
BACNET_ADDRESS * dest,
BACNET_PRIVATE_TRANSFER_DATA * private_data);
uint8_t Send_Get_Alarm_Summary_Address(
BACNET_ADDRESS *dest,
uint16_t max_apdu);
uint8_t Send_Get_Alarm_Summary(
uint32_t device_id);
uint8_t Send_Get_Event_Information_Address(
BACNET_ADDRESS *dest,
uint16_t max_apdu,
BACNET_OBJECT_ID * lastReceivedObjectIdentifier);
uint8_t Send_Get_Event_Information(
uint32_t device_id,
BACNET_OBJECT_ID * lastReceivedObjectIdentifier);
#ifdef __cplusplus
}
#endif /* __cplusplus */
+4
View File
@@ -53,6 +53,10 @@ typedef int (
extern "C" {
#endif /* __cplusplus */
int get_alarm_summary_encode_apdu(
uint8_t * apdu,
uint8_t invoke_id);
/* set GetAlarmSummary function */
void handler_get_alarm_summary_set(
BACNET_OBJECT_TYPE object_type,
+6
View File
@@ -325,6 +325,12 @@ extern "C" {
BACNET_ADDRESS * src,
BACNET_CONFIRMED_SERVICE_ACK_DATA * service_data);
void get_event_ack_handler(
uint8_t *service_request,
uint16_t service_len,
BACNET_ADDRESS *src,
BACNET_CONFIRMED_SERVICE_ACK_DATA *service_data);
#ifdef __cplusplus
}
+3
View File
@@ -104,6 +104,7 @@ HANDLER_SRC = \
$(BACNET_HANDLER)/h_getevent.c \
$(BACNET_HANDLER)/h_gas_a.c \
$(BACNET_HANDLER)/h_get_alarm_sum.c \
$(BACNET_HANDLER)/h_getevent_a.c \
$(BACNET_HANDLER)/h_pt.c \
$(BACNET_HANDLER)/h_pt_a.c \
$(BACNET_HANDLER)/h_upt.c \
@@ -111,6 +112,8 @@ HANDLER_SRC = \
$(BACNET_HANDLER)/s_awfs.c \
$(BACNET_HANDLER)/s_dcc.c \
$(BACNET_HANDLER)/s_ihave.c \
$(BACNET_HANDLER)/s_get_alarm_sum.c \
$(BACNET_HANDLER)/s_get_event.c \
$(BACNET_HANDLER)/s_iam.c \
$(BACNET_HANDLER)/s_cov.c \
$(BACNET_HANDLER)/s_ptransfer.c \
+17
View File
@@ -42,6 +42,23 @@
#include "get_alarm_sum.h"
#include "npdu.h"
/* encode service */
int get_alarm_summary_encode_apdu(
uint8_t * apdu,
uint8_t invoke_id
) {
int apdu_len = 0; /* total length of the apdu, return value */
if (apdu) {
apdu[0] = PDU_TYPE_CONFIRMED_SERVICE_REQUEST;
apdu[1] = encode_max_segs_max_apdu(0, MAX_APDU);
apdu[2] = invoke_id;
apdu[3] = SERVICE_CONFIRMED_GET_ALARM_SUMMARY;
apdu_len = 4;
}
return apdu_len;
}
/** Helper function encode the beginning of a GetAlarmSummary ACK.
*