dali/bacnet_stack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Feature/basic-program-object (#940)

Browse Source 
* Added basic Program object and unit test.

* Integrate the basic Program object with example applications.
This commit is contained in:
Steve Karg
2025-03-13 15:51:37 -05:00
committed by GitHub
parent 4ee129e249
commit 4df896b820
17 changed files with 1442 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/bacnet/bacenum.h
+8 -9
View File
@@ -1088,7 +1088,7 @@ typedef enum {
MAX_POLARITY = 2
} BACNET_POLARITY;
typedef enum {
typedef enum BACnetProgramRequest {
PROGRAM_REQUEST_READY = 0,
PROGRAM_REQUEST_LOAD = 1,
PROGRAM_REQUEST_RUN = 2,
@@ -1097,7 +1097,7 @@ typedef enum {
PROGRAM_REQUEST_UNLOAD = 5
} BACNET_PROGRAM_REQUEST;
typedef enum {
typedef enum BACnetProgramState {
PROGRAM_STATE_IDLE = 0,
PROGRAM_STATE_LOADING = 1,
PROGRAM_STATE_RUNNING = 2,
@@ -1106,18 +1106,17 @@ typedef enum {
PROGRAM_STATE_UNLOADING = 5
} BACNET_PROGRAM_STATE;
typedef enum {
typedef enum BACnetProgramError {
PROGRAM_ERROR_NORMAL = 0,
PROGRAM_ERROR_LOAD_FAILED = 1,
PROGRAM_ERROR_INTERNAL = 2,
PROGRAM_ERROR_PROGRAM = 3,
PROGRAM_ERROR_OTHER = 4,
/* Enumerated values 0-63 are reserved for definition by ASHRAE. */
/* Enumerated values 64-65535 may be used by others subject to */
/* the procedures and constraints described in Clause 23. */
/* do the max range inside of enum so that
compilers will allocate adequate sized datatype for enum
which is used to store decoding */
PROGRAM_ERROR_RESERVED_MIN = 5,
PROGRAM_ERROR_RESERVED_MAX = 63,
/* Enumerated values 0-63 are reserved for definition by ASHRAE.
Enumerated values 64-65535 may be used by others subject
to the procedures and constraints described in Clause 23. */
PROGRAM_ERROR_PROPRIETARY_MIN = 64,
PROGRAM_ERROR_PROPRIETARY_MAX = 65535
} BACNET_PROGRAM_ERROR;
src/bacnet/basic/object/device.c
+17 -7
View File
@@ -37,6 +37,7 @@
#include "bacnet/basic/object/bv.h"
#include "bacnet/basic/object/calendar.h"
#include "bacnet/basic/object/command.h"
#include "bacnet/basic/object/program.h"
#include "bacnet/basic/object/lc.h"
#include "bacnet/basic/object/lsp.h"
#include "bacnet/basic/object/lsz.h"
@@ -64,6 +65,7 @@
#include "bacnet/basic/object/netport.h"
#include "bacnet/basic/object/color_object.h"
#include "bacnet/basic/object/color_temperature.h"
#include "bacnet/basic/object/program.h"
/* external prototypes */
extern int Routed_Device_Read_Property_Local(BACNET_READ_PROPERTY_DATA *rpdata);
@@ -215,13 +217,13 @@ static object_functions_t My_Object_Table[] = {
NULL /* Add_List_Element */, NULL /* Remove_List_Element */,
Integer_Value_Create, Integer_Value_Delete, NULL /* Timer */ },
#endif
{ OBJECT_COMMAND, Command_Init, Command_Count, Command_Index_To_Instance,
Command_Valid_Instance, Command_Object_Name, Command_Read_Property,
Command_Write_Property, Command_Property_Lists,
NULL /* ReadRangeInfo */, NULL /* Iterator */, NULL /* Value_Lists */,
NULL /* COV */, NULL /* COV Clear */, NULL /* Intrinsic Reporting */,
NULL /* Add_List_Element */, NULL /* Remove_List_Element */,
NULL /* Create */, NULL /* Delete */, NULL /* Timer */ },
{ OBJECT_COMMAND, Command_Init, Command_Count, Command_Index_To_Instance,
Command_Valid_Instance, Command_Object_Name, Command_Read_Property,
Command_Write_Property, Command_Property_Lists,
NULL /* ReadRangeInfo */, NULL /* Iterator */, NULL /* Value_Lists */,
NULL /* COV */, NULL /* COV Clear */, NULL /* Intrinsic Reporting */,
NULL /* Add_List_Element */, NULL /* Remove_List_Element */,
NULL /* Create */, NULL /* Delete */, NULL /* Timer */ },
#if defined(INTRINSIC_REPORTING)
{ OBJECT_NOTIFICATION_CLASS, Notification_Class_Init,
Notification_Class_Count, Notification_Class_Index_To_Instance,
@@ -376,6 +378,14 @@ static object_functions_t My_Object_Table[] = {
NULL /* COV */, NULL /* COV Clear */, NULL /* Intrinsic Reporting */,
NULL /* Add_List_Element */, NULL /* Remove_List_Element */,
NULL /* Create */, NULL /* Delete */, NULL /* Timer */ },
{ OBJECT_PROGRAM, Program_Init, Program_Count,
Program_Index_To_Instance, Program_Valid_Instance,
Program_Object_Name, Program_Read_Property,
Program_Write_Property, Program_Property_Lists,
NULL /* ReadRangeInfo */, NULL /* Iterator */, NULL /* Value_Lists */,
NULL /* COV */, NULL /* COV Clear */, NULL /* Intrinsic Reporting */,
NULL /* Add_List_Element */, NULL /* Remove_List_Element */,
Program_Create, Program_Delete, Program_Timer },
{ MAX_BACNET_OBJECT_TYPE, NULL /* Init */, NULL /* Count */,
NULL /* Index_To_Instance */, NULL /* Valid_Instance */,
NULL /* Object_Name */, NULL /* Read_Property */,
src/bacnet/basic/object/program.c
+1110
View File
File diff suppressed because it is too large Load Diff
src/bacnet/basic/object/program.h
+134
View File
@@ -0,0 +1,134 @@
/**
* @file
* @brief API for Program object type
* @author Steve Karg <skarg@users.sourceforge.net>
* @date March 2025
* @copyright SPDX-License-Identifier: MIT
*/
#ifndef BACNET_BASIC_OBJECT_PROGRAM_H
#define BACNET_BASIC_OBJECT_PROGRAM_H
#include <stdbool.h>
#include <stdint.h>
/* BACnet Stack defines - first */
#include "bacnet/bacdef.h"
/* BACnet Stack API */
#include "bacnet/bacerror.h"
#include "bacnet/wp.h"
#include "bacnet/rp.h"
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
BACNET_STACK_EXPORT
void Program_Property_Lists(
const int **pRequired, const int **pOptional, const int **pProprietary);
BACNET_STACK_EXPORT
bool Program_Valid_Instance(uint32_t object_instance);
BACNET_STACK_EXPORT
unsigned Program_Count(void);
BACNET_STACK_EXPORT
uint32_t Program_Index_To_Instance(unsigned index);
BACNET_STACK_EXPORT
unsigned Program_Instance_To_Index(uint32_t object_instance);
BACNET_STACK_EXPORT
bool Program_Object_Name(
uint32_t object_instance, BACNET_CHARACTER_STRING *object_name);
BACNET_STACK_EXPORT
bool Program_Name_Set(uint32_t object_instance, const char *new_name);
BACNET_STACK_EXPORT
const char *Program_Name_ASCII(uint32_t object_instance);
BACNET_STACK_EXPORT
int Program_Read_Property(BACNET_READ_PROPERTY_DATA *rpdata);
BACNET_STACK_EXPORT
bool Program_Write_Property(BACNET_WRITE_PROPERTY_DATA *wp_data);
BACNET_STACK_EXPORT
BACNET_PROGRAM_STATE Program_State(uint32_t object_instance);
BACNET_STACK_EXPORT
bool Program_State_Set(uint32_t object_instance, BACNET_PROGRAM_STATE value);
BACNET_STACK_EXPORT
BACNET_PROGRAM_REQUEST Program_Change(uint32_t object_instance);
BACNET_STACK_EXPORT
bool Program_Change_Set(
uint32_t object_instance, BACNET_PROGRAM_REQUEST program_change);
BACNET_STACK_EXPORT
BACNET_PROGRAM_ERROR Program_Reason_For_Halt(uint32_t object_instance);
BACNET_STACK_EXPORT
bool Program_Reason_For_Halt_Set(
uint32_t object_instance, BACNET_PROGRAM_ERROR reason);
BACNET_STACK_EXPORT
bool Program_Description(
uint32_t object_instance, BACNET_CHARACTER_STRING *description);
BACNET_STACK_EXPORT
bool Program_Description_Set(uint32_t instance, const char *new_name);
BACNET_STACK_EXPORT
const char *Program_Description_ANSI(uint32_t object_instance);
BACNET_STACK_EXPORT
bool Program_Location(
uint32_t object_instance, BACNET_CHARACTER_STRING *description);
BACNET_STACK_EXPORT
bool Program_Location_Set(uint32_t instance, const char *new_name);
BACNET_STACK_EXPORT
const char *Program_Location_ANSI(uint32_t object_instance);
BACNET_STACK_EXPORT
bool Program_Instance_Of(
uint32_t object_instance, BACNET_CHARACTER_STRING *description);
BACNET_STACK_EXPORT
bool Program_Instance_Of_Set(uint32_t instance, const char *new_name);
BACNET_STACK_EXPORT
const char *Program_Instance_Of_ANSI(uint32_t object_instance);
BACNET_STACK_EXPORT
bool Program_Description_Of_Halt(
uint32_t object_instance, BACNET_CHARACTER_STRING *description);
BACNET_STACK_EXPORT
bool Program_Description_Of_Halt_Set(uint32_t instance, const char *new_name);
BACNET_STACK_EXPORT
const char *Program_Description_Of_Halt_ANSI(uint32_t object_instance);
BACNET_STACK_EXPORT
bool Program_Out_Of_Service(uint32_t instance);
BACNET_STACK_EXPORT
void Program_Out_Of_Service_Set(uint32_t instance, bool oos_flag);
BACNET_STACK_EXPORT
void Program_Timer(uint32_t object_instance, uint16_t milliseconds);
BACNET_STACK_EXPORT
uint32_t Program_Create(uint32_t object_instance);
BACNET_STACK_EXPORT
bool Program_Delete(uint32_t object_instance);
BACNET_STACK_EXPORT
void Program_Cleanup(void);
BACNET_STACK_EXPORT
void Program_Init(void);
/* API for the program requests */
BACNET_STACK_EXPORT
void Program_Context_Set(uint32_t object_instance, void *context);
BACNET_STACK_EXPORT
void Program_Load_Set(
uint32_t object_instance,
void (*load)(void *context, const char *location));
BACNET_STACK_EXPORT
void Program_Run_Set(uint32_t object_instance, void (*run)(void *context));
BACNET_STACK_EXPORT
void Program_Halt_Set(uint32_t object_instance, void (*halt)(void *context));
BACNET_STACK_EXPORT
void Program_Restart_Set(
uint32_t object_instance, void (*restart)(void *context));
BACNET_STACK_EXPORT
void Program_Unload_Set(
uint32_t object_instance, void (*unload)(void *context));
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif
src/bacnet/basic/server/bacnet_device.c
+26
View File
@@ -46,6 +46,7 @@
#include "bacnet/basic/object/iv.h"
#include "bacnet/basic/object/time_value.h"
#include "bacnet/basic/object/channel.h"
#include "bacnet/basic/object/program.h"
#include "bacnet/basic/object/lo.h"
#include "bacnet/basic/object/blo.h"
#include "bacnet/basic/object/netport.h"
@@ -102,6 +103,7 @@
defined(CONFIG_BACNET_BASIC_OBJECT_FILE) || \
defined(CONFIG_BACNET_BASIC_OBJECT_STRUCTURED_VIEW) || \
defined(CONFIG_BACNET_BASIC_OBJECT_BITSTRING_VALUE) || \
defined(CONFIG_BACNET_BASIC_OBJECT_PROGRAM) || \
defined(CONFIG_BACNET_BASIC_OBJECT_CHARACTERSTRING_VALUE))
#define CONFIG_BACNET_BASIC_OBJECT_ALL
#endif
@@ -130,6 +132,8 @@
#define CONFIG_BACNET_BASIC_OBJECT_FILE
#define CONFIG_BACNET_BASIC_OBJECT_STRUCTURED_VIEW
#define CONFIG_BACNET_BASIC_OBJECT_BITSTRING_VALUE
#define CONFIG_BACNET_BASIC_OBJECT_PROGRAM
#define CONFIG_BACNET_BASIC_OBJECT_CHARACTERSTRING_VALUE
#endif
#if (BACNET_PROTOCOL_REVISION < 14)
@@ -717,6 +721,28 @@ static object_functions_t Object_Table[] = {
CharacterString_Value_Create,
CharacterString_Value_Delete,
NULL /* Timer */ },
#endif
#if defined(CONFIG_BACNET_BASIC_OBJECT_PROGRAM)
{ OBJECT_BITSTRING_VALUE,
Program_Init,
Program_Count,
Program_Index_To_Instance,
Program_Valid_Instance,
Program_Object_Name,
Program_Read_Property,
Program_Write_Property,
Program_Property_Lists,
NULL /* ReadRangeInfo */,
NULL /* Iterator */,
NULL /* Value_Lists */,
NULL /* COV */,
NULL /* COV Clear */,
NULL /* Intrinsic Reporting */,
NULL /* Add_List_Element */,
NULL /* Remove_List_Element */,
Program_Create,
Program_Delete,
Program_Timer },
#endif
{
MAX_BACNET_OBJECT_TYPE,