Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
erikbosch committed Oct 22, 2024
1 parent 81a15f1 commit 706a633
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,13 @@ The quickest possible way to get Kuksa Databroker up and running.

> :bulb: **Tip:** You can stop the container using `ctrl-c`.

*Note that not all APIs are enabled by default, see [user guide](doc/user_guide.md) and*
*[protocols](doc/protocol/README.md) for more information!*

### Reading and writing VSS data using the CLI

1. Start the CLI in a container attached to the _kuksa_ bridge network and connect to the Databroker container:
The databroker supports both of `sdv.databroker.v1` and `kuksa.val.v1` as an API. Per default the databroker-cli uses the `sdv.databroker.v1` interface. To change it use `--protocol` option when starting. Chosse eihter one of `kuksa-val-v1` and `sdv-databroker-v1`.
The databroker supports both of `sdv.databroker.v1` and `kuksa.val.v1` as an API. Per default the databroker-cli uses the `sdv.databroker.v1` interface. To change it use `--protocol` option when starting. Choose either one of `kuksa-val-v1` and `sdv-databroker-v1`.

```sh
# in a new terminal
Expand Down
7 changes: 7 additions & 0 deletions doc/protocol/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ x<sup>2</sup> Relies on the non-standard `attribute` values which doesn't work w

For a more detailed view of the supported JSON-schemas [click here](https://github.com/eclipse/kuksa.val/blob/master/kuksa-val-server/include/VSSRequestJsonSchema.hpp)

### sdv.databroker.v1 in KUKSA Databroker

To enable the legacy `sdv.databroker.v1` API you must start Databroker with the `--enable-databroker-v1` argument.

### VISSv2 in KUKSA Databroker

KUKSA databroker aims to provide a standards compliant implementation of VISSv2 (using the websocket transport).
Expand All @@ -60,6 +64,9 @@ The `enable-viss` flag must be provided at startup in order to enable the VISSv2
$ databroker --enable-viss
```

The arguments `--viss-address` and `--viss-port` can be used if you want to use a different address or port than default for VISS.
If not specified, the address `127.0.0.1` will be used unless otherwise specified with `--address`, and the port 8090 will be used.

Using kuksa-client, the VISSv2 interface of databroker is available using the `ws` protocol in the uri, i.e.:

```shell
Expand Down
4 changes: 4 additions & 0 deletions doc/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ Options:
--insecure Allow insecure connections
--tls-cert <FILE> TLS certificate file (.pem)
--tls-private-key <FILE> TLS private key file (.key)
--enable-databroker-v1 Enable sdv.databroker.v1 (GRPC) service
--enable-viss Enable VISSv2 (websocket) service
--viss-address <IP> Bind address for VISS server, if argument is not provided, the value of --address is used [env: KUKSA_DATABROKER_VISS_ADDR=]
--viss-port <PORT> VISS port [env: KUKSA_DATABROKER_VISS_PORT=] [default: 8090]
-h, --help Print help
-V, --version Print version
```
Expand Down

0 comments on commit 706a633

Please sign in to comment.