Skip to main content

Intelligent Load Control (ILC) Agent

Eclipse VOLTTRON 10.0.5rc0 Python 3.10 Python 3.11 pypi version

Main branch tests:        Main Branch Passing?

Develop branch tests:   Develop Branch Passing?

ILC supports traditional demand response as well as transactive energy services. ILC manages controllable loads while also mitigating service-level excursions (e.g., occupant comfort, minimizing equipment ON/OFF cycling) by dynamically prioritizing available loads for curtailment using both quantitative (deviation of zone conditions from set point) and qualitative rules (type of zone).

Requirements

  • python >= 3.10
  • volttron >= 10.0
  • sympy >= 1.12
  • transitions >= 0.9.0

Documentation

More detailed documentation can be found on ReadTheDocs. The RST source of the documentation for this agent is located in the "docs" directory of this repository.

ILC Agent Configuration

The ILC agent, requires four configuration files per device cluster (i.e., homogenous set of devices). These files should be loaded into the agent's config store via vctl config command line interface. Samples of these files may be found in the sample_configs directory of this repository:

  1. config - ILC (main) configuration.
  2. control_config - Contains information related to the control of device cluster.
  3. criteria_config - Contains information related to the use of real time data to prioritize devices within cluster for load management.
  4. pairwise_criteria.json - Contains information related to the relative importance of each criteria for a device cluster.

Full documentation of ILC configurations can be found on ReadTheDocs. A web-based configuration tool has been developed to simplify creation of the configuration files for ILC. The web tool can be accessed here.

Instructions for the configuration web-tool can be found here.

Installation

Before installing, VOLTTRON should be installed and running. Its virtual environment should be active. Information on how to install of the VOLTTRON platform can be found here.

Install and start the Intelligent Load Control Agent.

vctl config store ilc.agent config <path of config file>
vctl config store ilc.agent control_config <path to device_control_config>
vctl config store ilc.agent criteria_config <path to device_criteria_config>
vctl config store ilc.agent pairwise_criteria.json <path to pairwise_criteria_config>
vctl install volttron-ilc --vip-identity ilc.agent --tag ilc --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

Metadata

Release files for volttron-ilc 2.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for volttron-ilc 2.2.2
File Size Uploaded Provenance Actions
volttron_ilc-2.2.2.tar.gz 28.9 kB Without provenance Details for volttron_ilc-2.2.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for volttron-ilc 2.2.2
File Interpreter ABI Platform Actions
volttron_ilc-2.2.2-py3-none-any.whl Python 3 none any Details for volttron_ilc-2.2.2-py3-none-any.whl

Total release size: 60.3 kB

Release files / volttron_ilc-2.2.2.tar.gz

Download URL volttron_ilc-2.2.2.tar.gz
Size 28.9 kB
Tags Source
SHA-256 checksum
How to use checksums
94fa602ec585450e87d3f74906fdb73d2fd310aa838c75dac6d438153827150b
BLAKE2b-256 checksum
How to use checksums
711ba2dc37ce8ff421c3a9b135f3ec3126e6adebee4c1ded54732471c679def2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.7.1 CPython/3.10.13 Linux/6.2.0-1016-azure

Release files / volttron_ilc-2.2.2-py3-none-any.whl

Download URL volttron_ilc-2.2.2-py3-none-any.whl
Size 31.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dbdf2d18a7c939296fa89d8996d4f83380570a1cbfef5243489efca43d61653b
BLAKE2b-256 checksum
How to use checksums
099388478a93ce10d8e7d894857fd2a1c5bf04ce3722491ed41eddefb4a8f46f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.7.1 CPython/3.10.13 Linux/6.2.0-1016-azure

Security for volttron-ilc 2.2.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page