├── Dockerfile ├── LICENSE ├── README.md ├── bacnet-wrapper ├── docker-compose.yml └── simulator /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ubuntu:18.04 2 | # Alpine preferred but glibc is needed and popular workarounds don't do enough. 3 | 4 | ADD https://astuteinternet.dl.sourceforge.net/project/bacnet/bacnet-stack/bacnet-stack-0.8.6/bacnet-stack-0.8.6.tgz . 5 | ADD bacnet-wrapper / 6 | ADD simulator / 7 | 8 | RUN apt-get update && apt-get -y install build-essential \ 9 | && tar zxf bacnet-stack-0.8.6.tgz \ 10 | && cd bacnet-stack-0.8.6 \ 11 | && make \ 12 | && rm -f bin/*.txt bin/*.bat \ 13 | && mv bin/* /usr/local/bin \ 14 | && chmod a+x /bacnet-wrapper \ 15 | && cd / \ 16 | && rm -rf /bacnet-stack* \ 17 | && apt-get -y remove build-essential \ 18 | && apt-get -y autoremove \ 19 | && apt-get -y autoclean 20 | 21 | EXPOSE 47808:47808/udp 22 | 23 | CMD ["/bacnet-wrapper"] 24 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # BACnet Tools in Docker 2 | 3 | This is a simple packaging of the [BACnet Protocol Stack](https://sourceforge.net/projects/bacnet) into a single docker image. Once there it's simple to simulate a network of BACnet/IP clients and servers of various types, each in their own container, specified by a simple docker-compose file. BACnet/ethernet might also be possible, but I haven't tried yet. 4 | 5 | It's instructive observe the traffic between containers with Wireshark or tcpdump. 6 | 7 | ## Usage 8 | First, build the BACnet container. 9 | 10 | ``` 11 | $ docker build -t bacnet . 12 | ``` 13 | 14 | Next, stand up several servers by editing docker-compose.yml for desired number of servers, clients, and device IDs, then: 15 | 16 | ``` 17 | $ docker-compose up -d 18 | ``` 19 | 20 | The "-d" runs everything in the background. You can then observe logs from all of them like this: 21 | 22 | ``` 23 | $ docker-compose logs 24 | Attaching to bacnet_whois_1, bacnet_server1_1, bacnet_server2_1, bacnet_server3_1 25 | whois_1 | Received I-Am Request from 200002, MAC = 172.17.0.3 BAC0 26 | whois_1 | Received I-Am Request from 200001, MAC = 172.17.0.4 BAC0 27 | whois_1 | Received I-Am Request from 200003, MAC = 172.17.0.2 BAC0 28 | whois_1 | ;Device MAC (hex) SNET SADR (hex) APDU 29 | whois_1 | ;-------- -------------------- ----- -------------------- ---- 30 | whois_1 | 200002 AC:11:00:03:BA:C0 0 00 1476 31 | whois_1 | 200001 AC:11:00:04:BA:C0 0 00 1476 32 | whois_1 | 200003 AC:11:00:02:BA:C0 0 00 1476 33 | whois_1 | ; 34 | whois_1 | ; Total Devices: 3 35 | ``` 36 | 37 | You can also issue commands as needed from a new, transient container: 38 | 39 | ``` 40 | $ docker run -it bacnet bacwi 41 | $ docker run -it bacnet bacepics -v 200002 42 | etc 43 | ``` 44 | See the [BACnet stack bin documentation](https://sourceforge.net/p/bacnet/code/HEAD/tree/branches/releases/bacnet-stack-0-8-0/bin/readme.txt) for ideas. 45 | 46 | ## Packet Capture 47 | The example `docker-compose.yml` uses bridge-mode networking, which means the `docker0` network interface (on Linux hosts, anyway) is usually carrying all the ethernet traffic. The tcpdump command looks like this; the wireshark one is similar. 48 | 49 | ``` 50 | $ sudo tcpdump -i docker0 51 | tcpdump: verbose output suppressed, use -v or -vv for full protocol decode 52 | listening on docker0, link-type EN10MB (Ethernet), capture size 262144 bytes 53 | 13:17:59.066397 IP6 foo > ff02::16: HBH ICMP6, multicast listener report v2, 2 group record(s), length 48 54 | 13:17:59.320945 IP 172.17.0.2.47808 > 172.17.255.255.47808: UDP, length 25 55 | 13:17:59.862393 IP6 foo > ff02::16: HBH ICMP6, multicast listener report v2, 2 group record(s), length 48 56 | ... 57 | ``` 58 | 59 | ## Comms Welcome 60 | Feel free to submit issues or pull requests. 61 | -------------------------------------------------------------------------------- /bacnet-wrapper: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | bin=/usr/local/bin 4 | 5 | if [[ x"$1" != x && -f $bin/$1 && -x $bin/$1 ]]; then 6 | exec $@ 7 | else 8 | echo 'Usage: docker run -it bacnet ' 9 | echo '... where is one of:' 10 | ls -C $bin 11 | exit 1 12 | fi 13 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | 2 | version: '3' 3 | services: 4 | 5 | server: 6 | image: bacnet 7 | command: ["bacserv", "200001"] 8 | network_mode: bridge 9 | 10 | # Pump values into server. 11 | # TODO: Needs more convenient Env based config 12 | simulator: 13 | image: bacnet 14 | depends_on: 15 | - server 16 | command: ["perl", "/simulator"] 17 | network_mode: bridge 18 | 19 | -------------------------------------------------------------------------------- /simulator: -------------------------------------------------------------------------------- 1 | # 2 | # Pump some random-walk values into the given bacnet server 3 | # See bacnet-stack-0.8.6/demo/perl/Documentation/index.html for details on the perl bindings 4 | # 5 | # The perl bindings in bacnet-stck would be best but they're not in the mood to compile today 6 | # and I'm not in the mood to debug them. 7 | # 8 | # bacwp 200001 1 3 85 16 -1 4 3.1415 9 | # WriteProperty Acknowledged! 10 | # 11 | # bacrp 200001 2 0 85 12 | # 39.914135 13 | # 14 | # bacrp 200001 2 1 85 15 | # 59.480858 16 | # 17 | use strict; 18 | use warnings; 19 | 20 | # default server params 21 | my $DEVICE = 200001; 22 | my $PRIORITY = 16; 23 | 24 | # update this often 25 | my $FREQ_SEC = 60; 26 | 27 | # Object Types 28 | my $OBJECT_ANALOG_INPUT = 0; 29 | my $OBJECT_ANALOG_OUTPUT = 1; 30 | my $OBJECT_ANALOG_VALUE = 2; 31 | 32 | # Application Tags 33 | my $BACNET_APPLICATION_TAG_NULL = 0; 34 | my $BACNET_APPLICATION_TAG_BOOLEAN = 1; 35 | my $BACNET_APPLICATION_TAG_UNSIGNED_INT = 2; 36 | my $BACNET_APPLICATION_TAG_SIGNED_INT = 3; 37 | my $BACNET_APPLICATION_TAG_REAL = 4; 38 | my $BACNET_APPLICATION_TAG_DOUBLE = 5; 39 | my $BACNET_APPLICATION_TAG_OCTET_STRING = 6; 40 | my $BACNET_APPLICATION_TAG_CHARACTER_STRING = 7; 41 | my $BACNET_APPLICATION_TAG_BIT_STRING = 8; 42 | my $BACNET_APPLICATION_TAG_ENUMERATED = 9; 43 | my $BACNET_APPLICATION_TAG_DATE = 10; 44 | my $BACNET_APPLICATION_TAG_TIME = 11; 45 | my $BACNET_APPLICATION_TAG_OBJECT_ID = 12; 46 | 47 | # Property IDs 48 | my $PROP_PRESENT_VALUE = 85; 49 | 50 | # Seed some initial values into current. Inst num -> value 51 | my @current_values = (44, 55, 66, 77); 52 | my $nvals = scalar @current_values; 53 | my $maxval = 1000; 54 | my $minval = 10; 55 | 56 | while (1) { 57 | for (my $idx=0; $idx < $nvals; $idx++) { 58 | # Move a random amount in a random direction, maximum of 10% of current value. 59 | my $oldval = $current_values[$idx]; 60 | my $sign = (rand 1 > 0.5) ? 1 : -1; 61 | my $amt = rand(.1 * $current_values[$idx]); 62 | my $newval = $oldval + $sign * $amt; 63 | if ($newval < $minval) { 64 | $newval = $minval + $amt; 65 | } 66 | elsif ($newval > $maxval) { 67 | $newval = $maxval - $amt; 68 | } 69 | $current_values[$idx] = $newval; 70 | 71 | print "$idx: $oldval -> $newval\n"; 72 | 73 | # bacwp device-instance object-type object-instance property priority index tag value [tag value...] 74 | my $cmd = "bacwp $DEVICE $OBJECT_ANALOG_VALUE $idx $PROP_PRESENT_VALUE $PRIORITY -1 $BACNET_APPLICATION_TAG_REAL $newval"; 75 | print("$cmd\n"); 76 | `$cmd`; 77 | } 78 | 79 | sleep $FREQ_SEC; 80 | } 81 | --------------------------------------------------------------------------------