Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add Documentation to README
Browse files Browse the repository at this point in the history
wba2hi committed Jan 10, 2025
1 parent c986372 commit 2b126c6
Showing 1 changed file with 36 additions and 2 deletions.
38 changes: 36 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -13,6 +13,41 @@ The KUKSA Java SDK allows you to interact with [VSS data](https://covesa.github.
from the [KUKSA Databroker](https://github.com/eclipse-kuksa/kuksa-databroker/tree/main/)
within a Java Application. The main functionality consists of fetching, updating and subscribing to VSS data.

Currently the following protocols are supported:
- kuksa.val.v1
- kuksa.val.v2

## kuksa.val.v1

You can interact with the Databroker using the kuksa.val.v1 interface by using the
org.eclipse.kuksa.connectivity.databroker.v1.DataBrokerConnector class.

After successfully connecting the following methods are supported by org.eclipse.kuksa.connectivity.databroker.v1.DataBrokerConnection:
- subscribe(SubscribeRequest, VssPathListener)
- unsubscribe(SubscribeRequest, VssPathListener)
- subscribe(VssNodeSubscribeRequest<T>, VssNodeListener<T>)
- unsubscribe(VssNodeSubscribeRequest<T>, VssNodeListener<T>)
- fetch(FetchRequest): GetResponse
- fetch(VssNodeFetchRequest<T>): T
- update(UpdateRequest): SetResponse
- update(VssNodeUpdateRequest<T>): VssNodeUpdateResponse

## kuksa.val.v2

You can interact with the Databroker using the kuksa.val.v1 interface by using the
org.eclipse.kuksa.connectivity.databroker.v2.DataBrokerConnectorV2 class.

After successfully connecting the following methods are supported by org.eclipse.kuksa.connectivity.databroker.v2.DataBrokerConnectionV2:
- fetchValue(FetchValueRequestV2): GetValueResponse
- fetchValues(FetchValuesRequestV2): GetValuesResponse
- subscribeById(SubscribeByIdRequestV2): Flow<SubscribeByIdResponse>
- subscribe(SubscribeRequestV2): Flow<SubscribeResponse>
- actuate(ActuateRequestV2): ActuateResponse
- batchActuate(BatchActuateRequestV2): BatchActuateResponse
- listMetadata(ListMetadataRequestV2): ListMetadataResponse
- publishValue(PublishValueRequestV2): PublishValueResponse
- openProviderStream(StreamObserver<OpenProviderStreamResponse>): StreamObserver<OpenProviderStreamRequest>

## Integration

*app/build.gradle.kts*
@@ -23,8 +58,7 @@ implementation("org.eclipse.kuksa:kuksa-java-sdk:<VERSION>")
The latest release version can be seen [here](https://github.com/eclipse-kuksa/kuksa-java-sdk/releases).


See the [quickstart guide](https://github.com/eclipse-kuksa/kuksa-java-sdk/tree/main/docs/QUICKSTART.md) for
additional integration options.
See the [quickstart guide](https://github.com/eclipse-kuksa/kuksa-java-sdk/tree/main/docs/QUICKSTART.md) for additional integration options.

### Maven Central

0 comments on commit 2b126c6

Please sign in to comment.