Skip to main content

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.

Project description

Eclipse VOLTTRON™ (VOLTTRON/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.

Python 3.10 Python 3.11 Pytests pypi version

Installation

It is recommended to use a virtual environment for installing volttron.

python -m venv env
source env/bin/activate

pip install volttron

Quick Start

  1. 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)

  2. Start the platform

    volttron -vv -l volttron.log &>/dev/null &
    
  3. Install listener agent

    vctl install volttron-listener --start
    
  4. View status of platform

    vctl status
    
  5. Shutdown the platform

    vctl shutdown --platform
    

Full VOLTTRON documentation available at VOLTTRON Readthedocs

Contributing to VOLTTRON

Please see the contributing.md document before contributing to this repository.

Please see developing_on_modular.md document for developing your agents against volttron.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

volttron-10.0.3a12.tar.gz (217.0 kB view details)

Uploaded Source

Built Distribution

volttron-10.0.3a12-py3-none-any.whl (297.7 kB view details)

Uploaded Python 3

File details

Details for the file volttron-10.0.3a12.tar.gz.

File metadata

  • Download URL: volttron-10.0.3a12.tar.gz
  • Upload date:
  • Size: 217.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.11 Linux/5.15.0-1036-azure

File hashes

Hashes for volttron-10.0.3a12.tar.gz
Algorithm Hash digest
SHA256 65a1f0e25b98e077c72063b9868c43c40433d051cb39cd3119c74e318689a993
MD5 fdb7a9ef357a50a62891c93620ede653
BLAKE2b-256 eb6c94b637a6f0fef5ef7efc3b2e35c0d20ec658a17a6992825e4649a3a24056

See more details on using hashes here.

File details

Details for the file volttron-10.0.3a12-py3-none-any.whl.

File metadata

  • Download URL: volttron-10.0.3a12-py3-none-any.whl
  • Upload date:
  • Size: 297.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.11 Linux/5.15.0-1036-azure

File hashes

Hashes for volttron-10.0.3a12-py3-none-any.whl
Algorithm Hash digest
SHA256 b9bfb91037bc2366792615420ac446a7986d38ce82aadfaa8da1ba4c3bde110b
MD5 3e2aa199cea3da6f3606043582293ec7
BLAKE2b-256 24713dc0731e8f3d943e6fcf38e4650e2d865cee75bccc366a54411f99be801d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page