diff --git a/docs/docs-gen/content/examples/_index.md b/docs/docs-gen/content/examples/_index.md index a1d1288..7b5cd87 100644 --- a/docs/docs-gen/content/examples/_index.md +++ b/docs/docs-gen/content/examples/_index.md @@ -34,6 +34,7 @@ Topic examples: Virtual signal platforms, VISSR etc. | Name | Relationship to the category | |------|-------------| | [RemotiveLabs feeder](https://github.com/COVESA/cdsp/tree/main/examples/remotivelabs-feeder) | Example bridge that streams vehicle data from the RemotiveLabs cloud platform into the IoTDB data store | +| [KUKSA CAN Provider feeder](https://github.com/COVESA/cdsp/tree/main/examples/kuksa-can-feeder) | Using the KUKSA CAN Provider as a feeder of CAN data translated to the VSS data model into the IoTDB data store | ## COVESA Touchpoints Topic examples: Low level vehicle abstraction, Mobile devices, Car2Cloud / Cloud etc. diff --git a/examples/kuksa-can-feeder/README.md b/examples/kuksa-can-feeder/README.md new file mode 100644 index 0000000..d1ead6e --- /dev/null +++ b/examples/kuksa-can-feeder/README.md @@ -0,0 +1,10 @@ +# KUKSA CAN Provider Feeder +The KUKSA project contains the component [KUKSA CAN Provider](https://github.com/eclipse-kuksa/kuksa-can-provider) which provides a CAN to VSS feeder with DBC support. Supported sources include CAN dumps and real and virtual SocketCAN connections. The Provider uses a translation table to translate CAN data into the VSS data model northbound. + +The COVESA Central Data Service Playground (CDSP) project has extended the CAN Provider to support writing to the Apache IoTDB timeseries database used in CDSP as a new northbound client type. + +The sources for the fork can be found [here](https://github.com/slawr/kuksa-can-provider.git) in the branch [covesa-cdsp](https://github.com/slawr/kuksa-can-provider/tree/covesa-cdsp). + +Documentation for how to use it, including an example of playing back a CAN dump via a virtual SocketCAN, can be found in the file [README-covesa-cdsp-iotdb.md](https://github.com/slawr/kuksa-can-provider/blob/covesa-cdsp/README-covesa-cdsp-iotdb.md) + +The intention is to talk to the KUKSA project about upstreaming the new client support.