Skip to content

Latest commit

 

History

History
151 lines (106 loc) · 5.68 KB

README.md

File metadata and controls

151 lines (106 loc) · 5.68 KB
Raw

volttron-lib-bacnet-driver

Passing? pypi version

Prerequisites

  • Python 3.8

Python

To install Python 3.8, we recommend using pyenv. 
# install pyenv
git clone https://github.com/pyenv/pyenv ~/.pyenv

# setup pyenv (you should also put these three lines in .bashrc or similar)
export PATH="${HOME}/.pyenv/bin:${PATH}"
export PYENV_ROOT="${HOME}/.pyenv"
eval "$(pyenv init -)"

# install Python 3.8
pyenv install 3.8.10

# make it available globally
pyenv global system 3.8.10

Poetry

This project uses poetry to install and manage dependencies. To install poetry, follow these instructions.

Installation

  1. Create and activate a virtual environment.
python -m venv env
source env/bin/activate
  1. Installing volttron-platform-driver requires a running volttron instance. Install volttron and start an instance in the background and save log output to a file named 'volttron.log'
pip install volttron
volttron -vv -l volttron.log &
  1. Install the volttron platform driver:
vctl install volttron-platform-driver --vip-identity platform.driver --start
  1. Install the BACnetProxy agent:
vctl install volttron-bacnet-proxy --agent-config <path to bacnet proxy agent configuration file> \
--vip-identity platform.bacnet_proxy \
--start
  1. Install the volttron bacnet driver library:
pip install volttron-lib-bacnet-driver
  1. Install a BACnet Driver onto the Platform Driver.

Installing a BACnet driver in the Platform Driver Agent requires adding copies of the device configuration and registry configuration files to the Platform Driver’s configuration store.

  • Create a config directory and navigate to it:
mkdir config
cd config
  • Create a file called bacnet.config; it should contain a JSON object that specifies the configuration of your BACnet driver. An example of such a file is provided at the root of this project; the example file is named 'bacnet.config'. The following JSON is an example of a bacnet.config:
{
    "driver_config": {"device_address": "123.45.67.890",
                      "device_id": 123456},
    "driver_type": "bacnet",
    "registry_config":"config://bacnet.csv",
    "interval": 15,
    "timezone": "US/Pacific"
}

ℹ️ TIP: In the driver_config, device_address is the address bound to the network port over which BACnet communication will happen on the computer running VOLTTRON. This is NOT the address of any target device. See BACnet Router Addressing.

  • Create another file called bacnet.csv; it should contain all the points on the device that you want published to Volttron. An example of such a CSV file is provided at the root of this project; the example CSV file is named 'bacnet.csv'. The following CSV file is an example:
Point Name,Volttron Point Name,Units,Unit Details,BACnet Object Type,Property,Writable,Index,Notes
12345a/Field Bus.12345A CHILLER.AHU-COIL-CHWR-T,12345a/Field Bus.12345A CHILLER.AHU-COIL-CHWR-T,degreesFahrenheit,-50.00 to 250.00,analogInput,presentValue,FALSE,3000741,,Primary CHW Return Temp
  • Add the bacnet driver config and bacnet csv file to the Platform Driver configuration store:
vctl config store platform.driver bacnet.csv bacnet.csv --csv
vctl config store platform.driver devices/bacnet bacnet.config
  1. Observe Data

To see data being published to the bus, install a Listener Agent:

vctl install volttron-listener --start

Once installed, you should see the data being published by viewing the Volttron logs file that was created in step 2. To watch the logs, open a separate terminal and run the following command:

tail -f <path to folder containing volttron.log>/volttron.log

Development

Please see the following for contributing guidelines contributing.

Please see the following helpful guide about developing modular VOLTTRON agents

Disclaimer Notice

This material was prepared as an account of work sponsored by an agency of the United States Government. Neither the United States Government nor the United States Department of Energy, nor Battelle, nor any of their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, or process disclosed, or represents that its use would not infringe privately owned rights.

Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or favoring by the United States Government or any agency thereof, or Battelle Memorial Institute. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.