Skip to content

Commit

Permalink
docs: improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
escalate committed Jan 13, 2024
1 parent f1d614d commit 3485674
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ A commandline tool to import [Loxone](https://www.loxone.com) controls into [HA-
**ATTENTION** It is recommended to create an backup of the current HA-Bridge configuration before using this tool.

## Supported Loxone control types and actions

This is just the list of already implemented control types with there meaningful actions.

Loxone offers many more control types and if you are missing one please create a Pull Request or open an Issue on Github.
Expand Down Expand Up @@ -40,24 +41,28 @@ Loxone offers many more control types and if you are missing one please create a
| WindowMonitor | - | - | - |

## Installation

Tested with Python 3.12 on Ubuntu 22.04

If you encounter issues with 3.12.x patch versions of Python, please open a Github issue.

### Requirements

Install needed requirements via pip

```
$ pip install -r requirements.txt
```

### Run

Run tool from commandline
```
$ ./importer.py
```

## Usage

```
$ ./importer.py --help
Expand All @@ -77,6 +82,7 @@ Options:
```

## Docker

Build Docker image
```
$ docker build \
Expand Down Expand Up @@ -108,11 +114,14 @@ $ docker run \
```

## Dependencies

* [click](https://pypi.python.org/pypi/click)
* [requests](https://pypi.python.org/pypi/requests)

## Contribute

Please note the separate [contributing guide](https://github.com/escalate/loxone-ha-bridge-importer/blob/master/CONTRIBUTING.md).

## License

MIT

0 comments on commit 3485674

Please sign in to comment.