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

Add multi-device support for BACnet gateway routing (#1279)

Browse Source 
* Expanded Object_List to Object_List[MAX_NUM_DEVICES] array to support per-device objects for virtual remote devices
* Added multi-device iteration for COV handler, device timer, and intrinsic reporting
* Added apps/gateway2 demo application
* When MAX_NUM_DEVICES == 1, behavior is identical to the original implementation
* Conditional compilation with macros ensures no impact on non-gateway applications

---------

Signed-off-by: Hyeongjun Kim <hjun1.kim@samsung.com>
Co-authored-by: haemeok-kang <haemeok.kang@samsung.com>
This commit is contained in:
Hyeongjun Kim
2026-03-31 04:16:17 +09:00
committed by GitHub
parent b8dd89b879
commit f408b6eb7f
54 changed files with 2592 additions and 586 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/Makefile
+4
View File
@@ -334,6 +334,10 @@ clean:
gateway: $(BACNET_LIB_TARGET)
$(MAKE) -B -C $@
.PHONY: gateway2
gateway2: $(BACNET_LIB_TARGET)
$(MAKE) -B -C $@
.PHONY: abort
abort: $(BACNET_LIB_TARGET)
$(MAKE) -B -C $@
apps/gateway2/Makefile
+97
View File
@@ -0,0 +1,97 @@
#Makefile to build BACnet Application using GCC compiler
# Executable file name
TARGET = bacgateway2
SRC := main.c
BACNET_SRC_DIR ?= $(realpath ../../src)
BACNET_OBJECT_DIR = $(BACNET_SRC_DIR)/bacnet/basic/object
BACNET_OBJECT_SRC := \
$(BACNET_OBJECT_DIR)/gateway/gw_device.c \
$(BACNET_OBJECT_DIR)/device.c \
$(BACNET_OBJECT_DIR)/access_credential.c \
$(BACNET_OBJECT_DIR)/access_door.c \
$(BACNET_OBJECT_DIR)/access_point.c \
$(BACNET_OBJECT_DIR)/access_rights.c \
$(BACNET_OBJECT_DIR)/access_user.c \
$(BACNET_OBJECT_DIR)/access_zone.c \
$(BACNET_OBJECT_DIR)/ai.c \
$(BACNET_OBJECT_DIR)/ao.c \
$(BACNET_OBJECT_DIR)/av.c \
$(BACNET_OBJECT_DIR)/acc.c \
$(BACNET_OBJECT_DIR)/auditlog.c \
$(BACNET_OBJECT_DIR)/bacfile.c \
$(BACNET_OBJECT_DIR)/bi.c \
$(BACNET_OBJECT_DIR)/bitstring_value.c \
$(BACNET_OBJECT_DIR)/bo.c \
$(BACNET_OBJECT_DIR)/blo.c \
$(BACNET_OBJECT_DIR)/bv.c \
$(BACNET_OBJECT_DIR)/calendar.c \
$(BACNET_OBJECT_DIR)/channel.c \
$(BACNET_OBJECT_DIR)/color_object.c \
$(BACNET_OBJECT_DIR)/color_temperature.c \
$(BACNET_OBJECT_DIR)/command.c \
$(BACNET_OBJECT_DIR)/credential_data_input.c \
$(BACNET_OBJECT_DIR)/csv.c \
$(BACNET_OBJECT_DIR)/iv.c \
$(BACNET_OBJECT_DIR)/lc.c \
$(BACNET_OBJECT_DIR)/lo.c \
$(BACNET_OBJECT_DIR)/loop.c \
$(BACNET_OBJECT_DIR)/lsp.c \
$(BACNET_OBJECT_DIR)/lsz.c \
$(BACNET_OBJECT_DIR)/ms-input.c \
$(BACNET_OBJECT_DIR)/mso.c \
$(BACNET_OBJECT_DIR)/msv.c \
$(BACNET_OBJECT_DIR)/nc.c \
$(BACNET_OBJECT_DIR)/netport.c \
$(BACNET_OBJECT_DIR)/osv.c \
$(BACNET_OBJECT_DIR)/piv.c \
$(BACNET_OBJECT_DIR)/program.c \
$(BACNET_OBJECT_DIR)/schedule.c \
$(BACNET_OBJECT_DIR)/structured_view.c \
$(BACNET_OBJECT_DIR)/time_value.c \
$(BACNET_OBJECT_DIR)/timer.c \
$(BACNET_OBJECT_DIR)/trendlog.c
BACNET_BASIC_SRC = \
$(wildcard $(BACNET_SRC_DIR)/bacnet/basic/*.c) \
$(wildcard $(BACNET_SRC_DIR)/bacnet/basic/binding/*.c) \
$(wildcard $(BACNET_SRC_DIR)/bacnet/basic/sys/*.c) \
$(BACNET_SRC_DIR)/bacnet/basic/npdu/h_routed_npdu.c \
$(BACNET_SRC_DIR)/bacnet/basic/npdu/s_router.c \
$(BACNET_SRC_DIR)/bacnet/basic/tsm/tsm.c \
$(wildcard $(BACNET_SRC_DIR)/bacnet/basic/service/*.c)
# TARGET_EXT is defined in apps/Makefile as .exe or nothing
TARGET_BIN = ${TARGET}$(TARGET_EXT)
SRCS := $(SRC) $(BACNET_OBJECT_SRC) $(BACNET_BASIC_SRC)
OBJS := $(SRCS:.c=.o)
CFLAGS += -DBAC_ROUTING
.PHONY: all
all: Makefile ${TARGET_BIN}
${TARGET_BIN}: ${OBJS}
${CC} ${PFLAGS} ${OBJS} ${LFLAGS} -o $@
size $@
cp $@ ../../bin
.c.o:
${CC} -c ${CFLAGS} $*.c -o $@
.PHONY: depend
depend:
rm -f .depend
${CC} -MM ${CFLAGS} *.c >> .depend
.PHONY: clean
clean:
rm -f core ${TARGET_BIN} ${OBJS} $(TARGET).map
.PHONY: include
include: .depend
apps/gateway2/gateway.h
+42
View File
@@ -0,0 +1,42 @@
/**
* @file
* @brief Header for example gateway (ie, BACnet Router and Devices)
* using the BACnet Stack.
* @author Tom Brennan <tbrennan3@users.sourceforge.net>
* @date 2010
* @copyright SPDX-License-Identifier: MIT
*/
#ifndef BACNET_GATEWAY_H_
#define BACNET_GATEWAY_H_
#include "bacnet/config.h"
/** @defgroup GatewayDemo Demo of a BACnet virtual gateway (multiple Device).
* @ingroup Demos
* This is a basic demonstration of a BACnet Router with child devices (ie,
* gateway) appearing on a virtual BACnet network behind the Router.
* This is an extension of the ServerDemo project.
*/
/* Device configuration definitions. */
#define FIRST_DEVICE_NUMBER 260001
#define VIRTUAL_DNET 2709 /* your choice of number here */
#define DEV_NAME_BASE "Gateway Demo Device"
#define DEV_DESCR_GATEWAY "Gateway Device and Router"
#define DEV_DESCR_REMOTE "Routed Remote Device"
#define VIRTUAL_DEVICE_COUNT 10
#define VIRTUAL_DEVICE_INDEX_OFFSET 1
#if VIRTUAL_DEVICE_COUNT >= MAX_NUM_DEVICES
#ifdef _MSC_VER
#pragma message( \
"VIRTUAL_DEVICE_COUNT >= MAX_NUM_DEVICES, adjusting to MAX_NUM_DEVICES-1")
#else
#warning \
"VIRTUAL_DEVICE_COUNT >= MAX_NUM_DEVICES, adjusting to MAX_NUM_DEVICES-1"
#endif
#undef VIRTUAL_DEVICE_COUNT
#define VIRTUAL_DEVICE_COUNT (MAX_NUM_DEVICES - 1)
#endif
#endif
apps/gateway2/main.c
+339
View File
@@ -0,0 +1,339 @@
/**
* @file
* @brief Example virtual gateway application using the BACnet Stack.
* Code for this project began with code from the demo/server project and
* Paul Chapman's vmac project.
* @author Tom Brennan <tbrennan3@users.sourceforge.net>
* @author Hyeongjun Kim <sicad3@gmail.com>
* @date 2026
* @copyright SPDX-License-Identifier: MIT
*/
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <signal.h>
#include <time.h>
/* BACnet Stack defines - first */
#include "bacnet/bacdef.h"
/* BACnet Stack API */
#include "bacnet/bacdcode.h"
#include "bacnet/npdu.h"
#include "bacnet/apdu.h"
#include "bacnet/iam.h"
#include "bacnet/dcc.h"
#include "bacnet/version.h"
/* some demo stuff needed */
#include "bacnet/basic/binding/address.h"
#include "bacnet/basic/tsm/tsm.h"
#include "bacnet/basic/services.h"
#include "bacnet/basic/sys/debug.h"
#include "bacnet/datalink/datalink.h"
#include "bacnet/datalink/dlenv.h"
/* include the device object */
#include "bacnet/basic/object/device.h"
#include "bacnet/basic/object/bacfile.h"
#include "bacnet/basic/object/lc.h"
#include "bacnet/basic/object/ai.h"
#include "bacnet/basic/object/ao.h"
#ifdef BACNET_TEST_VMAC
#include "bacnet/basic/bbmd6/vmac.h"
#endif
/* me! */
#include "gateway.h"
/* Prototypes */
/* (Doxygen note: The next two lines pull all the following Javadoc
* into the GatewayDemo module.) */
/** @addtogroup GatewayDemo */
/*@{*/
/** Buffer used for receiving */
static uint8_t Rx_Buf[MAX_MPDU] = { 0 };
/** The list of DNETs that our router can reach.
* Only one entry since we don't support downstream routers.
*/
int DNET_list[2] = {
VIRTUAL_DNET, -1 /* Need -1 terminator */
};
/* current version of the BACnet stack */
static const char *BACnet_Version = BACNET_VERSION_TEXT;
/* Virtual devices start at index 1 (gateway is at 0) */
static unsigned Routed_Device_Index = 1;
/** Initialize the Device Objects and each of the child Object instances.
* @param first_object_instance Set the first (gateway) Device to this
instance number, and subsequent devices to incremented values.
*/
static void Devices_Init(uint32_t first_object_instance)
{
int i;
int dev_idx;
int instance_number = 0;
char nameText[MAX_DEV_NAME_LEN];
char descText[MAX_DEV_DESC_LEN];
BACNET_CHARACTER_STRING name_string;
/* Gateway Device has already been initialized.
* But give it a better Description. */
Routed_Device_Set_Description(DEV_DESCR_GATEWAY, strlen(DEV_DESCR_GATEWAY));
/* Gateway - analog_input */
instance_number = 1000;
Analog_Input_Create(instance_number);
Analog_Input_Name_Set(instance_number, "Gateway Analog Input");
Analog_Input_Present_Value_Set(instance_number, 100.0);
/* Gateway - analog_onput */
instance_number = 1001;
Analog_Output_Create(instance_number);
Analog_Output_Name_Set(instance_number, "Gateway Analog Output");
Analog_Output_Present_Value_Set(instance_number, 50.0, BACNET_MAX_PRIORITY);
/* Now initialize the remote Device objects. */
for (i = 0; i < VIRTUAL_DEVICE_COUNT; i++) {
dev_idx = i + 1;
snprintf(
nameText, MAX_DEV_NAME_LEN, "%s %d", DEV_NAME_BASE, dev_idx + 1);
snprintf(
descText, MAX_DEV_DESC_LEN, "%s %d", DEV_DESCR_REMOTE, dev_idx);
characterstring_init_ansi(&name_string, nameText);
Add_Routed_Device(
(first_object_instance + dev_idx), &name_string, descText);
/* Gateway - analog_input */
instance_number = dev_idx * 10000 + 1000;
Analog_Input_Create(instance_number);
Analog_Input_Name_Set(instance_number, "Gateway Analog Input");
Analog_Input_Present_Value_Set(instance_number, 0.1 + (float)dev_idx);
/* Gateway - analog_onput */
instance_number = dev_idx * 10000 + 1001;
Analog_Output_Create(instance_number);
Analog_Output_Name_Set(instance_number, "Gateway Analog Output");
Analog_Output_Relinquish_Default_Set(instance_number, 100);
Analog_Output_Present_Value_Set(
instance_number, 0.9 + (float)i, BACNET_MAX_PRIORITY);
}
}
/** Initialize the BACnet Device Addresses for each Device object.
* The gateway has already gotten the normal address (eg, PC's IP for BIP) and
* the remote devices get
* - For BIP, the IP address reversed, and 4th byte equal to index.
* (Eg, 11.22.33.44 for the gateway becomes 44.33.22.01 for the first remote
* device.) This is sure to be unique! The port number stays the same.
* - For MS/TP, [Steve inserts a good idea here]
*/
static void Initialize_Device_Addresses(void)
{
int i = 0; /* First entry is Gateway Device */
uint32_t virtual_mac = 0;
BACNET_ADDRESS virtual_address = { 0 };
DEVICE_OBJECT_DATA *pDev = NULL;
/* Setup info for the main gateway device first */
pDev = Get_Routed_Device_Object(i);
/* we can't use datalink_get_my_address() since it is
mapped to routed_get_my_address() in this app
to get the parent device address */
#if defined(BACDL_BIP)
bip_get_my_address(&virtual_address);
#elif defined(BACDL_MSTP)
dlmstp_get_my_address(&virtual_address);
#elif defined(BACDL_ARCNET)
arcnet_get_my_address(&virtual_address);
#elif defined(BACDL_ETHERNET)
ethernet_get_my_address(&virtual_address);
#elif defined(BACDL_BIP6)
bip6_get_my_address(&virtual_address);
#else
#error "No support for this Data Link Layer type "
#endif
bacnet_address_copy(&pDev->bacDevAddr, &virtual_address);
/* broadcast an I-Am on startup */
Send_I_Am(&Handler_Transmit_Buffer[0]);
/* Virtual devices start at index 1 (gateway is at 0) */
for (i = 1; i < Get_Num_Managed_Devices(); i++) {
pDev = Get_Routed_Device_Object(i);
if (pDev == NULL) {
continue;
}
/* start with the router address */
bacnet_address_copy(&pDev->bacDevAddr, &virtual_address);
/* add the network number to each gateway device */
pDev->bacDevAddr.net = VIRTUAL_DNET;
/* use a virtual MAC for each gateway device */
virtual_mac = pDev->bacObj.Object_Instance_Number;
encode_unsigned24(&pDev->bacDevAddr.adr[0], virtual_mac);
pDev->bacDevAddr.len = 3;
}
}
/** Initialize the handlers we will utilize.
* @see Device_Init, apdu_set_unconfirmed_handler, apdu_set_confirmed_handler
*/
static void Init_Service_Handlers(uint32_t first_object_instance)
{
Device_Init(NULL);
Routing_Device_Init(first_object_instance);
/* we need to handle who-is to support dynamic device binding
* For the gateway, we will use the unicast variety so we can
* get back through switches to different subnets.
* Don't need the routed versions, since the npdu handler calls
* each device in turn.
*/
apdu_set_unconfirmed_handler(
SERVICE_UNCONFIRMED_WHO_IS, handler_who_is_unicast);
apdu_set_unconfirmed_handler(SERVICE_UNCONFIRMED_WHO_HAS, handler_who_has);
/* set the handler for all the services we don't implement */
/* It is required to send the proper reject message... */
apdu_set_unrecognized_service_handler_handler(handler_unrecognized_service);
/* Set the handlers for any confirmed services that we support. */
/* We must implement read property - it's required! */
apdu_set_confirmed_handler(
SERVICE_CONFIRMED_READ_PROPERTY, handler_read_property);
apdu_set_confirmed_handler(
SERVICE_CONFIRMED_READ_PROP_MULTIPLE, handler_read_property_multiple);
apdu_set_confirmed_handler(
SERVICE_CONFIRMED_WRITE_PROPERTY, handler_write_property);
apdu_set_confirmed_handler(
SERVICE_CONFIRMED_READ_RANGE, handler_read_range);
#if defined BACNET_BACKUP_RESTORE
apdu_set_confirmed_handler(
SERVICE_CONFIRMED_ATOMIC_READ_FILE, handler_atomic_read_file);
apdu_set_confirmed_handler(
SERVICE_CONFIRMED_ATOMIC_WRITE_FILE, handler_atomic_write_file);
#endif
apdu_set_confirmed_handler(
SERVICE_CONFIRMED_REINITIALIZE_DEVICE, handler_reinitialize_device);
apdu_set_unconfirmed_handler(
SERVICE_UNCONFIRMED_UTC_TIME_SYNCHRONIZATION, handler_timesync_utc);
apdu_set_unconfirmed_handler(
SERVICE_UNCONFIRMED_TIME_SYNCHRONIZATION, handler_timesync);
apdu_set_confirmed_handler(
SERVICE_CONFIRMED_SUBSCRIBE_COV, handler_cov_subscribe);
/* handle communication so we can shutup when asked */
apdu_set_confirmed_handler(
SERVICE_CONFIRMED_DEVICE_COMMUNICATION_CONTROL,
handler_device_communication_control);
}
/** Main function of server demo.
*
* @see Device_Set_Object_Instance_Number, dlenv_init, Send_I_Am,
* datalink_receive, npdu_handler,
* dcc_timer_seconds, datalink_maintenance_timer,
* handler_cov_task, tsm_timer_milliseconds
*
* @param argc [in] Arg count.
* @param argv [in] Takes one argument: the Device Instance #.
* @return 0 on success.
*/
int main(int argc, char *argv[])
{
BACNET_ADDRESS src = { 0 }; /* address where message came from */
uint16_t pdu_len = 0;
unsigned timeout = 1; /* milliseconds */
time_t last_seconds = 0;
time_t current_seconds = 0;
uint32_t elapsed_seconds = 0;
uint32_t elapsed_milliseconds = 0;
uint32_t first_object_instance = FIRST_DEVICE_NUMBER;
#ifdef BACNET_TEST_VMAC
/* Router data */
BACNET_DEVICE_PROFILE *device;
BACNET_VMAC_ADDRESS adr;
#endif
/* allow the device ID to be set */
if (argc > 1) {
first_object_instance = strtol(argv[1], NULL, 0);
if ((first_object_instance == 0) ||
(first_object_instance > BACNET_MAX_INSTANCE)) {
printf("Error: Invalid Object Instance %s \n", argv[1]);
printf(
"Provide a number from 1 to %lu \n",
(unsigned long)BACNET_MAX_INSTANCE);
exit(1);
}
}
printf(
"BACnet Router Demo\n"
"BACnet Stack Version %s\n"
"BACnet Device ID: %u\n"
"Max APDU: %d\n"
"Max Devices: %d\n"
"Virtual Devices Count: %d\n",
BACnet_Version, first_object_instance, MAX_APDU, MAX_NUM_DEVICES,
VIRTUAL_DEVICE_COUNT);
Init_Service_Handlers(first_object_instance);
dlenv_init();
atexit(datalink_cleanup);
Devices_Init(first_object_instance);
Initialize_Device_Addresses();
#ifdef BACNET_TEST_VMAC
/* initialize vmac table and router device */
device = vmac_initialize(99, 2001);
debug_printf(device->name, "ROUTER:%u", vmac_get_subnet());
#endif
/* configure the timeout values */
last_seconds = time(NULL);
/* broadcast an I-am-router-to-network on startup */
printf("Remote Network DNET Number %d \n", DNET_list[0]);
Send_I_Am_Router_To_Network(DNET_list);
Send_Network_Number_Is(NULL, DNET_list[0], NETWORK_NUMBER_CONFIGURED);
handler_cov_init();
/* loop forever */
for (;;) {
/* input */
current_seconds = time(NULL);
/* returns 0 bytes on timeout */
pdu_len = datalink_receive(&src, &Rx_Buf[0], MAX_MPDU, timeout);
/* process */
if (pdu_len) {
routing_npdu_handler(&src, DNET_list, &Rx_Buf[0], pdu_len);
}
/* at least one second has passed */
elapsed_seconds = current_seconds - last_seconds;
if (elapsed_seconds) {
last_seconds = current_seconds;
dcc_timer_seconds(elapsed_seconds);
datalink_maintenance_timer(elapsed_seconds);
dlenv_maintenance_timer(elapsed_seconds);
elapsed_milliseconds = elapsed_seconds * 1000;
tsm_timer_milliseconds(elapsed_milliseconds);
Device_Timer(elapsed_milliseconds);
}
handler_cov_task();
if (Routed_Device_Index < Get_Num_Managed_Devices()) {
Get_Routed_Device_Object(Routed_Device_Index);
/* broadcast an I-Am for each routed Device now */
Send_I_Am(&Handler_Transmit_Buffer[0]);
Routed_Device_Index++;
}
}
/* Dummy return */
return 0;
}
/* @} */
/* End group GatewayDemo */