bacnet_stack/src/bacnet/alarm_ack.c

/*####COPYRIGHTBEGIN####
 -------------------------------------------
 Copyright (C) 2009 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####*/
#include <stddef.h>
#include <stdint.h>
#include "bacnet/alarm_ack.h"

/** @file alarm_ack.c  Handles Event Notifications (ACKs) */

/**
 * @brief Creates an Unconfirmed Event Notification APDU
 *
 * @param apdu  Transmission buffer
 * @param invoke_id  Invoked ID
 * @param data  Alarm acknowledge data that will be copied into the payload.
 *
 * @return Length of the APDU
 */
int alarm_ack_encode_apdu(
    uint8_t *apdu, uint8_t invoke_id, BACNET_ALARM_ACK_DATA *data)
{
    int len = 0; /* length of each encoding */
    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_ACKNOWLEDGE_ALARM; /* service choice */
        apdu_len = 4;

        len = alarm_ack_encode_service_request(&apdu[apdu_len], data);
        apdu_len += len;
    }

    return apdu_len;
}

/**
 * @brief Encodes the service data part of Event Notification.
 *
 * @param apdu  Receive buffer
 * @param data  Alarm acknowledge data that will be filled in
 *              with the data from the payload.
 *
 * @return Total length of the apdu
 */
int alarm_ack_encode_service_request(uint8_t *apdu, BACNET_ALARM_ACK_DATA *data)
{
    int len = 0; /* length of each encoding */
    int apdu_len = 0; /* total length of the apdu, return value */

    if (apdu) {
        len = encode_context_unsigned(
            &apdu[apdu_len], 0, data->ackProcessIdentifier);
        apdu_len += len;

        len = encode_context_object_id(&apdu[apdu_len], 1,
            data->eventObjectIdentifier.type,
            data->eventObjectIdentifier.instance);
        apdu_len += len;

        len = encode_context_enumerated(
            &apdu[apdu_len], 2, data->eventStateAcked);
        apdu_len += len;

        len = bacapp_encode_context_timestamp(
            &apdu[apdu_len], 3, &data->eventTimeStamp);
        apdu_len += len;

        len = encode_context_character_string(
            &apdu[apdu_len], 4, &data->ackSource);
        apdu_len += len;

        len = bacapp_encode_context_timestamp(
            &apdu[apdu_len], 5, &data->ackTimeStamp);
        apdu_len += len;
    }

    return apdu_len;
}

/**
 * @brief Decodes the service data part of Event Notification.
 *
 * @param apdu  Receive buffer
 * @param apdu_len  Bytes valid in the buffer.
 * @param data  Alarm acknowledge data that will be filled.
 *
 * @return Total length of the apdu
 */
int alarm_ack_decode_service_request(
    uint8_t *apdu, unsigned apdu_len, BACNET_ALARM_ACK_DATA *data)
{
    int len = 0;
    int section_len = 0;
    uint32_t enum_value = 0;
    BACNET_UNSIGNED_INTEGER unsigned_value = 0;

    (void)apdu_len;
    section_len = decode_context_unsigned(&apdu[len], 0, &unsigned_value);
    if (section_len == BACNET_STATUS_ERROR) {
        return BACNET_STATUS_ERROR;
    }
    data->ackProcessIdentifier = (uint32_t)unsigned_value;
    len += section_len;

    section_len = decode_context_object_id(&apdu[len], 1,
        &data->eventObjectIdentifier.type,
        &data->eventObjectIdentifier.instance);
    if (section_len == BACNET_STATUS_ERROR) {
        return BACNET_STATUS_ERROR;
    }
    len += section_len;

    section_len = decode_context_enumerated(&apdu[len], 2, &enum_value);
    if (section_len == BACNET_STATUS_ERROR) {
        return BACNET_STATUS_ERROR;
    }
    data->eventStateAcked = (BACNET_EVENT_STATE)enum_value;
    len += section_len;

    section_len =
        bacapp_decode_context_timestamp(&apdu[len], 3, &data->eventTimeStamp);
    if (section_len == BACNET_STATUS_ERROR) {
        return BACNET_STATUS_ERROR;
    }
    len += section_len;

    section_len =
        decode_context_character_string(&apdu[len], 4, &data->ackSource);
    if (section_len == BACNET_STATUS_ERROR) {
        return BACNET_STATUS_ERROR;
    }
    len += section_len;

    section_len =
        bacapp_decode_context_timestamp(&apdu[len], 5, &data->ackTimeStamp);
    if (section_len == BACNET_STATUS_ERROR) {
        return BACNET_STATUS_ERROR;
    }
    len += section_len;

    return len;
}