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 should also work for Italy and Germany.

Installing

To install:

pip install pyskyqremote

Usage

Base

from pyskyqremote.skyq_remote import SkyQRemote

self.client = SkyQRemote('192.168.1.99')

Optional parameters:

epgCacheLen - Default = 20
port - Default = 49160
jsonPort - Default = 9006

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 an object such as below for the running application name:

{
   'appId':'com.bskyb.beehive',
   'title':'Beehive Bedlam'
}

### Get the active application (JSON)

app = self.client.getActiveApplication().as_json()


Will return a JSON structure such as below for the running application name:

{ "type":"app", "attributes":{ "appId":"com.bskyb.beehive", "title":"Beehive Bedlam" } }

Get current media

app = self.client.getCurrentMedia()

Will return an object such as below for live programme:

{
   'channel':'Sky Comedy HD',
   'channelno':'153',
   'imageUrl':'https://d2n0069hmnqmmx.cloudfront.net/epgdata/1.0/newchanlogos/600/600/skychb1143.png',
   'sid':1143,
   'pvrId':None,
   'live':True
}

or for recording

{
   'channel':None,
   'channelno':'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",
      "channelno":"101",
      "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,
      "channelno":null,
      "imageUrl":null,
      "sid":null,
      "pvrId":"P12345ABC",
      "live":false
   }
}

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',
         'channelname':'BBC One South',
         'status':'LIVE'
      },
      {
         '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',
         'channelname':'BBC One South',
         'status':'LIVE'
      },
      {...}
   ]
}

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",
            "channelname":"BBC One South",
            "status":"LIVE"
        }
      },
      {
         "__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",
            "channelname":"BBC One South"
            "status":"LIVE"
         }
      },
      {...},
   ]
}

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',
   'channelname':'Channel 5 HD',
   'status':'LIVE'
}

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",
      "channelname":"BBC ONE HD",
      "status":"LIVE"
   }
}

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',
   'channelname':'Channel 5 HD',
   'status':'LIVE'
}

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",
      "channelname":"BBC ONE HD",
      "status":"LIVE"
  }
}

Get recordings

recordings = self.client.getRecordings(status)

Will return an object such as below for recordings with the provided status (default returns all):

{
   'programmes':[
      {
        'programmeuuid':'54bfc205-c56e-4583-b03f-59c31f97f8c7',
        'starttime':'2020-08-02T19:58:00Z',
        'endtime':'2020-08-02T21:01:59Z',
        'title':'New: Batwoman',
        'season':1,
        'episode':19,
        'imageUrl':'https://images.metadata.sky.com/pd-image/54bfc205-c56e-4583-b03f-59c31f97f8c7/16-9',
        'channelname':'E4 HD',
        'status':'RECORDED'
      },
      {
        'programmeuuid':'af9ecd2c-5026-4050-9c15-37598fe26713',
        'starttime':null,
        'endtime':'null,
        'title':'Home and Away',
        'season':35,
        'episode':4,
        'imageUrl':'https://images.metadata.sky.com/pd-image/af9ecd2c-5026-4050-9c15-37598fe26713/16-9',
        'channelname':'Channel 5 HD',
        'status':'SCHEDULED'
      },
      {…}
      }
   ]
}

Get recordings (JSON)

recordings = self.client.getRecordings(status).as_json()

Will return an object such as below for recordings with the provided status (default returns all):

