/*####COPYRIGHTBEGIN#### ------------------------------------------- Copyright (C) 2009 Peter Mc Shane 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 READRANGE_H #define READRANGE_H #include "bacstr.h" #include "datetime.h" struct BACnet_Read_Range_Data; typedef struct BACnet_Read_Range_Data { BACNET_OBJECT_TYPE object_type; uint32_t object_instance; BACNET_PROPERTY_ID object_property; uint32_t array_index; uint8_t *application_data; int application_data_len; BACNET_BIT_STRING ResultFlags; /* FIRST_ITEM, LAST_ITEM, MORE_ITEMS */ int RequestType; /* Index, sequence or time based request */ int Overhead; /* How much space the baggage takes in the response */ uint32_t ItemCount; uint32_t FirstSequence; union { /* Pick the appropriate data type */ uint32_t RefIndex; uint32_t RefSeqNum; BACNET_DATE_TIME RefTime; } Range; int32_t Count; /* SIGNED value as +ve vs -ve is important */ BACNET_ERROR_CLASS error_class; BACNET_ERROR_CODE error_code; } BACNET_READ_RANGE_DATA; /* Defines to indicate which type of read range request it is Not really a bit map but we do it like this to allow quick checking of request against capabilities for the property */ #define RR_BY_POSITION 1 #define RR_BY_SEQUENCE 2 #define RR_BY_TIME 4 #define RR_READ_ALL 8 /* Read all of array - so don't send any range in the request */ #define RR_ARRAY_OF_LISTS 16 /* For info functionality indicates array of lists if set */ /* Bit String Enumerations */ typedef enum { RESULT_FLAG_FIRST_ITEM = 0, RESULT_FLAG_LAST_ITEM = 1, RESULT_FLAG_MORE_ITEMS = 2 } BACNET_RESULT_FLAGS; /* Defines for ReadRange packet overheads to allow us to determine how * much space is left for actual payload: * * Overhead is comprised of: * 1. PDU Type + invoke ID + service type = 3 bytes * 2. Object ID = 5 bytes * 3. Object Property = 2 bytes if property is 0-255, 3 if property is * 256-65535 – theoretical max of 5 bytes but how likely is that? * 4. Optional array index = 2 bytes if index is 0-255, 3 if index is * 256-65535 – theoretical max of 5 bytes but how likely is that? * 5. Flags = 3 bytes * 6. Opening and closing tag for data = 2 bytes * 7. firstSequenceNumber [6] Unsigned32 OPTIONAL -- used only if 'Item Count' > 0 * and the request was either of type 'By Sequence Number' or 'By Time' * = minimum of 2 bytes, maximum of 5 bytes. * * These figures give an absolute worst-case overhead of 28 bytes. A less * conservative value (if we assume object property is 3 bytes and array * index is 3 bytes) is 24. */ /* This is the fixed part of the overhead before we check for array and * first sequence number requirements. again if you are really paranoid * use a value of 18 */ #define RR_OVERHEAD 16 #define RR_1ST_SEQ_OVERHEAD 5 #define RR_INDEX_OVERHEAD 3 /* or 5 if paranoid */ /* Define pointer to function type for handling ReadRange request. This function will take the following parameters: 1. A pointer to a buffer of at least MAX_APDU bytes to build the response in. 2. A pointer to a BACNET_READ_RANGE_DATA structure with all the request information in it. The function is responsible for applying the request to the property in question and returning the response. */ typedef int (*rr_handler_function) ( uint8_t *apdu, BACNET_READ_RANGE_DATA *pRequest); /* Structure to return the type of requests a given object property can * accept and the address of the function to handle the request */ typedef struct rrpropertyinfo { int RequestTypes; rr_handler_function Handler; } RR_PROP_INFO; /* Function pointer for ReadRange information retrieval function */ typedef bool (*rr_info_function) ( BACNET_READ_RANGE_DATA *pRequest, /* Info on the request */ RR_PROP_INFO *pInfo); /* Where to write the response to */ int rr_encode_apdu( uint8_t * apdu, uint8_t invoke_id, BACNET_READ_RANGE_DATA * rrdata); int rr_decode_service_request( uint8_t * apdu, unsigned apdu_len, BACNET_READ_RANGE_DATA * rrdata); int rr_ack_encode_apdu( uint8_t * apdu, uint8_t invoke_id, BACNET_READ_RANGE_DATA * rrdata); int rr_ack_decode_service_request( uint8_t * apdu, int apdu_len, /* total length of the apdu */ BACNET_READ_RANGE_DATA * rrdata); uint8_t Send_ReadRange_Request( uint32_t device_id, /* destination device */ BACNET_READ_RANGE_DATA * read_access_data); #endif