Add property to optionally enable Distributed Clock on generic ECAT devices

Karl-G1 commented 2 years ago

[x] This contribution adheres to CONTRIBUTING.md.

What does this Pull Request accomplish?

Add a new property for 'generic EtherCAT devices' (third-party EtherCAT Slaves) to enable the Sync0 Distributed Clock

Add it to the configuration page and help documentation
Add it to the relevant configuration cluster
Use it in the engine during hardware configuration via a wrapper VI

Why should this Pull Request be merged?

Some EtherCAT devices want/need the Distributed Clock to be enabled. This is done via the EtherCAT API in LabVIEW and is inaccessible to users of the custom device today.

What testing has been done?

Enabled debugging and deployed to ensure that the property was persisted and used in the engine when set.

niveristand-diff-bot commented 2 years ago

Bleep bloop!

LabVIEW Diff Robot here with some diffs served up hot for your pull request.

Notice something funny? Help fix me on my GitHub repo.

SEECD Engine.lvlib--Configure All.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-22/17%3A15%3A26/SEECD%20Engine.lvlib--Configure%20All.vi.png)

SEECD Engine.lvlib--Configure ECAT Generic Slave Wrapper.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-22/17%3A15%3A26/SEECD%20Engine.lvlib--Configure%20ECAT%20Generic%20Slave%20Wrapper.vi.png)

SEECD Engine.lvlib--Configure ECAT Generic Slave.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-22/17%3A15%3A26/SEECD%20Engine.lvlib--Configure%20ECAT%20Generic%20Slave.vi.png)

SEECD Engine.lvlib--Get ECAT Config Wrapper.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-22/17%3A15%3A26/SEECD%20Engine.lvlib--Get%20ECAT%20Config%20Wrapper.vi.png)

SEECD Engine.lvlib--Get Generic Slave Data.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-22/17%3A15%3A26/SEECD%20Engine.lvlib--Get%20Generic%20Slave%20Data.vi.png)

SEECD Shared.lvlib--Property Strings.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-22/17%3A15%3A26/SEECD%20Shared.lvlib--Property%20Strings.vi.png)

SEECD System Explorer.lvlib--Get Slave Info.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-22/17%3A15%3A26/SEECD%20System%20Explorer.lvlib--Get%20Slave%20Info.vi.png)

SEECD System Explorer.lvlib--Scan Engine EtherCAT Generic Slave.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-22/17%3A15%3A26/SEECD%20System%20Explorer.lvlib--Scan%20Engine%20EtherCAT%20Generic%20Slave.vi.png)

SEECD System Explorer.lvlib--Scan Engine EtherCAT Slave.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-22/17%3A15%3A26/SEECD%20System%20Explorer.lvlib--Scan%20Engine%20EtherCAT%20Slave.vi.png)

SEECD System Explorer.lvlib--Set Slave Info.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-22/17%3A15%3A26/SEECD%20System%20Explorer.lvlib--Set%20Slave%20Info.vi.png)

niveristand-diff-bot commented 2 years ago

Bleep bloop!

LabVIEW Diff Robot here with some diffs served up hot for your pull request.

Notice something funny? Help fix me on my GitHub repo.

SEECD Engine.lvlib--Configure All.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-23/16%3A46%3A04/SEECD%20Engine.lvlib--Configure%20All.vi.png)

SEECD Engine.lvlib--Configure ECAT Generic Slave Wrapper.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-23/16%3A46%3A04/SEECD%20Engine.lvlib--Configure%20ECAT%20Generic%20Slave%20Wrapper.vi.png)

SEECD Engine.lvlib--Configure ECAT Generic Slave.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-23/16%3A46%3A04/SEECD%20Engine.lvlib--Configure%20ECAT%20Generic%20Slave.vi.png)

SEECD Engine.lvlib--Get ECAT Config Wrapper.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-23/16%3A46%3A04/SEECD%20Engine.lvlib--Get%20ECAT%20Config%20Wrapper.vi.png)

SEECD Engine.lvlib--Get Generic Slave Data.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-23/16%3A46%3A04/SEECD%20Engine.lvlib--Get%20Generic%20Slave%20Data.vi.png)

SEECD Shared.lvlib--Property Strings.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-23/16%3A46%3A04/SEECD%20Shared.lvlib--Property%20Strings.vi.png)

SEECD System Explorer.lvlib--Get Slave Info.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-23/16%3A46%3A04/SEECD%20System%20Explorer.lvlib--Get%20Slave%20Info.vi.png)

SEECD System Explorer.lvlib--Scan Engine EtherCAT Generic Slave.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-23/16%3A46%3A04/SEECD%20System%20Explorer.lvlib--Scan%20Engine%20EtherCAT%20Generic%20Slave.vi.png)

SEECD System Explorer.lvlib--Scan Engine EtherCAT Slave.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-23/16%3A46%3A04/SEECD%20System%20Explorer.lvlib--Scan%20Engine%20EtherCAT%20Slave.vi.png)

