Skip to main content

The Platform Driver agent is a special purpose agent that manages communication between the Volttron platform and devices. The Platform driver features a number of endpoints for collecting data and sending control signals using the message bus and automatically publishes data to the bus on a specified interval.

Project description

Platform Driver Agent

Passing? pypi version

The Platform Driver agent is a special purpose agent a user can install on the platform to manage communication of the platform with devices. The Platform driver features a number of endpoints for collecting data and sending control signals using the message bus and automatically publishes data to the bus on a specified interval.

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

Installation

Create and activate a virtual environment.

python -m venv env
source env/bin/activate

Installing volttron-platform-driver requires a running volttron instance.

pip install volttron

# Start platform with output going to volttron.log
volttron -vv -l volttron.log &

Install and start the volttron-platform-driver.

vctl install volttron-platform-driver --vip-identity platform.driver --start

View the status of the installed agent

vctl status

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.

Project details


Download files

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

Source Distribution

volttron_platform_driver-0.1.1a1.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

volttron_platform_driver-0.1.1a1-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file volttron_platform_driver-0.1.1a1.tar.gz.

File metadata

  • Download URL: volttron_platform_driver-0.1.1a1.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.8.14 Linux/5.15.0-1022-azure

File hashes

Hashes for volttron_platform_driver-0.1.1a1.tar.gz
Algorithm Hash digest
SHA256 0cf2de2556c810d99e874b0382f292ec23e5fe9d769276b9115e7ad1cdbc826c
MD5 9298afa4bf8486c574bfa839b9513a2f
BLAKE2b-256 543a6138be69a5a1b2caa0e48f878490342d0be8358688ebda484b012e7f73e4

See more details on using hashes here.

File details

Details for the file volttron_platform_driver-0.1.1a1-py3-none-any.whl.

File metadata

File hashes

Hashes for volttron_platform_driver-0.1.1a1-py3-none-any.whl
Algorithm Hash digest
SHA256 da65e8cd8bec8feab3e01ed2eb0c25341fceda26ae37267484e1bbd85bee2be3
MD5 44eaf68ccf4462f01fcda1127153795e
BLAKE2b-256 6c29737c6dc5671594a95c5704f31121a345449787f83d06529dc12bd3dec9f3

See more details on using hashes here.

Supported by

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