{% if installed %} Thanks for using this custom component.
{% endif %}
{% if prerelease %}
{% endif %}
The skyq platform allows you to control a SkyQ set top box.
Note: Whilst it will pull back information for UK boxes for current channel and live programme, it will do this for a ver limited set of countries (currently UK and IT). If you are in an unsupported country, or don't want this information set 'live_tv' to False in yoru config.
There is currently support for the following device types within Home Assistant:
- Media Player
Component showing current TV with default media control
Component showing application with default media control
Component showing recording with Mini Media Player
You can use HACS by adding this reposity as a custom Integration repository in HACS settings, or install the component manually:
- Put the files from
/custom_components/skyq/in your folder<config directory>/custom_components/skyq/
For either install method you must also:
- Put the files from
/www/community/skyq/in your folder<config directory>/www/community/skyq/
media_player:
- platform: skyq
name: SkyQ Living Room
host: 192.168.0.10
live_tv: True
country: "UK"
sources:
SkyOne: '1,0,6'
SkyNews: '5,0,1'
media_player: platform (string)(Required) Must be set to skyq
host (string)(Required) The IP of the SkyQ set top box, e.g., 192.168.0.10.
name (string)(Required) The name you would like to give to the SkyQ set top box.
sources (list)(Required) List of channels or other commands that will appear in the source selection.
name (string)(Required) The name you would like to give to the SkyQ set top box.
output_programme_image (boolean)(Optional) Default True Enables you to disable returning images when watching recorded programmes. Useful if using a modified media player UI, where you don't want the background changing.
live_tv (boolean)(Optional) Default True Enables you to disable the retrieval of live TV programme information. Useful for people in those countries where the TV schedules are not available from awk.epgsky.com.
country (string)(Optional) Default "UK" Enables to switch to another country. Currently only UK and IT are supported.
To configure sources, set as
<YourChanneName> : ‘<button>,<button>,<button>’.
sky, power, tvguide or home, boxoffice, search, sidebar, up, down, left, right, select, channelup, channeldown, i, dismiss, text, help,
play, pause, rewind, fastforward, stop, record
red, green, yellow, blue
0, 1, 2, 3, 4, 5, 6, 7, 8, 9
The behaviour of the next and previous buttons is fastforward and rewind (multiple presses to increase speed, play to resume)
A utility function has been created to generate yaml configuration for SkyQ enabled media players to support easy usage with other home assistant integrations, e.g. google home
Usage based on google home: “turn on <source name / channel name> in the ”
generate_switches_for_channels (boolean)(Optional) Default False Generate switches for each item listed in source. The files will be generated in /skyq.yaml
room (string)(Optional) Default 'Default Room' The room where the SkyQ set top box is located.
Avoid using [ ] in the name: or room: of your device. This field is required if you have more than one SkyQ box being configured with switches
media_player:
- platform: skyq
name: SkyQ Living Room
host: 192.168.0.10
sources:
SkyOne: '1,0,6'
SkyNews: '5,0,1'
room: Living Room
generate_switches_for_channels: true
To integrate these generated switch configuration files, add the generated yaml to your configuration.yaml. The following example configuration implements the generated switches from the generate_switches_for_channels function.
switch:
- platform: template
switches: !include skyq<room*>.yaml