mirror of
https://github.com/LukeSpad/BeoGateway.git
synced 2024-12-23 21:51:51 +00:00
Delete MLGW_CLIENT.py
This commit is contained in:
LukeSpad
GitHub
parent
ca0624f390
commit
477681868b
1 changed files with 0 additions and 409 deletions
|
|
@ -1,409 +0,0 @@
|
||||||
import asynchat
|
|
||||||
import logging
|
|
||||||
import socket
|
|
||||||
import time
|
|
||||||
import json
|
|
||||||
from collections import OrderedDict
|
|
||||||
|
|
||||||
import Resources.CONSTANTS as CONST
|
|
||||||
|
|
||||||
|
|
||||||
class MLGWClient(asynchat.async_chat):
|
|
||||||
"""Client to interact with a B&O Gateway via the MasterLink Gateway Protocol
|
|
||||||
http://mlgw.bang-olufsen.dk/source/documents/mlgw_2.24b/MlgwProto0240.pdf ."""
|
|
||||||
|
|
||||||
def __init__(self, host_address='blgw.local', port=9000, user='admin', pwd='admin', name='MLGW_Protocol', cb=None):
|
|
||||||
asynchat.async_chat.__init__(self)
|
|
||||||
self.log = logging.getLogger('Client (%7s)' % name)
|
|
||||||
self.log.setLevel('INFO')
|
|
||||||
|
|
||||||
self._host = host_address
|
|
||||||
self._port = int(port)
|
|
||||||
self._user = user
|
|
||||||
self._pwd = pwd
|
|
||||||
self.name = name
|
|
||||||
self.is_connected = False
|
|
||||||
|
|
||||||
self._received_data = bytearray()
|
|
||||||
self.last_sent = ''
|
|
||||||
self.last_sent_at = time.time()
|
|
||||||
self.last_received = ''
|
|
||||||
self.last_received_at = time.time()
|
|
||||||
self.last_message = {}
|
|
||||||
|
|
||||||
# Optional callback function
|
|
||||||
if cb:
|
|
||||||
self.messageCallBack = cb
|
|
||||||
else:
|
|
||||||
self.messageCallBack = None
|
|
||||||
|
|
||||||
# Expose dictionaries via API
|
|
||||||
self.BEO4_CMDS = CONST.BEO4_CMDS
|
|
||||||
self.BEORMT1_CMDS = CONST.beoremoteone_commanddict
|
|
||||||
self.CMDS_DEST = CONST.CMDS_DEST
|
|
||||||
self.MLGW_PL = CONST.MLGW_PL
|
|
||||||
|
|
||||||
# ########################################################################################
|
|
||||||
# ##### Open Socket and connect to B&O Gateway
|
|
||||||
self.client_connect()
|
|
||||||
|
|
||||||
# ########################################################################################
|
|
||||||
# ##### Client functions
|
|
||||||
def collect_incoming_data(self, data):
|
|
||||||
self.is_connected = True
|
|
||||||
self.log.debug(data)
|
|
||||||
self._received_data = bytearray(data)
|
|
||||||
|
|
||||||
bit1 = int(self._received_data[0]) # Start of Header == 1
|
|
||||||
bit2 = int(self._received_data[1]) # Message Type
|
|
||||||
bit3 = int(self._received_data[2]) # Payload length
|
|
||||||
bit4 = int(self._received_data[3]) # Spare Bit/End of Header == 0
|
|
||||||
|
|
||||||
payload = bytearray()
|
|
||||||
for item in self._received_data[4:bit3 + 4]:
|
|
||||||
payload.append(item)
|
|
||||||
|
|
||||||
if bit1 == 1 and len(self._received_data) == bit3 + 4 and bit4 == 0:
|
|
||||||
self.found_terminator(bit2, payload)
|
|
||||||
else:
|
|
||||||
self.log.info("Incomplete Telegram Received: " + str(list(self._received_data)) + " - Ignoring!\n")
|
|
||||||
|
|
||||||
def found_terminator(self, msg_type, payload):
|
|
||||||
self.last_received = str(list(self._received_data))
|
|
||||||
self.last_received_at = time.time()
|
|
||||||
self.log.debug(self._received_data)
|
|
||||||
|
|
||||||
header = self._received_data[0:4]
|
|
||||||
self._received_data = ""
|
|
||||||
self._decode(msg_type, header, payload)
|
|
||||||
|
|
||||||
def _decode(self, msg_type, header, payload):
|
|
||||||
message = OrderedDict()
|
|
||||||
payload_type = self._dictsanitize(CONST.mlgw_payloadtypedict, msg_type)
|
|
||||||
|
|
||||||
if payload_type == "MLGW virtual button event":
|
|
||||||
virtual_btn = payload[0]
|
|
||||||
if len(payload) < 1:
|
|
||||||
virtual_action = self._getvirtualactionstr(0x01)
|
|
||||||
else:
|
|
||||||
virtual_action = self._getvirtualactionstr(payload[1])
|
|
||||||
|
|
||||||
message["payload_type"] = payload_type
|
|
||||||
message["button"] = virtual_btn
|
|
||||||
message["action"] = virtual_action
|
|
||||||
|
|
||||||
elif payload_type == "Login status":
|
|
||||||
if payload == 0:
|
|
||||||
self.log.info("\tAuthentication Failed: MLGW protocol Password required for %s", self._host)
|
|
||||||
self.handle_close()
|
|
||||||
message['Connected'] = "False"
|
|
||||||
return
|
|
||||||
else:
|
|
||||||
self.log.info("\tLogin successful to %s", self._host)
|
|
||||||
self.is_connected = True
|
|
||||||
message["payload_type"] = payload_type
|
|
||||||
message['Connected'] = "True"
|
|
||||||
self.get_serial()
|
|
||||||
|
|
||||||
elif payload_type == "Pong":
|
|
||||||
self.is_connected = True
|
|
||||||
message["payload_type"] = payload_type
|
|
||||||
message['CONNECTION'] = 'Online'
|
|
||||||
|
|
||||||
elif payload_type == "Serial Number":
|
|
||||||
sn = ''
|
|
||||||
for c in payload:
|
|
||||||
sn += chr(c)
|
|
||||||
message["payload_type"] = payload_type
|
|
||||||
message['serial_Num'] = sn
|
|
||||||
|
|
||||||
elif payload_type == "Source Status":
|
|
||||||
self._get_device_info(message, payload)
|
|
||||||
message["payload_type"] = payload_type
|
|
||||||
message["MLN"] = payload[0]
|
|
||||||
message["State_Update"] = OrderedDict()
|
|
||||||
message["State_Update"]["nowPlaying"] = 'Unknown'
|
|
||||||
message["State_Update"]["nowPlayingDetails"] = OrderedDict()
|
|
||||||
message["State_Update"]["nowPlayingDetails"]["channel_track"] = \
|
|
||||||
self._hexword(payload[4], payload[5])
|
|
||||||
message["State_Update"]["nowPlayingDetails"]["source_medium_position"] = \
|
|
||||||
self._hexword(payload[2], payload[3])
|
|
||||||
message["State_Update"]["nowPlayingDetails"]["picture_format"] = \
|
|
||||||
self._getdictstr(CONST.ml_pictureformatdict, payload[7])
|
|
||||||
source = self._getselectedsourcestr(payload[1]).upper()
|
|
||||||
self._get_source_name(source, message)
|
|
||||||
message["State_Update"]["source"] = source
|
|
||||||
self._get_channel_track(message)
|
|
||||||
message["State_Update"]["state"] = self._getdictstr(CONST.sourceactivitydict, payload[6])
|
|
||||||
|
|
||||||
elif payload_type == "Picture and Sound Status":
|
|
||||||
self._get_device_info(message, payload)
|
|
||||||
message["payload_type"] = payload_type
|
|
||||||
message["MLN"] = payload[0]
|
|
||||||
message["State_Update"] = OrderedDict([("sound_status", OrderedDict()), ("picture_status", OrderedDict())])
|
|
||||||
message["State_Update"]["sound_status"]["mute_status"] = \
|
|
||||||
self._getdictstr(CONST.mlgw_soundstatusdict, payload[1])
|
|
||||||
message["State_Update"]["sound_status"]["speakermode"] = \
|
|
||||||
self._getdictstr(CONST.mlgw_speakermodedict, payload[2])
|
|
||||||
message["State_Update"]["sound_status"]["stereo_mode"] = \
|
|
||||||
self._getdictstr(CONST.mlgw_stereoindicatordict, payload[9])
|
|
||||||
message["State_Update"]["picture_status"]["screen1_mute"] = \
|
|
||||||
self._getdictstr(CONST.mlgw_screenmutedict, payload[4])
|
|
||||||
message["State_Update"]["picture_status"]["screen1_active"] = \
|
|
||||||
self._getdictstr(CONST.mlgw_screenactivedict, payload[5])
|
|
||||||
message["State_Update"]["picture_status"]["screen2_mute"] = \
|
|
||||||
self._getdictstr(CONST.mlgw_screenmutedict, payload[6])
|
|
||||||
message["State_Update"]["picture_status"]["screen2_active"] = \
|
|
||||||
self._getdictstr(CONST.mlgw_screenactivedict, payload[7])
|
|
||||||
message["State_Update"]["picture_status"]["cinema_mode"] = \
|
|
||||||
self._getdictstr(CONST.mlgw_cinemamodedict, payload[8])
|
|
||||||
message["volume"] = int(payload[3])
|
|
||||||
|
|
||||||
elif payload_type == "All standby notification":
|
|
||||||
message["payload_type"] = payload_type
|
|
||||||
message["command"] = "All Standby"
|
|
||||||
|
|
||||||
elif payload_type == "Light and Control command":
|
|
||||||
if CONST.rooms:
|
|
||||||
for room in CONST.rooms:
|
|
||||||
if room['Room_Number'] == payload[0]:
|
|
||||||
try:
|
|
||||||
message["Zone"] = room['Zone'].upper()
|
|
||||||
except KeyError:
|
|
||||||
pass
|
|
||||||
message["Room"] = room['Room_Name'].upper()
|
|
||||||
message["Type"] = self._getdictstr(CONST.mlgw_lctypedict, payload[1]).upper() + " COMMAND"
|
|
||||||
message["Device"] = 'Beo4/BeoRemote One'
|
|
||||||
message["payload_type"] = payload_type
|
|
||||||
message["room_number"] = str(payload[0])
|
|
||||||
message["command"] = self._getbeo4commandstr(payload[2])
|
|
||||||
|
|
||||||
if message != '':
|
|
||||||
self._report(header, payload, message)
|
|
||||||
|
|
||||||
def client_connect(self):
|
|
||||||
self.log.info('Connecting to host at %s, port %i', self._host, self._port)
|
|
||||||
self.set_terminator(b'\r\n')
|
|
||||||
# Create the socket
|
|
||||||
try:
|
|
||||||
self.create_socket(socket.AF_INET, socket.SOCK_STREAM)
|
|
||||||
except socket.error, e:
|
|
||||||
self.log.info("Error creating socket: %s" % e)
|
|
||||||
self.handle_close()
|
|
||||||
# Now connect
|
|
||||||
try:
|
|
||||||
self.connect((self._host, self._port))
|
|
||||||
except socket.gaierror, e:
|
|
||||||
self.log.info("\tError with address %s:%i - %s" % (self._host, self._port, e))
|
|
||||||
self.handle_close()
|
|
||||||
except socket.timeout, e:
|
|
||||||
self.log.info("\tSocket connection to %s:%i timed out- %s" % (self._host, self._port, e))
|
|
||||||
self.handle_close()
|
|
||||||
except socket.error, e:
|
|
||||||
self.log.info("\tError opening connection to %s:%i - %s" % (self._host, self._port, e))
|
|
||||||
self.handle_close()
|
|
||||||
else:
|
|
||||||
self.is_connected = True
|
|
||||||
self.log.info("\tConnected to B&O Gateway")
|
|
||||||
|
|
||||||
def handle_connect(self):
|
|
||||||
login = []
|
|
||||||
for c in self._user:
|
|
||||||
login.append(c)
|
|
||||||
login.append(0x00)
|
|
||||||
for c in self._pwd:
|
|
||||||
login.append(c)
|
|
||||||
|
|
||||||
self.log.info("\tAttempting to Authenticate...")
|
|
||||||
self._send_cmd(CONST.MLGW_PL.get("LOGIN REQUEST"), login)
|
|
||||||
|
|
||||||
def handle_close(self):
|
|
||||||
self.log.info(self.name + ": Closing socket")
|
|
||||||
self.is_connected = False
|
|
||||||
self.close()
|
|
||||||
|
|
||||||
def _report(self, header, payload, message):
|
|
||||||
self.last_message = message
|
|
||||||
self.log.debug(self.name + "\n" + str(json.dumps(message, indent=4)))
|
|
||||||
if self.messageCallBack:
|
|
||||||
self.messageCallBack(self.name, str(list(header)), str(list(payload)), message)
|
|
||||||
|
|
||||||
# ########################################################################################
|
|
||||||
# ##### mlgw send functions
|
|
||||||
|
|
||||||
# send_cmd command to mlgw
|
|
||||||
def _send_cmd(self, msg_type, payload):
|
|
||||||
# Construct header
|
|
||||||
telegram = [1, msg_type, len(payload), 0]
|
|
||||||
# append payload
|
|
||||||
for p in payload:
|
|
||||||
telegram.append(p)
|
|
||||||
|
|
||||||
try:
|
|
||||||
self.push(str(bytearray(telegram)))
|
|
||||||
except socket.timeout, e:
|
|
||||||
self.log.info("\tSocket connection to %s:%i timed out- %s" % (self._host, self._port, e))
|
|
||||||
self.handle_close()
|
|
||||||
except socket.error, e:
|
|
||||||
self.log.info("Error sending data: %s" % e)
|
|
||||||
self.handle_close()
|
|
||||||
else:
|
|
||||||
self.last_sent = str(bytearray(telegram))
|
|
||||||
self.last_sent_at = time.time()
|
|
||||||
self.log.info(
|
|
||||||
self.name + " >>-SENT--> "
|
|
||||||
+ self._getpayloadtypestr(msg_type)
|
|
||||||
+ ": "
|
|
||||||
+ str(list(telegram))
|
|
||||||
)
|
|
||||||
|
|
||||||
# Sleep to allow msg to arrive
|
|
||||||
time.sleep(0.2)
|
|
||||||
|
|
||||||
# Ping the gateway
|
|
||||||
def ping(self):
|
|
||||||
self._send_cmd(CONST.MLGW_PL.get("PING"), "")
|
|
||||||
|
|
||||||
# Get serial number of mlgw
|
|
||||||
def get_serial(self):
|
|
||||||
if self.is_connected:
|
|
||||||
# Request serial number
|
|
||||||
self._send_cmd(CONST.MLGW_PL.get("REQUEST SERIAL NUMBER"), "")
|
|
||||||
|
|
||||||
# send_cmd Beo4 command to mlgw
|
|
||||||
def send_beo4_cmd(self, mln, dest, cmd, sec_source=0x00, link=0x00):
|
|
||||||
payload = [
|
|
||||||
mln, # byte[0] MLN
|
|
||||||
dest, # byte[1] Dest-Sel (0x00, 0x01, 0x05, 0x0f)
|
|
||||||
cmd, # byte[2] Beo4 Command
|
|
||||||
sec_source, # byte[3] Sec-Source
|
|
||||||
link] # byte[4] Link
|
|
||||||
self._send_cmd(CONST.MLGW_PL.get("BEO4 COMMAND"), payload)
|
|
||||||
|
|
||||||
# send_cmd BeoRemote One command to mlgw
|
|
||||||
def send_beoremoteone_cmd(self, mln, cmd, network_bit=0x00):
|
|
||||||
payload = [
|
|
||||||
mln, # byte[0] MLN
|
|
||||||
cmd, # byte[1] Beo4 Command
|
|
||||||
0x00, # byte[2] AV (needs to be 0)
|
|
||||||
network_bit] # byte[3] Network_bit (0 = local source, 1 = network source)
|
|
||||||
self._send_cmd(CONST.MLGW_PL.get("BEOREMOTE ONE CONTROL COMMAND"), payload)
|
|
||||||
|
|
||||||
# send_cmd BeoRemote One Source Select to mlgw
|
|
||||||
def send_beoremoteone_select_source(self, mln, cmd, unit, network_bit=0x00):
|
|
||||||
payload = [
|
|
||||||
mln, # byte[0] MLN
|
|
||||||
cmd, # byte[1] Beoremote One Command self.BEORMT1_CMD.get('cmd')[0]
|
|
||||||
unit, # byte[2] Unit self.BEORMT1_CMD.get('cmd')[1]
|
|
||||||
0x00, # byte[3] AV (needs to be 0)
|
|
||||||
network_bit] # byte[4] Network_bit (0 = local source, 1 = network source)
|
|
||||||
self._send_cmd(CONST.MLGW_PL.get("BEOREMOTE ONE SOURCE SELECTION"), payload)
|
|
||||||
|
|
||||||
# send_cmd Beo4 commmand and store the source name
|
|
||||||
def send_beo4_select_source(self, mln, dest, source, sec_source=0x00, link=0x00):
|
|
||||||
self.send_beo4_cmd(mln, dest, source, sec_source, link)
|
|
||||||
|
|
||||||
# ########################################################################################
|
|
||||||
# ##### Utility functions
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _hexbyte(byte):
|
|
||||||
resultstr = hex(byte)
|
|
||||||
if byte < 16:
|
|
||||||
resultstr = resultstr[:2] + "0" + resultstr[2]
|
|
||||||
return resultstr
|
|
||||||
|
|
||||||
def _hexword(self, byte1, byte2):
|
|
||||||
resultstr = self._hexbyte(byte2)
|
|
||||||
resultstr = self._hexbyte(byte1) + resultstr[2:]
|
|
||||||
return resultstr
|
|
||||||
|
|
||||||
def _dictsanitize(self, d, s):
|
|
||||||
result = d.get(s)
|
|
||||||
if result is None:
|
|
||||||
result = "UNKNOWN (type=" + self._hexbyte(s) + ")"
|
|
||||||
return str(result)
|
|
||||||
|
|
||||||
# ########################################################################################
|
|
||||||
# ##### Decode MLGW Protocol packet to readable string
|
|
||||||
|
|
||||||
# Get message string for mlgw packet's payload type
|
|
||||||
def _getpayloadtypestr(self, payloadtype):
|
|
||||||
result = CONST.mlgw_payloadtypedict.get(payloadtype)
|
|
||||||
if result is None:
|
|
||||||
result = "UNKNOWN (type = " + self._hexbyte(payloadtype) + ")"
|
|
||||||
return str(result)
|
|
||||||
|
|
||||||
def _getbeo4commandstr(self, command):
|
|
||||||
result = CONST.beo4_commanddict.get(command)
|
|
||||||
if result is None:
|
|
||||||
result = "CMD = " + self._hexbyte(command)
|
|
||||||
return result
|
|
||||||
|
|
||||||
def _getvirtualactionstr(self, action):
|
|
||||||
result = CONST.mlgw_virtualactiondict.get(action)
|
|
||||||
if result is None:
|
|
||||||
result = "Action = " + self._hexbyte(action)
|
|
||||||
return result
|
|
||||||
|
|
||||||
def _getselectedsourcestr(self, source):
|
|
||||||
result = CONST.ml_selectedsourcedict.get(source)
|
|
||||||
if result is None:
|
|
||||||
result = "SRC = " + self._hexbyte(source)
|
|
||||||
return result
|
|
||||||
|
|
||||||
def _getspeakermodestr(self, source):
|
|
||||||
result = CONST.mlgw_speakermodedict.get(source)
|
|
||||||
if result is None:
|
|
||||||
result = "mode = " + self._hexbyte(source)
|
|
||||||
return result
|
|
||||||
|
|
||||||
def _getdictstr(self, mydict, mykey):
|
|
||||||
result = mydict.get(mykey)
|
|
||||||
if result is None:
|
|
||||||
result = self._hexbyte(mykey)
|
|
||||||
return result
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _get_source_name(source, message):
|
|
||||||
if CONST.available_sources:
|
|
||||||
for src in CONST.available_sources:
|
|
||||||
if src[1] == source:
|
|
||||||
message["State_Update"]["sourceName"] = src[0]
|
|
||||||
return
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _get_device_info(message, payload):
|
|
||||||
if CONST.rooms and CONST.devices:
|
|
||||||
for device in CONST.devices:
|
|
||||||
try:
|
|
||||||
if device['MLN'] == payload[0]:
|
|
||||||
name = device['Device']
|
|
||||||
for room in CONST.rooms:
|
|
||||||
if name in room['Products']:
|
|
||||||
try:
|
|
||||||
message["Zone"] = room['Zone'].upper()
|
|
||||||
except KeyError:
|
|
||||||
pass
|
|
||||||
message["Room"] = room['Room_Name'].upper()
|
|
||||||
message["Type"] = 'AV RENDERER'
|
|
||||||
message["Device"] = name
|
|
||||||
return
|
|
||||||
except KeyError:
|
|
||||||
pass
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _get_channel_track(message):
|
|
||||||
# Check device list for channel name information
|
|
||||||
if CONST.devices:
|
|
||||||
for device in CONST.devices:
|
|
||||||
try:
|
|
||||||
if device['Device'] == message['Device']:
|
|
||||||
if 'channels' in device['Sources'][message["State_Update"]["source"]]:
|
|
||||||
for channel in device['Sources'][message["State_Update"]["source"]]['channels']:
|
|
||||||
if channel['number'] == int(
|
|
||||||
message["State_Update"]['nowPlayingDetails']["channel_track"]):
|
|
||||||
message["State_Update"]["nowPlaying"] = channel['name']
|
|
||||||
return
|
|
||||||
except KeyError:
|
|
||||||
pass
|
|
||||||
Loading…
Reference in a new issue