diff --git a/README.md b/README.md index 90c3b62..31448fa 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ uv run diag-master --reference diag_master/config/sample.yml # The diag-worker needs to run privileged so that it can communicate with local Unix domain # sockets and read the journal of services running with elevated privileges # See notes below. -sudo uv run diag-worker --ptp4l-units ptp4l@eno1 ptp4l@***REMOVED*** +sudo uv run diag-worker --ptp4l-units ptp4l@eno1 ptp4l@enp2s0 ``` > **Note:** To run `uv` privileged, it needs to be installed system-wide. If `sudo uv` does not diff --git a/docs/design.md b/docs/design.md index b4fa10e..8c18cf9 100644 --- a/docs/design.md +++ b/docs/design.md @@ -183,7 +183,7 @@ different naming schemes: - **System Clock IDs**: Human-readable names like `my_host.sys` - **Interface IDs**: Network interface identifiers, e.g. `my_host.eno1` - **Linux Clock Device IDs**: Device names like `my_host.ptp0` (`/dev/ptp0`) -- **Sensor IDs**: Frame IDs used by sensors, e.g. `sensor@lidar/***REMOVED***` +- **Sensor IDs**: Frame IDs used by sensors, e.g. `sensor@lidar/top` When an alias update is received, the graph combines all nodes representing the same clock and updates all references to use the most human-readable identifier. diff --git a/docs/img/ptp_architectures.drawio b/docs/img/ptp_architectures.drawio index 8104ab9..203e7bc 100644 --- a/docs/img/ptp_architectures.drawio +++ b/docs/img/ptp_architectures.drawio @@ -380,7 +380,7 @@ - + diff --git a/docs/index.md b/docs/index.md index 5408aed..3fb1639 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,7 @@ Takes the **pain** out of **p**recision time synchroniz**a**t**i**o**n**. ## :fontawesome-solid-signs-post: First Steps * [PTP Architecture Guide](ptp-architecture-guide.md) - Set up PTP in a distributed system -* [Integrators' Guide](integrators-guide.md) - Set up SYNC.TOOLING for a ***REMOVED*** based system +* [Integrators' Guide](integrators-guide.md) - Set up SYNC.TOOLING in a vehicle * [Installation Guide](installation.md) - Install SYNC.TOOLING manually * [Usage Guide](usage.md) - Configure SYNC.TOOLING for your system diff --git a/docs/installation.md b/docs/installation.md index d851adc..166af58 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -6,7 +6,7 @@ software components necessary: `diag-master` !!! tip - If you are an integrator, or using ***REMOVED***, please refer to the + If you are an integrator, or want to set up SYNC.TOOLING in a vehicle, please refer to the [Integrators Guide](integrators-guide.md) for automated setup instructions. --8<-- "README.md:installation" @@ -129,7 +129,8 @@ ros2 bag record /sync_diag/graph_updates ``` The expected data rate is about `1 kB/s` per `ptp4l`, `phc2sys` or sensor instance. -For an architecture like ***REMOVED*** gen2, this results in a data rate of about `14 kB/s`. +Even for large architectures with many ECUs and sensors, the data rate stays in the low +10s of `kB/s` range. The bag can be replayed at a later time on any machine with only a `diag-master` running: diff --git a/docs/ptp-architecture-guide.md b/docs/ptp-architecture-guide.md index ac97bac..36a8f62 100644 --- a/docs/ptp-architecture-guide.md +++ b/docs/ptp-architecture-guide.md @@ -272,11 +272,8 @@ located in `/usr/share/doc/linuxptp/configs/`. !!! bug Do not run gPTP or Automotive PTP on network links with more than two participants, - as this will lead to synchronization faults. - -As a case study, ***REMOVED*** gen2 is using a switch that does not support gPTP, so it was necessary -to configure the switch to forward PTP traffic in a way that simulates many 1-to-1 links. -See [***REMOVED*** gen2 PTP troubleshooting](https://tier4.atlassian.net/wiki/x/jIAvwg) for details. + as this will lead to synchronization faults. If e.g. you want to sync four sensors with + gPTP from one ECU, the ECU needs four separate network interfaces, each supporting gPTP. ### ECU PTP Architecture diff --git a/docs/usage.md b/docs/usage.md index d2f7659..bb6c506 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -153,7 +153,8 @@ ros2 bag record /sync_diag/graph_updates ``` The expected data rate is about `1 kB/s` per `ptp4l`, `phc2sys` or sensor instance. -For an architecture like ***REMOVED*** gen2, this results in a data rate of about `14 kB/s`. +Even for large architectures with many ECUs and sensors, the data rate stays in the low +10s of `kB/s` range. The bag can be replayed at a later time on any machine with only a `diag-master` running: