mirror of
https://github.com/stargieg/bacnet-stack
synced 2025-10-26 23:35:52 +08:00
432 lines
14 KiB
C
432 lines
14 KiB
C
/**************************************************************************
|
|
*
|
|
* Copyright (C) 2006 Steve Karg <skarg@users.sourceforge.net>
|
|
*
|
|
* 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.
|
|
*
|
|
*********************************************************************/
|
|
|
|
/* Analog Value Objects - customize for your use */
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
#include <stdio.h>
|
|
|
|
#include "bacdef.h"
|
|
#include "bacdcode.h"
|
|
#include "bacenum.h"
|
|
#include "bacapp.h"
|
|
#include "config.h" /* the custom stuff */
|
|
#include "wp.h"
|
|
#include "av.h"
|
|
#include "handlers.h"
|
|
#include "hardware.h"
|
|
|
|
#ifndef MAX_ANALOG_VALUES
|
|
#define MAX_ANALOG_VALUES 2
|
|
#endif
|
|
|
|
static float Present_Value[MAX_ANALOG_VALUES];
|
|
|
|
/* These three arrays are used by the ReadPropertyMultiple handler */
|
|
static const int Analog_Value_Properties_Required[] = {
|
|
PROP_OBJECT_IDENTIFIER,
|
|
PROP_OBJECT_NAME,
|
|
PROP_OBJECT_TYPE,
|
|
PROP_PRESENT_VALUE,
|
|
PROP_STATUS_FLAGS,
|
|
PROP_EVENT_STATE,
|
|
PROP_OUT_OF_SERVICE,
|
|
PROP_UNITS,
|
|
-1
|
|
};
|
|
|
|
static const int Analog_Value_Properties_Optional[] = {
|
|
#if 0
|
|
PROP_PRIORITY_ARRAY,
|
|
PROP_RELINQUISH_DEFAULT,
|
|
#endif
|
|
-1
|
|
};
|
|
|
|
static const int Analog_Value_Properties_Proprietary[] = {
|
|
-1
|
|
};
|
|
|
|
void Analog_Value_Property_Lists(
|
|
const int **pRequired,
|
|
const int **pOptional,
|
|
const int **pProprietary)
|
|
{
|
|
if (pRequired)
|
|
*pRequired = Analog_Value_Properties_Required;
|
|
if (pOptional)
|
|
*pOptional = Analog_Value_Properties_Optional;
|
|
if (pProprietary)
|
|
*pProprietary = Analog_Value_Properties_Proprietary;
|
|
|
|
return;
|
|
}
|
|
|
|
void Analog_Value_Init(
|
|
void)
|
|
{
|
|
return;
|
|
}
|
|
|
|
/* we simply have 0-n object instances. Yours might be */
|
|
/* more complex, and then you need validate that the */
|
|
/* given instance exists */
|
|
bool Analog_Value_Valid_Instance(
|
|
uint32_t object_instance)
|
|
{
|
|
if (object_instance < MAX_ANALOG_VALUES)
|
|
return true;
|
|
|
|
return false;
|
|
}
|
|
|
|
/* we simply have 0-n object instances. Yours might be */
|
|
/* more complex, and then count how many you have */
|
|
unsigned Analog_Value_Count(
|
|
void)
|
|
{
|
|
return MAX_ANALOG_VALUES;
|
|
}
|
|
|
|
/* we simply have 0-n object instances. Yours might be */
|
|
/* more complex, and then you need to return the instance */
|
|
/* that correlates to the correct index */
|
|
uint32_t Analog_Value_Index_To_Instance(
|
|
unsigned index)
|
|
{
|
|
return index;
|
|
}
|
|
|
|
/* we simply have 0-n object instances. Yours might be */
|
|
/* more complex, and then you need to return the index */
|
|
/* that correlates to the correct instance number */
|
|
unsigned Analog_Value_Instance_To_Index(
|
|
uint32_t object_instance)
|
|
{
|
|
unsigned index = MAX_ANALOG_VALUES;
|
|
|
|
if (object_instance < MAX_ANALOG_VALUES)
|
|
index = object_instance;
|
|
|
|
return index;
|
|
}
|
|
|
|
float Analog_Value_Present_Value(
|
|
uint32_t object_instance)
|
|
{
|
|
float value = 0;
|
|
unsigned index = 0;
|
|
|
|
index = Analog_Value_Instance_To_Index(object_instance);
|
|
if (index < MAX_ANALOG_VALUES) {
|
|
value = Present_Value[index];
|
|
}
|
|
|
|
return value;
|
|
}
|
|
|
|
bool Analog_Value_Present_Value_Set(
|
|
uint32_t object_instance,
|
|
float value,
|
|
uint8_t priority)
|
|
{
|
|
unsigned index = 0;
|
|
bool status = false;
|
|
|
|
priority = priority;
|
|
index = Analog_Value_Instance_To_Index(object_instance);
|
|
if (index < MAX_ANALOG_VALUES) {
|
|
if (priority && (priority <= BACNET_MAX_PRIORITY) &&
|
|
(priority != 6 /* reserved */ ) &&
|
|
(value >= 0.0) && (value <= 100.0)) {
|
|
Present_Value[index] = value;
|
|
/* Note: you could set the physical output here if we
|
|
are the highest priority.
|
|
However, if Out of Service is TRUE, then don't set the
|
|
physical output. This comment may apply to the
|
|
main loop (i.e. check out of service before changing output) */
|
|
status = true;
|
|
}
|
|
}
|
|
return status;
|
|
}
|
|
|
|
/* note: the object name must be unique within this device */
|
|
bool Analog_Value_Object_Name(
|
|
uint32_t object_instance,
|
|
BACNET_CHARACTER_STRING * object_name)
|
|
{
|
|
static char text_string[32] = ""; /* okay for single thread */
|
|
unsigned index = 0;
|
|
bool status = false;
|
|
|
|
index = Analog_Value_Instance_To_Index(object_instance);
|
|
if (index < MAX_ANALOG_VALUES) {
|
|
sprintf(text_string, "AV-%lu", object_instance);
|
|
status = characterstring_init_ansi(object_name, text_string);
|
|
}
|
|
|
|
return status;
|
|
}
|
|
|
|
/* return apdu len, or -1 on error */
|
|
int Analog_Value_Read_Property(
|
|
BACNET_READ_PROPERTY_DATA * rpdata)
|
|
{
|
|
int apdu_len = 0; /* return value */
|
|
BACNET_BIT_STRING bit_string;
|
|
float real_value = 1.414F;
|
|
BACNET_CHARACTER_STRING char_string = { 0 };
|
|
#if 0
|
|
unsigned object_index = 0;
|
|
unsigned i = 0;
|
|
bool state = false;
|
|
#endif
|
|
uint8_t *apdu = NULL;
|
|
|
|
if ((rpdata->application_data == NULL) ||
|
|
(rpdata->application_data_len == 0)) {
|
|
return 0;
|
|
}
|
|
apdu = rpdata->application_data;
|
|
switch (rpdata->object_property) {
|
|
case PROP_OBJECT_IDENTIFIER:
|
|
apdu_len =
|
|
encode_application_object_id(&apdu[0], rpdata->object_type,
|
|
rpdata->object_instance);
|
|
break;
|
|
case PROP_OBJECT_NAME:
|
|
Analog_Value_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], rpdata->object_type);
|
|
break;
|
|
case PROP_PRESENT_VALUE:
|
|
real_value = Analog_Value_Present_Value(rpdata->object_instance);
|
|
apdu_len = encode_application_real(&apdu[0], real_value);
|
|
break;
|
|
case PROP_STATUS_FLAGS:
|
|
bitstring_init(&bit_string);
|
|
bitstring_set_bit(&bit_string, STATUS_FLAG_IN_ALARM, false);
|
|
bitstring_set_bit(&bit_string, STATUS_FLAG_FAULT, false);
|
|
bitstring_set_bit(&bit_string, STATUS_FLAG_OVERRIDDEN, false);
|
|
bitstring_set_bit(&bit_string, STATUS_FLAG_OUT_OF_SERVICE, false);
|
|
apdu_len = encode_application_bitstring(&apdu[0], &bit_string);
|
|
break;
|
|
case PROP_EVENT_STATE:
|
|
apdu_len =
|
|
encode_application_enumerated(&apdu[0], EVENT_STATE_NORMAL);
|
|
break;
|
|
case PROP_OUT_OF_SERVICE:
|
|
#if 0
|
|
object_index =
|
|
Analog_Value_Instance_To_Index(rpdata->object_instance);
|
|
state = Analog_Value_Out_Of_Service[object_index];
|
|
#endif
|
|
apdu_len = encode_application_boolean(&apdu[0], false);
|
|
break;
|
|
case PROP_UNITS:
|
|
apdu_len = encode_application_enumerated(&apdu[0], UNITS_PERCENT);
|
|
break;
|
|
#if 0
|
|
case PROP_PRIORITY_ARRAY:
|
|
/* Array element zero is the number of elements in the array */
|
|
if (rpdata->array_index == 0)
|
|
apdu_len =
|
|
encode_application_unsigned(&apdu[0], BACNET_MAX_PRIORITY);
|
|
/* if no index was specified, then try to encode the entire list */
|
|
/* into one packet. */
|
|
else if (rpdata->array_index == BACNET_ARRAY_ALL) {
|
|
object_index = Analog_Value_Instance_To_Index(object_instance);
|
|
for (i = 0; i < BACNET_MAX_PRIORITY; i++) {
|
|
/* FIXME: check if we have room before adding it to APDU */
|
|
if (Present_Value[object_index][i] == ANALOG_LEVEL_NULL)
|
|
len = encode_application_null(&apdu[apdu_len]);
|
|
else {
|
|
real_value = Present_Value[object_index][i];
|
|
len =
|
|
encode_application_real(&apdu[apdu_len],
|
|
real_value);
|
|
}
|
|
/* add it if we have room */
|
|
if ((apdu_len + len) < MAX_APDU)
|
|
apdu_len += len;
|
|
else {
|
|
rpdata->error_code =
|
|
ERROR_CODE_ABORT_SEGMENTATION_NOT_SUPPORTED;
|
|
apdu_len = BACNET_STATUS_ABORT;
|
|
break;
|
|
}
|
|
}
|
|
} else {
|
|
object_index =
|
|
Analog_Value_Instance_To_Index(rpdata->object_instance);
|
|
if (rpdata->array_index <= BACNET_MAX_PRIORITY) {
|
|
if (Present_Value[object_index][rpdata->array_index - 1] ==
|
|
ANALOG_LEVEL_NULL)
|
|
apdu_len = encode_application_null(&apdu[0]);
|
|
else {
|
|
real_value =
|
|
Present_Value[object_index][rpdata->array_index -
|
|
1];
|
|
apdu_len =
|
|
encode_application_real(&apdu[0], real_value);
|
|
}
|
|
} else {
|
|
rpdata->error_class = ERROR_CLASS_PROPERTY;
|
|
rpdata->error_code = ERROR_CODE_INVALID_ARRAY_INDEX;
|
|
apdu_len = BACNET_STATUS_ERROR;
|
|
}
|
|
}
|
|
|
|
break;
|
|
case PROP_RELINQUISH_DEFAULT:
|
|
real_value = ANALOG_RELINQUISH_DEFAULT;
|
|
apdu_len = encode_application_real(&apdu[0], real_value);
|
|
break;
|
|
#endif
|
|
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) &&
|
|
#if 0
|
|
(rpdata->object_property != PROP_PRIORITY_ARRAY) &&
|
|
#endif
|
|
(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;
|
|
}
|
|
|
|
/* returns true if successful */
|
|
bool Analog_Value_Write_Property(
|
|
BACNET_WRITE_PROPERTY_DATA * wp_data)
|
|
{
|
|
bool status = false; /* return value */
|
|
#if 0
|
|
unsigned int object_index = 0;
|
|
unsigned int priority = 0;
|
|
#endif
|
|
BACNET_APPLICATION_DATA_VALUE value;
|
|
int len = 0;
|
|
|
|
/* 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;
|
|
}
|
|
if ((wp_data->object_property != PROP_PRIORITY_ARRAY) &&
|
|
(wp_data->array_index != BACNET_ARRAY_ALL)) {
|
|
/* only array properties can have array options */
|
|
wp_data->error_class = ERROR_CLASS_PROPERTY;
|
|
wp_data->error_code = ERROR_CODE_PROPERTY_IS_NOT_AN_ARRAY;
|
|
return false;
|
|
}
|
|
switch (wp_data->object_property) {
|
|
case PROP_PRESENT_VALUE:
|
|
status =
|
|
WPValidateArgType(&value, BACNET_APPLICATION_TAG_REAL,
|
|
&wp_data->error_class, &wp_data->error_code);
|
|
if (status) {
|
|
status =
|
|
Analog_Value_Present_Value_Set(wp_data->object_instance,
|
|
value.type.Real, wp_data->priority);
|
|
if (!status) {
|
|
if (wp_data->priority == 6) {
|
|
/* Command priority 6 is reserved for use by Minimum On/Off
|
|
algorithm and may not be used for other purposes in any
|
|
object. */
|
|
wp_data->error_class = ERROR_CLASS_PROPERTY;
|
|
wp_data->error_code = ERROR_CODE_WRITE_ACCESS_DENIED;
|
|
} else {
|
|
wp_data->error_class = ERROR_CLASS_PROPERTY;
|
|
wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE;
|
|
}
|
|
}
|
|
}
|
|
break;
|
|
case PROP_OUT_OF_SERVICE:
|
|
#if 0
|
|
status =
|
|
WPValidateArgType(&value, BACNET_APPLICATION_TAG_BOOLEAN,
|
|
&wp_data->error_class, &wp_data->error_code);
|
|
if (status) {
|
|
object_index =
|
|
Analog_Value_Instance_To_Index(wp_data->object_instance);
|
|
Analog_Value_Out_Of_Service[object_index] = value.type.Boolean;
|
|
}
|
|
break;
|
|
#endif
|
|
case PROP_UNITS:
|
|
#if 0
|
|
status =
|
|
WPValidateArgType(&value, BACNET_APPLICATION_TAG_UNSIGNED_INT,
|
|
&wp_data->error_class, &wp_data->error_code);
|
|
if (status) {
|
|
object_index =
|
|
Analog_Value_Instance_To_Index(wp_data->object_instance);
|
|
Analog_Value_Units[object_index] = value.type.Unsigned_Int;
|
|
}
|
|
break;
|
|
#endif
|
|
case PROP_PRIORITY_ARRAY:
|
|
case PROP_OBJECT_IDENTIFIER:
|
|
case PROP_OBJECT_NAME:
|
|
case PROP_OBJECT_TYPE:
|
|
case PROP_STATUS_FLAGS:
|
|
case PROP_EVENT_STATE:
|
|
case PROP_DESCRIPTION:
|
|
wp_data->error_class = ERROR_CLASS_PROPERTY;
|
|
wp_data->error_code = ERROR_CODE_WRITE_ACCESS_DENIED;
|
|
break;
|
|
case PROP_RELINQUISH_DEFAULT:
|
|
default:
|
|
wp_data->error_class = ERROR_CLASS_PROPERTY;
|
|
wp_data->error_code = ERROR_CODE_UNKNOWN_PROPERTY;
|
|
break;
|
|
}
|
|
/* not using len at this time */
|
|
len = len;
|
|
|
|
return status;
|
|
}
|