skarg
928 lines
29 KiB
C
928 lines
29 KiB
C
/**
|
|
* @file
|
|
* @author Nikola Jelic
|
|
* @date 2014
|
|
* @brief Command objects, customize for your use
|
|
*
|
|
* @section DESCRIPTION
|
|
*
|
|
* The Command object type defines a standardized object whose
|
|
* properties represent the externally visible characteristics of a
|
|
* multi-action command procedure. A Command object is used to
|
|
* write a set of values to a group of object properties, based on
|
|
* the "action code" that is written to the Present_Value of the
|
|
* Command object. Whenever the Present_Value property of the
|
|
* Command object is written to, it triggers the Command object
|
|
* to take a set of actions that change the values of a set of other
|
|
* objects' properties.
|
|
*
|
|
* @section LICENSE
|
|
*
|
|
* Copyright (C) 2014 Nikola Jelic <nikola.jelic@euroicc.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.
|
|
*/
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
#include <stdio.h>
|
|
|
|
#include "bacdef.h"
|
|
#include "bacdcode.h"
|
|
#include "bacenum.h"
|
|
#include "bactext.h"
|
|
#include "config.h" /* the custom stuff */
|
|
#include "device.h"
|
|
#include "handlers.h"
|
|
#include "proplist.h"
|
|
#include "timestamp.h"
|
|
#include "command.h"
|
|
|
|
int cl_encode_apdu(
|
|
uint8_t * apdu,
|
|
BACNET_ACTION_LIST * bcl)
|
|
{
|
|
int len = 0;
|
|
int apdu_len = 0;
|
|
|
|
if (bcl->Device_Id.instance >= 0 &&
|
|
bcl->Device_Id.instance <= BACNET_MAX_INSTANCE) {
|
|
len =
|
|
encode_context_object_id(&apdu[apdu_len], 0, bcl->Device_Id.type,
|
|
bcl->Device_Id.instance);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
apdu_len += len;
|
|
}
|
|
/* TODO: Check for object type and instance limits */
|
|
len =
|
|
encode_context_object_id(&apdu[apdu_len], 1, bcl->Object_Id.type,
|
|
bcl->Object_Id.instance);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
apdu_len += len;
|
|
len =
|
|
encode_context_enumerated(&apdu[apdu_len], 2,
|
|
bcl->Property_Identifier);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
apdu_len += len;
|
|
if (bcl->Property_Array_Index != BACNET_ARRAY_ALL) {
|
|
len =
|
|
encode_context_unsigned(&apdu[apdu_len], 3,
|
|
bcl->Property_Array_Index);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
apdu_len += len;
|
|
}
|
|
len = bacapp_encode_context_data_value(&apdu[apdu_len], 4, &bcl->Value);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
apdu_len += len;
|
|
if (bcl->Priority != BACNET_NO_PRIORITY) {
|
|
len = encode_context_unsigned(&apdu[apdu_len], 5, bcl->Priority);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
apdu_len += len;
|
|
}
|
|
if (bcl->Post_Delay != 0xFFFFFFFFU) {
|
|
len = encode_context_unsigned(&apdu[apdu_len], 6, bcl->Post_Delay);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
apdu_len += len;
|
|
}
|
|
len = encode_context_boolean(&apdu[apdu_len], 7, bcl->Quit_On_Failure);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
apdu_len += len;
|
|
len = encode_context_boolean(&apdu[apdu_len], 8, bcl->Write_Successful);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
apdu_len += len;
|
|
|
|
return apdu_len;
|
|
}
|
|
|
|
int cl_decode_apdu(
|
|
uint8_t * apdu,
|
|
unsigned apdu_len,
|
|
BACNET_APPLICATION_TAG tag,
|
|
BACNET_ACTION_LIST * bcl)
|
|
{
|
|
int len = 0;
|
|
int dec_len = 0;
|
|
uint8_t tag_number = 0;
|
|
uint32_t len_value_type = 0;
|
|
|
|
if (decode_is_context_tag(&apdu[dec_len], 0)) {
|
|
/* Tag 0: Device ID */
|
|
dec_len++;
|
|
len =
|
|
decode_object_id(&apdu[dec_len], &bcl->Device_Id.type,
|
|
&bcl->Device_Id.instance);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
dec_len += len;
|
|
}
|
|
if (!decode_is_context_tag(&apdu[dec_len++], 1))
|
|
return BACNET_STATUS_REJECT;
|
|
len =
|
|
decode_object_id(&apdu[dec_len], &bcl->Object_Id.type,
|
|
&bcl->Object_Id.instance);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
dec_len += len;
|
|
len =
|
|
decode_tag_number_and_value(&apdu[dec_len], &tag_number,
|
|
&len_value_type);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
dec_len += len;
|
|
if (tag_number != 2)
|
|
return BACNET_STATUS_REJECT;
|
|
len =
|
|
decode_enumerated(&apdu[dec_len], len_value_type,
|
|
&bcl->Property_Identifier);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
dec_len += len;
|
|
if (decode_is_context_tag(&apdu[dec_len], 3)) {
|
|
len =
|
|
decode_tag_number_and_value(&apdu[dec_len], &tag_number,
|
|
&len_value_type);
|
|
dec_len += len;
|
|
len =
|
|
decode_unsigned(&apdu[dec_len], len_value_type,
|
|
&bcl->Property_Array_Index);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
dec_len += len;
|
|
} else {
|
|
bcl->Property_Array_Index = BACNET_ARRAY_ALL;
|
|
}
|
|
if (!decode_is_context_tag(&apdu[dec_len], 4))
|
|
return BACNET_STATUS_REJECT;
|
|
bcl->Value.context_specific = true;
|
|
bcl->Value.context_tag = 4;
|
|
bcl->Value.tag = tag;
|
|
switch (tag) {
|
|
case BACNET_APPLICATION_TAG_NULL:
|
|
len = 1;
|
|
break;
|
|
case BACNET_APPLICATION_TAG_BOOLEAN:
|
|
len =
|
|
decode_context_boolean2(&apdu[dec_len], 4,
|
|
&bcl->Value.type.Boolean);
|
|
break;
|
|
case BACNET_APPLICATION_TAG_UNSIGNED_INT:
|
|
len =
|
|
decode_context_unsigned(&apdu[dec_len], 4,
|
|
&bcl->Value.type.Unsigned_Int);
|
|
break;
|
|
case BACNET_APPLICATION_TAG_SIGNED_INT:
|
|
len =
|
|
decode_context_signed(&apdu[dec_len], 4,
|
|
&bcl->Value.type.Signed_Int);
|
|
break;
|
|
case BACNET_APPLICATION_TAG_REAL:
|
|
len =
|
|
decode_context_real(&apdu[dec_len], 4, &bcl->Value.type.Real);
|
|
break;
|
|
case BACNET_APPLICATION_TAG_DOUBLE:
|
|
len =
|
|
decode_context_double(&apdu[dec_len], 4,
|
|
&bcl->Value.type.Double);
|
|
break;
|
|
case BACNET_APPLICATION_TAG_OCTET_STRING:
|
|
len =
|
|
decode_context_octet_string(&apdu[dec_len], 4,
|
|
&bcl->Value.type.Octet_String);
|
|
break;
|
|
case BACNET_APPLICATION_TAG_CHARACTER_STRING:
|
|
len =
|
|
decode_context_character_string(&apdu[dec_len], 4,
|
|
&bcl->Value.type.Character_String);
|
|
break;
|
|
case BACNET_APPLICATION_TAG_BIT_STRING:
|
|
len =
|
|
decode_context_bitstring(&apdu[dec_len], 4,
|
|
&bcl->Value.type.Bit_String);
|
|
break;
|
|
case BACNET_APPLICATION_TAG_ENUMERATED:
|
|
len =
|
|
decode_context_enumerated(&apdu[dec_len], 4,
|
|
&bcl->Value.type.Enumerated);
|
|
break;
|
|
case BACNET_APPLICATION_TAG_DATE:
|
|
len =
|
|
decode_context_date(&apdu[dec_len], 4, &bcl->Value.type.Date);
|
|
break;
|
|
case BACNET_APPLICATION_TAG_TIME:
|
|
len =
|
|
decode_context_bacnet_time(&apdu[dec_len], 4,
|
|
&bcl->Value.type.Time);
|
|
break;
|
|
case BACNET_APPLICATION_TAG_OBJECT_ID:
|
|
len =
|
|
decode_context_object_id(&apdu[dec_len], 4,
|
|
&bcl->Value.type.Object_Id.type,
|
|
&bcl->Value.type.Object_Id.instance);
|
|
break;
|
|
case BACNET_APPLICATION_TAG_LIGHTING_COMMAND:
|
|
len =
|
|
lighting_command_decode(&apdu[dec_len], apdu_len - dec_len,
|
|
&bcl->Value.type.Lighting_Command);
|
|
break;
|
|
default:
|
|
return BACNET_STATUS_REJECT;
|
|
break;
|
|
}
|
|
if (len > 0)
|
|
dec_len += len;
|
|
if (decode_is_context_tag(&apdu[dec_len], 5)) {
|
|
uint32_t priority_dec;
|
|
len =
|
|
decode_tag_number_and_value(&apdu[dec_len], &tag_number,
|
|
&len_value_type);
|
|
dec_len += len;
|
|
len = decode_unsigned(&apdu[dec_len], len_value_type, &priority_dec);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
bcl->Priority = (uint8_t) priority_dec;
|
|
dec_len += len;
|
|
} else {
|
|
bcl->Priority = BACNET_NO_PRIORITY;
|
|
}
|
|
if (decode_is_context_tag(&apdu[dec_len], 6)) {
|
|
len =
|
|
decode_tag_number_and_value(&apdu[dec_len], &tag_number,
|
|
&len_value_type);
|
|
dec_len += len;
|
|
len =
|
|
decode_unsigned(&apdu[dec_len], len_value_type, &bcl->Post_Delay);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
dec_len += len;
|
|
} else {
|
|
bcl->Post_Delay = 0xFFFFFFFFU;
|
|
}
|
|
if (!decode_is_context_tag(&apdu[dec_len], 7)) {
|
|
return BACNET_STATUS_REJECT;
|
|
}
|
|
len = decode_context_boolean2(&apdu[dec_len], 7, &bcl->Quit_On_Failure);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
dec_len += len;
|
|
if (!decode_is_context_tag(&apdu[dec_len], 8)) {
|
|
return BACNET_STATUS_REJECT;
|
|
}
|
|
len = decode_context_boolean2(&apdu[dec_len], 8, &bcl->Write_Successful);
|
|
if (len < 0)
|
|
return BACNET_STATUS_REJECT;
|
|
dec_len += len;
|
|
if (dec_len < apdu_len) {
|
|
return BACNET_STATUS_REJECT;
|
|
}
|
|
|
|
return dec_len;
|
|
}
|
|
|
|
COMMAND_DESCR Command_Descr[MAX_COMMANDS];
|
|
|
|
/* These arrays are used by the ReadPropertyMultiple handler */
|
|
static const int Properties_Optional[] = {
|
|
PROP_DESCRIPTION,
|
|
-1
|
|
};
|
|
|
|
static const int Properties_Proprietary[] = {
|
|
-1
|
|
};
|
|
|
|
/**
|
|
* Returns the list of required, optional, and proprietary properties.
|
|
* Used by ReadPropertyMultiple service.
|
|
*
|
|
* @param pRequired - pointer to list of int terminated by -1, of
|
|
* BACnet required properties for this object.
|
|
* @param pOptional - pointer to list of int terminated by -1, of
|
|
* BACnet optkional properties for this object.
|
|
* @param pProprietary - pointer to list of int terminated by -1, of
|
|
* BACnet proprietary properties for this object.
|
|
*/
|
|
void Command_Property_Lists(
|
|
const int **pRequired,
|
|
const int **pOptional,
|
|
const int **pProprietary)
|
|
{
|
|
if (pRequired)
|
|
*pRequired = property_list_required(OBJECT_COMMAND);
|
|
if (pOptional)
|
|
*pOptional = Properties_Optional;
|
|
if (pProprietary)
|
|
*pProprietary = Properties_Proprietary;
|
|
|
|
return;
|
|
}
|
|
|
|
|
|
/**
|
|
* Initializes the Command object data
|
|
*/
|
|
void Command_Init(
|
|
void)
|
|
{
|
|
unsigned i;
|
|
for (i = 0; i < MAX_COMMANDS; i++) {
|
|
Command_Descr[i].Present_Value = 0;
|
|
Command_Descr[i].In_Process = false;
|
|
Command_Descr[i].All_Writes_Successful = true; /* Optimistic default */
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Determines if a given object instance is valid
|
|
*
|
|
* @param object_instance - object-instance number of the object
|
|
*
|
|
* @return true if the instance is valid, and false if not
|
|
*/
|
|
bool Command_Valid_Instance(
|
|
uint32_t object_instance)
|
|
{
|
|
unsigned int index;
|
|
|
|
index = Command_Instance_To_Index(object_instance);
|
|
if (index < MAX_COMMANDS)
|
|
return true;
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Determines the number of this object instances
|
|
*
|
|
* @return Number of objects
|
|
*/
|
|
unsigned Command_Count(
|
|
void)
|
|
{
|
|
return MAX_COMMANDS;
|
|
}
|
|
|
|
/**
|
|
* Determines the object instance-number for a given 0..N index
|
|
* of objects where N is the total number of this object instances.
|
|
*
|
|
* @param index - 0..total number of this object instances
|
|
*
|
|
* @return object instance-number for the given index
|
|
*/
|
|
uint32_t Command_Index_To_Instance(
|
|
unsigned index)
|
|
{
|
|
return index;
|
|
}
|
|
|
|
/**
|
|
* For a given object instance-number, determines a 0..N index
|
|
* of this object where N is the total number of this object instances
|
|
*
|
|
* @param object_instance - object-instance number of the object.
|
|
*
|
|
* @return index for the given instance-number, or
|
|
* the total number of this object instances if not valid.
|
|
*/
|
|
unsigned Command_Instance_To_Index(
|
|
uint32_t object_instance)
|
|
{
|
|
unsigned index = MAX_COMMANDS;
|
|
|
|
if (object_instance < MAX_COMMANDS)
|
|
index = object_instance;
|
|
|
|
return index;
|
|
}
|
|
|
|
/**
|
|
* For a given object instance-number, determines the present-value
|
|
*
|
|
* @param object_instance - object-instance number of the object
|
|
*
|
|
* @return present-value of the object
|
|
*/
|
|
uint32_t Command_Present_Value(
|
|
uint32_t object_instance)
|
|
{
|
|
uint32_t value = 0;
|
|
unsigned int index;
|
|
|
|
index = Command_Instance_To_Index(object_instance);
|
|
if (index < MAX_COMMANDS) {
|
|
value = Command_Descr[index].Present_Value;
|
|
}
|
|
|
|
return value;
|
|
}
|
|
|
|
/**
|
|
* For a given object instance-number, sets the present-value
|
|
*
|
|
* @param object_instance - object-instance number of the object
|
|
* @param value - present-value to set
|
|
*
|
|
* @return true if values are within range and present-value is set.
|
|
*/
|
|
bool Command_Present_Value_Set(
|
|
uint32_t object_instance,
|
|
uint32_t value)
|
|
{
|
|
bool status = false;
|
|
unsigned int index;
|
|
|
|
index = Command_Instance_To_Index(object_instance);
|
|
if (index < MAX_COMMANDS) {
|
|
Command_Descr[index].Present_Value = value;
|
|
status = true;
|
|
}
|
|
|
|
return status;
|
|
}
|
|
|
|
/**
|
|
* For a given object instance-number, determines if the command
|
|
* is in-process. This true value indicates that the Command object has
|
|
* begun processing one of a set of action sequences. Once all of the
|
|
* writes have been attempted by the Command object, the In_Process
|
|
* property shall be set back to false.
|
|
*
|
|
* @param object_instance - object-instance number of the object
|
|
*
|
|
* @return true if this object-instance is in-process.
|
|
*/
|
|
bool Command_In_Process(
|
|
uint32_t object_instance)
|
|
{
|
|
bool value = false;
|
|
unsigned int index;
|
|
|
|
index = Command_Instance_To_Index(object_instance);
|
|
if (index < MAX_COMMANDS) {
|
|
value = Command_Descr[index].In_Process;
|
|
}
|
|
|
|
return value;
|
|
}
|
|
|
|
/**
|
|
* For a given object instance-number, sets the command in-process value.
|
|
*
|
|
* @param object_instance - object-instance number of the object
|
|
* @param value - true or false value to set
|
|
*
|
|
* @return true if values are within range and in-process flag is set.
|
|
*/
|
|
bool Command_In_Process_Set(
|
|
uint32_t object_instance,
|
|
bool value)
|
|
{
|
|
bool status = false;
|
|
unsigned int index;
|
|
|
|
index = Command_Instance_To_Index(object_instance);
|
|
if (index < MAX_COMMANDS) {
|
|
Command_Descr[index].In_Process = value;
|
|
status = true;
|
|
}
|
|
|
|
return status;
|
|
}
|
|
|
|
/**
|
|
* For a given object instance-number, indicates the success or failure
|
|
* of the sequence of actions that are triggered when the Present_Value
|
|
* property is written to.
|
|
*
|
|
* @param object_instance - object-instance number of the object
|
|
*
|
|
* @return true if all writes were successful for this object-instance
|
|
*/
|
|
bool Command_All_Writes_Successful(
|
|
uint32_t object_instance)
|
|
{
|
|
bool value = false;
|
|
unsigned int index;
|
|
|
|
index = Command_Instance_To_Index(object_instance);
|
|
if (index < MAX_COMMANDS) {
|
|
value = Command_Descr[index].All_Writes_Successful;
|
|
}
|
|
|
|
return value;
|
|
}
|
|
|
|
/**
|
|
* For a given object instance-number, sets the all-writes-successful value.
|
|
*
|
|
* @param object_instance - object-instance number of the object
|
|
* @param value - true or false value to set
|
|
*
|
|
* @return true if values are within range and all-writes-succcessful is set.
|
|
*/
|
|
bool Command_All_Writes_Successful_Set(
|
|
uint32_t object_instance,
|
|
bool value)
|
|
{
|
|
bool status = false;
|
|
unsigned int index;
|
|
|
|
index = Command_Instance_To_Index(object_instance);
|
|
if (index < MAX_COMMANDS) {
|
|
Command_Descr[index].All_Writes_Successful = value;
|
|
status = true;
|
|
}
|
|
|
|
return status;
|
|
}
|
|
|
|
/**
|
|
* For a given object instance-number, loads the object-name into
|
|
* a characterstring.
|
|
*
|
|
* @param object_instance - object-instance number of the object
|
|
* @param object_name - holds the object-name retrieved
|
|
*
|
|
* @return true if object-name was retrieved
|
|
*/
|
|
bool Command_Object_Name(
|
|
uint32_t object_instance,
|
|
BACNET_CHARACTER_STRING * object_name)
|
|
{
|
|
static char text_string[32] = ""; /* okay for single thread */
|
|
unsigned int index;
|
|
bool status = false;
|
|
|
|
index = Command_Instance_To_Index(object_instance);
|
|
if (index < MAX_COMMANDS) {
|
|
sprintf(text_string, "COMMAND %lu", (unsigned long) index);
|
|
status = characterstring_init_ansi(object_name, text_string);
|
|
}
|
|
|
|
return status;
|
|
}
|
|
|
|
/**
|
|
* ReadProperty handler for this object. For the given ReadProperty
|
|
* data, the application_data is loaded or the error flags are set.
|
|
*
|
|
* @param rpdata - BACNET_READ_PROPERTY_DATA data, including
|
|
* requested data and space for the reply, or error response.
|
|
*
|
|
* @return number of APDU bytes in the response, or
|
|
* BACNET_STATUS_ERROR on error.
|
|
*/
|
|
int Command_Read_Property(
|
|
BACNET_READ_PROPERTY_DATA * rpdata)
|
|
{
|
|
int apdu_len = 0; /* return value */
|
|
int len = 0;
|
|
BACNET_CHARACTER_STRING char_string;
|
|
unsigned object_index = 0;
|
|
uint8_t *apdu = NULL;
|
|
uint16_t apdu_max = 0;
|
|
COMMAND_DESCR *CurrentCommand;
|
|
const int *pRequired = NULL, *pOptional = NULL, *pProprietary = NULL;
|
|
|
|
if ((rpdata == NULL) || (rpdata->application_data == NULL) ||
|
|
(rpdata->application_data_len == 0)) {
|
|
return 0;
|
|
}
|
|
apdu_max = rpdata->application_data_len;
|
|
object_index = Command_Instance_To_Index(rpdata->object_instance);
|
|
if (object_index < MAX_COMMANDS) {
|
|
CurrentCommand = &Command_Descr[object_index];
|
|
} else {
|
|
return false;
|
|
}
|
|
|
|
apdu = rpdata->application_data;
|
|
switch ((int) rpdata->object_property) {
|
|
case PROP_OBJECT_IDENTIFIER:
|
|
apdu_len =
|
|
encode_application_object_id(&apdu[0], OBJECT_COMMAND,
|
|
rpdata->object_instance);
|
|
break;
|
|
|
|
case PROP_OBJECT_NAME:
|
|
case PROP_DESCRIPTION:
|
|
Command_Object_Name(rpdata->object_instance, &char_string);
|
|
apdu_len =
|
|
encode_application_character_string(&apdu[0], &char_string);
|
|
break;
|
|
|
|
case PROP_OBJECT_TYPE:
|
|
apdu_len = encode_application_enumerated(&apdu[0], OBJECT_COMMAND);
|
|
break;
|
|
|
|
case PROP_PRESENT_VALUE:
|
|
apdu_len =
|
|
encode_application_unsigned(&apdu[0],
|
|
Command_Present_Value(rpdata->object_instance));
|
|
break;
|
|
case PROP_IN_PROCESS:
|
|
apdu_len =
|
|
encode_application_boolean(&apdu[0],
|
|
Command_In_Process(rpdata->object_instance));
|
|
break;
|
|
case PROP_ALL_WRITES_SUCCESSFUL:
|
|
apdu_len =
|
|
encode_application_boolean(&apdu[0],
|
|
Command_All_Writes_Successful(rpdata->object_instance));
|
|
break;
|
|
case PROP_ACTION:
|
|
/* TODO */
|
|
if (rpdata->array_index == 0)
|
|
apdu_len = encode_application_unsigned(&apdu[0], MAX_COMMAND_ACTIONS);
|
|
else if (rpdata->array_index == BACNET_ARRAY_ALL) {
|
|
int i;
|
|
for (i = 0; i < MAX_COMMAND_ACTIONS; i++) {
|
|
BACNET_ACTION_LIST *Curr_CL_Member =
|
|
&CurrentCommand->Action[0];
|
|
/* another loop, for aditional actions in the list */
|
|
for (; Curr_CL_Member != NULL;
|
|
Curr_CL_Member = Curr_CL_Member->next) {
|
|
len =
|
|
cl_encode_apdu(&apdu[apdu_len],
|
|
&CurrentCommand->Action[0]);
|
|
apdu_len += len;
|
|
/* assume the next one is of the same length, which need not be the case */
|
|
if ((i != MAX_COMMAND_ACTIONS - 1) &&
|
|
(apdu_len + len) >= apdu_max) {
|
|
rpdata->error_code =
|
|
ERROR_CODE_ABORT_SEGMENTATION_NOT_SUPPORTED;
|
|
apdu_len = BACNET_STATUS_ABORT;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
if (rpdata->array_index < MAX_COMMAND_ACTIONS) {
|
|
BACNET_ACTION_LIST *Curr_CL_Member =
|
|
&CurrentCommand->Action[rpdata->array_index];
|
|
/* another loop, for aditional actions in the list */
|
|
for (; Curr_CL_Member != NULL;
|
|
Curr_CL_Member = Curr_CL_Member->next) {
|
|
len =
|
|
cl_encode_apdu(&apdu[apdu_len],
|
|
&CurrentCommand->Action[0]);
|
|
apdu_len += len;
|
|
/* assume the next one is of the same length, which need not be the case */
|
|
if ((apdu_len + len) >= apdu_max) {
|
|
rpdata->error_code =
|
|
ERROR_CODE_ABORT_SEGMENTATION_NOT_SUPPORTED;
|
|
apdu_len = BACNET_STATUS_ABORT;
|
|
break;
|
|
}
|
|
}
|
|
} else {
|
|
rpdata->error_class = ERROR_CLASS_PROPERTY;
|
|
rpdata->error_code = ERROR_CODE_INVALID_ARRAY_INDEX;
|
|
apdu_len = BACNET_STATUS_ERROR;
|
|
}
|
|
}
|
|
break;
|
|
case PROP_PROPERTY_LIST:
|
|
Command_Property_Lists(&pRequired, &pOptional, &pProprietary);
|
|
apdu_len =
|
|
property_list_encode(rpdata, pRequired, pOptional,
|
|
pProprietary);
|
|
break;
|
|
default:
|
|
rpdata->error_class = ERROR_CLASS_PROPERTY;
|
|
rpdata->error_code = ERROR_CODE_UNKNOWN_PROPERTY;
|
|
apdu_len = BACNET_STATUS_ERROR;
|
|
break;
|
|
}
|
|
/* only array properties can have array options */
|
|
if ((apdu_len >= 0) && (rpdata->object_property != PROP_ACTION)
|
|
&& (rpdata->object_property != PROP_PROPERTY_LIST)
|
|
&& (rpdata->array_index != BACNET_ARRAY_ALL)) {
|
|
rpdata->error_class = ERROR_CLASS_PROPERTY;
|
|
rpdata->error_code = ERROR_CODE_PROPERTY_IS_NOT_AN_ARRAY;
|
|
apdu_len = BACNET_STATUS_ERROR;
|
|
}
|
|
|
|
return apdu_len;
|
|
}
|
|
|
|
/**
|
|
* WriteProperty handler for this object. For the given WriteProperty
|
|
* data, the application_data is loaded or the error flags are set.
|
|
*
|
|
* @param wp_data - BACNET_WRITE_PROPERTY_DATA data, including
|
|
* requested data and space for the reply, or error response.
|
|
*
|
|
* @return false if an error is loaded, true if no errors
|
|
*/
|
|
bool Command_Write_Property(
|
|
BACNET_WRITE_PROPERTY_DATA * wp_data)
|
|
{
|
|
bool status = false; /* return value */
|
|
unsigned int object_index = 0;
|
|
int len = 0;
|
|
BACNET_APPLICATION_DATA_VALUE value;
|
|
/* decode the some of the request */
|
|
len =
|
|
bacapp_decode_application_data(wp_data->application_data,
|
|
wp_data->application_data_len, &value);
|
|
/* FIXME: len < application_data_len: more data? */
|
|
if (len < 0) {
|
|
/* error while decoding - a value larger than we can handle */
|
|
wp_data->error_class = ERROR_CLASS_PROPERTY;
|
|
wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE;
|
|
return false;
|
|
}
|
|
/* only array properties can have array options */
|
|
if ((wp_data->object_property != PROP_ACTION) &&
|
|
(wp_data->object_property != PROP_PROPERTY_LIST) &&
|
|
(wp_data->array_index != BACNET_ARRAY_ALL)) {
|
|
wp_data->error_class = ERROR_CLASS_PROPERTY;
|
|
wp_data->error_code = ERROR_CODE_PROPERTY_IS_NOT_AN_ARRAY;
|
|
return false;
|
|
}
|
|
object_index = Command_Instance_To_Index(wp_data->object_instance);
|
|
if (object_index >= MAX_COMMANDS) {
|
|
return false;
|
|
}
|
|
|
|
switch ((int) wp_data->object_property) {
|
|
case PROP_PRESENT_VALUE:
|
|
status =
|
|
WPValidateArgType(&value, BACNET_APPLICATION_TAG_UNSIGNED_INT,
|
|
&wp_data->error_class, &wp_data->error_code);
|
|
if (status) {
|
|
if (value.type.Unsigned_Int >= MAX_COMMAND_ACTIONS) {
|
|
wp_data->error_class = ERROR_CLASS_PROPERTY;
|
|
wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE;
|
|
return false;
|
|
}
|
|
Command_Present_Value_Set(wp_data->object_instance,
|
|
value.type.Unsigned_Int);
|
|
} else {
|
|
wp_data->error_class = ERROR_CLASS_PROPERTY;
|
|
wp_data->error_code = ERROR_CODE_WRITE_ACCESS_DENIED;
|
|
status = false;
|
|
}
|
|
|
|
break;
|
|
|
|
case PROP_OBJECT_IDENTIFIER:
|
|
case PROP_OBJECT_NAME:
|
|
case PROP_OBJECT_TYPE:
|
|
case PROP_IN_PROCESS:
|
|
case PROP_ALL_WRITES_SUCCESSFUL:
|
|
case PROP_ACTION:
|
|
case PROP_PROPERTY_LIST:
|
|
wp_data->error_class = ERROR_CLASS_PROPERTY;
|
|
wp_data->error_code = ERROR_CODE_WRITE_ACCESS_DENIED;
|
|
break;
|
|
default:
|
|
wp_data->error_class = ERROR_CLASS_PROPERTY;
|
|
wp_data->error_code = ERROR_CODE_UNKNOWN_PROPERTY;
|
|
break;
|
|
}
|
|
|
|
return status;
|
|
}
|
|
|
|
void Command_Intrinsic_Reporting(
|
|
uint32_t object_instance)
|
|
{
|
|
}
|
|
|
|
#ifdef TEST
|
|
#include <assert.h>
|
|
#include <string.h>
|
|
#include "ctest.h"
|
|
|
|
bool WPValidateArgType(
|
|
BACNET_APPLICATION_DATA_VALUE * pValue,
|
|
uint8_t ucExpectedTag,
|
|
BACNET_ERROR_CLASS * pErrorClass,
|
|
BACNET_ERROR_CODE * pErrorCode)
|
|
{
|
|
bool bResult;
|
|
|
|
/*
|
|
* start out assuming success and only set up error
|
|
* response if validation fails.
|
|
*/
|
|
bResult = true;
|
|
if (pValue->tag != ucExpectedTag) {
|
|
bResult = false;
|
|
*pErrorClass = ERROR_CLASS_PROPERTY;
|
|
*pErrorCode = ERROR_CODE_INVALID_DATA_TYPE;
|
|
}
|
|
|
|
return (bResult);
|
|
}
|
|
|
|
void testCommand(
|
|
Test * pTest)
|
|
{
|
|
uint8_t apdu[MAX_APDU] = { 0 };
|
|
int len = 0;
|
|
uint32_t len_value = 0;
|
|
uint8_t tag_number = 0;
|
|
uint32_t decoded_instance = 0;
|
|
uint16_t decoded_type = 0;
|
|
BACNET_READ_PROPERTY_DATA rpdata;
|
|
BACNET_ACTION_LIST clist, clist_test;
|
|
Command_Init();
|
|
rpdata.application_data = &apdu[0];
|
|
rpdata.application_data_len = sizeof(apdu);
|
|
rpdata.object_type = OBJECT_COMMAND;
|
|
rpdata.object_instance = 1;
|
|
rpdata.object_property = PROP_OBJECT_IDENTIFIER;
|
|
rpdata.array_index = BACNET_ARRAY_ALL;
|
|
len = Command_Read_Property(&rpdata);
|
|
ct_test(pTest, len != 0);
|
|
len = decode_tag_number_and_value(&apdu[0], &tag_number, &len_value);
|
|
ct_test(pTest, tag_number == BACNET_APPLICATION_TAG_OBJECT_ID);
|
|
len = decode_object_id(&apdu[len], &decoded_type, &decoded_instance);
|
|
ct_test(pTest, decoded_type == rpdata.object_type);
|
|
ct_test(pTest, decoded_instance == rpdata.object_instance);
|
|
memset(&clist, 0, sizeof(BACNET_ACTION_LIST));
|
|
memset(&clist_test, 0, sizeof(BACNET_ACTION_LIST));
|
|
clist.Device_Id.type = OBJECT_DEVICE;
|
|
clist.Device_Id.instance = 3389;
|
|
clist.Object_Id.type = OBJECT_ANALOG_VALUE;
|
|
clist.Object_Id.instance = 42;
|
|
clist.Property_Identifier = PROP_PRESENT_VALUE;
|
|
clist.Property_Array_Index = BACNET_ARRAY_ALL;
|
|
clist.Value.tag = BACNET_APPLICATION_TAG_REAL;
|
|
clist.Value.type.Real = 39.0f;
|
|
clist.Priority = 4;
|
|
clist.Post_Delay = 0xFFFFFFFFU;
|
|
clist.Quit_On_Failure = true;
|
|
clist.Write_Successful = false;
|
|
clist.next = NULL;
|
|
len = cl_encode_apdu(apdu, &clist);
|
|
ct_test(pTest, len > 0);
|
|
len = cl_decode_apdu(apdu, len, BACNET_APPLICATION_TAG_REAL, &clist_test);
|
|
ct_test(pTest, len > 0);
|
|
ct_test(pTest, clist.Device_Id.type == clist_test.Device_Id.type);
|
|
ct_test(pTest, clist.Device_Id.instance == clist_test.Device_Id.instance);
|
|
ct_test(pTest, clist.Object_Id.type == clist_test.Object_Id.type);
|
|
ct_test(pTest, clist.Object_Id.instance == clist_test.Object_Id.instance);
|
|
ct_test(pTest,
|
|
clist.Property_Identifier == clist_test.Property_Identifier);
|
|
ct_test(pTest,
|
|
clist.Property_Array_Index == clist_test.Property_Array_Index);
|
|
ct_test(pTest, clist.Value.tag == clist_test.Value.tag);
|
|
ct_test(pTest, clist.Value.type.Real == clist_test.Value.type.Real);
|
|
ct_test(pTest, clist.Priority == clist_test.Priority);
|
|
ct_test(pTest, clist.Post_Delay == clist_test.Post_Delay);
|
|
ct_test(pTest, clist.Quit_On_Failure == clist_test.Quit_On_Failure);
|
|
ct_test(pTest, clist.Write_Successful == clist_test.Write_Successful);
|
|
return;
|
|
}
|
|
|
|
#ifdef TEST_COMMAND
|
|
int main(
|
|
void)
|
|
{
|
|
Test *pTest;
|
|
bool rc;
|
|
|
|
pTest = ct_create("BACnet Command", NULL);
|
|
/* individual tests */
|
|
rc = ct_addTestFunction(pTest, testCommand);
|
|
assert(rc);
|
|
|
|
ct_setStream(pTest, stdout);
|
|
ct_run(pTest);
|
|
(void) ct_report(pTest);
|
|
ct_destroy(pTest);
|
|
|
|
return 0;
|
|
}
|
|
#endif /* TEST_COMMAND */
|
|
#endif /* TEST */
|