Update README.md
This commit is contained in:
@@ -44,7 +44,7 @@ accordance with section (3) of the GNU General Public License."
|
|||||||
|
|
||||||
The code is written in C for portability, and includes unit tests (PC based
|
The code is written in C for portability, and includes unit tests (PC based
|
||||||
unit tests). Since the code is designed to be portable, it compiles with GCC as
|
unit tests). Since the code is designed to be portable, it compiles with GCC as
|
||||||
well as other compilers, such as Borland C++ or MicroChip C18.
|
well as other compilers, such as Clang or IAR.
|
||||||
|
|
||||||
The BACnet protocol is an ASHRAE/ANSI/ISO standard, so this library adheres to
|
The BACnet protocol is an ASHRAE/ANSI/ISO standard, so this library adheres to
|
||||||
that standard. BACnet has no royalties or licensing restrictions, and
|
that standard. BACnet has no royalties or licensing restrictions, and
|
||||||
@@ -53,12 +53,19 @@ registration for a BACnet vendor ID is free.
|
|||||||
What the code does
|
What the code does
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
The stack comes with unit tests that can be run in a command shell using the
|
For an overview of this library architecture and how to use it, see
|
||||||
test.sh script. The unit tests can also be run using individual .mak files.
|
https://sourceforge.net/p/bacnet/src/ci/master/tree/doc/README.developer
|
||||||
They were tested on a Linux PC.
|
|
||||||
|
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
|
||||||
|
every commit within the Continuous Integration environment.
|
||||||
|
|
||||||
|
The BACnet stack was functionally tested using a variety of tools
|
||||||
|
as well as various controllers and workstations. It has been included
|
||||||
|
in many products that successfully completed BTL testing.
|
||||||
|
|
||||||
The BACnet stack was functionally tested using VTS (Visual Test Shell), another
|
|
||||||
project hosted on SourceForge, as well as various controllers and workstations.
|
|
||||||
Using the Makefile in the project root directory, a dozen sample applications
|
Using the Makefile in the project root directory, a dozen sample applications
|
||||||
are created that run under Windows or Linux. They use the BACnet/IP datalink
|
are created that run under Windows or Linux. They use the BACnet/IP datalink
|
||||||
layer for communication by default, but could be compiled to use BACnet
|
layer for communication by default, but could be compiled to use BACnet
|
||||||
@@ -67,25 +74,28 @@ Ethernet, ARCNET, or MS/TP.
|
|||||||
Linux/Unix/Cygwin
|
Linux/Unix/Cygwin
|
||||||
$ make clean all
|
$ make clean all
|
||||||
|
|
||||||
Windows
|
Windows MinGW Bash
|
||||||
c:\> build.bat
|
$ make win32
|
||||||
|
|
||||||
|
Windows Command Line
|
||||||
|
c:> build.bat
|
||||||
|
|
||||||
The BACnet stack can be compiled by a variety of compilers. The most common
|
The BACnet stack can be compiled by a variety of compilers. The most common
|
||||||
free compiler is GCC (MinGW under Windows). The makefiles use GCC by
|
free compiler is GCC (or MinGW under Windows). The makefiles use GCC by
|
||||||
default. Makefile.b32 are written for the Borland C++ 5.5 compiler, and
|
default.
|
||||||
projects are also included for Microsoft Visual Studio and Code::Blocks.
|
|
||||||
|
|
||||||
The demo applications are all client applications that provide one main BACnet
|
The demo applications are all client applications that provide one main BACnet
|
||||||
service, except the one server application. Each application will accept
|
service, except the one server application and one gateway application.
|
||||||
command line parameters, and prints the output to stdout or stderr. The client
|
Each application will accept command line parameters, and prints the output to
|
||||||
applications are command line based and can be used in scripts or for
|
stdout or stderr. The client applications are command line based and can
|
||||||
troubleshooting. The demo applications make use of environment variables to
|
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.
|
setup the network options. See each individual demo for the options.
|
||||||
|
|
||||||
There are also projects in the ports/ directory for ARM7, AVR, RTOS-32,
|
There are also projects in the ports/ directory for ARM7, AVR, RTOS-32, PIC,
|
||||||
and PIC. Each of those projects has a demo application for specific hardware.
|
and others. Each of those projects has a demo application for specific hardware.
|
||||||
In the case of the ARM7 and AVR, the makefile works with GCC compilers and
|
In the case of the ARM7 and AVR, their makefile works with GCC compilers and
|
||||||
there are project files for IAR Embedded Workbench.
|
there are project files for IAR Embedded Workbench and Rowley Crossworks for ARM.
|
||||||
|
|
||||||
Project Documentation
|
Project Documentation
|
||||||
---------------------
|
---------------------
|
||||||
@@ -93,15 +103,33 @@ Project Documentation
|
|||||||
The project documentation is in the doc/ directory. Similar documents are
|
The project documentation is in the doc/ directory. Similar documents are
|
||||||
on the project website at <http://bacnet.sourceforge.net/>.
|
on the project website at <http://bacnet.sourceforge.net/>.
|
||||||
|
|
||||||
Project Mailing List
|
Project Mailing List and Help
|
||||||
--------------------
|
-----------------------------
|
||||||
|
|
||||||
If you want to help this project, or have a problem getting it to work for
|
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
|
||||||
|
your code considered for inclusion.
|
||||||
|
|
||||||
|
If you find a bug in this project, please tell us about it at
|
||||||
|
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
|
||||||
|
https://sourceforge.net/p/bacnet/support-requests/
|
||||||
|
|
||||||
|
If you have a feature request, you can post it at
|
||||||
|
https://sourceforge.net/p/bacnet/feature-requests/
|
||||||
|
|
||||||
|
If you have a problem getting this library to work for
|
||||||
your device, or have a BACnet question, join the developers mailing list at:
|
your device, or have a BACnet question, join the developers mailing list at:
|
||||||
http://lists.sourceforge.net/mailman/listinfo/bacnet-developers
|
http://lists.sourceforge.net/mailman/listinfo/bacnet-developers
|
||||||
|
or post the question to the Open Discussion, Developers, or Help forums at
|
||||||
|
https://sourceforge.net/p/bacnet/discussion/
|
||||||
|
|
||||||
I hope that you get your BACnet Device working! If not, join us on the
|
I hope that you get your BACnet Device working!
|
||||||
mailing list and we can help.
|
|
||||||
|
|
||||||
Steve Karg, Birmingham, Alabama USA
|
Steve Karg, Birmingham, Alabama USA
|
||||||
skarg@users.sourceforge.net
|
skarg@users.sourceforge.net
|
||||||
|
|||||||
Reference in New Issue
Block a user