{
   "__type__":"__recordings__",
   "attributes":{

   },
   "programmes":[
      {
         "__type__":"__programme__",
         "attributes":{
            "programmeuuid":"54bfc205-c56e-4583-b03f-59c31f97f8c7",
            "starttime":"2020-08-02T19:58:00Z",
            "endtime":"2020-08-02T21:01:59Z",
            "title":"New: Batwoman",
            "season":1,
            "episode":19,
            "imageUrl":"https://images.metadata.sky.com/pd-image/54bfc205-c56e-4583-b03f-59c31f97f8c7/16-9",
            "channelname":"E4 HD",
            "status":"RECORDED"
        }
      },
      {
         "__type__":"__programme__",
         "attributes":{
            "programmeuuid":"af9ecd2c-5026-4050-9c15-37598fe26713",
            "starttime":"null",
            "endtime":"null",
            "title":"Home and Away",
            "season":35,
            "episode":4,
            "imageUrl":"https://images.metadata.sky.com/pd-image/af9ecd2c-5026-4050-9c15-37598fe26713/16-9",
            "channelname":"Channel 5 HD",
            "status":"SCHEDULED"
     },
      {...}
      }
   ]
}

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),
   'channelname':'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',
   'status':'RECORDED'
}

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",
      "channelname":"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",
      "status":"RECORDED"
   }
}

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',
         'channelsid'='2153',
         'channelimageurl'='https://d2n0069hmnqmmx.cloudfront.net/epgdata/1.0/newchanlogos/600/600/skychb2153.png',
         'channeltype':'video',
         'channelnoint':101,
         'sf':'sd'
      },
      {
         'channelno':'0102',
         'channelname':'BBC R2',
         'channelsid'='2153',
         'channelimageurl'='https://d2n0069hmnqmmx.cloudfront.net/epgdata/1.0/newchanlogos/600/600/skychb2153.png',
         'channeltype':'audio',
         'channelnoint':102,
         '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",
            "channelsid":"2153",
            "channelimageurl":"https://d2n0069hmnqmmx.cloudfront.net/epgdata/1.0/newchanlogos/600/600/skychb2153.png",
            "channeltype":"video",
            "channelnoint":101,
            "sf":"sd"
         }
      },
      {
         "__type__":"__channel__",
         "attributes":{
            "channelno":"0102",
            "channelname":"BBC R2",
            "channelsid":"2153",
            "channelimageurl":"https://d2n0069hmnqmmx.cloudfront.net/epgdata/1.0/newchanlogos/600/600/skychb2153.png",
            "channeltype":"audio",
            "channelnoint":102,
            "sf":"au"
         }
      },
      {...},
   ]
}

Get Channel Information (for a specific channel number)

channelInfo = self.client.getChannelInfo(channelNo)

Will return an object such as below:

{
   'channelno'='101',
   'channelname'='BBC One South',
   'channelsid'='2153',
   'channelimageurl'='https://d2n0069hmnqmmx.cloudfront.net/epgdata/1.0/newchanlogos/600/600/skychb2153.png',
   'channeltype'='video',
   'channelnoint'=101,
   'sf'='sd'
}

Get Channel Information (for a specific channel number) (JSON)

channelInfo = self.client.getChannelInfo(channelNo).as_json()

Will return an object such as below:

{
   "__type__":"__channel__",
   "attributes":{
      "channelno":"101",
      "channelname":"BBC One South",
      "channelsid":"2153",
      "channelimageurl":"https://d2n0069hmnqmmx.cloudfront.net/epgdata/1.0/newchanlogos/600/600/skychb2153.png",
      "channeltype":"video",
      "channelnoint":101,
      "sf":"sd"
   }
}

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

Project details

Release history Release notifications | RSS feed

0.3.26

Aug 29, 2023

0.3.25

Apr 1, 2023

0.3.24

Jan 18, 2023

0.3.23

Dec 29, 2022

0.3.22

Dec 26, 2022

0.3.21

Nov 25, 2022

0.3.20

Nov 10, 2022

0.3.19

Nov 9, 2022

0.3.18

Nov 9, 2022

0.3.17

Oct 25, 2022

0.3.16

Aug 14, 2022

0.3.15

Aug 8, 2022

0.3.14

Jul 30, 2022

0.3.13

Jul 30, 2022

0.3.12

May 21, 2022

0.3.11

May 20, 2022

0.3.10

May 20, 2022

0.3.9

May 18, 2022

0.3.8

May 18, 2022

0.3.7

May 8, 2022

0.3.6

Apr 22, 2022

0.3.5

Mar 1, 2022

0.3.4

Mar 1, 2022

0.3.3

Mar 1, 2022

0.3.2

Feb 20, 2022

0.3.1

Feb 11, 2022

0.3.0

Feb 8, 2022

0.2.59

Feb 3, 2022

0.2.58

Feb 1, 2022

0.2.57

Jan 27, 2022

0.2.56

Jan 13, 2022

0.2.55

Jan 6, 2022

0.2.54

Dec 14, 2021

0.2.53

Dec 13, 2021

0.2.52

Dec 3, 2021

0.2.51

Nov 24, 2021

0.2.50

Nov 24, 2021

0.2.49

Nov 23, 2021

0.2.48

Nov 23, 2021

0.2.47

Nov 23, 2021

0.2.46

Nov 22, 2021

0.2.45

Nov 11, 2021

0.2.44

Nov 8, 2021

0.2.43

Nov 7, 2021

This version

0.2.42

Oct 20, 2021

