Add ts client component requirements by ryan-steel · Pull Request #149 · eclipse-score/time

ryan-steel · 2026-08-04T14:44:04Z

Adds component requirements documentation for ts_client following S-CORE requirements engineering process and module_template.

Related ticket

Addresses part of #97

github-actions · 2026-08-04T14:45:03Z

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //:license-check

Status: ⚠️ Needs Review

Click to expand output

[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: dd285f70-41e5-4d91-9492-2dac9f17bcd7
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'platforms', the root module requires module version platforms@1.0.0, but got platforms@1.1.0 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 3 packages loaded
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)

Analyzing: target //:license-check (50 packages loaded, 10 targets configured)

Analyzing: target //:license-check (97 packages loaded, 47 targets configured)

Analyzing: target //:license-check (144 packages loaded, 2902 targets configured)

Analyzing: target //:license-check (160 packages loaded, 6131 targets configured)

Analyzing: target //:license-check (160 packages loaded, 9331 targets configured)

Analyzing: target //:license-check (171 packages loaded, 9409 targets configured)

Analyzing: target //:license-check (172 packages loaded, 9417 targets configured)

Analyzing: target //:license-check (172 packages loaded, 9417 targets configured)

Analyzing: target //:license-check (172 packages loaded, 9417 targets configured)

Analyzing: target //:license-check (175 packages loaded, 11305 targets configured)

Analyzing: target //:license-check (176 packages loaded, 11429 targets configured)

INFO: Analyzed target //:license-check (177 packages loaded, 11555 targets configured).
[9 / 16] Creating runfiles tree bazel-out/k8-opt-exec-ST-d57f47055a04/bin/external/score_tooling+/dash/tool/formatters/dash_format_converter.runfiles [for tool]; 0s local
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[13 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox
[14 / 16] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 31.360s, Critical Path: 2.53s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

github-actions · 2026-08-04T14:51:23Z

The created documentation from the pull request is available at: docu-html

Copilot

Pull request overview

This PR adds S-CORE process documentation for the score/ts_client component, primarily introducing component requirements plus the associated inspection/checklist scaffolding and initial architecture documentation structure.

Changes:

Added component requirements and AoU requirements for the Time Sync Client (ts_client) in Sphinx-needs format.
Added requirements and architecture toctrees and inspection checklist documents for ts_client.
Updated component doc navigation (including a change to time_slave’s docs index).

Reviewed changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
score/ts_client/docs/requirements/requirements.rst	New component requirements and AoU requirement definitions for `ts_client`.
score/ts_client/docs/requirements/index.rst	Requirements section toctree for the `ts_client` docs.
score/ts_client/docs/requirements/chklst_req_inspection.rst	Requirements inspection checklist content and needtables (currently includes template placeholders).
score/ts_client/docs/index.rst	Top-level `ts_client` component doc entry and links to requirements/architecture sections.
score/ts_client/docs/architecture/index.rst	Architecture section toctree for the `ts_client` docs.
score/ts_client/docs/architecture/component_architecture.rst	Initial component architecture document and `comp` / static+dynamic view needs.
score/ts_client/docs/architecture/chklst_arc_inspection.rst	Architecture inspection checklist document.
score/ts_client/docs/.gitkeep	Placeholder for docs directory.
score/time_slave/docs/index.rst	Removes multiple toctree entries from the `time_slave` docs index.

Suppressed comments (3)

score/ts_client/docs/requirements/chklst_req_inspection.rst:48

Typo in the inspection roles list: duplicated "is" in "who is is".

- moderator: <committer explicitly named here, who is is the safety manager, security manager or quality manager initiating the inspection>

score/time_slave/docs/index.rst:22

This PR removes the time_slave docs toctree entries for architecture/requirements/manuals/etc., but that change isn’t mentioned in the PR description. If the intent is to temporarily omit these sections (e.g., because the pages don’t exist yet), add an explanatory note here (or move this change to a separate PR).

.. toctree::
   :maxdepth: 1

   component_classification

score/ts_client/docs/requirements/chklst_req_inspection.rst:187

The AoU inspection needtable still uses the template placeholder "component_name" in both the filter and tag selector, so it will never match this component’s needs.

.. needtable::
   :filter: "component_name" in docname and "requirements" in docname and docname is not None and status == "valid"
   :style: table
   :types: aou_req
   :tags: component_name

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

BjoernAtBosch

First chunk of comments

BjoernAtBosch · 2026-09-03T13:53:03Z


-[A short (~200 word) description of the component.]
-
+This component provides IPC mechanisms for time synchronization data exchange between time daemons and client applications within an ECU.


Suggested change

This component provides IPC mechanisms for time synchronization data exchange between time daemons and client applications within an ECU.

This component encapsulates the IPC mechanisms for time synchronization data exchange between the components time_slave and time_daemon.

BjoernAtBosch · 2026-09-03T13:56:04Z

+   :version: 1
+   :satisfied_by: comp__ts_client
+
+   The ts_client component shall provide operations to create, open, and close shared memory channels for gPTP data exchange between time daemon and time-aware applications.


AI hallucination? ;-)

