--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/bacnet/runtime/bo.c Fri Jun 08 13:28:00 2018 +0200
@@ -0,0 +1,567 @@
+/**************************************************************************
+*
+* Copyright (C) 2006 Steve Karg <skarg@users.sourceforge.net>
+* Copyright (C) 2017 Mario de Sousa <msousa@fe.up.pt>
+*
+* 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.
+*
+*********************************************************************/
+
+/* Binary Output Objects - customize for your use */
+
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdio.h>
+
+#include "config_bacnet_for_beremiz_%(locstr)s.h" /* the custom configuration for beremiz plugin */
+#include "bacdef.h"
+#include "bacdcode.h"
+#include "bacenum.h"
+#include "bacapp.h"
+#include "wp.h"
+#include "rp.h"
+#include "bo_%(locstr)s.h"
+#include "handlers.h"
+
+/* we choose to have a NULL level in our system represented by */
+/* a particular value. When the priorities are not in use, they */
+/* will be relinquished (i.e. set to the NULL level). */
+// BINARY_NULL
+/* test whether value is NULL */
+#define BINARY_OUTPUT_IS_NULL(x) ((x) == BINARY_NULL)
+
+/* When all the priorities are level null, the present value returns
+ * the Relinquish Default value
+ */
+#define BO_VALUE_RELINQUISH_DEFAULT BINARY_INACTIVE
+
+/* The IEC 61131-3 located variables mapped onto the Binary Output objects of BACnet protocol */
+%(BO_lvars)s
+
+
+/* The array where we keep all the state related to the Binary Output Objects */
+#define MAX_BINARY_OUTPUTS %(BO_count)s
+static BINARY_OUTPUT_DESCR BO_Descr[MAX_BINARY_OUTPUTS] = {
+%(BO_param)s
+};
+
+
+
+
+/* These three arrays are used by the ReadPropertyMultiple handler,
+ * as well as to initialize the XXX_Property_List used by the
+ * Property List (PROP_PROPERTY_LIST) property.
+ */
+static const int Binary_Output_Properties_Required[] = {
+ /* (1) Currently Supported */
+ /* (2) Required by standard ASHRAE 135-2016 */
+ /*(1)(2) */
+ PROP_OBJECT_IDENTIFIER, /* R R ( 75) */
+ PROP_OBJECT_NAME, /* R R ( 77) */
+ PROP_OBJECT_TYPE, /* R R ( 79) */
+ PROP_PRESENT_VALUE, /* W W ( 85) */
+ PROP_STATUS_FLAGS, /* R R (111) */
+ PROP_EVENT_STATE, /* R R ( 36) */
+ PROP_OUT_OF_SERVICE, /* W R ( 81) */
+ PROP_POLARITY, /* R R ( 84) */
+ PROP_PRIORITY_ARRAY, /* R R ( 87) */
+ PROP_RELINQUISH_DEFAULT, /* R R (104) */
+// PROP_PROPERTY_LIST, /* R R (371) */
+// PROP_CURRENT_COMMAND_PRIORITY,/* R R (431) */
+ -1
+};
+
+static const int Binary_Output_Properties_Optional[] = {
+ /* (1) Currently Supported */
+ /* (2) Required by standard ASHRAE 135-2016 */
+ /*(1)(2) */
+ PROP_DESCRIPTION, /* R O ( 28) */
+ -1
+};
+
+static const int Binary_Output_Properties_Proprietary[] = {
+ -1
+};
+
+
+/* This array stores the PROPERTY_LIST which may be read by clients.
+ * End of list is marked by following the last element with the value '-1'
+ *
+ * It is initialized by Binary_Output_Init() based off the values
+ * stored in Binary_Output_Properties_Required
+ * Binary_Output_Properties_Optional
+ * Binary_Output_Properties_Proprietary
+ */
+/* TODO: Allocate memory for this array with malloc() at startup */
+static int Binary_Output_Properties_List[64];
+
+
+
+
+
+/********************************************************/
+/** Callback functions. **/
+/** Functions required by BACnet devie implementation. **/
+/********************************************************/
+
+
+/* This is a callback function. Callback set in My_Object_Table[] array declared in device.c, */
+void Binary_Output_Property_Lists(
+ const int **pRequired,
+ const int **pOptional,
+ const int **pProprietary)
+{
+ if (pRequired)
+ *pRequired = Binary_Output_Properties_Required;
+ if (pOptional)
+ *pOptional = Binary_Output_Properties_Optional;
+ if (pProprietary)
+ *pProprietary = Binary_Output_Properties_Proprietary;
+
+ return;
+}
+
+
+/* This is a callback function. Callback set in My_Object_Table[] array declared in device.c, */
+void Binary_Output_Init(
+ void)
+{
+ unsigned i, j;
+ static bool initialized = false;
+
+ // fprintf(stderr, "BACnet plugin: Binary_Output_Init() called!\n");
+
+ if (!initialized) {
+ initialized = true;
+
+ /* initialize the Binary_Output_Properties_List array */
+ int len = 0;
+ len += BACnet_Init_Properties_List(Binary_Output_Properties_List + len,
+ Binary_Output_Properties_Required);
+ len += BACnet_Init_Properties_List(Binary_Output_Properties_List + len,
+ Binary_Output_Properties_Optional);
+ len += BACnet_Init_Properties_List(Binary_Output_Properties_List + len,
+ Binary_Output_Properties_Proprietary);
+
+ /* initialize all the binary values priority arrays to NULL */
+ for (i = 0; i < MAX_BINARY_OUTPUTS; i++) {
+ for (j = 0; j < BACNET_MAX_PRIORITY; j++) {
+ BO_Descr[i].Present_Value[j] = BINARY_NULL;
+ }
+ }
+ }
+
+ return;
+}
+
+
+
+/* validate that the given instance (Object ID) exists */
+/* This is a callback function. Callback set in My_Object_Table[] array declared in device.c, */
+bool Binary_Output_Valid_Instance(
+ uint32_t object_instance)
+{
+ // fprintf(stderr, "BACnet plugin: Binary_Output_Valid_Instance(obj_ID=%%u) called!\n", object _instance);
+ return (Binary_Output_Instance_To_Index(object_instance) < MAX_BINARY_OUTPUTS);
+}
+
+
+/* the number of Binary Output Objects */
+/* This is a callback function. Callback set in My_Object_Table[] array declared in device.c, */
+unsigned Binary_Output_Count(void) {return MAX_BINARY_OUTPUTS;}
+
+
+/* returns the instance (i.e. Object Identifier) that correlates to the correct index */
+/* This is a callback function. Callback set in My_Object_Table[] array declared in device.c, */
+uint32_t Binary_Output_Index_To_Instance(unsigned index) {return BO_Descr[index].Object_Identifier;}
+
+
+/* returns the index that correlates to the correct instance number (Object Identifier) */
+unsigned Binary_Output_Instance_To_Index(
+ uint32_t object_instance)
+{
+ unsigned index = 0;
+
+ for (index = 0; index < MAX_BINARY_OUTPUTS; index++)
+ if (object_instance == BO_Descr[index].Object_Identifier)
+ return index;
+
+ /* error, this object ID is not in our list! */
+ return MAX_BINARY_OUTPUTS;
+}
+
+
+
+BACNET_BINARY_PV Binary_Output_Present_Value(
+ uint32_t object_instance)
+{
+ BACNET_BINARY_PV value = BO_VALUE_RELINQUISH_DEFAULT;
+ unsigned index = 0;
+ unsigned i = 0;
+
+ // fprintf(stderr, "BACnet plugin: Binary_Output_Present_Value(obj_ID=%%u) called!\n", object_instance);
+
+ index = Binary_Output_Instance_To_Index(object_instance);
+ if (index < MAX_BINARY_OUTPUTS) {
+ for (i = 0; i < BACNET_MAX_PRIORITY; i++) {
+ if (!BINARY_OUTPUT_IS_NULL(BO_Descr[index].Present_Value[i])) {
+ value = BO_Descr[index].Present_Value[i];
+ break;
+ }
+ }
+ }
+
+ return value;
+}
+
+
+
+/* returns command priority (1..16), or 0 if all priority values are at NULL */
+int Binary_Output_Current_Command_Priority(
+ uint32_t object_instance)
+{
+ unsigned index = 0;
+ unsigned i = 0;
+
+ index = Binary_Output_Instance_To_Index(object_instance);
+ if (index < MAX_BINARY_OUTPUTS) {
+ for (i = 0; i < BACNET_MAX_PRIORITY; i++) {
+ if (!BINARY_OUTPUT_IS_NULL(BO_Descr[index].Present_Value[i])) {
+ return i+1; // +1 since priority is 1..16, and not 0..15
+ }
+ }
+ }
+ // command values in all priorities are set to NULL
+ return 0;
+}
+
+
+
+/* note: the object name must be unique within this device */
+/* This is a callback function. Callback set in My_Object_Table[] array declared in device.c, */
+bool Binary_Output_Object_Name(
+ uint32_t object_instance,
+ BACNET_CHARACTER_STRING * object_name)
+{
+ bool status = false;
+ unsigned index = Binary_Output_Instance_To_Index(object_instance);
+
+ if (index < MAX_BINARY_OUTPUTS)
+ status = characterstring_init_ansi(object_name, BO_Descr[index].Object_Name);
+
+ return status;
+}
+
+
+
+bool Binary_Output_Object_Description(
+ uint32_t object_instance,
+ BACNET_CHARACTER_STRING * object_name)
+{
+ bool status = false;
+ unsigned index = Binary_Output_Instance_To_Index(object_instance);
+
+ if (index < MAX_BINARY_OUTPUTS)
+ status = characterstring_init_ansi(object_name, BO_Descr[index].Description);
+
+ return status;
+}
+
+
+
+/* return apdu len, or BACNET_STATUS_ERROR on error */
+/* This is a callback function. Callback set in My_Object_Table[] array declared in device.c, */
+int Binary_Output_Read_Property(
+ BACNET_READ_PROPERTY_DATA * rpdata)
+{
+ int len = 0;
+ int apdu_len = 0; /* return value */
+ BACNET_BIT_STRING bit_string;
+ BACNET_CHARACTER_STRING char_string;
+ BACNET_BINARY_PV present_value = BINARY_INACTIVE;
+ unsigned object_index = 0;
+ unsigned i = 0;
+ bool state = false;
+ uint8_t *apdu = NULL;
+
+ // fprintf(stderr, "BACnet plugin: Binary_Output_Read_Property() called!\n");
+
+ if ((rpdata == NULL) || (rpdata->application_data == NULL) ||
+ (rpdata->application_data_len == 0)) {
+ return 0;
+ }
+
+ object_index = Binary_Output_Instance_To_Index(rpdata->object_instance);
+ if (object_index >= MAX_BINARY_OUTPUTS) {
+ rpdata->error_class = ERROR_CLASS_OBJECT;
+ rpdata->error_code = ERROR_CODE_UNKNOWN_OBJECT;
+ return BACNET_STATUS_ERROR;
+ }
+
+ apdu = rpdata->application_data;
+ switch (rpdata->object_property) {
+ case PROP_OBJECT_IDENTIFIER:
+ apdu_len =
+ encode_application_object_id(&apdu[0], OBJECT_BINARY_OUTPUT,
+ rpdata->object_instance);
+ break;
+ case PROP_OBJECT_NAME:
+ Binary_Output_Object_Name(rpdata->object_instance, &char_string);
+ apdu_len =
+ encode_application_character_string(&apdu[0], &char_string);
+ break;
+ case PROP_DESCRIPTION:
+ Binary_Output_Object_Description(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_BINARY_OUTPUT);
+ break;
+ case PROP_PRESENT_VALUE:
+ present_value =
+ Binary_Output_Present_Value(rpdata->object_instance);
+ apdu_len = encode_application_enumerated(&apdu[0], present_value);
+ break;
+ case PROP_STATUS_FLAGS:
+ /* note: see the details in the standard on how to use these */
+ 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);
+ state = BO_Descr[object_index].Out_Of_Service;
+ bitstring_set_bit(&bit_string, STATUS_FLAG_OUT_OF_SERVICE, state);
+ apdu_len = encode_application_bitstring(&apdu[0], &bit_string);
+ break;
+ case PROP_EVENT_STATE:
+ /* note: see the details in the standard on how to use this */
+ apdu_len =
+ encode_application_enumerated(&apdu[0], EVENT_STATE_NORMAL);
+ break;
+ case PROP_OUT_OF_SERVICE:
+ state = BO_Descr[object_index].Out_Of_Service;
+ apdu_len = encode_application_boolean(&apdu[0], state);
+ break;
+ case PROP_PRIORITY_ARRAY:
+ BACnet_encode_array(BO_Descr[object_index].Present_Value,
+ BACNET_MAX_PRIORITY,
+ BINARY_OUTPUT_IS_NULL,
+ encode_application_enumerated)
+ break;
+// case PROP_CURRENT_COMMAND_PRIORITY: {
+// unsigned i = Binary_Output_Current_Command_Priority(rpdata->object_instance);
+// if (i == 0) apdu_len = encode_application_null (&apdu[0]);
+// else apdu_len = encode_application_unsigned(&apdu[0], i);
+// break;
+// }
+
+ case PROP_RELINQUISH_DEFAULT:
+ present_value = BO_VALUE_RELINQUISH_DEFAULT;
+ apdu_len = encode_application_enumerated(&apdu[0], present_value);
+ break;
+ case PROP_POLARITY:
+ apdu_len = encode_application_enumerated(&apdu[0],
+ BO_Descr[object_index].Polarity);
+ break;
+// case PROP_PROPERTY_LIST:
+// BACnet_encode_array(Binary_Output_Properties_List,
+// property_list_count(Binary_Output_Properties_List),
+// retfalse, encode_application_enumerated);
+// 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_PRIORITY_ARRAY) &&
+// (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;
+}
+
+
+
+
+/* returns true if successful */
+/* This is a callback function. Callback set in My_Object_Table[] array declared in device.c, */
+bool Binary_Output_Write_Property(
+ BACNET_WRITE_PROPERTY_DATA * wp_data)
+{
+ bool status = false; /* return value */
+ unsigned int object_index = 0;
+ unsigned int priority = 0;
+ BACNET_BINARY_PV level = BINARY_NULL;
+ 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_PRIORITY_ARRAY) &&
+ (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;
+ }
+ /* No need to check whether object_index is within bounds.
+ * Has already been checked before Binary_Output_Write_Property() is called
+ */
+ object_index = Binary_Output_Instance_To_Index(wp_data->object_instance);
+
+ switch (wp_data->object_property) {
+ case PROP_PRESENT_VALUE:
+ if (value.tag == BACNET_APPLICATION_TAG_ENUMERATED) {
+ priority = wp_data->priority;
+ if (priority && (priority <= BACNET_MAX_PRIORITY) &&
+ (priority != 6 /* reserved */ ) &&
+ (value.type.Enumerated <= MAX_BINARY_PV)) {
+ level = (BACNET_BINARY_PV) value.type.Enumerated;
+ priority--;
+ BO_Descr[object_index].Present_Value[priority] = level;
+ status = true;
+ } else if (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;
+ }
+ } else {
+ status =
+ WPValidateArgType(&value, BACNET_APPLICATION_TAG_NULL,
+ &wp_data->error_class, &wp_data->error_code);
+ if (status) {
+ level = BINARY_NULL;
+ priority = wp_data->priority;
+ if (priority && (priority <= BACNET_MAX_PRIORITY)) {
+ priority--;
+ BO_Descr[object_index].Present_Value[priority] = level;
+ } else {
+ status = false;
+ wp_data->error_class = ERROR_CLASS_PROPERTY;
+ wp_data->error_code = ERROR_CODE_VALUE_OUT_OF_RANGE;
+ }
+ }
+ }
+ break;
+ case PROP_OUT_OF_SERVICE:
+ {
+ bool Previous_Out_Of_Service = BO_Descr[object_index].Out_Of_Service;
+ status =
+ WPValidateArgType(&value, BACNET_APPLICATION_TAG_BOOLEAN,
+ &wp_data->error_class, &wp_data->error_code);
+ if (status) {
+ BO_Descr[object_index].Out_Of_Service = value.type.Boolean;
+ if (Previous_Out_Of_Service && !BO_Descr[object_index].Out_Of_Service)
+ /* We have just changed from Out_of_Service -> In Service */
+ /* We need to update the Present_Value to the value
+ * currently in the PLC...
+ */
+ BO_Descr[object_index].Present_Value[BACNET_MAX_PRIORITY-1] =
+ *(BO_Descr[object_index].Located_Var_ptr);
+ }
+ break;
+ }
+ case PROP_OBJECT_IDENTIFIER:
+ case PROP_OBJECT_NAME:
+ case PROP_DESCRIPTION:
+ case PROP_OBJECT_TYPE:
+ case PROP_STATUS_FLAGS:
+ case PROP_EVENT_STATE:
+ case PROP_PRIORITY_ARRAY:
+// case PROP_CURRENT_COMMAND_PRIORITY:
+ case PROP_RELINQUISH_DEFAULT:
+ case PROP_POLARITY:
+// 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;
+}
+
+
+
+
+
+/********************************************/
+/** Functions required for Beremiz plugin **/
+/********************************************/
+
+
+
+void Binary_Output_Copy_Present_Value_to_Located_Var(void) {
+ unsigned i;
+ for (i = 0; i < MAX_BINARY_OUTPUTS; i++) {
+ // decouple PLC's Located Variable from Bacnet Object's Present Value if Out_Of_Service is true
+ if (BO_Descr[i].Out_Of_Service)
+ continue;
+
+ // copy the value
+ *(BO_Descr[i].Located_Var_ptr) = Binary_Output_Present_Value(BO_Descr[i].Object_Identifier);
+ }
+}
+
+void Binary_Output_Copy_Located_Var_to_Present_Value(void) {
+ unsigned i;
+ for (i = 0; i < MAX_BINARY_OUTPUTS; i++) {
+ // decouple PLC's Located Variable from Bacnet Object's Present Value if Out_Of_Service is true
+ if (BO_Descr[i].Out_Of_Service)
+ continue;
+
+ // copy the value
+ BO_Descr[i].Present_Value[BACNET_MAX_PRIORITY-1] = *(BO_Descr[i].Located_Var_ptr);
+
+ // If the Present_Value was set to an invalid value (i.e. > 1, and < BINARY_NULL)
+ // then we set it to BINARY_ACTIVE
+ // (i.e. we assume 0 is FALSE, all other non NULL values are TRUE)
+ if ((BO_Descr[i].Present_Value[BACNET_MAX_PRIORITY-1] != BINARY_INACTIVE) &&
+ (BO_Descr[i].Present_Value[BACNET_MAX_PRIORITY-1] != BINARY_ACTIVE ) &&
+ (BO_Descr[i].Present_Value[BACNET_MAX_PRIORITY-1] != BINARY_NULL ))
+ BO_Descr[i].Present_Value[BACNET_MAX_PRIORITY-1] = BINARY_ACTIVE;
+ }
+}
+
+