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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
631f8b2
Update docs
erikbosch Oct 22, 2024
ba5856e
Initiate Kuksa requirements analysis
rafaeling Apr 26, 2024
822fe82
Update comments for Databroker API proposal
rafaeling Apr 29, 2024
2dd467a
Move Domain Requirements to the end of the document
rafaeling Apr 30, 2024
f9272df
New NFRs: Throttling-mode. Shared and zero-copy memory
rafaeling Apr 30, 2024
951017c
Use terminology
rafaeling Apr 30, 2024
2c16e59
Remove duplicate use case
rafaeling Apr 30, 2024
a43e28e
Possible content of the client's request
rafaeling Apr 30, 2024
c3bbc6b
Update doc/kuksa_requirementes.md
rafaeling May 7, 2024
bc985ca
Update doc/kuksa_requirementes.md
rafaeling May 7, 2024
6b1793a
Update doc/kuksa_requirementes.md
rafaeling May 7, 2024
21e98c6
Update doc/kuksa_requirementes.md
rafaeling May 7, 2024
8a1bb15
Update doc/kuksa_requirementes.md
rafaeling May 7, 2024
7250f30
Update doc/kuksa_requirementes.md
rafaeling May 7, 2024
a448f65
Rephrase with "shall" some Consumer requirements
rafaeling May 14, 2024
14807a4
Use shall
rafaeling May 14, 2024
3650c89
Remove denied requirements from Consumer
rafaeling May 14, 2024
c3a4b57
Update and remove requirements
rafaeling May 14, 2024
d40b392
Updating provider requirements
BjoernAtBosch May 17, 2024
91fe2b6
Restructure documentation
rafaeling Jun 7, 2024
1f3e100
Create test.md
BjoernAtBosch Jun 7, 2024
5aa32a6
Delete doc/test.md
BjoernAtBosch Jun 7, 2024
1966cba
Update client subscribe diagram
BjoernAtBosch Jun 7, 2024
f0536ff
Files moved
rafaeling Jun 10, 2024
ef7d144
Add sequenc diagram for multiple provide actuation
lukasmittag Sep 17, 2024
6340150
Add more topics to the list
rafaeling Sep 30, 2024
357113c
Update documentation to kuksa.val.v2
rafaeling Oct 23, 2024
97d00e0
Update link kuksa.val.v2
rafaeling Oct 23, 2024
56131c7
Fix dead links
rafaeling Oct 24, 2024
79f98fe
FIx dead link 2
rafaeling Oct 24, 2024
8d46133
Update correct diagrams and requirements
rafaeling Oct 24, 2024
1c0dbbe
Update diagram
rafaeling Oct 24, 2024
1aa9acf
Update server info diagram
rafaeling Oct 24, 2024
f8770cd
Fix format
rafaeling Oct 24, 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
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,13 @@ The quickest possible way to get Kuksa Databroker up and running.

> :bulb: **Tip:** You can stop the container using `ctrl-c`.

*Note that not all APIs are enabled by default, see [user guide](doc/user_guide.md) and*
*[protocols](doc/protocol/README.md) for more information!*

### 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