SEECD System Explorer.lvlib--Set Slave Info.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-23/16%3A46%3A04/SEECD%20System%20Explorer.lvlib--Set%20Slave%20Info.vi.png)

niveristand-diff-bot commented 2 years ago

Bleep bloop!

LabVIEW Diff Robot here with some diffs served up hot for your pull request.

Notice something funny? Help fix me on my GitHub repo.

Scan Engine Unit Tests.lvclass--test Wrapper VIs.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-24/17%3A21%3A22/Scan%20Engine%20Unit%20Tests.lvclass--test%20Wrapper%20VIs.vi.png)

SEECD Engine.lvlib--Configure All.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-24/17%3A21%3A22/SEECD%20Engine.lvlib--Configure%20All.vi.png)

SEECD Engine.lvlib--Configure ECAT Generic Slave Wrapper.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-24/17%3A21%3A22/SEECD%20Engine.lvlib--Configure%20ECAT%20Generic%20Slave%20Wrapper.vi.png)

SEECD Engine.lvlib--Configure ECAT Generic Slave.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-24/17%3A21%3A22/SEECD%20Engine.lvlib--Configure%20ECAT%20Generic%20Slave.vi.png)

SEECD Engine.lvlib--Get ECAT Config Wrapper.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-24/17%3A21%3A22/SEECD%20Engine.lvlib--Get%20ECAT%20Config%20Wrapper.vi.png)

SEECD Engine.lvlib--Get Generic Slave Data.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-24/17%3A21%3A22/SEECD%20Engine.lvlib--Get%20Generic%20Slave%20Data.vi.png)

SEECD Shared.lvlib--Property Strings.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-24/17%3A21%3A22/SEECD%20Shared.lvlib--Property%20Strings.vi.png)

SEECD System Explorer.lvlib--Get Slave Info.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-24/17%3A21%3A22/SEECD%20System%20Explorer.lvlib--Get%20Slave%20Info.vi.png)

SEECD System Explorer.lvlib--Scan Engine EtherCAT Generic Slave.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-24/17%3A21%3A22/SEECD%20System%20Explorer.lvlib--Scan%20Engine%20EtherCAT%20Generic%20Slave.vi.png)

SEECD System Explorer.lvlib--Scan Engine EtherCAT Slave.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-24/17%3A21%3A22/SEECD%20System%20Explorer.lvlib--Scan%20Engine%20EtherCAT%20Slave.vi.png)

SEECD System Explorer.lvlib--Set Slave Info.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-24/17%3A21%3A22/SEECD%20System%20Explorer.lvlib--Set%20Slave%20Info.vi.png)

niveristand-diff-bot commented 2 years ago

Bleep bloop!

LabVIEW Diff Robot here with some diffs served up hot for your pull request.

Notice something funny? Help fix me on my GitHub repo.

Scan Engine Unit Tests.lvclass--test Wrapper VIs.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-25/12%3A22%3A09/Scan%20Engine%20Unit%20Tests.lvclass--test%20Wrapper%20VIs.vi.png)

SEECD Engine.lvlib--Configure All.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-25/12%3A22%3A09/SEECD%20Engine.lvlib--Configure%20All.vi.png)

SEECD Engine.lvlib--Configure ECAT Generic Slave Wrapper.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-25/12%3A22%3A09/SEECD%20Engine.lvlib--Configure%20ECAT%20Generic%20Slave%20Wrapper.vi.png)

SEECD Engine.lvlib--Configure ECAT Generic Slave.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-25/12%3A22%3A09/SEECD%20Engine.lvlib--Configure%20ECAT%20Generic%20Slave.vi.png)

SEECD Engine.lvlib--Get ECAT Config Wrapper.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-25/12%3A22%3A09/SEECD%20Engine.lvlib--Get%20ECAT%20Config%20Wrapper.vi.png)

SEECD Engine.lvlib--Get Generic Slave Data.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-25/12%3A22%3A09/SEECD%20Engine.lvlib--Get%20Generic%20Slave%20Data.vi.png)

SEECD Shared.lvlib--Property Strings.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-25/12%3A22%3A09/SEECD%20Shared.lvlib--Property%20Strings.vi.png)

SEECD System Explorer.lvlib--Get Slave Info.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-25/12%3A22%3A09/SEECD%20System%20Explorer.lvlib--Get%20Slave%20Info.vi.png)

SEECD System Explorer.lvlib--Scan Engine EtherCAT Generic Slave.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-25/12%3A22%3A09/SEECD%20System%20Explorer.lvlib--Scan%20Engine%20EtherCAT%20Generic%20Slave.vi.png)

SEECD System Explorer.lvlib--Scan Engine EtherCAT Slave.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-25/12%3A22%3A09/SEECD%20System%20Explorer.lvlib--Scan%20Engine%20EtherCAT%20Slave.vi.png)

SEECD System Explorer.lvlib--Set Slave Info.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-scan-engine-ethercat-custom-device/PR-216/2022-08-25/12%3A22%3A09/SEECD%20System%20Explorer.lvlib--Set%20Slave%20Info.vi.png)

ni / niveristand-scan-engine-ethercat-custom-device