Commit 88090976 authored by William Hughes's avatar William Hughes
Browse files

Add config option to override source names

parent 7e282a6f

custom_components/smartir/media_player.py

+10 −1
Original line number Diff line number Diff line
@@ -27,13 +27,15 @@ CONF_UNIQUE_ID = 'unique_id' 
CONF_DEVICE_CODE = 'device_code'

CONF_CONTROLLER_DATA = "controller_data"

CONF_POWER_SENSOR = 'power_sensor'

CONF_SOURCE_NAMES = 'source_names'



PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({

    vol.Optional(CONF_UNIQUE_ID): cv.string,

    vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,

    vol.Required(CONF_DEVICE_CODE): cv.positive_int,

    vol.Required(CONF_CONTROLLER_DATA): cv.string,

    vol.Optional(CONF_POWER_SENSOR): cv.entity_id

    vol.Optional(CONF_POWER_SENSOR): cv.entity_id,

    vol.Optional(CONF_SOURCE_NAMES): dict

})



async def async_setup_platform(hass, config, async_add_entities, discovery_info=None):
@@ -119,6 +121,13 @@ class SmartIRMediaPlayer(MediaPlayerDevice, RestoreEntity): 
        if 'sources' in self._commands and self._commands['sources'] is not None:

            self._support_flags = self._support_flags | SUPPORT_SELECT_SOURCE



            for source, new_name in config.get(CONF_SOURCE_NAMES, {}).items():

                if source in self._commands['sources']:

                    if new_name is not None:

                        self._commands['sources'][new_name] = self._commands['sources'][source]



                    del self._commands['sources'][source]



            #Sources list

            for key in self._commands['sources']:

                self._sources_list.append(key)

docs/MEDIA_PLAYER.md

+18 −0
Original line number Diff line number Diff line
@@ -11,6 +11,24 @@ Find your device's brand code [here](MEDIA_PLAYER.md#available-codes-for-tv-devi 
**device_code** (Required): ...... (Accepts only positive numbers)<br />

**controller_data** (Required): The data required for the controller to function. Enter the IP address of the Broadlink device **(must be an already configured device)**, or the entity id of the Xiaomi IR controller, or the MQTT topic on which to send commands.<br />

**power_sensor** (Optional): *entity_id* for a sensor that monitors whether your device is actually On or Off. This may be a power monitor sensor. (Accepts only on/off states)<br />

**source_names** (Optional): Override the names of sources as displayed in HomeAssistant (see below)<br />



### Overriding Source Names



Source names in device files are usually set to the name that the media player uses. These often aren't very descriptive, so you can override these names in the configuration file. You can also remove a source by setting its name to `null`



```yaml

media_player:

  - platform: smartir

    name: Living room TV

    unique_id: living_room_tv

    device_code: 1000

    controller_data: 192.168.10.10

    source_names:

      HDMI1: DVD Player

      HDMI2: Xbox

      VGA: null

```



## Example (using broadlink controller):

```yaml