VOLTTRON™ is an open source platform for distributed sensing and control. The platform provides services for collecting and storing data from buildings and devices and provides an environment for developing applications which interact with that data.
> pip install volttron
Setup VOLTTRON_HOME environment variable: export VOLTTRON_HOME=/path/to/volttron_home/dir
NOTE This is madatory if you have/had in the past, a monolithic VOLTTRON version that used the default VOLTTRON_HOME $HOME/.volttron. This modular version of VOLTTRON cannot work with volttron_home used by monolithic version of VOLTTRON(version 8.3 or earlier)
Start the platform
> volttron -vv -l volttron.log &>/dev/null &
Install listener agent
> vctl install volttron-listener
View status of platform
> vctl status
Shutdown the platform
> vctl shutdown --platform
Full VOLTTRON documentation available at VOLTTRON Readthedocs
Please see the contributing.md document before contributing to this repository.
Setup VOLTTRON_HOME environment variable: export VOLTTRON_HOME=/path/to/volttron_home/dir.
This is madatory if you have/had in the past, a monolithic VOLTTRON version that used the default VOLTTRON_HOME $HOME/.volttron. Modular version of VOLTTRON cannot work with volttron_home used by monolithic version of VOLTTRON(version 8.3 or earlier)
VOLTTRON uses Poetry, a dependency management and packaging tool for Python. If you don't have Poetry installed on your machine, follow these steps to install it on your machine.
To check if Poetry is installed, run poetry --version
. If you receive the error 'command not found: poetry', add the following line to your '~/.bashrc' script: export PATH=$PATH:$HOME/.local/bin
.
By default, poetry creates a virtual environment in {cache-dir}/virtualenvs. To configure 'poetry' to create the virtualenv inside this project's root directory, run the following command:
poetry config virtualenvs.in-project true
Clone the repository
git clone https://github.com/eclipse-volttron/volttron-core -b develop
cd into volttron-core directory
cd volttron-core
Install volttron into the current directory
poetry install
Run tests
poetry run pytest
Activate environment (removes the need for add poetry run to all commands)
poetry shell
Run volttron
volttron -vv -l volttron.log &>/dev/null &
In order to run VOLTTRON from within an ide the recommended way is to run the platform using the modules
> poetry shell
> python -m volttron.server -vv -l volttron.log &
> python -m volttron.commands.control -vv status
Please see the contributing.md document before contributing to this repository.
Happy Editing!