media_player.py

Go to the documentation of this file.

"""Support for interfacing with NAD receivers through RS-232."""
 
from __future__ import annotations
 
from nad_receiver import NADReceiver, NADReceiverTCP, NADReceiverTelnet
import voluptuous as vol
 
from homeassistant.components.media_player import (
    PLATFORM_SCHEMA as MEDIA_PLAYER_PLATFORM_SCHEMA,
    MediaPlayerEntity,
    MediaPlayerEntityFeature,
    MediaPlayerState,
)
from homeassistant.const import CONF_HOST, CONF_NAME, CONF_PORT, CONF_TYPE
from homeassistant.core import HomeAssistant
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
DEFAULT_TYPE = "RS232"
DEFAULT_SERIAL_PORT = "/dev/ttyUSB0"
DEFAULT_PORT = 53
DEFAULT_NAME = "NAD Receiver"
DEFAULT_MIN_VOLUME = -92
DEFAULT_MAX_VOLUME = -20
DEFAULT_VOLUME_STEP = 4
 
SUPPORT_NAD = (
    MediaPlayerEntityFeature.VOLUME_SET
    | MediaPlayerEntityFeature.VOLUME_MUTE
    | MediaPlayerEntityFeature.TURN_ON
    | MediaPlayerEntityFeature.TURN_OFF
    | MediaPlayerEntityFeature.VOLUME_STEP
    | MediaPlayerEntityFeature.SELECT_SOURCE
)
 
CONF_SERIAL_PORT = "serial_port"  # for NADReceiver
CONF_MIN_VOLUME = "min_volume"
CONF_MAX_VOLUME = "max_volume"
CONF_VOLUME_STEP = "volume_step"  # for NADReceiverTCP
CONF_SOURCE_DICT = "sources"  # for NADReceiver
 
# Max value based on a C658 with an MDC HDM-2 card installed
SOURCE_DICT_SCHEMA = vol.Schema({vol.Range(min=1, max=12): cv.string})
 