0.2.41

Sep 14, 2021

0.2.40

Apr 20, 2021

0.2.39

Mar 26, 2021

0.2.38

Mar 8, 2021

0.2.37

Mar 8, 2021

0.2.36

Feb 24, 2021

0.2.35

Feb 20, 2021

0.2.34

Jan 20, 2021

0.2.33

Nov 27, 2020

0.2.32

Oct 22, 2020

0.2.31

Oct 15, 2020

0.2.31b1 pre-release

Oct 14, 2020

0.2.30

Sep 24, 2020

0.2.30b5 pre-release

Sep 22, 2020

0.2.30b4 pre-release

Sep 22, 2020

0.2.30b3 pre-release

Sep 22, 2020

0.2.30b2 pre-release

Sep 22, 2020

0.2.30b1 pre-release

Sep 21, 2020

0.2.28

Aug 15, 2020

0.2.27

Aug 6, 2020

0.2.26

Aug 3, 2020

0.2.26b1 pre-release

Aug 1, 2020

0.2.26b0 pre-release

Jul 31, 2020

0.2.25

Jul 29, 2020

0.2.24

Jul 5, 2020

0.2.23

Jul 1, 2020

0.2.22

Jun 21, 2020

0.2.21

Jun 9, 2020

0.2.21b2 pre-release

Jun 8, 2020

0.2.21b1 pre-release

Jun 6, 2020

0.2.20

Jun 5, 2020

0.2.19

May 29, 2020

0.2.19b1 pre-release

May 24, 2020

0.2.19b0 pre-release

May 23, 2020

0.2.18

May 20, 2020

0.2.17

May 18, 2020

0.2.16

May 17, 2020

0.2.15

May 17, 2020

0.2.14

May 17, 2020

0.2.13

May 6, 2020

0.2.12

May 4, 2020

0.2.11

May 1, 2020

0.2.10

Apr 29, 2020

0.2.9

Apr 29, 2020

0.2.8

Apr 27, 2020

0.2.7

Apr 25, 2020

0.2.6

Apr 22, 2020

0.2.5

Apr 19, 2020

0.2.4

Apr 17, 2020

0.2.3

Apr 17, 2020

0.2.2

Apr 16, 2020

0.2.1

Apr 14, 2020

0.2.0

Apr 14, 2020

0.1.0

Apr 12, 2020

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.42.tar.gz (22.4 kB view hashes)

Uploaded Oct 20, 2021 Source

Built Distribution

pyskyqremote-0.2.42-py3-none-any.whl (26.1 kB view hashes)

Uploaded Oct 20, 2021 Python 3

Hashes for pyskyqremote-0.2.42.tar.gz

Hashes for pyskyqremote-0.2.42.tar.gz
Algorithm	Hash digest
SHA256	`957bca5ab28dd25eebf87ed640203e3c0b8b16f98857ca58e7883759aee22395`
MD5	`b5d08f7f6214c2731faaf8b7ba255179`
BLAKE2b-256	`26ef24e7618797a17f5e67811c77042ec60e42941385cf030532e8fae17a8071`

Hashes for pyskyqremote-0.2.42-py3-none-any.whl

Hashes for pyskyqremote-0.2.42-py3-none-any.whl
Algorithm	Hash digest
SHA256	`b12a4f02793fabb0fbd8b5c8cf4a407039b09cd9a9854e1d6bece3ea9e8b4f95`
MD5	`aeffb76259a353b93b93fa9bc06be124`
BLAKE2b-256	`2c903ff0a3586dda4644e6dcaca06130644e8b1b241fad2e2892707337e1f05d`

pyskyqremote 0.2.42

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Project description

pyskyqremote

Introduction

Installing

Usage

Base

Get device information

Get device information (JSON)

Decode device information (JSON)

Get power status

Get current state

Get the active application

Get current media

Get current media (JSON)

Decode current media (JSON)

Get EPG information

Get EPG information (JSON)

Decode EPG information (JSON)

Get programme at a point in time on a day

Get programme at a point in time on a day (JSON)

Decode programme information (JSON)

Get current live TV programme on a channel

Get current live TV programme on a channel (JSON)

Get recordings

Get recordings (JSON)

Get recording

Get recording (JSON)

Decode recording information (JSON)

Get Channel List

Get Channel List (JSON)

Get Channel Information (for a specific channel number)

Get Channel Information (for a specific channel number) (JSON)

Decode EPG information (JSON)

Send key press

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution