This is a dedicated RPC server BACnet app with a web UI that also has "rest like" features to read and write BACnet data to and from a building automation system (BAS) or some sort of BACnet device operating on a LAN inside a building. This has been tested on Linux with the CLI interface. Supports tls and Basic Auth through the Fast API web framework. This Linux app is meant to run on a intranet or edge environment behind the firewall along side typical operations technology (OT).
$ python -m pip install bacpypes3 ifaddr fastapi uvicorn
$ python app/rpc-server.py --host 0.0.0.0 --port 8080 --debugExample args to run app on http with setting Basic Auth username for the app of myusername and password of mypassword. Default app username and pass is admin and secret which should be changed for security purposes.
$ python app/rpc-server.py --basic-auth-username=myusername --basic-auth-password=mypasswordIf running your app on http without tls support log into swagger UI on: http:https://192.168.0.102:8000/docs
To ecprypte http web app TCP traffic only, not BACnet which runs on UDP... Generate certs with running the bash script inside the scripts directory. Step through the Q/A process for generating the self signed certs about inputing country code, organization, and contact info.
$ ./scripts/generate_certs.sh$ python app/rpc-server.py --tls --debugIf running your app with tls support log into the Fast API swagger UI: https://192.168.0.102:5000/docs
Proceed to then enter your credentials for the Authorize in the Swagger UI.
Tutorial via Swagger UI
When the app starts successfully dial into the built in Swagger UI feature of Fast API which can be used to test various BACnet commands.
Test if the BACnet device responds to a whois for the devices BACnet instance ID.
If successful should return:
[
{
"i-am-device-identifier": "device,201201",
"max-apdu-length-accepted": 286,
"segmentation-supported": "no-segmentation",
"vendor-id": 11
}
]Read request to device 201201 analog-value 301 present-value which is a temperature sensor.
If successful should return:
{
"success": true,
"message": "BACnet read request successfully invoked",
"data": {
"device_instance": 201201,
"object_identifier": "analog-input,2",
"property_identifier": "present-value",
"read_result": 69.42999267578125
}
}
Read property of a different property_identifier which can be unique to the BACnet device. See bacpypes3 repo basetypes.py for more info: https://github.com/JoelBender/BACpypes3/blob/main/bacpypes3/basetypes.py
If successful should return:
{
"success": true,
"message": "BACnet read request successfully invoked",
"data": {
"device_instance": 201201,
"object_identifier": "analog-input,2",
"property_identifier": "out-of-service",
"read_result": false
}
}
Write request to device 201201 analog-value 301 present-value for a value of 10 on BACnet priority 10.
If successful should return:
{
"success": true,
"message": "BACnet write request successfully invoked",
"data": {
"device_instance": 201201,
"object_identifier": "analog-value,301",
"property_identifier": "present-value",
"written_value": 10,
"priority": 10
}
}Release an override by passing in the value of null.
If successful should return:
{
"success": true,
"message": "BACnet write request successfully invoked",
"data": {
"device_instance": 201201,
"object_identifier": "analog-value,301",
"property_identifier": "present-value",
"written_value": "null",
"priority": 10
}
}TODO on implementing future BACnet features:
- whois POST request for a range of instance ID's
- read multiple request
- point discovery
- who is router-to-network
- read point proirity array
- read range for BACnet devices that support trend log data
- create unit tests
- add pydantic model validation for server requests
- add ModBus support which would be used to read a utility meter only
MIT License
Copyright (c) 2024 Ben Bartling
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
ADDITIONAL CYBERSECURITY NOTICE: Users are encouraged to apply the highest level of cybersecurity, OT, IoT, and IT measures when using this software. The authors and copyright holders disclaim any liability for cybersecurity breaches, mechanical equipment damage, financial damage, or loss of life arising from the use of the Software. Users assume full responsibility for ensuring the secure deployment and operation of the Software in their environments.