Suggested change

The ts_client component shall provide operations to create, open, and close shared memory channels for gPTP data exchange between time daemon and time-aware applications.

The ts_client component shall provide operations to create, open, and close shared memory channels for gPTP data exchange between time_slave and time_daemon.

BjoernAtBosch · 2026-09-03T14:05:27Z

   :status: draft
   :version: 1
-   :safety: ASIL_B
+   :safety: QM


I think, this should stay ASIL_B: This component is used by/linked to time_daemon that has ASIB_B rating.

BjoernAtBosch · 2026-09-03T14:07:52Z

+   :version: 1
+   :satisfied_by: comp__ts_client
+
+   The ts_client Receiver shall indicate whether received data is valid or corrupted.


I think, this can't be achieved with just checking the magic. We could weaken this a bit and say: "[...] shall indicate whether the shared memory channel is obviously corrupted." - or something similar

BjoernAtBosch · 2026-09-03T14:12:03Z

+   :version: 1
+   :satisfied_by: comp__ts_client
+
+   The ts_client component shall implement lock-free synchronization between writer and readers to prevent blocking and ensure readers can detect concurrent writes.


I prefer the term "non-blocking" over "lock-free": Thers's still the need for some locking mechanism, but that's not blocking the reader's and writer's threads.

Suggested change

The ts_client component shall implement lock-free synchronization between writer and readers to prevent blocking and ensure readers can detect concurrent writes.

The ts_client component shall implement non-blocking synchronization between writer and readers and ensure readers can detect concurrent writes.

BjoernAtBosch · 2026-09-04T13:55:03Z

+   :reqtype: Functional
+   :security: NO
+   :safety: ASIL_B
+   :derived_from: feat_req__time__vehicle_time_sync[version==1]


I think we should add the "ctrl flow one" to "motivate" shmem usage plus ASIL rating

Suggested change

:derived_from: feat_req__time__vehicle_time_sync[version==1]

:derived_from: feat_req__time__vehicle_time_sync[version==1], feat_req__time__vehicle_time_ctrl_flow[version==1]

BjoernAtBosch · 2026-09-04T14:27:51Z

+.. comp_req:: gPTP Synchronization Status Exchange
+   :id: comp_req__ts_client__sync_status_data
+   :reqtype: Interface
+   :security: NO
+   :safety: ASIL_B
+   :derived_from: feat_req__time__vehicle_time_sync[version==1]
+   :status: valid
+   :version: 1
+   :satisfied_by: comp__ts_client
+
+   The ts_client component shall exchange gPTP synchronization status information containing synchronized state, timeout condition, time discontinuity detection (future and past), and correctness indication.
+


This is in the code (currently), but we just need the synchronization state which - in the end - just tells if there was at least one sync+fup frame received and it has not timed out. (I think this needs rework)

BjoernAtBosch · 2026-09-04T14:41:52Z

+   :status: valid
+   :version: 1
+
+   The user shall configure shared memory permissions to allow publisher write access and reader read access. Incorrect permissions will cause channel creation or opening failures.


Isn't that handled in the code?

BjoernAtBosch · 2026-09-04T15:43:59Z

+   :reqtype: Functional
+   :security: NO
+   :safety: ASIL_B
+   :derived_from: feat_req__time__vehicle_time_sync[version==1]


Suggested change

:derived_from: feat_req__time__vehicle_time_sync[version==1]

:derived_from: feat_req__time__vehicle_time_sync[version==1], feat_req__time__vehicle_time_acc_qual_api[version==1], feat_req__time__vehicle_time_time_pt_qual[version==1]

BjoernAtBosch · 2026-09-04T15:46:35Z

+   :reqtype: Functional
+   :security: NO
+   :safety: ASIL_B
+   :derived_from: feat_req__time__vehicle_time_ctrl_flow[version==1]


Suggested change

:derived_from: feat_req__time__vehicle_time_ctrl_flow[version==1]

