sonar: explain time cfg (automatic/ntp server)#91
Conversation
|
|
||
| Automatic configures the Sonar to attempt to achieve time sync with either an NTP server on the internet or with the GUI. | ||
|
|
||
| At boot, the Sonar's system time will be some timestamp far in the past. |
There was a problem hiding this comment.
What's the relevance of adding this info?
Also, it's "the sonar's time" not "the Sonar's system time". Additionally, GUI uses term "sonar time" not "sonar system time".
|
|
||
| The GUI will warn the user if the host computer's system time is more than 2 seconds away from the Sonar's time. | ||
|
|
||
| Automatic is a best-effort time configuration. At the time of writing (release 1.6.0), when configured as automatic, it is recommended to open the GUI on a host on the same network as the Sonar before starting data collection to look for synchronization warnings in the GUI. A future release will give better time sync feedback through the integration API. |
There was a problem hiding this comment.
Probably needs a rewrite to remove promises or features that may or may not be implemented, as well as adding why a version is important.
Example:
It's recommended to have both the GUI and the sonar on the same network to ensure accurate time sync between the two. Time sync can also be updated through the integration API. See the changelog (link) regarding changes to time sync across firmware versions.
| #### Time configuration: NTP Server | ||
|
|
||
| At boot, the Sonar's system time will be some timestamp far in the past. | ||
| The Sonar will continuously attempt to achieve NTP sync with the configured NTP server. |
There was a problem hiding this comment.
Again: What importance does it have to mention timestamp in the past?
"The sonar will attempt to retrieve sync with the provided NTP server continously."
| At boot, the Sonar's system time will be some timestamp far in the past. | ||
| The Sonar will continuously attempt to achieve NTP sync with the configured NTP server. | ||
|
|
||
| On serious ROV missions where the Sonar's output is used together with other sensors, it is recommended to configure NTP Server with a common NTP server on the local network of the ROV. |
There was a problem hiding this comment.
"When the sonar is used together with other sensors, it's recommended to use an NTP server on the same network as the ROV."
|
|
||
| On serious ROV missions where the Sonar's output is used together with other sensors, it is recommended to configure NTP Server with a common NTP server on the local network of the ROV. | ||
|
|
||
| At the time of writing (release 1.6.0), the only way to check whether NTP has synchronized with the configured server is to inspect the timestamps of Sonar output, or to re-apply the NTP server setting and look for errors. A future release will give better time sync feedback through the integration API. |
There was a problem hiding this comment.
See the comment further up regarding mentioning versions and the suggested rewrite for sections like these.
| The Sonar will continuously attempt to achieve NTP sync with an NTP server on the internet. | ||
| If the GUI is opened, it will check whether the Sonar has achieved NTP sync. If not, it will manually set time to the current system time on the host computer. If the GUI set a manual time, the Sonar will stop attempting to sync with an NTP server on the internet. | ||
|
|
||
| The GUI will warn the user if the host computer's system time is more than 2 seconds away from the Sonar's time. |
There was a problem hiding this comment.
"The GUI will show a warning if the sonar time and the host computer deviates with more than 2 seconds"
coreusw
left a comment
coreusw
left a comment
There was a problem hiding this comment.
General feedback: Some typos and suggestions for general consensus.
Things like "sonar" instead of "Sonar" when used in the middle of a sentence and referring to the changelog.
2 participants
No description provided.