Welcome to Easy ASO, the ultimate command tool for Automated Supervisory Optimization (ASO) of BACnet systems in EMIS applications. Built on a seamless Python asyncio framework, Easy ASO comes with a fully integrated BACnet asyncio stack for convenience, making BACnet—the default protocol in the HVAC industry—effortless to use. Other protocols can also be implemented during the development process, offering flexibility and extensibility.
Control BACnet systems on a simple on_start, on_step, and on_stop structure:
class CustomHvacAso(EasyASO):
async def on_start(self):
print("Custom ASO is deploying! Lets do something!")
async def on_step(self):
# BACnet read request
sensor = await self.bacnet_read("192.168.0.122", "analog-input,1")
# Custom step logic - BACnet write request
override_valve = sensor + 5.0
await self.bacnet_write("192.168.0.122", "analog-output,2", override_valve)
print("Executing step actions... The system is being optimized!")
await asyncio.sleep(60)
async def on_stop(self):
# Custom stop logic - BACnet release request
await self.bacnet_write("192.168.0.122", "analog-output,2", 'null')
print("Executing stop actions... The system is released back to normal!")- Read
- Write
- Read Multiple
- Write Multiple
- Whois
- Read Priority Array
- Anything else? 🤔
The tester.py script, located in the scripts directory, provides a utility for exploring a remote BACnet site via the bacpypes3 console.
This tool is designed to assist in the setup and configuration of the easy-aso project, streamlining the integration process.
For detailed information and instructions on using the Tester.py script, please refer to the setup_scripts directory README for more information.
- Read Property (
read_property) - Write Property (
write_property) - Read Property Multiple (
read_property_multiple) - Read Priority Array (
read_propertywithpriority-array) - Device Discovery (
who-is) - Object Discovery (
who-has) - Read All Points (
do_point_discovery) - Router Discovery (
who_is_router_to_network)
Why can't a BAS be free?
Can ASO be easy?
Can ASO be used to aid Fault Detection and Diagnostics (FDD)?
- Overhaul app code with bacpypes3
- Test basic functionality with a fake BACnet app
- Create unit tests for BACnet server and client with docker containers
- Publish the project as a Python library on PyPI
- Make tutorials for ASO based on an LBNL reference for:
- Electrical load shed example
- Classic BAS Supervisory control to share data globally via BACnet priority
- AHU duct static pressure and temperature setpoint trim and respond (T&R)
- AHU demand control ventilation based on G36 and ventilation calcs
- VAV box system occupied-standby with occupancy integration to HVAC
- Overnight building flush
- Overnight BACnet override release bot
- Heat pump system cold weather staggered start for electrical power management
- Electrical load shift
- Identify rogue zones in an HVAC system
- Self-commissioning AHU system bots
- How to run Python scripts long-term in a Docker container
easy-aso is designed to be a fully discoverable BACnet server that can seamlessly integrate into any existing building automation system (BAS).
The core of this integration relies on a discoverable BACnet binary-value point named optimization-enabled.
This point allows building operators to maintain full control over the Automated Systems Optimization (ASO) processes.
If, at any time, an operator needs to disable an ASO instance, the optimization-enabled point provides a direct means to turn off the optimization for any part of the HVAC system.
This feature is crucial for maintaining operational flexibility and preventing unwanted system behavior.
In the event of an issue, such as undesired system behavior or an operator decision to revert control, this BACnet point can be incorporated directly into the logic of easy-aso.
This ensures that any overrides the script may have applied are released safely and promptly.
For a clearer understanding of how this callback is integrated into the ASO design of easy-aso, refer to the example Python files that demonstrate its practical implementation.
By default, easy-aso is deployed within a secure, internal network (behind a firewall), where it can operate efficiently with existing IoT.
However, easy-aso is also fully compatible with traditional operational technology (OT) systems that do not have internet access, supporting more traditional building environments that rely solely on local control.
Flexibility is at the heart of easy-aso. In a Python asyncio environment, it is easy to extend and build around, enabling the potential for cloud-based integrations.
This presents an intriguing solution for a Master Systems Integrator (MSI) looking to completely revamp their existing edge environment and start fresh with a modernized approach.
Follow the instructions below to set up the easy-aso project on your local Linux machine.
Until the project is available on PyPI, you can install it locally by following these steps.
After the scripts are thoroughly tested and commissioned, they can be run long-term in a Docker container.
See the sub-directory docker_setup for more information.
First, clone the easy-aso repository to your local machine:
git clone https://github.com/bbartling/easy-asoNavigate into the project directory and install it using pip. This will make the easy-aso package available in your Python environment.
cd easy-aso
pip install .- Check out the
examplesdirectory for sample applications. - Review the
easy-asoAPI documentation README for method call specifics when creating apps. - Run a fake BACnet app and try out code such as
tester.pyin a sandbox environment. Note that both require two Linux devices — I use an Ubuntu VM and a Raspberry Pi for the fake BACnet device, which acts as another BACnet device on the LAN.
Easy ASO is designed as an operations technology (OT) application with no built-in cloud connectivity, but it is fully capable of anything programmed in Python. Any implementation of cloud connectivity for this app is the responsibility of the user. It is crucial to understand the cybersecurity implications of sending bi-directional signals to building systems.
Security Best Practices:
- Ensure the safety of your systems by following recommended cybersecurity best practices, including network, VPN, and VM access hardening, secure configurations, and routine security checks. 🛡️
- Work closely with the IT team when enabling cloud connectivity to ensure it complies with your organization's security policies. 🔒
- Involve IT in all stages of the project and address any issues related to the implementation of easy-aso.
- Safeguard building control systems by utilizing access controls, encryption, and secure communication protocols to prevent unauthorized access. 🔐
- Act in the capacity of an ICS security specialist on behalf of your client, and promptly report any vulnerabilities or issues you discover.
- Develop an incident response plan to ensure the project is prepared for any potential security breaches, enabling swift and effective action from the incident response team should an issue arise during the implementation of easy-aso. 🔧
PRs, git issues, and discussions are highly encouraged!
Please reference the README for more information.
【MIT License】
Copyright 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.