PLATFORM_SCHEMA = MEDIA_PLAYER_PLATFORM_SCHEMA.extend(
    {
        vol.Optional(CONF_TYPE, default=DEFAULT_TYPE): vol.In(
            ["RS232", "Telnet", "TCP"]
        ),
        vol.Optional(CONF_SERIAL_PORT, default=DEFAULT_SERIAL_PORT): cv.string,
        vol.Optional(CONF_HOST): cv.string,
        vol.Optional(CONF_PORT, default=DEFAULT_PORT): int,
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_MIN_VOLUME, default=DEFAULT_MIN_VOLUME): int,
        vol.Optional(CONF_MAX_VOLUME, default=DEFAULT_MAX_VOLUME): int,
        vol.Optional(CONF_SOURCE_DICT, default={}): SOURCE_DICT_SCHEMA,
        vol.Optional(CONF_VOLUME_STEP, default=DEFAULT_VOLUME_STEP): int,
    }
)
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the NAD platform."""
    if config.get(CONF_TYPE) in ("RS232", "Telnet"):
        add_entities(
            [NAD(config)],
            True,
        )
    else:
        add_entities(
            [NADtcp(config)],
            True,
        )
 
 
class NAD(MediaPlayerEntity):
    """Representation of a NAD Receiver."""
 
    _attr_icon = "mdi:speaker-multiple"
    _attr_supported_features = SUPPORT_NAD
 
    def __init__(self, config):
        """Initialize the NAD Receiver device."""
        self.configconfig = config
        self._instantiate_nad_receiver_instantiate_nad_receiver()
        self._attr_name_attr_name = self.configconfig[CONF_NAME]
        self._min_volume_min_volume = config[CONF_MIN_VOLUME]
        self._max_volume_max_volume = config[CONF_MAX_VOLUME]
        self._source_dict_source_dict = config[CONF_SOURCE_DICT]
        self._reverse_mapping_reverse_mapping = {value: key for key, value in self._source_dict_source_dict.items()}
 
    def _instantiate_nad_receiver(self) -> NADReceiver:
        if self.configconfig[CONF_TYPE] == "RS232":
            self._nad_receiver_nad_receiver = NADReceiver(self.configconfig[CONF_SERIAL_PORT])
        else:
            host = self.configconfig.get(CONF_HOST)
            port = self.configconfig[CONF_PORT]
            self._nad_receiver_nad_receiver = NADReceiverTelnet(host, port)
 
    def turn_off(self) -> None:
        """Turn the media player off."""
        self._nad_receiver_nad_receiver.main_power("=", "Off")
 
    def turn_on(self) -> None:
        """Turn the media player on."""
        self._nad_receiver_nad_receiver.main_power("=", "On")
 
    def volume_up(self) -> None:
        """Volume up the media player."""
        self._nad_receiver_nad_receiver.main_volume("+")
 
    def volume_down(self) -> None:
        """Volume down the media player."""
        self._nad_receiver_nad_receiver.main_volume("-")
 
    def set_volume_level(self, volume: float) -> None:
        """Set volume level, range 0..1."""
        self._nad_receiver_nad_receiver.main_volume("=", self.calc_dbcalc_db(volume))
 
    def mute_volume(self, mute: bool) -> None:
        """Mute (true) or unmute (false) media player."""
        if mute:
            self._nad_receiver_nad_receiver.main_mute("=", "On")
        else:
            self._nad_receiver_nad_receiver.main_mute("=", "Off")
 
    def select_source(self, source: str) -> None:
        """Select input source."""
        self._nad_receiver_nad_receiver.main_source("=", self._reverse_mapping_reverse_mapping.get(source))
 
    @property
    def source_list(self):
        """List of available input sources."""
        return sorted(self._reverse_mapping_reverse_mapping)
 
    @property
    def available(self) -> bool:
        """Return if device is available."""
        return self.statestatestatestatestate is not None
 
    def update(self) -> None:
        """Retrieve latest state."""
        power_state = self._nad_receiver_nad_receiver.main_power("?")
        if not power_state:
            self._attr_state_attr_state = None
            return
        self._attr_state_attr_state = (
            MediaPlayerState.ON
            if self._nad_receiver_nad_receiver.main_power("?") == "On"
            else MediaPlayerState.OFF
        )
 
        if self.statestatestatestatestate == MediaPlayerState.ON:
            self._attr_is_volume_muted_attr_is_volume_muted = self._nad_receiver_nad_receiver.main_mute("?") == "On"
            volume = self._nad_receiver_nad_receiver.main_volume("?")
            # Some receivers cannot report the volume, e.g. C 356BEE,
            # instead they only support stepping the volume up or down
            self._attr_volume_level_attr_volume_level = (
                self.calc_volumecalc_volume(volume) if volume is not None else None
            )
            self._attr_source_attr_source = self._source_dict_source_dict.get(
                self._nad_receiver_nad_receiver.main_source("?")
            )
 
    def calc_volume(self, decibel):
        """Calculate the volume given the decibel.
 
        Return the volume (0..1).
        """
        return abs(self._min_volume_min_volume - decibel) / abs(
            self._min_volume_min_volume - self._max_volume_max_volume
        )
 
    def calc_db(self, volume):
        """Calculate the decibel given the volume.
 
        Return the dB.
        """
        return self._min_volume_min_volume + round(
            abs(self._min_volume_min_volume - self._max_volume_max_volume) * volume
        )
 
 
class NADtcp(MediaPlayerEntity):
    """Representation of a NAD Digital amplifier."""
 
    _attr_supported_features = SUPPORT_NAD
 
    def __init__(self, config):
        """Initialize the amplifier."""
        self._attr_name_attr_name = config[CONF_NAME]
        self._nad_receiver_nad_receiver = NADReceiverTCP(config.get(CONF_HOST))
        self._min_vol_min_vol = (config[CONF_MIN_VOLUME] + 90) * 2  # from dB to nad vol (0-200)
        self._max_vol_max_vol = (config[CONF_MAX_VOLUME] + 90) * 2  # from dB to nad vol (0-200)
        self._volume_step_volume_step = config[CONF_VOLUME_STEP]
        self._nad_volume_nad_volume = None
        self._source_list_source_list = self._nad_receiver_nad_receiver.available_sources()
 
    def turn_off(self) -> None:
        """Turn the media player off."""
        self._nad_receiver_nad_receiver.power_off()
 
    def turn_on(self) -> None:
        """Turn the media player on."""
        self._nad_receiver_nad_receiver.power_on()
 
    def volume_up(self) -> None:
        """Step volume up in the configured increments."""
        self._nad_receiver_nad_receiver.set_volume(self._nad_volume_nad_volume + 2 * self._volume_step_volume_step)
 
    def volume_down(self) -> None:
        """Step volume down in the configured increments."""
        self._nad_receiver_nad_receiver.set_volume(self._nad_volume_nad_volume - 2 * self._volume_step_volume_step)
 
    def set_volume_level(self, volume: float) -> None:
        """Set volume level, range 0..1."""
        nad_volume_to_set = int(
            round(volume * (self._max_vol_max_vol - self._min_vol_min_vol) + self._min_vol_min_vol)
        )
        self._nad_receiver_nad_receiver.set_volume(nad_volume_to_set)
 
    def mute_volume(self, mute: bool) -> None:
        """Mute (true) or unmute (false) media player."""
        if mute:
            self._nad_receiver_nad_receiver.mute()
        else:
            self._nad_receiver_nad_receiver.unmute()
 
    def select_source(self, source: str) -> None:
        """Select input source."""
        self._nad_receiver_nad_receiver.select_source(source)
 
    @property
    def source_list(self):
        """List of available input sources."""
        return self._nad_receiver_nad_receiver.available_sources()
 
    def update(self) -> None:
        """Get the latest details from the device."""
        try:
            nad_status = self._nad_receiver_nad_receiver.status()
        except OSError:
            return
        if nad_status is None:
            return
 
        # Update on/off state
        if nad_status["power"]:
            self._attr_state_attr_state = MediaPlayerState.ON
        else:
            self._attr_state_attr_state = MediaPlayerState.OFF
 
        # Update current volume
        self._attr_volume_level_attr_volume_level = self.nad_vol_to_internal_volnad_vol_to_internal_vol(nad_status["volume"])
        self._nad_volume_nad_volume = nad_status["volume"]
 
        # Update muted state
        self._attr_is_volume_muted_attr_is_volume_muted = nad_status["muted"]
 
        # Update current source
        self._attr_source_attr_source = nad_status["source"]
 
    def nad_vol_to_internal_vol(self, nad_volume):
        """Convert nad volume range (0-200) to internal volume range.
 
        Takes into account configured min and max volume.
        """
        if nad_volume < self._min_vol_min_vol:
            volume_internal = 0.0
        elif nad_volume > self._max_vol_max_vol:
            volume_internal = 1.0
        else:
            volume_internal = (nad_volume - self._min_vol_min_vol) / (
                self._max_vol_max_vol - self._min_vol_min_vol
            )
        return volume_internal