feat: sisyfos enhancements

[olzzon]

About the Contributor

This PR is posted on behalf of BBC

Type of Contribution

This is a: Feature request

Bug fix / Feature / Code improvement / Documentation improvement / Other (please specify)

Old Behavior:

Sisyfos and TSR had some limitation in the API, regarding mute, inputGain & inputSelector.

New Behavior

TSR and Sisyfos has been enhanced to include support for optional mute, inputgain, inputselector and get sisyfos state of a fader. Following changes has been made:

• Added:
  • setMutoOn, setInputgain, setInputSelector in:
  • SisyfosChannelOptions in TSR types sisyfos integration
  • API types SisyfosSendChannelAPI and SisyfosReceiveChannelAPI - with new features as optionals.
  • SisyfosCommandType as SET_INPUT_SELECTOR, SET_INPUT_GAIN and SET_MUTE
  • 2 new actions are added:
  • ReSyncChannel - the ability to resync a channel from Sisyfos without reconnection (as a full resin/reinit does)
  • SetSisyfosChannelState - works like triggerValue but as an action
  • Updated the receiver() to include receiving a single channel from Sifyfos
• Refactor:
  • the SET_CHANNEL command shares setSisyfosChannel() with the SetSisyfosChannelState action.

Fixes:

• quickTSR has been update to check if a timeline refers to an unmapped object.

Testing Instructions

use quickTSR to test the new implementations. All features implemented as optional, so it don't have breaking changes in the current TSR-Sisyfos behavior.

Other Information

Status

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

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 25.67568% with 55 lines in your changes are missing coverage. Please review.

Project coverage is 53.46%. Comparing base (b7ceb69) to head (3cb6f70).

Files	Patch %	Lines
...te-resolver/src/integrations/sisyfos/connection.ts	34.69%	28 Missing and 4 partials :warning:
...e-state-resolver/src/integrations/sisyfos/index.ts	0.00%	19 Missing and 4 partials :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## release51 #324 +/- ## ============================================= - Coverage 53.59% 53.46% -0.14% ============================================= Files 125 125 Lines 10129 10172 +43 Branches 2358 2510 +152 ============================================= + Hits 5429 5438 +9 + Misses 4698 4347 -351 - Partials 2 387 +385 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[olzzon]

Following bugs has been fixed:

• Channel index/number issues between internal (index) and OSC (channel number)
• When receiving Sisyfos' current state from ReSyncChannel it didn't set the State in TSR
• Backward compatibility between Sisyfos using showChannel and TSR using visible.

@mint-dewit do you have time for a look?