```sh
# in a new terminal
Expand Down
131 changes: 131 additions & 0 deletions doc/diagrams/consumer_actuate.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
<mxfile host="65bd71144e">
<diagram name="Seite-1" id="DjCrLJOEe4nHxTjUXNSd">
<mxGraphModel dx="1956" dy="1169" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="0"/>
<mxCell id="1" parent="0"/>
<mxCell id="sU0O0qOnpkfrYUOIyIDh-27" value=":DataBroker" style="shape=umlLifeline;perimeter=lifelinePerimeter;whiteSpace=wrap;html=1;container=1;collapsible=0;recursiveResize=0;outlineConnect=0;rounded=1;" parent="1" vertex="1">
<mxGeometry x="360" y="40" width="100" height="550" as="geometry"/>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-17" value="" style="html=1;points=[[0,0,0,0,5],[0,1,0,0,-5],[1,0,0,0,5],[1,1,0,0,-5]];perimeter=orthogonalPerimeter;outlineConnect=0;targetShapes=umlLifeline;portConstraint=eastwest;newEdgeStyle={&quot;curved&quot;:0,&quot;rounded&quot;:0};" parent="sU0O0qOnpkfrYUOIyIDh-27" vertex="1">
<mxGeometry x="45" y="120" width="10" height="370" as="geometry"/>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-10" value="" style="html=1;points=[[0,0,0,0,5],[0,1,0,0,-5],[1,0,0,0,5],[1,1,0,0,-5]];perimeter=orthogonalPerimeter;outlineConnect=0;targetShapes=umlLifeline;portConstraint=eastwest;newEdgeStyle={&quot;curved&quot;:0,&quot;rounded&quot;:0};" parent="sU0O0qOnpkfrYUOIyIDh-27" vertex="1">
<mxGeometry x="39" y="250" width="10" height="40" as="geometry"/>
</mxCell>
<mxCell id="sU0O0qOnpkfrYUOIyIDh-33" value=":Signal Consumer" style="shape=umlLifeline;perimeter=lifelinePerimeter;whiteSpace=wrap;html=1;container=1;collapsible=0;recursiveResize=0;outlineConnect=0;rounded=1;" parent="1" vertex="1">
<mxGeometry y="40" width="100" height="550" as="geometry"/>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-4" value="" style="html=1;points=[[0,0,0,0,5],[0,1,0,0,-5],[1,0,0,0,5],[1,1,0,0,-5]];perimeter=orthogonalPerimeter;outlineConnect=0;targetShapes=umlLifeline;portConstraint=eastwest;newEdgeStyle={&quot;curved&quot;:0,&quot;rounded&quot;:0};" parent="sU0O0qOnpkfrYUOIyIDh-33" vertex="1">
<mxGeometry x="45" y="250" width="10" height="40" as="geometry"/>
</mxCell>
<mxCell id="sU0O0qOnpkfrYUOIyIDh-39" value=":Provider" style="shape=umlLifeline;perimeter=lifelinePerimeter;whiteSpace=wrap;html=1;container=1;collapsible=0;recursiveResize=0;outlineConnect=0;rounded=1;" parent="1" vertex="1">
<mxGeometry x="885" y="40" width="100" height="550" as="geometry"/>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-18" value="" style="html=1;points=[[0,0,0,0,5],[0,1,0,0,-5],[1,0,0,0,5],[1,1,0,0,-5]];perimeter=orthogonalPerimeter;outlineConnect=0;targetShapes=umlLifeline;portConstraint=eastwest;newEdgeStyle={&quot;curved&quot;:0,&quot;rounded&quot;:0};" parent="sU0O0qOnpkfrYUOIyIDh-39" vertex="1">
<mxGeometry x="45" y="120" width="10" height="370" as="geometry"/>
</mxCell>
<mxCell id="THUKiZGTHPrwo03LJUuz-1" value="" style="html=1;points=[[0,0,0,0,5],[0,1,0,0,-5],[1,0,0,0,5],[1,1,0,0,-5]];perimeter=orthogonalPerimeter;outlineConnect=0;targetShapes=umlLifeline;portConstraint=eastwest;newEdgeStyle={&quot;curved&quot;:0,&quot;rounded&quot;:0};" parent="sU0O0qOnpkfrYUOIyIDh-39" vertex="1">
<mxGeometry x="51" y="250" width="10" height="110" as="geometry"/>
</mxCell>
<mxCell id="3" value="" style="html=1;points=[[0,0,0,0,5],[0,1,0,0,-5],[1,0,0,0,5],[1,1,0,0,-5]];perimeter=orthogonalPerimeter;outlineConnect=0;targetShapes=umlLifeline;portConstraint=eastwest;newEdgeStyle={&quot;curved&quot;:0,&quot;rounded&quot;:0};" vertex="1" parent="sU0O0qOnpkfrYUOIyIDh-39">
<mxGeometry x="56" y="300" width="10" height="60" as="geometry"/>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-2" value=":Vehicle Network" style="shape=umlLifeline;perimeter=lifelinePerimeter;whiteSpace=wrap;html=1;container=1;collapsible=0;recursiveResize=0;outlineConnect=0;rounded=1;" parent="1" vertex="1">
<mxGeometry x="1118" y="40" width="106" height="550" as="geometry"/>
</mxCell>
<mxCell id="4" value="" style="html=1;points=[[0,0,0,0,5],[0,1,0,0,-5],[1,0,0,0,5],[1,1,0,0,-5]];perimeter=orthogonalPerimeter;outlineConnect=0;targetShapes=umlLifeline;portConstraint=eastwest;newEdgeStyle={&quot;curved&quot;:0,&quot;rounded&quot;:0};" vertex="1" parent="56O69Gt65AHP2GdqeosO-2">
<mxGeometry x="48" y="300" width="10" height="60" as="geometry"/>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-14" value="" style="endArrow=classic;html=1;rounded=0;" parent="1" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="405" y="330" as="sourcePoint"/>
<mxPoint x="49.700000000000045" y="330" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-15" value="ActuateResponse" style="edgeLabel;resizable=0;html=1;;align=center;verticalAlign=middle;" parent="56O69Gt65AHP2GdqeosO-14" connectable="0" vertex="1">
<mxGeometry relative="1" as="geometry">
<mxPoint y="-9" as="offset"/>
</mxGeometry>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-12" value="" style="endArrow=classic;html=1;rounded=0;" parent="1" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="55" y="289.9999999999999" as="sourcePoint"/>
<mxPoint x="400" y="290" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-13" value="Actuate(ActuateRequest=actuator_path)" style="edgeLabel;resizable=0;html=1;;align=center;verticalAlign=middle;" parent="56O69Gt65AHP2GdqeosO-12" connectable="0" vertex="1">
<mxGeometry relative="1" as="geometry">
<mxPoint y="-9" as="offset"/>
</mxGeometry>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-19" value="" style="endArrow=classic;html=1;rounded=0;" parent="1" edge="1" source="56O69Gt65AHP2GdqeosO-18">
<mxGeometry relative="1" as="geometry">
<mxPoint x="925" y="160" as="sourcePoint"/>
<mxPoint x="415" y="160" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-20" value="OpenProviderStream(&lt;b&gt;&lt;font color=&quot;#007fff&quot;&gt;stream&lt;/font&gt;&lt;/b&gt;&amp;nbsp;OpenProviderStreamRequest=ProvideActuationRequest(actutators))" style="edgeLabel;resizable=0;html=1;;align=center;verticalAlign=middle;" parent="56O69Gt65AHP2GdqeosO-19" connectable="0" vertex="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="10" y="-11" as="offset"/>
</mxGeometry>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-22" value="" style="endArrow=classic;html=1;rounded=0;" parent="1" edge="1" target="56O69Gt65AHP2GdqeosO-18">
<mxGeometry relative="1" as="geometry">
<mxPoint x="415.0348837209301" y="180" as="sourcePoint"/>
<mxPoint x="924.9999999999995" y="179.99999999999977" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-23" value="&lt;b&gt;&lt;font color=&quot;#007fff&quot;&gt;stream&lt;/font&gt;&lt;/b&gt;&amp;nbsp;OpenProviderStreamResponse=ProvideActuationResponse" style="edgeLabel;resizable=0;html=1;;align=center;verticalAlign=middle;" parent="56O69Gt65AHP2GdqeosO-22" connectable="0" vertex="1">
<mxGeometry relative="1" as="geometry">
<mxPoint y="-10" as="offset"/>
</mxGeometry>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-38" value="" style="endArrow=classic;html=1;rounded=0;" parent="1" edge="1" source="THUKiZGTHPrwo03LJUuz-1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="932" y="329.22" as="sourcePoint"/>
<mxPoint x="410" y="330" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-39" value="&lt;b&gt;&lt;font color=&quot;#007fff&quot;&gt;stream&lt;/font&gt;&lt;/b&gt;&amp;nbsp;OpenProviderStreamRequest=BatchActuateStreamResponse" style="edgeLabel;resizable=0;html=1;;align=center;verticalAlign=middle;" parent="56O69Gt65AHP2GdqeosO-38" connectable="0" vertex="1">
<mxGeometry relative="1" as="geometry">
<mxPoint y="-8" as="offset"/>
</mxGeometry>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-40" value="" style="endArrow=classic;html=1;rounded=0;" parent="1" source="56O69Gt65AHP2GdqeosO-10" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="415" y="290" as="sourcePoint"/>
<mxPoint x="940" y="290" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="56O69Gt65AHP2GdqeosO-41" value="&lt;b&gt;&lt;font color=&quot;#007fff&quot;&gt;stream&lt;/font&gt;&lt;/b&gt;&amp;nbsp;OpenProviderStreamResponse=BatchActuateStreamRequest(actuator_path, value)" style="edgeLabel;resizable=0;html=1;;align=center;verticalAlign=middle;" parent="56O69Gt65AHP2GdqeosO-40" connectable="0" vertex="1">
<mxGeometry relative="1" as="geometry">
<mxPoint y="-8" as="offset"/>
</mxGeometry>
</mxCell>
<mxCell id="THUKiZGTHPrwo03LJUuz-2" value="" style="endArrow=classic;html=1;rounded=0;" parent="1" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="950" y="340" as="sourcePoint"/>
<mxPoint x="1164" y="340" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="THUKiZGTHPrwo03LJUuz-3" value="write_data_frame(data)" style="edgeLabel;resizable=0;html=1;;align=center;verticalAlign=middle;" parent="THUKiZGTHPrwo03LJUuz-2" connectable="0" vertex="1">
<mxGeometry relative="1" as="geometry">
<mxPoint y="-8" as="offset"/>
</mxGeometry>
</mxCell>
<mxCell id="THUKiZGTHPrwo03LJUuz-4" value="" style="endArrow=classic;html=1;rounded=0;" parent="1" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="1164.5" y="399.9999999999999" as="sourcePoint"/>
<mxPoint x="947" y="399.9999999999999" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="THUKiZGTHPrwo03LJUuz-5" value="ack_write_operation" style="edgeLabel;resizable=0;html=1;;align=center;verticalAlign=middle;" parent="THUKiZGTHPrwo03LJUuz-4" connectable="0" vertex="1">
<mxGeometry relative="1" as="geometry">
<mxPoint y="-8" as="offset"/>
</mxGeometry>
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
1 change: 1 addition & 0 deletions doc/diagrams/consumer_actuate.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading