Add time slave component requirements - #151
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run //:license-checkStatus: Click to expand output |
|
The created documentation from the pull request is available at: docu-html |
There was a problem hiding this comment.
Pull request overview
Adds initial S-CORE process documentation scaffolding for the score/time_slave component, introducing draft requirements and architecture artefacts to establish traceable needs for future work.
Changes:
- Added initial component requirements (
comp_req/aou_req) and a requirements inspection checklist. - Added architecture boilerplate (static/dynamic views) and an architecture inspection checklist.
- Updated the component documentation landing page to reference the new sections.
Reviewed changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| score/time_slave/docs/index.rst | Reworked component landing page and toctree to point at requirements/architecture. |
| score/time_slave/docs/requirements/index.rst | Introduces requirements section toctree. |
| score/time_slave/docs/requirements/requirements.rst | Adds initial component requirements and AoU needs for time_slave. |
| score/time_slave/docs/requirements/chklst_req_inspection.rst | Adds requirements inspection checklist template for the component. |
| score/time_slave/docs/requirements/.gitkeep | Placeholder file for requirements directory. |
| score/time_slave/docs/architecture/index.rst | Introduces architecture section toctree. |
| score/time_slave/docs/architecture/component_architecture.rst | Adds architecture boilerplate including comp, static view, and dynamic view needs. |
| score/time_slave/docs/architecture/chklst_arc_inspection.rst | Adds architecture inspection checklist template for the component. |
| score/time_slave/docs/architecture/.gitkeep | Placeholder file for architecture directory. |
Suppressed comments (2)
score/time_slave/docs/architecture/chklst_arc_inspection.rst:181
- Typo in quoted string:
""n/a"has an extra quote, which reads oddly in the rendered docs.
Note: If a Review ID is not applicable for your architecture, then state ""n/a" in status and comment accordingly in remarks.
score/time_slave/docs/architecture/component_architecture.rst:74
- The
:belongs_to:targetfeat__timeis not defined anywhere in this repository (search only finds this reference). If the feature need lives in an external bundle, please make sure it’s available when building these docs; otherwise update this link to an existing feature need ID.
:belongs_to: feat__time
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
42e1e86 to
1a9f07d
Compare
1a9f07d to
f5b6dc1
Compare
8a7e005 to
dc32e15
Compare
8340059 to
d2d59b2
Compare
8d2ff6c to
6e3358e
Compare
2b656d0 to
28c592a
Compare
| :version: 1 | ||
| :satisfied_by: comp__time_slave | ||
|
|
||
| The time_slave component shall receive IEEE 802.1AS event messages (Sync, Follow_Up, Pdelay_Resp, Pdelay_Resp_Follow_Up) sent to the Ethernet address specified in the IEEE 801.1AS standard. It shall send event messages (Pdelay_Req) to the same address. |
There was a problem hiding this comment.
Sorry - needs an update
| The time_slave component shall receive IEEE 802.1AS event messages (Sync, Follow_Up, Pdelay_Resp, Pdelay_Resp_Follow_Up) sent to the Ethernet address specified in the IEEE 801.1AS standard. It shall send event messages (Pdelay_Req) to the same address. | |
| The time_slave component shall receive the IEEE 802.1AS messages Sync, Follow_Up, PdelayReq, Pdelay_Resp, and Pdelay_Resp_Follow_Up sent to the Ethernet address specified in the IEEE 801.1AS standard. It shall send outgoing Pdelay messages (Pdelay_Req, Pdelay_Resp, and Pdelay_Resp_Follow_Up) to the same address. |
| :version: 1 | ||
| :satisfied_by: comp__time_slave | ||
|
|
||
| The time_slave component shall transmit IEEE 802.1AS PDelayReq messages at the configured interval (configurable, default 1000 milliseconds) and record the transmit timestamp. |
There was a problem hiding this comment.
| The time_slave component shall transmit IEEE 802.1AS PDelayReq messages at the configured interval (configurable, default 1000 milliseconds) and record the transmit timestamp. | |
| After the configured initial warmup delay (default: 2000 milliseconds), the time_slave component shall periodically transmit IEEE 802.1AS PDelayReq messages at the configured interval (default: 1000 milliseconds) and record the transmit timestamp. |
| :status: valid | ||
| :version: 1 | ||
|
|
||
| The user shall run exactly one time_slave instance per network interface to prevent gPTP protocol conflicts. Multiple instances binding to the same interface will cause raw socket binding failures or multicast group membership conflicts. |
There was a problem hiding this comment.
| The user shall run exactly one time_slave instance per network interface to prevent gPTP protocol conflicts. Multiple instances binding to the same interface will cause raw socket binding failures or multicast group membership conflicts. | |
| The user shall run exactly one time_slave instance only. Multiple instances are not supported and will cause failures or conflicts on the single IPC interface to the TimeDaemon. |
| :version: 1 | ||
|
|
||
| The user shall run exactly one time_slave instance per network interface to prevent gPTP protocol conflicts. Multiple instances binding to the same interface will cause raw socket binding failures or multicast group membership conflicts. | ||
|
|
There was a problem hiding this comment.
| .. aou_req:: Hardware Timestamping Support | |
| :id: aou_req__time_slave__hw_timestamping | |
| :reqtype: Process | |
| :security: NO | |
| :safety: QM | |
| :status: valid | |
| :version: 1 | |
| If the user has high demands regarding the synchronization accuracy and precision, they must configure a NIC providing hardware timestamping and driver software support. |
| :version: 1 | ||
| :satisfied_by: comp__time_slave | ||
|
|
||
| According to IEEE 802.1AS, the time_slave component shall only process received gPTP Sync and FollowUp messages matching the configured domain number (0-127 per IEEE 802.1AS). The time_slave component shall only process received gPTP Pdelay messages matching the domain number 0. It shall use the domain number 0 in send gPTP Pdelay messages. |
There was a problem hiding this comment.
Sorry - some details found recently
| According to IEEE 802.1AS, the time_slave component shall only process received gPTP Sync and FollowUp messages matching the configured domain number (0-127 per IEEE 802.1AS). The time_slave component shall only process received gPTP Pdelay messages matching the domain number 0. It shall use the domain number 0 in send gPTP Pdelay messages. | |
| According to IEEE 802.1AS, the time_slave component shall only process received gPTP Sync and FollowUp messages matching the configured domain number (0-127 per IEEE 802.1AS). The time_slave component shall ignore the domain number contained in received gPTP Pdelay messages. It shall set the domain number to 0 in sent gPTP Pdelay messages. |
Improvement
Description
Add initial component requirements for time_slave following S-CORE process.
Related ticket
Part of #65