:derived_from: feat_req__time__vehicle_time_ctrl_flow[version==1], feat_req__time__vehicle_time_ctrl_flow[version==1]

BjoernAtBosch · 2026-09-04T15:51:29Z

+   :reqtype: Functional
+   :security: NO
+   :safety: ASIL_B
+   :derived_from: feat_req__time__vehicle_time_sync[version==1]


Suggested change

:derived_from: feat_req__time__vehicle_time_sync[version==1]

:derived_from: feat_req__time__vehicle_time_sync[version==1], feat_req__time__vehicle_time_acc_qual_api[version==1], feat_req__time__vehicle_time_time_pt_qual[version==1]

BjoernAtBosch · 2026-09-04T15:52:15Z

+   :reqtype: Functional
+   :security: NO
+   :safety: ASIL_B
+   :derived_from: feat_req__time__vehicle_time_sync[version==1]


Suggested change

:derived_from: feat_req__time__vehicle_time_sync[version==1]

:derived_from: feat_req__time__vehicle_time_sync[version==1], feat_req__time__vehicle_time_ctrl_flow[version==1]

BjoernAtBosch · 2026-09-04T15:52:53Z

+   :id: comp_req__ts_client__sync_status_data
+   :reqtype: Interface
+   :security: NO
+   :safety: ASIL_B


Could be QM

Suggested change

:safety: ASIL_B

:safety: QM

BjoernAtBosch · 2026-09-04T15:53:54Z

+   :id: comp_req__ts_client__sync_fup_data
+   :reqtype: Interface
+   :security: NO
+   :safety: ASIL_B


Suggested change

:safety: ASIL_B

:safety: QM

BjoernAtBosch · 2026-09-04T15:54:08Z

+   :id: comp_req__ts_client__pdelay_data
+   :reqtype: Interface
+   :security: NO
+   :safety: ASIL_B


Suggested change

:safety: ASIL_B

:safety: QM

BjoernAtBosch · 2026-09-04T15:54:22Z

+   :id: comp_req__ts_client__time_correlation_data
+   :reqtype: Interface
+   :security: NO
+   :safety: ASIL_B


Suggested change

:safety: ASIL_B

:safety: ASIL_QM

BjoernAtBosch · 2026-09-04T15:56:48Z

+.. comp_req:: Linux Platform Support
+   :id: comp_req__ts_client__platform_linux
+   :reqtype: Functional
+   :security: NO
+   :safety: ASIL_B
+   :derived_from: feat_req__time__vehicle_time_sync[version==1]
+   :status: valid
+   :version: 1
+   :satisfied_by: comp__ts_client
+
+   The ts_client component shall support Linux platforms for shared memory operations and inter-process communication.
+
+.. comp_req:: QNX Platform Support
+   :id: comp_req__ts_client__platform_qnx
+   :reqtype: Functional
+   :security: NO
+   :safety: ASIL_B
+   :derived_from: feat_req__time__vehicle_time_sync[version==1]
+   :status: valid
+   :version: 1
+   :satisfied_by: comp__ts_client
+
+   The ts_client component shall support QNX 8.0 SDP platforms for shared memory operations and inter-process communication.


Same as for time_daemon plus we should link something meaningful here (and in general) - we can also link sort of common requirements here. Not sure how to achieve this. There is stkh_req__functional_req__operating_system but I don't think, we can link that directly

BjoernAtBosch · 2026-09-04T15:57:15Z

+   :id: comp_req__ts_client__error_reporting
+   :reqtype: Functional
+   :security: NO
+   :safety: ASIL_B


Suggested change

:safety: ASIL_B

:safety: QM

github-project-automation Bot added this to TIM - Time FT Aug 4, 2026

github-project-automation Bot moved this to In Progress in TIM - Time FT Aug 4, 2026

ryan-steel had a problem deploying to workflow-approval August 4, 2026 14:44 — with GitHub Actions Error

ryan-steel force-pushed the add-ts_client-component-requirements branch from 2956a19 to 1daac44 Compare August 4, 2026 14:49

ryan-steel had a problem deploying to workflow-approval August 4, 2026 14:49 — with GitHub Actions Error

ryan-steel had a problem deploying to workflow-approval August 4, 2026 14:56 — with GitHub Actions Error

ryan-steel had a problem deploying to workflow-approval August 4, 2026 15:02 — with GitHub Actions Error

ryan-steel marked this pull request as ready for review August 5, 2026 08:49

ryan-steel had a problem deploying to workflow-approval August 5, 2026 13:17 — with GitHub Actions Error

ryan-steel mentioned this pull request Aug 5, 2026

feat: Quality pack targets #150

Open

ryan-steel had a problem deploying to workflow-approval August 6, 2026 09:53 — with GitHub Actions Error

ryan-steel force-pushed the add-ts_client-component-requirements branch from 21fc11f to 2641242 Compare August 6, 2026 09:53

ryan-steel had a problem deploying to workflow-approval August 6, 2026 09:53 — with GitHub Actions Error

ryan-steel requested a lite review from Copilot August 6, 2026 10:01

Copilot started reviewing on behalf of ryan-steel August 6, 2026 10:01 View session

Copilot AI reviewed Aug 6, 2026

View reviewed changes

ryan-steel had a problem deploying to workflow-approval August 6, 2026 14:13 — with GitHub Actions Error

ryan-steel had a problem deploying to workflow-approval August 6, 2026 14:17 — with GitHub Actions Error

ryan-steel had a problem deploying to workflow-approval August 6, 2026 15:11 — with GitHub Actions Error

ryan-steel had a problem deploying to workflow-approval August 18, 2026 09:17 — with GitHub Actions Error

ryan-steel had a problem deploying to workflow-approval August 19, 2026 12:39 — with GitHub Actions Error

ryan-steel had a problem deploying to workflow-approval August 19, 2026 12:40 — with GitHub Actions Error

ryan-steel had a problem deploying to workflow-approval August 19, 2026 12:41 — with GitHub Actions Error

ryan-steel requested a deployment to workflow-approval August 19, 2026 12:41 — with GitHub Actions Waiting

ryan-steel had a problem deploying to workflow-approval August 19, 2026 12:46 — with GitHub Actions Error

ryan-steel force-pushed the add-ts_client-component-requirements branch from 8792013 to 29e3087 Compare August 19, 2026 13:28

ryan-steel had a problem deploying to workflow-approval August 19, 2026 13:28 — with GitHub Actions Error

ryan-steel marked this pull request as ready for review August 19, 2026 13:43

ryan-steel marked this pull request as draft August 19, 2026 16:02

ryan-steel had a problem deploying to workflow-approval August 19, 2026 16:05 — with GitHub Actions Error

ryan-steel had a problem deploying to workflow-approval August 20, 2026 14:03 — with GitHub Actions Error

ryan-steel had a problem deploying to workflow-approval August 20, 2026 14:09 — with GitHub Actions Error

ryan-steel marked this pull request as ready for review August 20, 2026 14:11

ryan-steel force-pushed the add-ts_client-component-requirements branch from a0a8c6f to 093756b Compare August 20, 2026 14:11

ryan-steel had a problem deploying to workflow-approval August 20, 2026 14:11 — with GitHub Actions Error

ryan-steel added 3 commits August 31, 2026 13:40

add ts_client comp reqs

16589fa

Merge main

1c6de2c

update Specification section

a454532

BjoernAtBosch reviewed Sep 4, 2026

View reviewed changes


		[A short (~200 word) description of the component.]

		This component provides IPC mechanisms for time synchronization data exchange between time daemons and client applications within an ECU.

	This component provides IPC mechanisms for time synchronization data exchange between time daemons and client applications within an ECU.
	This component encapsulates the IPC mechanisms for time synchronization data exchange between the components time_slave and time_daemon.

	The ts_client component shall provide operations to create, open, and close shared memory channels for gPTP data exchange between time daemon and time-aware applications.
	The ts_client component shall provide operations to create, open, and close shared memory channels for gPTP data exchange between time_slave and time_daemon.

	The ts_client component shall implement lock-free synchronization between writer and readers to prevent blocking and ensure readers can detect concurrent writes.
	The ts_client component shall implement non-blocking synchronization between writer and readers and ensure readers can detect concurrent writes.

	:derived_from: feat_req__time__vehicle_time_sync[version==1]
	:derived_from: feat_req__time__vehicle_time_sync[version==1], feat_req__time__vehicle_time_ctrl_flow[version==1]

Uh oh!

Conversation

ryan-steel commented Aug 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

License Check Results

Uh oh!

github-actions Bot commented Aug 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BjoernAtBosch left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BjoernAtBosch Sep 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BjoernAtBosch Sep 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BjoernAtBosch Sep 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ryan-steel commented Aug 4, 2026 •

edited

Loading

github-actions Bot commented Aug 4, 2026 •

edited

Loading

BjoernAtBosch Sep 3, 2026 •

edited

Loading

BjoernAtBosch Sep 4, 2026 •

edited

Loading

BjoernAtBosch Sep 4, 2026 •

edited

Loading