2.2.103. Sound Switch Command Class, version 2

The Sound Switch Command Class is used to manage nodes with a speaker or sound notification capability. It can be used for a doorbell, alarm clock, siren or any device issuing sound notifications.

2.2.103.1. Compatibility Considerations

The Sound Switch Command Class is backwards compatible with the Sound Switch Command Class, version 1.

\requirement{CC:0079.02.00.21.001}{0}

All Commands and fields not mentioned in this version MUST remain unchanged from the Sound Switch Command Class, version 1.

This version extends the following commands to allow a controlling node to modify the volume setting only for a single Tone Play Set Command:

  • Sound Switch Tone Play Set Command

  • Sound Switch Tone Play Report Command

2.2.103.2. Sound Switch Tone Play Set Command

This command is used to instruct a supporting node to play (or stop playing) a tone.

\requirement{CC:0079.02.08.11.001}{0}

The supporting node MUST play the specified tone immediately when receiving this command.

\requirement{CC:0079.02.08.11.002}{0}

A node already playing a tone MUST interrupt the current tone and start playing the tone specified in this command.

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_SOUND_SWITCH (0x79)

Command = SOUND_SWITCH_TONE_PLAY_SET (0x08)

Tone Identifier

Play Command Tone Volume

\requirement{CC:0079.02.08.11.003}{0}

All fields not described below MUST remain unchanged from version 1.

Play Command Tone Volume (8 bits)

This field is used to configure the volume for the actual Play Command.

\requirement{CC:0079.02.08.11.005}{0} \requirement{CC:0079.02.08.11.006}{4}

The volume setting configured with the Sound Switch Configuration Set Command MUST remain unchanged by this command and this field MUST be used for the volume of the actual tone that will start playing.

\requirement{CC:0079.02.08.11.007}{0}

This field MUST be set to 0x00 and ignored by a receiving node if the Tone identifier field is set to 0x00.

\requirement{CC:0079.02.08.11.008}{0}

The encoding of this field MUST be according to Table 2.530.

Table 2.530 Sound Switch Tone Play Set::Play Command Volume encoding

Value

Description

0 (0x00)

This value MUST indicate to use the configured volume at the node (Sound Switch Configuration Set Command).

1..100 (0x01..0x64)

These values MUST indicate the actual volume setting from respectively 1% to 100% to use for the Play Set Command

This value SHOULD be used for critical applications (e.g. security alarm) where it is important to have the sound played even when the device is muted.

255 (0xFF)

This value MUST indicate to use most recent non-zero volume setting if the current volume is muted (0x00).

If the current configured volume is not muted (>0x00), this value MUST indicate to use the configured current volume at the node (Sound Switch Configuration Set Command)

This value SHOULD be used only for critical application (e.g. security alarm) where it is important to have the sound played even when the device is muted.

All other values are reserved and MUST NOT be used by a sending node. Reserved values MUST be ignored by a receiving node.

2.2.103.3. Sound Switch Tone Play Report Command

This command is used to advertise the current tone being played by the sending node.

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_SOUND_SWITCH (0x79)

Command = SOUND_SWITCH_TONE_PLAY_REPORT (0x0A)

Tone Identifier

Play Command Tone Volume

All fields not described below MUST remain unchanged from version 1.

Play Command Tone Volume (8 bits)

\requirement{CC:0079.02.0A.11.001}{0}

This field MUST advertise the actual playing volume represented with the value from 0x00 …0x64 (0 … 100%). The values 0x00 and 0x64 MUST represent mute and maximum volume, respectively.

This field MUST be set to 0x00 if the Tone Identifier field is set to 0x00.