=======================
Prototype - description
=======================

Text from prototyping phase kept for historical reasons.

Summary
-------

**Class:** SoundPlayer

**Interdependencies:** None

**Deployment:** See *Test installations* below

**Contact:** C.Youngman.

**Known failure and recovery modes:** None known, restart device or server is
unproblematic.

**Synopsis:** MDL plays pre-recorded sound files on monitored device(s)
changing state and meeting a specific condition.

**Status:** testing in MID and SCS.

Test installations
------------------

There are two, both running on control room PCs which have sound cards and have
been connected to powered speakers to generate a suitable sound level when
playing. One in MID (xbeam@mid-cy-sys-cpc-4) and another in
the SCS (xbeam@exflqr30529) control room. The xbeam account has been used as
this was available (control room PCs have no xctrl account) and a Karabo 2.6.1
installation performed. The middlelayer device server needed to run the
soundPlayer is the only device server on the installation,
hence ``karabo-start`` or ``karabo-stop`` can be performed without creating
additional processes like dataloggers etc. Correspondingly, two CAS_TEST
projects: CY_MID_SOUND_PLAYER and CY_SCS_SOUND_PLAYER.

SoundPlayer cannot be started with an empty deviceIds list. For test purposes
an additional device, SoundPlayerTarget, is provided which can be clicked
through ACTIVE, ERROR and UNKNOWN.