Set sub-device peripheralDeviceId from deviceOptions parentDeviceName

[scriptorian]

About the Contributor

This PR has been opened by SuperFly.tv on behalf of EVS Broadcast Equipment (henceforth EVS).

Type of Contribution

This is a:

Feature

Current Behaviour

When configuring a new peripheral sub-device in a Studio upgrade the peripheralDeviceId would be left undefined.

New Behaviour

The updated code allows the device options of the new sub-device to specify a parentDeviceName property that is then used to find a peripheralDeviceId with a matching name.
Parent devices append an extra string to the configured name so the search for a match uses only the first characters of the parent device _id property.

Testing

• I have added one or more unit tests for this PR
• I have updated the relevant unit tests
• No unit test changes are needed for this PR

Affected areas

This PR affects peripheral sub-devices configured through a studio upgrade operation triggered by the API.

Time Frame

We would like to get this merged into the in-development release.

Status

• PR is ready to be reviewed.
• The functionality has been tested by the author.
• Relevant unit tests has been added / updated.
• Relevant documentation (code comments, system documentation) has been added / updated.

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!