bacnet_stack/src/bacnet/rpm.h

/**
 * @file
 * @brief BACnet ReadPropertyMultiple -Request and -Ack encode and decode
 * API header file
 * @author Steve Karg <skarg@users.sourceforge.net>
 * @date 2005
 * @copyright SPDX-License-Identifier: MIT
 */
#ifndef BACNET_READ_PROPERTY_MULTIPLE_H
#define BACNET_READ_PROPERTY_MULTIPLE_H

#include <stdint.h>
#include <stdbool.h>
/* BACnet Stack defines - first */
#include "bacnet/bacdef.h"
/* BACnet Stack API */
#include "bacnet/bacapp.h"
#include "bacnet/proplist.h"
#include "bacnet/rp.h"
/*
 * Bundle together commonly used data items for convenience when calling
 * rpm helper functions.
 */

typedef struct BACnet_RPM_Data {
    BACNET_OBJECT_TYPE object_type;
    uint32_t object_instance;
    BACNET_PROPERTY_ID object_property;
    BACNET_ARRAY_INDEX array_index;
    BACNET_ERROR_CLASS error_class;
    BACNET_ERROR_CODE error_code;
} BACNET_RPM_DATA;

struct BACnet_Read_Access_Data;
typedef struct BACnet_Read_Access_Data {
    BACNET_OBJECT_TYPE object_type;
    uint32_t object_instance;
    /* simple linked list of values */
    BACNET_PROPERTY_REFERENCE *listOfProperties;
    struct BACnet_Read_Access_Data *next;
} BACNET_READ_ACCESS_DATA;

/** Fetches the lists of properties (array of BACNET_PROPERTY_ID's) for this
 *  object type, grouped by Required, Optional, and Proprietary.
 * A function template; @see device.c for assignment to object types.
 * @ingroup ObjHelpers
 *
 * @param pRequired [out] Pointer reference for the list of Required properties.
 * @param pOptional [out] Pointer reference for the list of Optional properties.
 * @param pProprietary [out] Pointer reference for the list of Proprietary
 *                           properties for this BACNET_OBJECT_TYPE.
 */
typedef void (*rpm_property_lists_function)(
    const int **pRequired, const int **pOptional, const int **pProprietary);

typedef void (*rpm_object_property_lists_function)(
    BACNET_OBJECT_TYPE object_type,
    struct special_property_list_t *pPropertyList);

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

/* encode functions */
/* Start with the Init function, and then add an object,
 then add its properties, and then end the object.
 Continue to add objects and properties as needed
 until the APDU is full.*/

/* RPM */
BACNET_STACK_EXPORT
int rpm_encode_apdu_init(uint8_t *apdu, uint8_t invoke_id);

BACNET_STACK_EXPORT
int rpm_encode_apdu_object_begin(
    uint8_t *apdu, BACNET_OBJECT_TYPE object_type, uint32_t object_instance);

BACNET_STACK_EXPORT
int rpm_encode_apdu_object_property(
    uint8_t *apdu,
    BACNET_PROPERTY_ID object_property,
    BACNET_ARRAY_INDEX array_index);

BACNET_STACK_EXPORT
int rpm_encode_apdu_object_end(uint8_t *apdu);

BACNET_STACK_EXPORT
int read_property_multiple_request_encode(
    uint8_t *apdu, BACNET_READ_ACCESS_DATA *data);
BACNET_STACK_EXPORT
size_t read_property_multiple_request_service_encode(
    uint8_t *apdu, size_t apdu_size, BACNET_READ_ACCESS_DATA *data);

BACNET_STACK_EXPORT
int rpm_encode_apdu(
    uint8_t *apdu,
    size_t max_apdu,
    uint8_t invoke_id,
    BACNET_READ_ACCESS_DATA *read_access_data);

/* decode the object portion of the service request only */
BACNET_STACK_EXPORT
int rpm_decode_object_id(
    const uint8_t *apdu, unsigned apdu_len, BACNET_RPM_DATA *rpmdata);

/* is this the end of this object property list? */
BACNET_STACK_EXPORT
int rpm_decode_object_end(const uint8_t *apdu, unsigned apdu_len);

/* decode the object property portion of the service request only */
BACNET_STACK_EXPORT
int rpm_decode_object_property(
    const uint8_t *apdu, unsigned apdu_len, BACNET_RPM_DATA *rpmdata);

/* RPM Ack - reply from server */
BACNET_STACK_EXPORT
int rpm_ack_encode_apdu_init(uint8_t *apdu, uint8_t invoke_id);

BACNET_STACK_EXPORT
int rpm_ack_encode_apdu_object_begin(
    uint8_t *apdu, const BACNET_RPM_DATA *rpmdata);

BACNET_STACK_EXPORT
int rpm_ack_encode_apdu_object_property(
    uint8_t *apdu,
    BACNET_PROPERTY_ID object_property,
    BACNET_ARRAY_INDEX array_index);

BACNET_STACK_EXPORT
int rpm_ack_encode_apdu_object_property_value(
    uint8_t *apdu,
    const uint8_t *application_data,
    unsigned application_data_len);

BACNET_STACK_EXPORT
int rpm_ack_encode_apdu_object_property_error(
    uint8_t *apdu,
    BACNET_ERROR_CLASS error_class,
    BACNET_ERROR_CODE error_code);

BACNET_STACK_EXPORT
int rpm_ack_encode_apdu_object_end(uint8_t *apdu);

BACNET_STACK_EXPORT
int rpm_ack_decode_object_id(
    const uint8_t *apdu,
    unsigned apdu_len,
    BACNET_OBJECT_TYPE *object_type,
    uint32_t *object_instance);
/* is this the end of the list of this objects properties values? */
BACNET_STACK_EXPORT
int rpm_ack_decode_object_end(const uint8_t *apdu, unsigned apdu_len);
BACNET_STACK_EXPORT
int rpm_ack_decode_object_property(
    const uint8_t *apdu,
    unsigned apdu_len,
    BACNET_PROPERTY_ID *object_property,
    BACNET_ARRAY_INDEX *array_index);
BACNET_STACK_EXPORT
void rpm_ack_object_property_process(
    uint8_t *apdu,
    unsigned apdu_len,
    uint32_t device_id,
    BACNET_READ_PROPERTY_DATA *rp_data,
    read_property_ack_process callback);

#ifdef __cplusplus
}
#endif /* __cplusplus */
/** @defgroup DSRPM Data Sharing -Read Property Multiple Service (DS-RPM)
 * @ingroup DataShare
 * 15.7 ReadPropertyMultiple Service <br>
 * The ReadPropertyMultiple service is used by a client BACnet-user to request
 * the values of one or more specified properties of one or more BACnet Objects.
 * This service allows read access to any property of any object, whether a
 * BACnet-defined object or not. The user may read a single property of a single
 * object, a list of properties of a single object, or any number of properties
 * of any number of objects.
 * A 'Read Access Specification' with the property identifier ALL can be used to
 * learn the implemented properties of an object along with their values.
 */
#endif