Rename SynchronizationPTP's time_source to leader_time_source (#169)

JGoldstone · web-flow · commit 78b5dfb7b194 · 2025-02-13T23:35:52.000Z
diff --git a/src/main/python/camdkit/examples.py b/src/main/python/camdkit/examples.py
@@ -200,7 +200,7 @@ def _get_complete_dynamic_clip():
       leader_identity="00:11:22:33:44:55",
       leader_priorities=SynchronizationPTPPriorities(128, 128),
       leader_accuracy=0.00000005,
-      time_source=PTPLeaderTimeSource.GNSS,
+      leader_time_source=PTPLeaderTimeSource.GNSS,
       mean_path_delay=0.000123,
       vlan=100)
   ),)
diff --git a/src/main/python/camdkit/timing_types.py b/src/main/python/camdkit/timing_types.py
@@ -139,8 +139,8 @@ class SynchronizationPTP(CompatibleBaseModel):
     leader_accuracy: Annotated[NonNegativeFloat,
       Field(alias="leaderAccuracy")]
 
-    time_source: Annotated[PTPLeaderTimeSource | None,
-      Field(alias="timeSource")] = None
+    leader_time_source: Annotated[PTPLeaderTimeSource | None,
+      Field(alias="leaderTimeSource")] = None
 
     mean_path_delay: Annotated[NonNegativeFloat,
       Field(alias="meanPathDelay")]
@@ -263,7 +263,7 @@ class Timing(CompatibleBaseModel):
     following:
     - "vlan": Integer representing the VLAN ID for PTP traffic (e.g., 100 for
     VLAN 100)
-    - "timeSource": Indicates the leader's source of time, such as GNSS, atomic
+    - "leaderTimeSource": Indicates the leader's source of time, such as GNSS, atomic
     clock, or NTP
     - "genlock": The tracking device has an external black/burst or
     tri-level analog sync signal that is triggering the capture of
diff --git a/src/test/python/test_model.py b/src/test/python/test_model.py
@@ -100,7 +100,7 @@ def test_serialize(self):
                              leader_identity="00:11:22:33:44:55",
                              leader_priorities=SynchronizationPTPPriorities(128, 128),
                              leader_accuracy=0.1,
-                             time_source=PTPLeaderTimeSource.GNSS,
+                             leader_time_source=PTPLeaderTimeSource.GNSS,
                              mean_path_delay=0.2,
                              vlan=100),
       source=SynchronizationSourceEnum.PTP)
@@ -202,7 +202,7 @@ def test_serialize(self):
                           "leaderIdentity": "00:11:22:33:44:55",
                           "leaderPriorities": {"priority1": 128, "priority2": 128},
                           "leaderAccuracy": 0.1,
-                          "timeSource": PTPLeaderTimeSource.GNSS.value,
+                          "leaderTimeSource": PTPLeaderTimeSource.GNSS.value,
                           "meanPathDelay": 0.2,
                           "vlan": 100},
                   "offsets": {"translation":1.0, "rotation":2.0, "lensEncoders":3.0 } }
diff --git a/src/test/python/test_schema_regression.py b/src/test/python/test_schema_regression.py
@@ -26,7 +26,7 @@
 #                 with open("/tmp/sorted_current_schema_file.json", "w") as scusf:
 #                     json.dump(current_schema, scusf, indent=4, sort_keys=True)
 #                 self.assertEqual(classic_schema, current_schema)
-
-
+#
+#
 # if __name__ == '__main__':
 #     unittest.main()
diff --git a/src/test/resources/classic/examples/complete_dynamic_example.json b/src/test/resources/classic/examples/complete_dynamic_example.json
@@ -124,7 +124,7 @@
         "leaderAccuracy": 5e-08,
         "meanPathDelay": 0.000123,
         "vlan": 100,
