Kari Argillander
f806c5829b
* pre-commit: Update and enable clang-format check There is newer version from clang-format so use that. We do not yet want 18 as that is little bit too new. * Format some thing by hand which clang-format "breaks" Clang-format will format some things little bit off in some cases. Format some things by hand so we get cleaner end result. * Run clang-format with ``` pre-commit run --all-files clang-format ``` We have already in previously checked places where clang-format does not make good format and ignored those (hopefully most of the things). --------- Co-authored-by: Kari Argillander <kari.argillander@fidelix.com>
113 lines
3.1 KiB
C
113 lines
3.1 KiB
C
/**
|
|
* @file
|
|
* @author Nikola Jelic <nikola.jelic@euroicc.com>
|
|
* @date 2014
|
|
* @brief API for basic Command objects, customize for your use
|
|
* @copyright SPDX-License-Identifier: MIT
|
|
*/
|
|
#ifndef BACNET_BASIC_OBJECT_COMMAND_H
|
|
#define BACNET_BASIC_OBJECT_COMMAND_H
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
/* BACnet Stack defines - first */
|
|
#include "bacnet/bacdef.h"
|
|
/* BACnet Stack API */
|
|
#include "bacnet/bacaction.h"
|
|
#include "bacnet/rp.h"
|
|
#include "bacnet/wp.h"
|
|
|
|
#ifndef MAX_COMMANDS
|
|
#define MAX_COMMANDS 4
|
|
#endif
|
|
|
|
#ifndef MAX_COMMAND_ACTIONS
|
|
#define MAX_COMMAND_ACTIONS 8
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
typedef struct command_descr {
|
|
uint32_t Present_Value;
|
|
bool In_Process;
|
|
bool All_Writes_Successful;
|
|
BACNET_ACTION_LIST Action[MAX_COMMAND_ACTIONS];
|
|
} COMMAND_DESCR;
|
|
|
|
BACNET_STACK_EXPORT
|
|
void Command_Property_Lists(
|
|
const int **pRequired, const int **pOptional, const int **pProprietary);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Command_Valid_Instance(uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
unsigned Command_Count(void);
|
|
BACNET_STACK_EXPORT
|
|
uint32_t Command_Index_To_Instance(unsigned index);
|
|
BACNET_STACK_EXPORT
|
|
unsigned Command_Instance_To_Index(uint32_t instance);
|
|
BACNET_STACK_EXPORT
|
|
bool Command_Object_Instance_Add(uint32_t instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Command_Object_Name(
|
|
uint32_t object_instance, BACNET_CHARACTER_STRING *object_name);
|
|
BACNET_STACK_EXPORT
|
|
bool Command_Name_Set(uint32_t object_instance, char *new_name);
|
|
|
|
BACNET_STACK_EXPORT
|
|
char *Command_Description(uint32_t instance);
|
|
BACNET_STACK_EXPORT
|
|
bool Command_Description_Set(uint32_t instance, const char *new_name);
|
|
|
|
BACNET_STACK_EXPORT
|
|
int Command_Read_Property(BACNET_READ_PROPERTY_DATA *rpdata);
|
|
BACNET_STACK_EXPORT
|
|
bool Command_Write_Property(BACNET_WRITE_PROPERTY_DATA *wp_data);
|
|
|
|
BACNET_STACK_EXPORT
|
|
uint32_t Command_Present_Value(uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
bool Command_Present_Value_Set(uint32_t object_instance, uint32_t value);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Command_In_Process(uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
bool Command_In_Process_Set(uint32_t object_instance, bool value);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Command_All_Writes_Successful(uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
bool Command_All_Writes_Successful_Set(uint32_t object_instance, bool value);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool Command_Change_Of_Value(uint32_t instance);
|
|
BACNET_STACK_EXPORT
|
|
void Command_Change_Of_Value_Clear(uint32_t instance);
|
|
BACNET_STACK_EXPORT
|
|
bool Command_Encode_Value_List(
|
|
uint32_t object_instance, BACNET_PROPERTY_VALUE *value_list);
|
|
float Command_COV_Increment(uint32_t instance);
|
|
BACNET_STACK_EXPORT
|
|
void Command_COV_Increment_Set(uint32_t instance, float value);
|
|
|
|
BACNET_STACK_EXPORT
|
|
BACNET_ACTION_LIST *
|
|
Command_Action_List_Entry(uint32_t instance, unsigned index);
|
|
BACNET_STACK_EXPORT
|
|
unsigned Command_Action_List_Count(uint32_t instance);
|
|
|
|
/* note: header of Intrinsic_Reporting function is required
|
|
even when INTRINSIC_REPORTING is not defined */
|
|
BACNET_STACK_EXPORT
|
|
void Command_Intrinsic_Reporting(uint32_t object_instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
void Command_Init(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
#endif
|