Implement EqualizerController in Alexa for media_player. (#30159)
This commit is contained in:
1 parent
4ea42c2479
commit
25f78dd1a9
5 files changed
+248
-1
No files matched your search
@@ -120,7 +120,20 @@ class AlexaCapability:
|
||||
|
||||
@staticmethod
|
||||
def configuration():
|
||||
"""Return the configuration object."""
|
||||
"""Return the configuration object.
|
||||
|
||||
Applicable to the ThermostatController, SecurityControlPanel, ModeController, RangeController,
|
||||
and EventDetectionSensor.
|
||||
"""
|
||||
return []
|
||||
|
||||
@staticmethod
|
||||
def configurations():
|
||||
"""Return the configurations object.
|
||||
|
||||
The plural configurations object is different that the singular configuration object.
|
||||
Applicable to EqualizerController interface.
|
||||
"""
|
||||
return []
|
||||
|
||||
@staticmethod
|
||||
@@ -177,6 +190,11 @@ class AlexaCapability:
|
||||
if configuration:
|
||||
result["configuration"] = configuration
|
||||
|
||||
# The plural configurations object is different than the singular configuration object above.
|
||||
configurations = self.configurations()
|
||||
if configurations:
|
||||
result["configurations"] = configurations
|
||||
|
||||
semantics = self.semantics()
|
||||
if semantics:
|
||||
result["semantics"] = semantics
|
||||
@@ -1356,3 +1374,55 @@ class AlexaEventDetectionSensor(AlexaCapability):
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
class AlexaEqualizerController(AlexaCapability):
|
||||
"""Implements Alexa.EqualizerController.
|
||||
|
||||
https://developer.amazon.com/en-US/docs/alexa/device-apis/alexa-equalizercontroller.html
|
||||
"""
|
||||
|
||||
def name(self):
|
||||
"""Return the Alexa API name of this interface."""
|
||||
return "Alexa.EqualizerController"
|
||||
|
||||
def properties_supported(self):
|
||||
"""Return what properties this entity supports.
|
||||
|
||||
Either bands, mode or both can be specified. Only mode is supported at this time.
|
||||
"""
|
||||
return [{"name": "mode"}]
|
||||
|
||||
def get_property(self, name):
|
||||
"""Read and return a property."""
|
||||
if name != "mode":
|
||||
raise UnsupportedProperty(name)
|
||||
|
||||
sound_mode = self.entity.attributes.get(media_player.ATTR_SOUND_MODE)
|
||||
if sound_mode and sound_mode.upper() in (
|
||||
"MOVIE",
|
||||
"MUSIC",
|
||||
"NIGHT",
|
||||
"SPORT",
|
||||
"TV",
|
||||
):
|
||||
return sound_mode.upper()
|
||||
|
||||
return None
|
||||
|
||||
def configurations(self):
|
||||
"""Return the sound modes supported in the configurations object.
|
||||
|
||||
Valid Values for modes are: MOVIE, MUSIC, NIGHT, SPORT, TV.
|
||||
"""
|
||||
configurations = None
|
||||
sound_mode_list = self.entity.attributes.get(media_player.ATTR_SOUND_MODE_LIST)
|
||||
if sound_mode_list:
|
||||
supported_sound_modes = []
|
||||
for sound_mode in sound_mode_list:
|
||||
if sound_mode.upper() in ("MOVIE", "MUSIC", "NIGHT", "SPORT", "TV"):
|
||||
supported_sound_modes.append({"name": sound_mode.upper()})
|
||||
|
||||
configurations = {"modes": {"supported": supported_sound_modes}}
|
||||
|
||||
return configurations
|
||||
@@ -196,3 +196,11 @@ class Inputs:
|
||||
"video3": "VIDEO 3",
|
||||
"xbox": "XBOX",
|
||||
}
|
||||
|
||||
VALID_SOUND_MODE_MAP = {
|
||||
"movie": "MOVIE",
|
||||
"music": "MUSIC",
|
||||
"night": "NIGHT",
|
||||
"sport": "SPORT",
|
||||
"tv": "TV",
|
||||
}
|
||||
@@ -42,6 +42,7 @@ from .capabilities import (
|
||||
AlexaContactSensor,
|
||||
AlexaDoorbellEventSource,
|
||||
AlexaEndpointHealth,
|
||||
AlexaEqualizerController,
|
||||
AlexaEventDetectionSensor,
|
||||
AlexaInputController,
|
||||
AlexaLockController,
|
||||
@@ -522,6 +523,9 @@ class MediaPlayerCapabilities(AlexaEntity):
|
||||
if supported & media_player.const.SUPPORT_PLAY_MEDIA:
|
||||
yield AlexaChannelController(self.entity)
|
||||
|
||||
if supported & media_player.const.SUPPORT_SELECT_SOUND_MODE:
|
||||
yield AlexaEqualizerController(self.entity)
|
||||
|
||||
yield AlexaEndpointHealth(self.hass, self.entity)
|
||||
yield Alexa(self.hass)
|
||||
|
||||
|
||||
@@ -1352,3 +1352,43 @@ async def async_api_seek(hass, config, directive, context):
|
||||
return directive.response(
|
||||
name="StateReport", namespace="Alexa.SeekController", payload=payload
|
||||
)
|
||||
|
||||
|
||||
@HANDLERS.register(("Alexa.EqualizerController", "SetMode"))
|
||||
async def async_api_set_eq_mode(hass, config, directive, context):
|
||||
"""Process a SetMode request for EqualizerController."""
|
||||
mode = directive.payload["mode"]
|
||||
entity = directive.entity
|
||||
data = {ATTR_ENTITY_ID: entity.entity_id}
|
||||
|
||||
sound_mode_list = entity.attributes.get(media_player.const.ATTR_SOUND_MODE_LIST)
|
||||
if sound_mode_list and mode.lower() in sound_mode_list:
|
||||
data[media_player.const.ATTR_SOUND_MODE] = mode.lower()
|
||||
else:
|
||||
msg = "failed to map sound mode {} to a mode on {}".format(
|
||||
mode, entity.entity_id
|
||||
)
|
||||
raise AlexaInvalidValueError(msg)
|
||||
|
||||
await hass.services.async_call(
|
||||
entity.domain,
|
||||
media_player.SERVICE_SELECT_SOUND_MODE,
|
||||
data,
|
||||
blocking=False,
|
||||
context=context,
|
||||
)
|
||||
|
||||
return directive.response()
|
||||
|
||||
|
||||
@HANDLERS.register(("Alexa.EqualizerController", "AdjustBands"))
|
||||
@HANDLERS.register(("Alexa.EqualizerController", "ResetBands"))
|
||||
@HANDLERS.register(("Alexa.EqualizerController", "SetBands"))
|
||||
async def async_api_bands_directive(hass, config, directive, context):
|
||||
"""Handle an AdjustBands, ResetBands, SetBands request.
|
||||
|
||||
Only mode directives are currently supported for the EqualizerController.
|
||||
"""
|
||||
# Currently bands directives are not supported.
|
||||
msg = "Entity does not support directive"
|
||||
raise AlexaInvalidDirectiveError(msg)
|
||||
Reference in new issue
Block a user