-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
94 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,87 @@ | ||
| # kuksa-java-sdk | ||
| The Java SDK for Eclipse KUKSA | ||
|
|
||
| [](https://opensource.org/licenses/Apache-2.0) | ||
| [](https://gitter.im/kuksa-val/community) | ||
|
|
||
| [](https://github.com/eclipse-kuksa/kuksa-java-sdk/actions/workflows/daily_integration_main-master.yaml?query=branch%3Amain) | ||
|
|
||
| This is a Java SDK for the [KUKSA Vehicle Abstraction Layer](https://github.com/eclipse-kuksa/kuksa-databroker). | ||
|
|
||
| ## Overview | ||
|
|
||
| The KUKSA Java SDK allows you to interact with [VSS data](https://covesa.github.io/vehicle_signal_specification/) | ||
| 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. | ||
|
|
||
| ## Integration | ||
|
|
||
| *app/build.gradle.kts* | ||
| ``` | ||
| 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. | ||
|
|
||
| ### Maven Central | ||
|
|
||
| The KUKSA Java SDK is currently uploaded to [Maven Central](https://central.sonatype.com/search?q=org.eclipse.kuksa). | ||
| 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](https://github.com/eclipse-kuksa/kuksa-java-sdk/blob/main/docs/QUICKSTART.md) | ||
| > for instructions on how to establish a **secure** connection to the Databroker. | ||
| ```kotlin | ||
| 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 | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ```kotlin | ||
| fun fetch() { | ||
| lifecycleScope.launch { | ||
| val request = FetchRequest("Vehicle.Speed", listOf(Field.FIELD_VALUE)) | ||
| val response = dataBrokerConnection?.fetch(request) ?: return@launch | ||
| val entry = entriesList.first() // Don't forget to handle empty responses | ||
| val value = entry.value | ||
| val speed = value.float | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Refer to the [quickstart guide](https://github.com/eclipse-kuksa/kuksa-java-sdk/tree/main/docs/QUICKSTART.md) or | ||
| [class diagrams](https://github.com/eclipse-kuksa/kuksa-java-sdk/blob/main/docs/kuksa-sdk_class-diagram.puml) for | ||
| further insight into the KUKSA SDK API. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - A working setup requires at least a running [KUKSA Databroker](https://github.com/eclipse-kuksa/kuksa-databroker/tree/main) | ||
| - Optional: The [KUKSA Databroker CLI](https://github.com/eclipse-kuksa/kuksa-databroker/tree/main/databroker-cli) can be used to manually feed data and test your app. | ||
| See [this chapter](https://github.com/eclipse-kuksa/kuksa-databroker/tree/main?tab=readme-ov-file#reading-and-writing-vss-data-using-the-cli) on how to read and write data via the CLI. | ||
| - Optional: The [KUKSA Mock Provider](https://github.com/eclipse-kuksa/kuksa-mock-provider?tab=readme-ov-file#kuksa-mock-provider) can be used to simulate a "real" environment. | ||
|
|
||
| ## Contribution | ||
|
|
||
| Please feel free to create [GitHub issues](https://github.com/eclipse-kuksa/kuksa-java-sdk/issues) and [contribute](https://github.com/eclipse-kuksa/kuksa-java-sdk/blob/main/docs/CONTRIBUTING.md). | ||
|
|
||
| ## License | ||
|
|
||
| The KUKSA Java SDK is provided under the terms of the [Apache Software License 2.0](https://github.com/eclipse-kuksa/kuksa-java-sdk/blob/main/LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters