You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Overview.md
+35-5Lines changed: 35 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -252,33 +252,63 @@ Devices MUST report the externalSynchronizationStatus as follows:
252
252
253
253
The externalSynchronizationStatusMessage is a nullable property where devices MAY offer the reason and further details as to why the current status value was chosen.
254
254
255
-
Devices are RECOMMENDED to publish in the externalSynchronizationStatusMessage property information about the previous synchronization source and originating interface as well as the current synchronization source and its originating interface.
255
+
Devices are RECOMMENDED to publish in the externalSynchronizationStatusMessage property information about the previous synchronization source and originating interface.
256
256
257
257
Example:
258
258
259
259
```log
260
-
Sync source change, from:baseband on SDI1, to: 0x00:0c:ec:ff:fe:0a:2b:a1 on NIC1
260
+
Source change from:SDI1
261
261
```
262
262
263
263
or
264
264
265
265
```log
266
-
Sync source change, from:0x70:35:09:ff:fe:c7:da:00 on NIC1, to: 0x00:0c:ec:ff:fe:0a:2b:a1 on NIC2
266
+
Source change from: 00:0c:ec:ff:fe:0a:2b:a1 on NIC1
267
267
```
268
268
269
269
Furthermore, where possible Device implementations are RECOMMENDED to retain the previous status message when returning to a Healthy state from a PartiallyHealthy or Unhealthy state by prepending the previous message with "Previously: ".
270
270
271
271
For example, upon recovery to a healthy state the externalSynchronizationStatusMessage could hold the following value
272
272
273
273
```log
274
-
Previously: Sync source change, from:baseband on SDI1, to: 0x00:0c:ec:ff:fe:0a:2b:a1 on NIC1
274
+
Previously: Source change from:SDI1
275
275
```
276
276
277
277
#### Synchronization source change
278
278
279
279
When devices intend to use external synchronization they MUST publish the synchronization source id currently being used in the `synchronizationSourceId` property and update the `externalSynchronizationStatus` property whenever it changes, setting the `synchronizationSourceId` to `null` if a synchronization source cannot be discovered. Devices which are not intending to use external synchronization MUST populate this property with `internal` or their own id if they themselves are the synchronization source (e.g. the device is a grandmaster).
280
280
281
-
When devices observe a synchronization source change the `externalSynchronizationStatus` property MUST temporarily transition to a `PartiallyUnhealthy` state. It can then return to a different state if the operating conditions match it more closely (returning to a healthier state MUST respect the requirements in the [status reporting delay section](#sender-status-reporting-delay)).
281
+
Where possible devices are RECOMMENDED to also indicate the interface used in the synchronization source id like in the following examples.
282
+
283
+
```log
284
+
00:0c:ec:ff:fe:0a:2b:a1 on NIC1
285
+
```
286
+
287
+
or
288
+
289
+
```log
290
+
00:1d:ec:ff:fe:0a:2b:b4, Blue
291
+
```
292
+
293
+
or
294
+
295
+
```log
296
+
SDI1
297
+
```
298
+
299
+
or
300
+
301
+
```log
302
+
BlackBurst 1
303
+
```
304
+
305
+
or
306
+
307
+
```log
308
+
WCLK BNC1
309
+
```
310
+
311
+
When devices observe a synchronization source id change the `externalSynchronizationStatus` property MUST temporarily transition to a `PartiallyHealthy` state. It can then return to a different state if the operating conditions match it more closely (returning to a healthier state MUST respect the requirements in the [status reporting delay section](#sender-status-reporting-delay)). Devices capable of reporting the specific interface used in the synchronization source id MUST follow the previous transition requirement even when the only change observed is the interface now being used for synchronization.
0 commit comments