Add Quickstart guide #40
Conversation
|
|
||
| It allows you to access VSS data from KUKSA databroker using an Android System. | ||
| The Kuksa Android SDK allows you to interact with [VSS data](https://github.com/COVESA/vehicle_signal_specification) | ||
| from the [KUKSA Databroker](https://github.com/eclipse/kuksa.val/tree/master/kuksa_databroker) |
There was a problem hiding this comment.
Probably also better to link here to the main page, instead of the sub page:
https://github.com/eclipse/kuksa.val/
There was a problem hiding this comment.
I am a little bit disagreeing here because everyone would just go instantly to the sub link from the main page. Feels more like the right entry point to me.
There was a problem hiding this comment.
Removed the last sentence and linked to GitHub packet
README.md
Outdated
| 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 | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
This needs "more explanation" because if we can connect secure or insecure highly depends on how the databroker is started. Should be fine to add a note here, to check the sample code as you did in the quickstart.md.
A backreference to how to start databroker secure / insecure would also be great here.
Whatever you do make sure to keep Quickstart aligned.
There was a problem hiding this comment.
Added a note to the README. The secure way is references in the QUICKSTART guide. Probably enough?
The main focus was on the QUICKSTART guide but also adds a bit more to the README file. The PR also adds more sample code for the specification usage.
I decided against creating another sample module for the specifications for the sake of simplicity.