Skip to content

Commit

Permalink
Merge pull request #6 from bonicim/update-readme
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
shwethanidd authored Dec 28, 2022
2 parents 85c27b9 + 7af35f0 commit 06481ca
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BACnet Proxy Agent

![Passing?](https://github.com/eclipse-volttron/volttron-bacnet-proxy/actions/workflows/run-tests.yml/badge.svg)
[![Passing?](https://github.com/eclipse-volttron/volttron-bacnet-proxy/actions/workflows/run-tests.yml/badge.svg)](https://github.com/eclipse-volttron/volttron-bacnet-proxy/actions/workflows/run-tests.yml)
[![pypi version](https://img.shields.io/pypi/v/volttron-bacnet-proxy.svg)](https://pypi.org/project/volttron-bacnet-proxy/)

BACnet Proxy is an agent that supports communication and management of BACnet devices.
Expand Down Expand Up @@ -43,19 +43,19 @@ python -m venv env
source env/bin/activate
```

Installing volttron-platform-driver requires a running volttron instance.
Installing volttron-platform-driver requires a running volttron instance. Install volttron and start an instance in the background and save log output to a file named 'volttron.log'

```shell
pip install volttron

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

Install and start the BACnet proxy agent.

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

View the status of the installed agent
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ classifiers = [
"Intended Audience :: Other Audience",
"License :: OSI Approved :: Apache Software License"
]
include = ["IDENTITY"]

[tool.poetry.dependencies]
python = ">=3.8,<4.0"
Expand All @@ -53,7 +54,7 @@ coverage = "^6.3.2"
isort = "^5.10.1"
pytest-sugar = "^0.9.6"

[tool.poetry.group.documentation.dependencies]
[tool.poetry.group.docs.dependencies]
Sphinx = "^4.5.0"
sphinx-rtd-theme = "^1.0.0"

Expand Down

0 comments on commit 06481ca

Please sign in to comment.