Node Documentation¶
This section describes all the nodes in the Multi Device Synchronization Module node tree organized by branch.
devices¶
/devices ¶
| Properties: | Read, Write |
| Type: | String |
| Unit: | None |
Defines which instruments should be included in the synchronization. Expects a comma-separated list of devices in the order the devices are connected.
group¶
/group ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
Defines in which synchronization group should be accessed by the module.
message¶
phasesync¶
/phasesync ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
Set to 1 to reset the phases of all oscillators on all of the synchronized devices.
recover¶
/recover ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
Set to 1 to resynchronize the device group if the synchronization has been lost.
start¶
/start ¶
| Properties: | Read, Write |
| Type: | Integer (64 bit) |
| Unit: | None |
Set to true to start the synchronization process.
status¶
/status ¶
| Properties: | Read |
| Type: | Integer (enumerated) |
| Unit: | None |
Status of the synchronization process.
| Value | Description |
|---|---|
| -1 | error |
| 0 | idle |
| 1 | synchronization in progress |
| 2 | successful synchronization |