Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Readme: Removed misleading mentioning of Android Autotmotive #59

Merged
merged 2 commits into from
Feb 15, 2024
Merged

Readme: Removed misleading mentioning of Android Autotmotive #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bdfdfc4
fix: Remove misleading mention of Android Automotive
SebastianSchildt Feb 14, 2024
3e39136
chore: Remove spurious linebreaks and fix some markdown linter issues
SebastianSchildt Feb 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 8 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,28 @@
# kuksa-android-companion

The KUKSA Companion App demonstrates the capabilities of the Android SDK to connect to an
Android Automotive vehicle with an integrated KUKSA Databroker, read data and interact with
the actuators of the vehicle. The KUKSA Framework is based on the COVESA Vehicle Signal
Specification (VSS).
The KUKSA Companion App demonstrates the capabilities of the Android SDK to connect to a vehicle with an integrated KUKSA Databroker, read data and interact with the actuators of the vehicle. The KUKSA framework is based on the COVESA Vehicle Signal Specification (VSS).

The VSS defines the names and semantics of a large set of data entries that represent the
current and/or intended state of a vehicle's sensors and actuators organized in a tree-like
structure. For example, the vehicle's current speed is represented by the Vehicle.Speed entry.
The VSS defines the names and semantics of a large set of data entries that represent the current and/or intended state of a vehicle's sensors and actuators organized in a tree-like structure. For example, the vehicle's current speed is represented by the Vehicle.Speed entry.

However, VSS does not define how these signals are to be collected and managed within a
vehicle, nor does it prescribe how other components in the vehicle can read or write
signal values from and to the tree.
However, VSS does not define how these signals are to be collected and managed within a vehicle, nor does it prescribe how other components in the vehicle can read or write signal values from and to the tree.

The KUKSA Databroker is a resource efficient implementation of the VSS signal tree and is
intended to be run within a vehicle on a microprocessor based platform. It allows
applications in the vehicle to interact with the vehicle's sensors and actuators using a
uniform, high level gRPC API for querying signals, updating current and target values of
sensors and actuators and getting notified about changes to signals of interest.
The KUKSA Databroker is a resource efficient implementation of the VSS signal tree and is intended to be run within a vehicle on a microprocessor based platform. It allows applications in the vehicle to interact with the vehicle's sensors and actuators using a uniform, high level gRPC API for querying signals, updating current and target values of sensors and actuators and getting notified about changes to signals of interest.

Showcases covered by the Companion App are:

- Door Control
- Temperature Control
- Light Control
- Tire Pressure Check

Find out more about KUKSA:

- Vehicle Signal Specification: https://covesa.github.io/vehicle_signal_specification/
- KUKSA Databroker: https://github.com/eclipse/kuksa.val/
- KUKSA Android SDK: https://github.com/eclipse-kuksa/kuksa-android-sdk/
- KUKSA Companion App: https://github.com/eclipse-kuksa/kuksa-android-companion/

Read our [quickstart guide](docs/QUICKSTART.md) to find out how to use the KUKSA Companion App
and setup it's infrastructure.
Read our [quickstart guide](docs/QUICKSTART.md) to find out how to use the KUKSA Companion App and setup it's infrastructure.

Includes digital car model by BMW AG licensed under CC-BY-4.0
Includes digital car model by BMW AG licensed under CC-BY-4.0
(https://github.com/bmwcarit/digital-car-3d).
21 changes: 6 additions & 15 deletions fastlane/metadata/android/en-US/full_description.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,20 @@
The KUKSA Companion App demonstrates the capabilities of the Android SDK to connect to an
Android Automotive vehicle with an integrated KUKSA Databroker, read data and interact with
the actuators of the vehicle. The KUKSA Framework is based on the COVESA Vehicle Signal
Specification (VSS).
The KUKSA Companion App demonstrates the capabilities of the Android SDK to connect to a vehicle with an integrated KUKSA Databroker, read data and interact with the actuators of the vehicle. The KUKSA framework is based on the COVESA Vehicle Signal Specification (VSS).

The VSS defines the names and semantics of a large set of data entries that represent the
current and/or intended state of a vehicle's sensors and actuators organized in a tree-like
structure. For example, the vehicle's current speed is represented by the Vehicle.Speed entry.
The VSS defines the names and semantics of a large set of data entries that represent the current and/or intended state of a vehicle's sensors and actuators organized in a tree-like structure. For example, the vehicle's current speed is represented by the Vehicle.Speed entry.

However, VSS does not define how these signals are to be collected and managed within a
vehicle, nor does it prescribe how other components in the vehicle can read or write
signal values from and to the tree.
However, VSS does not define how these signals are to be collected and managed within a vehicle, nor does it prescribe how other components in the vehicle can read or write signal values from and to the tree.

The KUKSA Databroker is a resource efficient implementation of the VSS signal tree and is
intended to be run within a vehicle on a microprocessor based platform. It allows
applications in the vehicle to interact with the vehicle's sensors and actuators using a
uniform, high level gRPC API for querying signals, updating current and target values of
sensors and actuators and getting notified about changes to signals of interest.
The KUKSA Databroker is a resource efficient implementation of the VSS signal tree and is intended to be run within a vehicle on a microprocessor based platform. It allows applications in the vehicle to interact with the vehicle's sensors and actuators using a uniform, high level gRPC API for querying signals, updating current and target values of sensors and actuators and getting notified about changes to signals of interest.

Showcases covered by the Companion App are:

- Door Control
- Temperature Control
- Light Control
- Tire Pressure Check

Find out more about KUKSA:

- Vehicle Signal Specification: https://covesa.github.io/vehicle_signal_specification/
- KUKSA Databroker: https://github.com/eclipse/kuksa.val/
- KUKSA Android SDK: https://github.com/eclipse-kuksa/kuksa-android-sdk/
Expand Down
Loading