BACnet open source protocol for embedded systems using Zephyr OS integrated with BACnet Stack C library hosted on Sourceforge and Github sites.

• Github
• Sourceforge

This integration uses automated continuous integration services to assist in automated compilation, validation, linting, security scanning, and unit testing to produce robust C code.

GitHub Workflow: BACnet Stack Zephyr Twister Unit Tests and Sample Build

GitHub Workflow: CodeQL Analysis

The Zephyr OS integration offers a collection of samples in the zephyr/samples folder that highlight the features of this BACnet integration, including some BACnet Basic dynamically created objects and services that can be used to quickly create a custom BACnet device on a variety of existing boards.

These samples are crafted to be simple and easy to understand, serving as a starting point for your own projects.

This repository is a Zephyr manifest-module, which means it can be used in either of the following ways:

• As a module brought in by a different manifest (recommended for product development)

  [Prototyped but not verified] Add the following into the root manifest file (e.g., $workspace_dir/$manifest_repo/west.yml)

  # In external manifest repository, `west.yml`
  # to bring in the Zephyr integration of bacnet-stack
  # as a Zephyr module
  
    # Add the following under remotes:
      - name: bacnet-stack
        url-base: https://github.com/bacnet-stack
  
    # Add the following under projects:
      - name: bacnet
        repo-path: bacnet-stack-zephyr
        path: modules/lib/bacnet
        import:
          name-allowlist:
            - bacnet-stack
  
      - name: bacnet-stack
        path: modules/lib/bacnet/stack
  

  • As a workspace manifest repository (recommended for bacnet-stack contributions):

    west init -m https://github.com/bacnet-stack/bacnet-stack-zephyr --mr default $my_workspace

Note that as Zephyr OS versions change, their API often changes. This library will use the following methods to accommodate the changes:

1. Use defines from <zephyr/version.h> for API changes:

   #if ZEPHYR_VERSION_CODE >= ZEPHYR_VERSION(4,2,0)
   typedef uint64_t mgmt_event_t;
   #else
   typedef uint32_t mgmt_event_t;
   #endif
   

2. In CMakeLists.txt, after find_package(Zephyr) has returned, by checking the Zephyr version for source files, include paths, or compile definitions:

   if ("${KERNEL_VERSION_STRING}" VERSION_GREATER_EQUAL "4.2.0")
   # Do stuff...
   endif()
   

   KERNEL_VERSION_STRING is not available before find_package(Zephyr) runs Kconfig, so this cannot select Kconfig fragments (CONF_FILE, EXTRA_CONF_FILE) or board overlays. See 3 and 4.

3. In Kconfig, which is processed by the Zephyr tree being built. Kconfig is processed inside find_package(Zephyr), so CONF_FILE and EXTRA_CONF_FILE cannot be chosen from KERNEL_VERSION_STRING in CMakeLists.txt. When a symbol was renamed between Zephyr versions, use a sample Kconfig that selects both names, since selecting a symbol that the Zephyr tree does not define is ignored. See the b-asc sample.

4. There is not a clean way to manage version breaking changes in .dts, .dtsi or .overlay files since the device tree compile occurs before the version.h file is generated.

A simple "Hello World" sample that can be used with any supported board boards and prints "Hello BACnet-Stack" to the console.

A device application demonstrating configuration of a BACnet Smart Actuator (B-SA) device profile that can be used with any supported boards.

A device application demonstrating configuration of a BACnet Smart Sensor (B-SS) device profile that can be used with any supported boards.

A device application demonstrating configuration of a BACnet Lighting Device (B-LD) device profile that can be used with any supported boards.

A device application demonstrating configuration of a BACnet Lighting Supervisor (B-LS) device profile that can be used with any supported boards.

A device application demonstrating configuration of a BACnet Application Specific Controller (B-ASC) device profile that can be used with any supported boards.

See the BACnet File shell guide for configuration, commands, and backup decoding details.

See Zephyr Project Coding Guidelines