Library for Sky Q Remote
Project description
pyskyqremote
Python module for accessing SkyQ box and EPG, and sending commands
Introduction
This library enables access to SkyQ devices, primarily focused on the UK, but may be useable in other countries. However EPG information is not available unless provided from awk.epgsky.com.
Installing
To install:
pip install pyskyqremote
Usage
Base
from pyskyqremote import SkyQRemote
self.client = SkyQRemote('192.168.1.99')
Get device information
device = self.client.getDeviceInformation()
Will return an object such as below for device informatiom:
{
'ASVersion':'Q112.000.21.00-AS_asdev',
'IPAddress':'192.168.1.22',
'countryCode':'GBR',
'epgCountryCode':'GBR',
'hardwareModel':'ES240',
'hardwareName':'Falcon',
'manufacturer':'Sky',
'modelNumber':'Q112.000.21.00L (53wk8j8)',
'serialNumber':'0627086857 2',
'versionNumber':'32B12D'
}
Get device information (JSON)
device = self.client.getDeviceInformation().as_json()
Will return a JSON structure such as below for device information:
{
"__type__":"__device__",
"attributes":{
"ASVersion":"Q112.000.21.00-AS_asdev",
"IPAddress":"192.168.x.xx",
"countryCode":"GBR",
"epgCountryCode":"GBR",
"hardwareModel":"ES240",
"hardwareName":"Falcon",
"manufacturer":"Sky",
"modelNumber":"Q112.000.21.00L (53wk8j8)",
"serialNumber":"##########",
"versionNumber":"32B12D"
}
}
Decode device information (JSON)
from pyskyqremote.media import DeviceDecoder
device = DeviceDecoder(deviceJSON)
Will decode the JSON structure to a python object.
Get power status
status = self.client.powerStatus()
Will return "POWERED OFF", "STANDBY or "ON"
Get current state
status = self.client.getCurrentState()
Will return "OFF", "STANDBY", "PLAYING", "PAUSED PLAYBACK"
Get the active application
app = self.client.getActiveApplication()
Will return the running application name or 'com.bskyb.epgui'
Get current media
app = self.client.getCurrentMedia()
Will return an object such as below for live programme:
{
'channel':'Sky Comedy HD',
'imageUrl':'https://d2n0069hmnqmmx.cloudfront.net/epgdata/1.0/newchanlogos/600/600/skychb1143.png',
'sid':1143,
'pvrId':None,
'live':True
}
or for recording
{
'channel':None,
'imageUrl':None,
'sid':None,
'pvrId':'P12345ABC'
'live':False
}
Get current media (JSON)
media = self.client.getCurrentMedia().as_json()
Will return a JSON structure such as below for live programme:
{
"__type__":"__media__",
"attributes":{
"channel":"BBC One South",
"imageUrl":"https://d2n0069hmnqmmx.cloudfront.net/epgdata/1.0/newchanlogos/600/600/skychb2153.png",
"sid":2153,
"pvrId":null,
"live":true
}
}
or for recording
{
"__type__":"__media__",
"attributes":{
"channel":null,
"imageUrl":null,
"sid":null,
"pvrId":"P12345ABC",
"live":faalse
}
}
Decode current media (JSON)
from pyskyqremote.media import MediaDecoder
media = MediaDecoder(mediaJSON)
Will decode the JSON structure to a python object.
Get EPG information
epg = self.client.getEpgData(sid, epgDate, days)
Will return an object with an array of events including the specified number of days. Defaults to 2 days.
{
'sid':2153,
'channelno':'101',
'channelname':'BBC One South',
'channelImageUrl':'https://d2n0069hmnqmmx.cloudfront.net/epgdata/1.0/newchanlogos/600/600/skychb2153.png',
'programmes':[
{
'progammeuuid':'57a11caf-1ebd-4c01-a40b-7fdfe5c5fad0',
'starttime':datetime.datetime(2020,4,16,21,50),
'endtime':datetime.datetime(2020,4,16,22,50),
'title':'New: Tonight Show Starring. Jimmy Fallon',
'season':7,
'episode':119,
'imageUrl':'https://images.metadata.sky.com/pd-image/57a11caf-1ebd-4c01-a40b-7fdfe5c5fad0/16-9'
},
{
'progammeuuid':'d2d67048-673a-4ea8-8a32-3ad386e306d2',
'starttime':datetime.datetime(2020,4,16,22,50),
'endtime':datetime.datetime(2020,4,16,23,50),
'title':'New: Late Late Show With...',
'season':2020,
'episode':89,
'imageUrl':'https://images.metadata.sky.com/pd-image/d2d67048-673a-4ea8-8a32-3ad386e306d2/16-9'
},
{...}
]
}
Get EPG information (JSON)
epg = self.client.getEpgData(sid, epgDate, days).as_json()
Will return a JSON structure with an array of events including the specified number of days. Defaults to 2 days.
{
"__type__":"__channel__",
"attributes":{
"sid":2153,
"channelno":"101",
"channelname":"BBC One South",
"channelImageUrl":"https://d2n0069hmnqmmx.cloudfront.net/epgdata/1.0/newchanlogos/600/600/skychb2153.png"
},
"programmes":[
{
"__type__":"__programme__",
"attributes":{
"programmeuuid":"62ad0457-1a6a-4b45-9ef7-6e144639d734",
"starttime":"2020-04-27T21:45:00Z",
"endtime":"2020-04-27T22:10:00Z",
"title":"Man Like Mobeen",
"season":3,
"episode":5,
"imageUrl":"https://images.metadata.sky.com/pd-image/62ad0457-1a6a-4b45-9ef7-6e144639d734/16-9"
}
},
{
"__type__":"__programme__",
"attributes":{
"programmeuuid":"a975bdeb-c19b-4de2-9557-c6d2757bdae7",
"starttime":"2020-04-27T22:10:00Z",
"endtime":"2020-04-27T22:50:00Z",
"title":"Have I Got A Bit More News For You",
"season":59,
"episode":4,
"imageUrl":"https://images.metadata.sky.com/pd-image/a975bdeb-c19b-4de2-9557-c6d2757bdae7/16-9"
}
},
{...},
]
}
Decode EPG information (JSON)
from pyskyqremote.channel import ChannelDecoder
channel = ChannelDecoder(channelJSON)
Will decode the JSON structure to a python object.
Get programme at a point in time on a day
Note that at the end of a day, the programme may appear on the next day's schedule.
programme = self.client.getProgrammeFromEpg(sid, epgDate, queryDate)
Will return an object such as below:
{
'progammeuuid':'9fbdcefe-312c-4681-b996-00637e85313a',
'starttime':datetime.datetime(2020,4,17,8,30),
'endtime':datetime.datetime(2020,4,17,9,0),
'title':'Parks And Recreation',
'season':4,
'episode':5,
'imageUrl':'https://images.metadata.sky.com/pd-image/9fbdcefe-312c-4681-b996-00637e85313a/16-9'
}
Get programme at a point in time on a day (JSON)
Note that at the end of a day, the programme may appear on the next day's schedule.
programme = self.client.getProgrammeFromEpg(sid, epgDate, queryDate).as_json()
Will return a JSON structure such as below:
{
"__type__":"__programme__",
"attributes":{
"programmeuuid":"e11d9e93-0eec-4855-88f5-6ade9946d5dd",
"starttime":"2020-04-28T21:00:00Z",
"endtime":"2020-04-28T21:30:00Z",
"title":"BBC News at Ten",
"season":null,
"episode":null,
"imageUrl":"https://images.metadata.sky.com/pd-image/e11d9e93-0eec-4855-88f5-6ade9946d5dd/16-9"
}
}
Decode programme information (JSON)
from pyskyqremote.programme import ProgrammeDecoder
programme = ProgrammeDecoder(programmeJSON)
Get current live TV programme on a channel
currentTV = self.client.getCurrentLiveTVProgramme(sid)
Will return an object such as below:
{
'progammeuuid':'9fbdcefe-312c-4681-b996-00637e85313a',
'starttime':datetime.datetime(2020,4,17,8,30),
'endtime':datetime.datetime(2020,4,17,9,0),
'title':'Parks And Recreation',
'season':4,
'episode':5,
'imageUrl':'https://images.metadata.sky.com/pd-image/9fbdcefe-312c-4681-b996-00637e85313a/16-9'
}
Get current live TV programme on a channel (JSON)
currentTV = self.client.getCurrentLiveTVProgramme(sid).as_json()
Will return a JSON structure such as below:
{
"__type__":"__programme__",
"attributes":{
"programmeuuid":"e11d9e93-0eec-4855-88f5-6ade9946d5dd",
"starttime":"2020-04-28T21:00:00Z",
"endtime":"2020-04-28T21:30:00Z",
"title":"BBC News at Ten",
"season":null,
"episode":null,
"imageUrl":"https://images.metadata.sky.com/pd-image/e11d9e93-0eec-4855-88f5-6ade9946d5dd/16-9"
}
}
Get recording
recording = self.client.getRecording(pvrId)
Will return an object such as below:
{
'progammeuuid':'9fbdcefe-312c-4681-b996-00637e85313a',
'starttime':datetime.datetime(2020,4,17,8,30),
'endtime':datetime.datetime(2020,4,17,9,0),
'channel':'ITV HD',
'title':'Van Der Valk',
'season':4,
'episode':5,
'imageUrl':'https://images.metadata.sky.com/pd-image/ddcd727f-487f-4558-8365-7bed4fe41c87/16-9'
}
Get recording (JSON)
recording = self.client.getRecording(pvrId).as_json()
Will return an object such as below:
{
"__type__":"__recording__",
"attributes":{
"programmeuuid":"e11d9e93-0eec-4855-88f5-6ade9946d5dd",
"starttime":"2020-04-28T21:00:00Z",
"endtime":"2020-04-28T21:30:00Z",
"channel":"ITV HD",
"title":"BBC News at Ten",
"season":null,
"episode":null,
"imageUrl":"https://images.metadata.sky.com/pd-image/e11d9e93-0eec-4855-88f5-6ade9946d5dd/16-9"
}
}
Decode recording information (JSON)
from pyskyqremote.programme import RecordedProgrammeDecoder
recording = RecordedProgrammeDecoder(recordingJSON)
Get Channel List
channelList = self.client.getChannelList()
Will return an object with an array of channels.
{
'channels':[
{
'channelno':'101',
'channelname':'BBC ONE',
'channeltype':'video',
'sf':'sd'
},
{
'channelno':'0102',
'channelname':'BBC R2',
'channeltype':'audio',
'sf':'au'
},
{...}
]
}
Get Channel List (JSON)
channelList = self.client.getChannelList().as_json()
Will return a JSON structure with an array of channels.
{
"__type__":"__channellist__",
"attributes":{
},
"channels":[
{
"__type__":"__channel__",
"attributes":{
"channelno":"101",
"channelname":"BBC ONE",
"channeltype":"video",
"sf":"sd"
}
},
{
"__type__":"__channel__",
"attributes":{
"channelno":"0102",
"channelname":"BBC R2",
"channeltype":"audio",
"sf":"au"
}
},
{...},
]
}
Decode EPG information (JSON)
from pyskyqremote.channel import ChannelDecoder
channel = ChannelDecoder(channelJSON)
Will decode the JSON structure to a python object.
Send key press
self.client.press(sequence)
Allows the sending of a sequence of key presses which are submitted at 1/2 second intervals
Valid values are:
power
select
backup
dismiss
channelup
channeldown
interactive
sidebar
help
services
search
tvguide
home
i
text
up
down
left
right
red
green
yellow
blue
0
1
2
3
4
5
6
7
8
9,
play
pause
stop
record
fastforward
rewind
boxoffice
sky
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pyskyqremote-0.2.25.tar.gz
(19.9 kB
view hashes)
Built Distribution
Close
Hashes for pyskyqremote-0.2.25-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ecaaeb9f00326b1d80cdc50f548fdd31b23c020132ce97fe92d5154b3ef60f30 |
|
| MD5 | 5fee7c74bdda2867a6f692d5211efb3e |
|
| BLAKE2b-256 | 68891b498ede8e839001e34614f154491a9f1ba3779459f15604ca03aadc9f45 |
