kuksa-java-sdk

This is a Java SDK for the KUKSA Vehicle Abstraction Layer.

Overview

The KUKSA Java SDK allows you to interact with VSS data from the KUKSA Databroker 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

Unsupported protocols:

• sdv.databroker.v1

kuksa.val.v1

You can interact with the Databroker using the kuksa.val.v1 interface. The interface is exposed by the org.eclipse.kuksa.connectivity.databroker.DataBrokerConnection#kuksaValV1 property.

After successfully connecting the following methods are supported by org.eclipse.kuksa.connectivity.databroker.v1.DataBrokerConnection:

• fetch(FetchRequest): GetResponse
• fetch(VssNodeFetchRequest)
• subscribe(SubscribeRequest, VssPathListener)
• subscribe(SubscribeRequest): Flow
• subscribe(VssNodeSubscribeRequest, VssNodeListener)
• update(UpdateRequest): SetResponse
• update(request: VssNodeUpdateRequest): VssNodeUpdateResponse
• streamedUpdate(StreamObserver<...Response>): StreamObserver<...Request>

kuksa.val.v2

You can interact with the Databroker using the kuksa.val.v2 interface. The interface is exposed by the org.eclipse.kuksa.connectivity.databroker.DataBrokerConnection#kuksaValV1 property.

• fetchValue(FetchValueRequestV2): GetValueResponse
• fetchValues(FetchValuesRequestV2): GetValuesResponse
• subscribeById(SubscribeByIdRequestV2): Flow
• subscribe(SubscribeRequestV2): Flow {
• actuate(ActuateRequestV2): ActuateResponse
• batchActuate(BatchActuateRequestV2): BatchActuateResponse
• listMetadata(ListMetadataRequestV2): ListMetadataResponse
• publishValue(PublishValueRequestV2): PublishValueResponse
• openProviderStream(StreamObserver<...Response>): StreamObserver<...Request>
• fetchServerInfo(): GetServerInfoResponse

Integration

app/build.gradle.kts

implementation("org.eclipse.kuksa:kuksa-java-sdk:<VERSION>")

// uncomment for android
// implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:<x.y.z>")

// uncomment for java
// implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:<x.y.z>")

The latest release version of the kuksa-java-sdk can be seen here.

See the quickstart guide for additional integration options.

Maven Central

The KUKSA Java SDK is currently uploaded to Maven Central. Snapshot builds are also available (but of course less stable): https://oss.sonatype.org/content/repositories/snapshots/

Usage

Note

The following snippet expects an unsecure setup of the Databroker. See the quickstart guide for instructions on how to establish a secure connection to the Databroker.

private var dataBrokerConnection: DataBrokerConnection? = null

fun connectInsecure(host: String, port: Int) {
    lifecycleScope.launch {
        val managedChannel = ManagedChannelBuilder.forAddress(host, port)
            .usePlaintext()
            .build()

        val connector = DataBrokerConnector(managedChannel)
        dataBrokerConnection = connector.connect()
        // Connection to the Databroker successfully established
    } catch (e: DataBrokerException) {
        // Connection to the Databroker failed
    }
}

Sample Code:

fun fetch() {
    lifecycleScope.launch {
        val request = FetchRequest("Vehicle.Speed", listOf(Field.FIELD_VALUE))
        val response = dataBrokerConnection?.kuksaValV1.fetch(request) ?: return@launch
        val entry = entriesList.first() // Don't forget to handle empty responses
        val value = entry.value
        val speed = value.float
    }
}

More samples can be found here here Refer to the quickstart guide or class diagrams for further insight into the KUKSA SDK API.

Requirements

• A working setup requires at least a running KUKSA Databroker
• Optional: The KUKSA Databroker CLI can be used to manually feed data and test your app. See this chapter on how to read and write data via the CLI.
• Optional: The KUKSA Mock Provider can be used to simulate a "real" environment.

Contribution

Please feel free to create GitHub issues and contribute.

License

The KUKSA Java SDK is provided under the terms of the Apache Software License 2.0.