Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates for modular RC. #13

Merged
merged 17 commits into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 13 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@
# Requires

* python >= 3.10
* bacpypes == "0.16.7"
* volttron >= 10.0
* volttron-lib-base-driver
* volttron-bacnet-proxy
* bacpypes == 0.16.7
* volttron-core >= 2.0.0rc0
* volttron-lib-base-driver >= 2.0.0rc0
* volttron-bacnet-proxy >= 2.0.0rc0

# Documentation
More detailed documentation can be found on [ReadTheDocs](https://eclipse-volttron.readthedocs.io/en/latest/external-docs/volttron-platform-driver/docs/source/index.html). The RST source
More detailed documentation can be found on [ReadTheDocs](https://eclipse-volttron.readthedocs.io/en/latest/external-docs/volttron-lib-bacnet-driver/index.html#bacnet-driver). The RST source
of the documentation for this component is located in the "docs" directory of this repository.


Expand All @@ -28,19 +28,19 @@ Information on how to install of the VOLTTRON platform can be found
1. If it is not already, install the VOLTTRON Platform Driver Agent:

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

2. Install the BACnetProxy Agent:
2. Install the BACnetProxy Agent. An example configuration can be found [here](https://github.com/eclipse-volttron/volttron-bacnet-proxy/blob/main/config)

```shell
vctl install volttron-bacnet-proxy --agent-config <path to bacnet proxy agent configuration file> --vip-identity platform.bacnet_proxy --start
vctl install volttron-bacnet-proxy --agent-config <path to bacnet proxy agent configuration file> --vip-identity platform.bacnet_proxy
```

3. Install the VOLTTRON BACnet Driver Library:

```shell
pip install volttron-lib-bacnet-driver
poetry add --directory $VOLTTRON_HOME volttron-lib-bacnet-driver
```

4. Store device and registry files for the BACnet device to the Platform Driver configuration store:
Expand All @@ -52,7 +52,7 @@ Information on how to install of the VOLTTRON platform can be found
cd config
```

* Create a file called `bacnet.config`; it should contain a JSON object that specifies the configuration of your BACnet driver. An example of such a file is provided at the root of this project; the example file is named 'bacnet.config'. The following JSON is an example of a `bacnet.config`:
* Create a file called `device_name.config`; it should contain a JSON object that specifies the configuration of your BACnet driver. An example of such a file is provided at the root of this project; the example file is named 'bacnet.config'. The following JSON is an example of a `bacnet.config`:

```json
{
Expand All @@ -65,9 +65,7 @@ Information on how to install of the VOLTTRON platform can be found
}
```

ℹ️ **TIP:** In the `driver_config`, `device_address` is the address bound to the network port over which BACnet communication will happen on the computer running VOLTTRON. This is NOT the address of any target device. See [BACnet Router Addressing](https://eclipse-volttron.readthedocs.io/en/latest/external-docs/volttron-bacnet-proxy/docs/source/bacnet-router-addressing.html).

* Create another file called `bacnet.csv`; it should contain all the points on the device that you want published to Volttron. An example of such a CSV file is provided at the root of this project; the example CSV file is named 'bacnet.csv'. The following CSV file is an example:
* Create another file called `device_name.csv`; it should contain all the points on the device that you want published to Volttron. An example of such a CSV file is provided at the root of this project; the example CSV file is named 'bacnet.csv'. The following CSV file is an example:

```csv
Point Name,Volttron Point Name,Units,Unit Details,BACnet Object Type,Property,Writable,Index,Notes
Expand All @@ -83,7 +81,7 @@ Information on how to install of the VOLTTRON platform can be found

5. Observe Data

To see data being published to the bus, install a [Listener Agent](https://pypi.org/project/volttron-listener/):
To see data being published to the bus, install a [Listener Agent](https://github.com/eclipse-volttron/volttron-listener):

```
vctl install volttron-listener --start
Expand All @@ -100,7 +98,7 @@ Information on how to install of the VOLTTRON platform can be found

Please see the following for contributing guidelines [contributing](https://github.com/eclipse-volttron/volttron-core/blob/develop/CONTRIBUTING.md).

Please see the following helpful guide about [developing modular VOLTTRON agents](https://github.com/eclipse-volttron/volttron-core/blob/develop/DEVELOPING_ON_MODULAR.md)
Please see the following helpful guide about [developing modular VOLTTRON agents](https://eclipse-volttron.readthedocs.io/en/latest/developing-volttron/developing-agents/agent-development.html)

# Disclaimer Notice

Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"

[tool.poetry]
name = "volttron-lib-bacnet-driver"
version = "0.2.0-rc"
version = "2.0.0rc0"
description = "BACnet driver supported and maintained by the Volttron team."
authors = ["Mark Bonicillo <[email protected]>"]
license = "Apache License 2.0"
Expand All @@ -23,8 +23,8 @@ classifiers = [
]

[tool.poetry.dependencies]
python = "^3.10"
volttron-lib-base-driver = "^0.2.1rc2"
python = ">=3.10,<4.0"
volttron-lib-base-driver = ">=2.0.0rc0"
bacpypes = "0.16.7"

[tool.poetry.group.dev.dependencies]
Expand Down
Loading
Loading