Skip to content
This repository was archived by the owner on Dec 18, 2024. It is now read-only.

Commit 30962e1

Browse files
committed
Update README
1 parent c6ae7a6 commit 30962e1

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

kuksa_databroker/README.md

+19-16
Original file line numberDiff line numberDiff line change
@@ -105,14 +105,14 @@ USAGE:
105105
databroker [OPTIONS]
106106

107107
OPTIONS:
108-
--address <ADDR> Bind address [default: 127.0.0.1]
109-
--port <PORT> Bind port [default: 55555]
110-
--metadata <FILE(S)> Populate data broker with metadata from a
111-
(comma-separated) list of files.
112-
[env:KUKSA_DATA_BROKER_METADATA_FILE=]
113-
--dummy-metadata Populate data broker with dummy metadata
114-
-h, --help Print help information
115-
-V, --version Print version information
108+
--address <ADDR> Bind address [env: KUKSA_DATA_BROKER_ADDR=] [default: 127.0.0.1]
109+
--port <PORT> Bind port [env: KUKSA_DATA_BROKER_PORT=] [default: 55555]
110+
--metadata <FILE>... Populate data broker with metadata from (comma-separated) list of
111+
files [env: KUKSA_DATA_BROKER_METADATA_FILE=]
112+
--jwt-public-key <FILE> Public key used to verify JWT access tokens
113+
--dummy-metadata Populate data broker with dummy metadata
114+
-h, --help Print help information
115+
-V, --version Print version information
116116

117117
```
118118

@@ -157,14 +157,15 @@ This will enable `TAB`-completion for the available properties in the client. Ru
157157

158158
Get data points by running "get"
159159
```shell
160-
client> get Vehicle.ADAS.CruiseControl.Error
161-
-> Vehicle.ADAS.CruiseControl.Error: NotAvailable
160+
sdv.databroker.v1 > get Vehicle.ADAS.CruiseControl.IsEnabled
161+
[get] OK
162+
Vehicle.ADAS.CruiseControl.IsEnabled: ( NotAvailable )
162163
```
163164

164165
Set data points by running "set"
165166
```shell
166-
client> set Vehicle.ADAS.CruiseControl.Error Nooooooo!
167-
-> Ok
167+
sdv.databroker.v1 > set Vehicle.ADAS.CruiseControl.IsEnabled false
168+
[set] OK
168169
```
169170

170171
### Data Broker Query Syntax
@@ -175,13 +176,14 @@ Detailed information about the databroker rule engine can be found in [QUERY.md]
175176
You can try it out in the client using the subscribe command in the client:
176177

177178
```shell
178-
client> subscribe
179+
sdv.databroker.v1 > subscribe
179180
SELECT
180-
Vehicle.ADAS.ABS.Error
181+
Vehicle.ADAS.ABS.IsError
181182
WHERE
182-
Vehicle.ADAS.ABS.IsActive
183+
Vehicle.ADAS.ABS.IsEngaged
183184

184-
-> status: OK
185+
[subscribe] OK
186+
Subscription is now running in the background. Received data is identified by [1].
185187
```
186188

187189
### Configuration
@@ -192,6 +194,7 @@ WHERE
192194
| dummy-metadata | <no active> | --dummy-metadata | <no active> | Populate data broker with dummy metadata |
193195
| listen_address | "127.0.0.1" | --address | KUKSA_DATA_BROKER_ADDR | Listen for rpc calls |
194196
| listen_port | 55555 | --port | KUKSA_DATA_BROKER_PORT | Listen for rpc calls |
197+
| jwt-public-key | <no active> | --jwt-public-key | <no active> | Public key used to verify JWT access tokens
195198

196199
To change the default configuration use the arguments during startup see [run section](#running) or environment variables.
197200

0 commit comments

Comments
 (0)