Skip to content

Commit 0148d63

Browse files
committed
Updated README with reference to actions and samples.
1 parent 7d57037 commit 0148d63

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,36 @@
11
# bacnet-stack-zephyr
22

3-
[Zephyr OS](https://zephyrproject.org/) integration of BACnet Stack
3+
BACnet open source protocol for embedded systems
4+
using [Zephyr OS](https://zephyrproject.org/) integrated with BACnet Stack
45
C library hosted on Sourceforge and Github sites.
56

67
* [Github](https://github.com/bacnet-stack/bacnet-stack)
78
* [Sourceforge](https://bacnet.sourceforge.net/)
89

10+
# Continuous Integration
11+
12+
This integration uses automated continuous integration services to assist in automated compilation, validation, linting, security scanning, and unit testing to produce robust C code.
13+
14+
[![Actions Status](https://github.com/bacnet-stack/bacnet-stack/workflows/CMake/badge.svg)](https://github.com/bacnet-stack/bacnet-stack/actions/workflows/zephyr.yml) GitHub Workflow: BACnet Stack Zephyr Twister Unit Tests
15+
16+
# What the code does
17+
18+
The Zephyr OS integration offers a collection of samples in the zephyr/samples
19+
folder that highlight the features of this BACnet integration, include some
20+
BACnet Basic objects and services that can be used to quickly create a BACnet
21+
device on a variety of existing boards.
22+
23+
These samples are crafted to be simple and easy to understand, serving as a starting point for your own projects.
24+
25+
## Hello BACnet Stack
26+
27+
A simple "Hello World" sample that can be used with any supported board boards and prints ["Hello BACnet-Stack"](./zephyr/samples/hello_bacnet_stack/README.rst) to the console.
28+
29+
## BACnet Application Profile Simple Sensor (B-SS)
30+
31+
A device application demonstrating configuration of a
32+
[BACnet B-SS (simple sensor) device profile](./zephyr/samples/profiles/b-ss/README.rst) that can be used with any supported board boards.
33+
934
# Coding Style and Guidelines
1035

1136
See Zephyr Project [Coding Guidelines](https://docs.zephyrproject.org/latest/contribute/coding_guidelines/index.html)

0 commit comments

Comments
 (0)