Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ For a detailed concept and architectural design, please refer to the :doc:`time_
:caption: Contents:

features/index
module/index

Project Layout
--------------
Expand Down
45 changes: 45 additions & 0 deletions docs/module/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
..
# *******************************************************************************
# Copyright (c) 2026 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Module
======

The S-CORE ``time`` module provides a unified API for accessing system, steady, high-resolution steady, and PTP-synchronized vehicle time. The module contains four components: a client library for application-facing access, Time Slave for PTP clock synchronization, ``ts_client`` for shared-memory IPC between Time Slave and Time Daemon, and Time Daemon for synchronization quality validation before serving Vehicle Time.

.. code-block:: rst

.. mod:: Time
:id: mod__time
:includes: comp__component_name_template

Module View
-----------

.. code-block:: rst

.. mod_view_sta:: Time Module Static View
:id: mod_view_sta__time__time
:includes: comp__component_name_template

.. needarch::
:scale: 50
:align: center

{{ draw_module(need(), needs) }}

Module Documents
----------------

.. toctree::
:maxdepth: 1
8 changes: 8 additions & 0 deletions score/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,11 @@
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

load("@score_docs_as_code//:docs.bzl", "docs_bundle")

docs_bundle(
name = "docs_bundle",
source_dir = "docs",
visibility = ["//visibility:public"],
)
7 changes: 7 additions & 0 deletions score/time/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@

load("@score_baselibs//:bazel/unit_tests.bzl", "cc_unit_test_suites_for_host_and_qnx")
load("@score_baselibs//third_party/itf:py_unittest_qnx_test.bzl", "py_unittest_qnx_test")
load("@score_docs_as_code//:docs.bzl", "docs_bundle")

docs_bundle(
name = "docs_bundle",
source_dir = "docs",
visibility = ["//visibility:public"],
)

py_unittest_qnx_test(
name = "qnx_unit_test_cases",
Expand Down
7 changes: 7 additions & 0 deletions score/time_daemon/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@
# *******************************************************************************

load("@score_baselibs//:bazel/unit_tests.bzl", "cc_unit_test_suites_for_host_and_qnx")
load("@score_docs_as_code//:docs.bzl", "docs_bundle")

docs_bundle(
name = "docs_bundle",
source_dir = "docs",
visibility = ["//visibility:public"],
)

cc_unit_test_suites_for_host_and_qnx(
name = "unit_test_suite",
Expand Down
7 changes: 7 additions & 0 deletions score/time_slave/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@
# *******************************************************************************

load("@score_baselibs//:bazel/unit_tests.bzl", "cc_unit_test_suites_for_host_and_qnx")
load("@score_docs_as_code//:docs.bzl", "docs_bundle")

docs_bundle(
name = "docs_bundle",
source_dir = "docs",
visibility = ["//visibility:public"],
)

cc_unit_test_suites_for_host_and_qnx(
name = "unit_test_suite",
Expand Down
Loading