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.

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

Initiate Comprehensive Kuksa Requirements Analysis for Enhanced Version Development #21

Open
wants to merge 34 commits into
base: feature/databroker-api-v2
Choose a base branch
from

Conversation

rafaeling
Copy link
Contributor

@rafaeling rafaeling commented Apr 26, 2024

This pull request marks the beginning of an in-depth analysis aimed at addressing the various challenges and use cases that contributors and the developer community have encountered with recent versions of Kuksa.

The primary goals of this PR are to:

1. Analyze Software Requirements: Review of the existing software requirements against the reported issues and use cases.

2. Lay the Groundwork for Future Updates: Establish a solid foundation for the development of an updated and improved version of Kuksa.

3. Identify and Document Issues: Catalogue the specific difficulties experienced by users of the latest Kuksa versions, creating a clear and structured record of known issues.

New Content:

Kuksa Analysis

Copy link

@BjoernAtBosch BjoernAtBosch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding first bunch of findings

doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
Copy link

@BjoernAtBosch BjoernAtBosch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some comments to the diagrams

doc/diagrams/Client_actuate.png Outdated Show resolved Hide resolved
doc/diagrams/Client_gets.drawio.png Outdated Show resolved Hide resolved
doc/diagrams/Client_subscribes.drawio.png Outdated Show resolved Hide resolved
doc/diagrams/Provider_subscribes.drawio.png Outdated Show resolved Hide resolved
doc/diagrams/Provider_sets.drawio.png Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_requirementes.md Outdated Show resolved Hide resolved
doc/kuksa_use_cases.md Outdated Show resolved Hide resolved
doc/kuksa_use_cases.md Outdated Show resolved Hide resolved
doc/kuksa_use_cases.md Outdated Show resolved Hide resolved
doc/kuksa_use_cases.md Outdated Show resolved Hide resolved
doc/kuksa_use_cases.md Outdated Show resolved Hide resolved
doc/kuksa_use_cases.md Outdated Show resolved Hide resolved
@rafaeling rafaeling changed the base branch from main to feature/databroker-api-v2 October 23, 2024 13:07
Copy link
Contributor

@lukasmittag lukasmittag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we have an app use case here as well wer we subscribe values then publish values from a provider and finally actuate upon a value from databroker and do the actuation and value update. Maybe not the right scope here just a thought.

### Reading and writing VSS data using the CLI

1. Start the CLI in a container attached to the _kuksa_ bridge network and connect to the Databroker container:
The databroker supports both of `sdv.databroker.v1` and `kuksa.val.v1` as an API. Per default the databroker-cli uses the `sdv.databroker.v1` interface. To change it use `--protocol` option when starting. Chosse eihter one of `kuksa-val-v1` and `sdv-databroker-v1`.
The databroker supports both of `sdv.databroker.v1` and `kuksa.val.v1` as an API. Per default the databroker-cli uses the `sdv.databroker.v1` interface. To change it use `--protocol` option when starting. Choose either one of `kuksa-val-v1` and `sdv-databroker-v1`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mention kuksa.val.v2? but nothing for this PR I guess

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants