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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: volttron-10.0.3a10.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.3a10.tar.gz
Algorithm Hash digest
SHA256 c99e7128989a0fff358efb24318a882c4630f4853a80246d0b98c748b8c3e59b
MD5 42afe3387371afbdbed19c4d6445233d
BLAKE2b-256 f6c94eb95b473f67c0ba4b22f12747b0579c159a76e96fd4d9564d64287a1dae

See more details on using hashes here.

File details

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

File metadata

  • Download URL: volttron-10.0.3a10-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.3a10-py3-none-any.whl
Algorithm Hash digest
SHA256 0aa1bd679038e0d6c1575a08dd84efde65aad4d5a2ebc7c4f27849c16769dfb3
MD5 2889b8c321aedb7e2836cfa67711276a
BLAKE2b-256 e0cc6c82bc6dfe65fac88ddf07cb01fc4968fef0cff8d76e38606046cf2c427e

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