Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Philip Vanloo committed Jun 4, 2019
1 parent f6df873 commit 6b22c22
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ Snap package for python-velbustcp

## Connect serial/USB interface

```
:warning: Not connecting the interface will cause the program to not function. :warning:
```
:warning: Not connecting the interface will cause the connection to the bus to fail :warning:

To allow the snap to access your Velbus USB interface, connect it to the raw-usb plug using

Expand All @@ -20,8 +18,10 @@ Alternatively, if you are running on a gadget which exposes a serial-port slot,

By default, the application will connect to the first Velbus USB interface it can find and use. If you want to change this behaviour, you can manually set the port using

`snap set velbus-tcp serial.autodiscover=false`
`snap set velbus-tcp serial.port=/dev/ttyACM0`
```
snap set velbus-tcp serial.autodiscover=false
snap set velbus-tcp serial.port=/dev/ttyACM0
```

## Authorization

Expand All @@ -45,8 +45,10 @@ You can enable SSL to encrypt the connection between you and your Velbus install

By default, a certificate is generated during installation. If you want to supply your own certificate, use

`snap set velbus-tcp tcp.cert=PATH_TO_YOUR_CERTIFICATE`
`snap set velbus-tcp tcp.pk=PATH_TO_YOUR_PRIVATE_KEY`
```
snap set velbus-tcp tcp.cert=PATH_TO_YOUR_CERTIFICATE
snap set velbus-tcp tcp.pk=PATH_TO_YOUR_PRIVATE_KEY
```

## Configuration

Expand Down

0 comments on commit 6b22c22

Please sign in to comment.