Strip tabs and trailing white spaces, and fix end of files (#748)
* format: Strip trailing whitespaces
We want to get rid of trailing whitespaces completly as they make just git
noice. Much better to start using automated tools to get rid of them once and
not getting them back again. This way git history will be cleaner and review
easier.
Commit was generated with:
pre-commit run --all-files trailing-whitespace
* format: Files should have exactly one new line end of them
It is good practice that every file has one new line. It is not now days so
mandatory but it also is not nice if file has lot of newlines end of it. We will
use pre-commit which takes automatically care about this so let's fix all.
Commit was generated with:
pre-commit run --all-files end-of-file-fixer
* format: Convert tabs to spaces
Project mostly use spaces over tabs. When mixing tabs and spaces this usually
makes formatting issues and also when changing those in commits it will make lot
of git noise. We will force spaces most of the time and use pre-commit to fix.
Commit was generated with:
pre-commit run --all-files remove-tabs
---------
Co-authored-by: Kari Argillander <kari.argillander@fidelix.com>
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
# BACnet Stack
|
||||
# BACnet Stack
|
||||
|
||||
BACnet open source protocol stack C library for embedded systems,
|
||||
Linux, MacOS, BSD, and Windows
|
||||
@@ -38,18 +38,18 @@ the standard (just like IEEE or ANSI or ISO).
|
||||
For software developers, the BACnet protocol is a standard way to send and
|
||||
receive messages containing data that are understood by other BACnet
|
||||
compliant devices. The BACnet standard defines a standard way to communicate
|
||||
over various wires or radios, known as Data Link/Physical Layers: Ethernet,
|
||||
EIA-485, EIA-232, ARCNET, and LonTalk. The BACnet standard also defines a
|
||||
over various wires or radios, known as Data Link/Physical Layers: Ethernet,
|
||||
EIA-485, EIA-232, ARCNET, and LonTalk. The BACnet standard also defines a
|
||||
standard way to communicate using UDP, IP, HTTP (Web Services), and Websockets.
|
||||
|
||||
This BACnet protocol stack implementation is specifically designed for the
|
||||
embedded BACnet appliance, using a GPL with exception license (like eCos),
|
||||
which means that any changes to the core code that are distributed are shared,
|
||||
but the BACnet library can be linked to proprietary code without the proprietary
|
||||
code becoming GPL. Note that some of the source files are designed as
|
||||
which means that any changes to the core code that are distributed are shared,
|
||||
but the BACnet library can be linked to proprietary code without the proprietary
|
||||
code becoming GPL. Note that some of the source files are designed as
|
||||
skeleton or example or template files, and are not copyrighted as GPL.
|
||||
|
||||
The text of the GPL exception included in each source file is as follows:
|
||||
The text of the GPL exception included in each source file is as follows:
|
||||
|
||||
* SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
@@ -70,8 +70,8 @@ https://sourceforge.net/p/bacnet/src/ci/master/tree/doc/README.developer
|
||||
|
||||
This stack includes unit tests that can be run using the Makefile in the
|
||||
project root directory "make test".
|
||||
The unit tests can also be run using individual make invocations.
|
||||
The unit tests run a PC and continue to do so with
|
||||
The unit tests can also be run using individual make invocations.
|
||||
The unit tests run a PC and continue to do so with
|
||||
every commit within the Continuous Integration environment.
|
||||
|
||||
The BACnet stack was functionally tested using a variety of tools
|
||||
@@ -80,7 +80,7 @@ in many products that successfully completed BTL testing.
|
||||
|
||||
Using the Makefile in the project root directory, a dozen sample applications
|
||||
are created that run under Windows or Linux. They use the BACnet/IPv4 datalink
|
||||
layer for communication by default, but could be compiled to use BACnet IPv6,
|
||||
layer for communication by default, but could be compiled to use BACnet IPv6,
|
||||
Ethernet, ARCNET, or MS/TP.
|
||||
|
||||
Linux/Unix/Cygwin
|
||||
@@ -106,7 +106,7 @@ to generate a Code::Blocks project:
|
||||
$ mkdir build
|
||||
$ cd build/
|
||||
$ cmake .. -G"CodeBlocks - Unix Makefiles"
|
||||
|
||||
|
||||
c:\> mkdir build
|
||||
c:\> cd build/
|
||||
c:\> cmake .. -G"CodeBlocks - MinGW Makefiles"
|
||||
@@ -114,22 +114,22 @@ to generate a Code::Blocks project:
|
||||
The unit tests also use CMake and may be run with the command sequence:
|
||||
|
||||
$ make test
|
||||
|
||||
|
||||
The unit test framework uses a slightly modified ztest, and the tests are located
|
||||
in the test/ folder. The unit test builder uses CMake, and the test coverage
|
||||
uses LCOV. The HTML results of the unit testing coverage are available starting
|
||||
in the test/ folder. The unit test builder uses CMake, and the test coverage
|
||||
uses LCOV. The HTML results of the unit testing coverage are available starting
|
||||
in the test/build/lcoverage/index.html file.
|
||||
|
||||
The demo applications are all client applications that provide one main BACnet
|
||||
service, except the one server application and one gateway application,
|
||||
service, except the one server application and one gateway application,
|
||||
a couple router applications, and a couple of MS/TP specific applications.
|
||||
Each application will accept command line parameters, and prints the output to
|
||||
stdout or stderr. The client applications are command line based and can
|
||||
be used in scripts or for troubleshooting.
|
||||
The demo applications make use of environment variables to
|
||||
Each application will accept command line parameters, and prints the output to
|
||||
stdout or stderr. The client applications are command line based and can
|
||||
be used in scripts or for troubleshooting.
|
||||
The demo applications make use of environment variables to
|
||||
setup the network options. See each individual demo for the options.
|
||||
|
||||
There are also projects in the ports/ directory for ARM7, AVR, RTOS-32, PIC,
|
||||
There are also projects in the ports/ directory for ARM7, AVR, RTOS-32, PIC,
|
||||
and others. Each of those projects has a demo application for specific hardware.
|
||||
In the case of the ARM7 and AVR, their makefile works with GCC compilers and
|
||||
there are project files for IAR Embedded Workbench and Rowley Crossworks for ARM.
|
||||
@@ -146,7 +146,7 @@ Project Mailing List and Help
|
||||
If you want to contribute to this project and have some C coding skills,
|
||||
join us via https://github.com/bacnet-stack/bacnet-stack/
|
||||
or via https://sourceforge.net/p/bacnet/src/ and create a
|
||||
fork or branch, and eventually a pull request to have
|
||||
fork or branch, and eventually a pull request to have
|
||||
your code considered for inclusion.
|
||||
|
||||
If you find a bug in this project, please tell us about it at
|
||||
@@ -154,7 +154,7 @@ https://sourceforge.net/p/bacnet/bugs/
|
||||
or
|
||||
https://github.com/bacnet-stack/bacnet-stack/issues
|
||||
|
||||
If you have a support request, you can post it at
|
||||
If you have a support request, you can post it at
|
||||
https://sourceforge.net/p/bacnet/support-requests/
|
||||
|
||||
If you have a feature request, you can post it at
|
||||
@@ -171,6 +171,6 @@ I hope that you get your BACnet Device working!
|
||||
Steve Karg, Birmingham, Alabama USA
|
||||
skarg@users.sourceforge.net
|
||||
|
||||
ASHRAE® and BACnet® are registered trademarks of the
|
||||
ASHRAE® and BACnet® are registered trademarks of the
|
||||
American Society of Heating, Refrigerating and Air-Conditioning Engineers, Inc.
|
||||
180 Technology Parkway NW, Peachtree Corners, Georgia 30092 US.
|
||||
|
||||
Reference in New Issue
Block a user