Skip to content

Commit 458c2a4

Browse files
Mirror sync source changes from BCP-008-01
See AMWA-TV/bcp-008-01#23
1 parent 040b6aa commit 458c2a4

File tree

1 file changed

+35
-5
lines changed

1 file changed

+35
-5
lines changed

docs/Overview.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -252,33 +252,63 @@ Devices MUST report the externalSynchronizationStatus as follows:
252252

253253
The externalSynchronizationStatusMessage is a nullable property where devices MAY offer the reason and further details as to why the current status value was chosen.
254254

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.
256256

257257
Example:
258258

259259
```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
261261
```
262262

263263
or
264264

265265
```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
267267
```
268268

269269
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: ".
270270

271271
For example, upon recovery to a healthy state the externalSynchronizationStatusMessage could hold the following value
272272

273273
```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
275275
```
276276

277277
#### Synchronization source change
278278

279279
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).
280280

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.
282312

283313
### Sender essence validation
284314

0 commit comments

Comments
 (0)