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.3a13.tar.gz (217.0 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: volttron-10.0.3a13.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-1037-azure

File hashes

Hashes for volttron-10.0.3a13.tar.gz
Algorithm Hash digest
SHA256 7a28837039d78165761cc2d2dd092a5d85d9fce85a695350aa237deee08102ba
MD5 a4f6659ac0fcfe0be3e420867bd4ef3c
BLAKE2b-256 2c9255761e8c6e960b1634b687a8d9933460325f4cb7b40df62fb7286d8bb048

See more details on using hashes here.

File details

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

File metadata

  • Download URL: volttron-10.0.3a13-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-1037-azure

File hashes

Hashes for volttron-10.0.3a13-py3-none-any.whl
Algorithm Hash digest
SHA256 1bcd9106d4afff7ef2a72ead2a8cfd4b0ed4b95b0682c16eccc28fcc97ac1318
MD5 4db8336cc5e4d3107e51381a8191cadc
BLAKE2b-256 f04d7d1e1d7b77b827ffc73d8c066dca412c6d5f844924ff05888122df08d204

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