-        "timeSource": "GNSS"
+        "leaderTimeSource": "GNSS"
       }
     },
     "timecode": {
diff --git a/src/test/resources/classic/examples/complete_static_example.json b/src/test/resources/classic/examples/complete_static_example.json
@@ -171,7 +171,7 @@
         "leaderAccuracy": 5e-08,
         "meanPathDelay": 0.000123,
         "vlan": 100,
-        "timeSource": "GNSS"
+        "leaderTimeSource": "GNSS"
       }
     },
     "timecode": {
diff --git a/src/test/resources/classic/schema.json b/src/test/resources/classic/schema.json
@@ -460,7 +460,7 @@
                   "type": "number",
                   "minimum": 0.0
                 },
-                "timeSource": {
+                "leaderTimeSource": {
                   "enum": [
                     "GNSS",
                     "Atomic clock",
@@ -494,7 +494,7 @@
             "source"
           ],
           "additionalProperties": false,
-          "description": "Object describing how the tracking device is synchronized for this\nsample.\n\nfrequency: The frequency of a synchronization signal.This may differ from\nthe sample frame rate for example in a genlocked tracking device. This is\nnot required if the synchronization source is PTP or NTP.\nlocked: Is the tracking device locked to the synchronization source\noffsets: Offsets in seconds between sync and sample. Critical for e.g.\nframe remapping, or when using different data sources for\nposition/rotation and lens encoding\npresent: Is the synchronization source present (a synchronization\nsource can be present but not locked if frame rates differ for\nexample)\nptp: If the synchronization source is a PTP leader, then this object\ncontains:\n- \"profile\": Specifies the PTP profile in use. This defines the operational\nrules and parameters for synchronization. For example \"SMPTE ST2059-2:2021\"\nfor SMPTE 2110 based systems, or \"IEEE Std 1588-2019\" or\n\"IEEE Std 802.1AS-2020\" for industrial applications\n- \"domain\": Identifies the PTP domain the device belongs to. Devices in the\nsame domain can synchronize with each other\n- \"leaderIdentity\": The unique identifier (usually MAC address) of the\ncurrent PTP leader (grandmaster)\n- \"leaderPriorities\": The priority values of the leader used in the Best\nMaster Clock Algorithm (BMCA). Lower values indicate higher priority\n- \"priority1\": Static priority set by the administrator\n- \"priority2\": Dynamic priority based on the leader's role or clock quality\n- \"leaderAccuracy\": The timing offset in seconds from the sample timestamp\nto the PTP timestamp\n- \"meanPathDelay\": The average round-trip delay between the device and the\nPTP leader, measured in seconds\nsource: The source of synchronization must be defined as one of the\nfollowing:\n- \"vlan\": Integer representing the VLAN ID for PTP traffic (e.g., 100 for\nVLAN 100)\n- \"timeSource\": Indicates the leader's source of time, such as GNSS, atomic\nclock, or NTP\n- \"genlock\": The tracking device has an external black/burst or\ntri-level analog sync signal that is triggering the capture of\ntracking samples\n- \"videoIn\": The tracking device has an external video signal that is\ntriggering the capture of tracking samples\n- \"ptp\": The tracking device is locked to a PTP leader\n- \"ntp\": The tracking device is locked to an NTP server\n"
+          "description": "Object describing how the tracking device is synchronized for this\nsample.\n\nfrequency: The frequency of a synchronization signal.This may differ from\nthe sample frame rate for example in a genlocked tracking device. This is\nnot required if the synchronization source is PTP or NTP.\nlocked: Is the tracking device locked to the synchronization source\noffsets: Offsets in seconds between sync and sample. Critical for e.g.\nframe remapping, or when using different data sources for\nposition/rotation and lens encoding\npresent: Is the synchronization source present (a synchronization\nsource can be present but not locked if frame rates differ for\nexample)\nptp: If the synchronization source is a PTP leader, then this object\ncontains:\n- \"profile\": Specifies the PTP profile in use. This defines the operational\nrules and parameters for synchronization. For example \"SMPTE ST2059-2:2021\"\nfor SMPTE 2110 based systems, or \"IEEE Std 1588-2019\" or\n\"IEEE Std 802.1AS-2020\" for industrial applications\n- \"domain\": Identifies the PTP domain the device belongs to. Devices in the\nsame domain can synchronize with each other\n- \"leaderIdentity\": The unique identifier (usually MAC address) of the\ncurrent PTP leader (grandmaster)\n- \"leaderPriorities\": The priority values of the leader used in the Best\nMaster Clock Algorithm (BMCA). Lower values indicate higher priority\n- \"priority1\": Static priority set by the administrator\n- \"priority2\": Dynamic priority based on the leader's role or clock quality\n- \"leaderAccuracy\": The timing offset in seconds from the sample timestamp\nto the PTP timestamp\n- \"meanPathDelay\": The average round-trip delay between the device and the\nPTP leader, measured in seconds\nsource: The source of synchronization must be defined as one of the\nfollowing:\n- \"vlan\": Integer representing the VLAN ID for PTP traffic (e.g., 100 for\nVLAN 100)\n- \"leaderTimeSource\": Indicates the leader's source of time, such as GNSS, atomic\nclock, or NTP\n- \"genlock\": The tracking device has an external black/burst or\ntri-level analog sync signal that is triggering the capture of\ntracking samples\n- \"videoIn\": The tracking device has an external video signal that is\ntriggering the capture of tracking samples\n- \"ptp\": The tracking device is locked to a PTP leader\n- \"ntp\": The tracking device is locked to an NTP server\n"
         },
         "timecode": {
           "type": "object",
diff --git a/src/test/resources/classic/subschemas/timing.json b/src/test/resources/classic/subschemas/timing.json
@@ -82,7 +82,7 @@
     },
     "synchronization": {
       "additionalProperties": false,
-      "description": "Object describing how the tracking device is synchronized for this\nsample.\n\nfrequency: The frequency of a synchronization signal.This may differ from\nthe sample frame rate for example in a genlocked tracking device. This is\nnot required if the synchronization source is PTP or NTP.\nlocked: Is the tracking device locked to the synchronization source\noffsets: Offsets in seconds between sync and sample. Critical for e.g.\nframe remapping, or when using different data sources for\nposition/rotation and lens encoding\npresent: Is the synchronization source present (a synchronization\nsource can be present but not locked if frame rates differ for\nexample)\nptp: If the synchronization source is a PTP leader, then this object\ncontains:\n- \"profile\": Specifies the PTP profile in use. This defines the operational\nrules and parameters for synchronization. For example \"SMPTE ST2059-2:2021\"\nfor SMPTE 2110 based systems, or \"IEEE Std 1588-2019\" or\n\"IEEE Std 802.1AS-2020\" for industrial applications\n- \"domain\": Identifies the PTP domain the device belongs to. Devices in the\nsame domain can synchronize with each other\n- \"leaderIdentity\": The unique identifier (usually MAC address) of the\ncurrent PTP leader (grandmaster)\n- \"leaderPriorities\": The priority values of the leader used in the Best\nMaster Clock Algorithm (BMCA). Lower values indicate higher priority\n- \"priority1\": Static priority set by the administrator\n- \"priority2\": Dynamic priority based on the leader's role or clock quality\n- \"leaderAccuracy\": The timing offset in seconds from the sample timestamp\nto the PTP timestamp\n- \"meanPathDelay\": The average round-trip delay between the device and the\nPTP leader, measured in seconds\nsource: The source of synchronization must be defined as one of the\nfollowing:\n- \"vlan\": Integer representing the VLAN ID for PTP traffic (e.g., 100 for\nVLAN 100)\n- \"timeSource\": Indicates the leader's source of time, such as GNSS, atomic\nclock, or NTP\n- \"genlock\": The tracking device has an external black/burst or\ntri-level analog sync signal that is triggering the capture of\ntracking samples\n- \"videoIn\": The tracking device has an external video signal that is\ntriggering the capture of tracking samples\n- \"ptp\": The tracking device is locked to a PTP leader\n- \"ntp\": The tracking device is locked to an NTP server\n",
+      "description": "Object describing how the tracking device is synchronized for this\nsample.\n\nfrequency: The frequency of a synchronization signal.This may differ from\nthe sample frame rate for example in a genlocked tracking device. This is\nnot required if the synchronization source is PTP or NTP.\nlocked: Is the tracking device locked to the synchronization source\noffsets: Offsets in seconds between sync and sample. Critical for e.g.\nframe remapping, or when using different data sources for\nposition/rotation and lens encoding\npresent: Is the synchronization source present (a synchronization\nsource can be present but not locked if frame rates differ for\nexample)\nptp: If the synchronization source is a PTP leader, then this object\ncontains:\n- \"profile\": Specifies the PTP profile in use. This defines the operational\nrules and parameters for synchronization. For example \"SMPTE ST2059-2:2021\"\nfor SMPTE 2110 based systems, or \"IEEE Std 1588-2019\" or\n\"IEEE Std 802.1AS-2020\" for industrial applications\n- \"domain\": Identifies the PTP domain the device belongs to. Devices in the\nsame domain can synchronize with each other\n- \"leaderIdentity\": The unique identifier (usually MAC address) of the\ncurrent PTP leader (grandmaster)\n- \"leaderPriorities\": The priority values of the leader used in the Best\nMaster Clock Algorithm (BMCA). Lower values indicate higher priority\n- \"priority1\": Static priority set by the administrator\n- \"priority2\": Dynamic priority based on the leader's role or clock quality\n- \"leaderAccuracy\": The timing offset in seconds from the sample timestamp\nto the PTP timestamp\n- \"meanPathDelay\": The average round-trip delay between the device and the\nPTP leader, measured in seconds\nsource: The source of synchronization must be defined as one of the\nfollowing:\n- \"vlan\": Integer representing the VLAN ID for PTP traffic (e.g., 100 for\nVLAN 100)\n- \"leaderTimeSource\": Indicates the leader's source of time, such as GNSS, atomic\nclock, or NTP\n- \"genlock\": The tracking device has an external black/burst or\ntri-level analog sync signal that is triggering the capture of\ntracking samples\n- \"videoIn\": The tracking device has an external video signal that is\ntriggering the capture of tracking samples\n- \"ptp\": The tracking device is locked to a PTP leader\n- \"ntp\": The tracking device is locked to an NTP server\n",
       "properties": {
         "frequency": {
           "additionalProperties": false,
@@ -164,6 +164,14 @@
               ],
               "type": "object"
             },
+            "leaderTimeSource": {
+              "enum": [
+                "GNSS",
+                "Atomic clock",
+                "NTP"
+              ],
+              "type": "string"
+            },
             "meanPathDelay": {
               "minimum": 0.0,
               "type": "number"
@@ -176,14 +184,6 @@
               ],
               "type": "string"
             },
-            "timeSource": {
-              "enum": [
-                "GNSS",
-                "Atomic clock",
-                "NTP"
-              ],
-              "type": "string"
-            },
             "vlan": {
               "maximum": 4294967295,
               "minimum": 0,

Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@`
`124`	`124`	`"leaderAccuracy": 5e-08,`
`125`	`125`	`"meanPathDelay": 0.000123,`
`126`	`126`	`"vlan": 100,`
`127`		`- "timeSource": "GNSS"`
	`127`	`+ "leaderTimeSource": "GNSS"`
`128`	`128`	`}`
`129`	`129`	`},`
`130`	`130`	`"timecode": {`
Original file line number	Diff line number	Diff line change
`@@ -171,7 +171,7 @@`
`171`	`171`	`"leaderAccuracy": 5e-08,`
`172`	`172`	`"meanPathDelay": 0.000123,`
`173`	`173`	`"vlan": 100,`
`174`		`- "timeSource": "GNSS"`
	`174`	`+ "leaderTimeSource": "GNSS"`
`175`	`175`	`}`
`176`	`176`	`},`
`177`	`177`	`"timecode": {`