@@ -13,6 +13,41 @@ The KUKSA Java SDK allows you to interact with [VSS data](https://covesa.github.
1313from the [ KUKSA Databroker] ( https://github.com/eclipse-kuksa/kuksa-databroker/tree/main/ )
1414within a Java Application. The main functionality consists of fetching, updating and subscribing to VSS data.
1515
16+ Currently the following protocols are supported:
17+ - kuksa.val.v1
18+ - kuksa.val.v2
19+
20+ ## kuksa.val.v1
21+
22+ You can interact with the Databroker using the kuksa.val.v1 interface by using the
23+ org.eclipse.kuksa.connectivity.databroker.v1.DataBrokerConnector class.
24+
25+ After successfully connecting the following methods are supported by org.eclipse.kuksa.connectivity.databroker.v1.DataBrokerConnection:
26+ - subscribe(SubscribeRequest, VssPathListener)
27+ - unsubscribe(SubscribeRequest, VssPathListener)
28+ - subscribe(VssNodeSubscribeRequest<T >, VssNodeListener<T >)
29+ - unsubscribe(VssNodeSubscribeRequest<T >, VssNodeListener<T >)
30+ - fetch(FetchRequest): GetResponse
31+ - fetch(VssNodeFetchRequest<T >): T
32+ - update(UpdateRequest): SetResponse
33+ - update(VssNodeUpdateRequest<T >): VssNodeUpdateResponse
34+
35+ ## kuksa.val.v2
36+
37+ You can interact with the Databroker using the kuksa.val.v1 interface by using the
38+ org.eclipse.kuksa.connectivity.databroker.v2.DataBrokerConnectorV2 class.
39+
40+ After successfully connecting the following methods are supported by org.eclipse.kuksa.connectivity.databroker.v2.DataBrokerConnectionV2:
41+ - fetchValue(FetchValueRequestV2): GetValueResponse
42+ - fetchValues(FetchValuesRequestV2): GetValuesResponse
43+ - subscribeById(SubscribeByIdRequestV2): Flow<SubscribeByIdResponse >
44+ - subscribe(SubscribeRequestV2): Flow<SubscribeResponse >
45+ - actuate(ActuateRequestV2): ActuateResponse
46+ - batchActuate(BatchActuateRequestV2): BatchActuateResponse
47+ - listMetadata(ListMetadataRequestV2): ListMetadataResponse
48+ - publishValue(PublishValueRequestV2): PublishValueResponse
49+ - openProviderStream(StreamObserver<OpenProviderStreamResponse >): StreamObserver<OpenProviderStreamRequest >
50+
1651## Integration
1752
1853* app/build.gradle.kts*
@@ -23,8 +58,7 @@ implementation("org.eclipse.kuksa:kuksa-java-sdk:<VERSION>")
2358The latest release version can be seen [ here] ( https://github.com/eclipse-kuksa/kuksa-java-sdk/releases ) .
2459
2560
26- See the [ quickstart guide] ( https://github.com/eclipse-kuksa/kuksa-java-sdk/tree/main/docs/QUICKSTART.md ) for
27- additional integration options.
61+ See the [ quickstart guide] ( https://github.com/eclipse-kuksa/kuksa-java-sdk/tree/main/docs/QUICKSTART.md ) for additional integration options.
2862
2963### Maven Central
3064
0 commit comments