/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Copyright (C) 2015 Simon Stuerz * * * * This file is part of guh. * * * * Guh is free software: you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation, version 2 of the License. * * * * Guh is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU General Public License for more details. * * * * You should have received a copy of the GNU General Public License * * along with guh. If not, see . * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /*! \page lgsmarttv.html \title LG Smart Tv \ingroup plugins \ingroup network This plugin allows to interact with \l{http://www.lg.com/us/experience-tvs/smart-tv}{LG Smart Tv's} with the \l{http://developer.lgappstv.com/TV_HELP/index.jsp?topic=%2Flge.tvsdk.references.book%2Fhtml%2FUDAP%2FUDAP%2FLG+UDAP+2+0+Protocol+Specifications.htm}{LG UDAP 2.0 Protocol Specifications}. \chapter Plugin properties Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses} and \l{Vendor}{Vendors} of this \l{DevicePlugin}. Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes} and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device} will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}. The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}. The detailed implementation of each \l{DeviceClass} can be found in the source code. \note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes} will be created automatically. \quotefile plugins/deviceplugins/lgsmarttv/devicepluginlgsmarttv.json */ #include "devicepluginlgsmarttv.h" #include "plugin/device.h" #include "devicemanager.h" #include "plugininfo.h" #include DeviceClassId lgSmartTvDeviceClassId = DeviceClassId("1d41b5a8-74ff-4a12-b365-c7bbe610848f"); StateTypeId tvReachableStateTypeId = StateTypeId("b056c36b-df87-4177-8d5d-1e7c1e8cdc7a"); StateTypeId tv3DModeStateTypeId = StateTypeId("8ad3d77f-d340-495d-8c2a-5569a80e9d36"); StateTypeId tvVolumeLevelStateTypeId = StateTypeId("07d39a6e-7eab-42d0-851d-9f3bcd3bbb57"); StateTypeId tvMuteStateTypeId = StateTypeId("a6ac9061-3de7-403a-a646-790ca5d73764"); StateTypeId tvChannelTypeStateTypeId = StateTypeId("84c86670-77c7-4fc6-9e23-abca066e76aa"); StateTypeId tvChannelNameStateTypeId = StateTypeId("265dc5f7-3f4d-4002-a6fe-2a53986bcf1d"); StateTypeId tvChannelNumberStateTypeId = StateTypeId("881629a3-4ce2-42ba-8ce6-10d90c383799"); StateTypeId tvProgramNameStateTypeId = StateTypeId("3f53e52e-1ad7-40e7-8080-76908e720cac"); StateTypeId tvInputSourceIndexStateTypeId = StateTypeId("e895017a-139f-410c-bfb2-4d008104e164"); StateTypeId tvInputSourceLabelNameStateTypeId = StateTypeId("58b734ec-2269-4c57-99e1-e1eeee401053"); ActionTypeId commandVolumeUpActionTypeId = ActionTypeId("ac5d7dcd-dfe8-4a94-9ab9-21b3f804b39e"); ActionTypeId commandVolumeDownActionTypeId = ActionTypeId("62b17bec-f461-4ffa-93d1-67a9430d55e1"); ActionTypeId commandMuteActionTypeId = ActionTypeId("1aa9d7f0-0f66-4b90-bb72-f6b7b2118221"); ActionTypeId commandUnmuteActionTypeId = ActionTypeId("b7e31999-ba67-443d-8e5c-ec104af987bd"); ActionTypeId commandChannelUpActionTypeId = ActionTypeId("acd1f6a0-2cfa-4665-9607-cf94245ec5a3"); ActionTypeId commandChannelDownActionTypeId = ActionTypeId("6ea66772-0e6d-40b1-978c-a01fb53871dd"); ActionTypeId commandPowerOffActionTypeId = ActionTypeId("cbe41134-ff11-4916-815b-3ac289c64090"); ActionTypeId commandArrowUpActionTypeId = ActionTypeId("57c483b4-4ddf-4470-828c-8d8767e7a923"); ActionTypeId commandArrowDownActionTypeId = ActionTypeId("614cf1af-5cf7-4bb2-885c-4414078d8899"); ActionTypeId commandArrowLeftActionTypeId = ActionTypeId("916394dd-7833-4875-8d7a-49d7d24ceeb2"); ActionTypeId commandArrowRightActionTypeId = ActionTypeId("01e3df1e-638b-4e14-ba85-660267766062"); ActionTypeId commandOkActionTypeId = ActionTypeId("257dfa59-0d38-4e18-a3fc-213809fdb12f"); ActionTypeId commandBackActionTypeId = ActionTypeId("ce4184b3-6b8e-4fc3-a4cb-7b8ec72f2ce9"); ActionTypeId commandHomeActionTypeId = ActionTypeId("33f941c1-f5fc-4449-b6e3-93eafca493e0"); ActionTypeId commandInputSourceActionTypeId = ActionTypeId("9a6e5111-95d3-49ac-8056-249e704b1509"); ActionTypeId commandExitActionTypeId = ActionTypeId("d76efdb8-056e-4b39-a839-2ef6d6001b00"); ActionTypeId commandInfoActionTypeId = ActionTypeId("9c1290d5-3135-4124-a576-fc7522cffdcf"); ActionTypeId commandMyAppsActionTypeId = ActionTypeId("47d65cac-fe75-4c36-9dee-9862c1c1130e"); ActionTypeId commandProgramListActionTypeId = ActionTypeId("9aa3a97e-505d-4906-9764-14b6dc4e31e8"); DevicePluginLgSmartTv::DevicePluginLgSmartTv() { } DeviceManager::HardwareResources DevicePluginLgSmartTv::requiredHardware() const { return DeviceManager::HardwareResourceTimer | DeviceManager::HardwareResourceUpnpDisovery | DeviceManager::HardwareResourceNetworkManager; } DeviceManager::DeviceError DevicePluginLgSmartTv::discoverDevices(const DeviceClassId &deviceClassId, const ParamList ¶ms) { Q_UNUSED(params) if(deviceClassId != lgSmartTvDeviceClassId){ return DeviceManager::DeviceErrorDeviceClassNotFound; } qCDebug(dcLgSmartTv) << "Start discovering"; upnpDiscover("udap:rootservice","UDAP/2.0"); return DeviceManager::DeviceErrorAsync; } DeviceManager::DeviceSetupStatus DevicePluginLgSmartTv::setupDevice(Device *device) { if (device->deviceClassId() != lgSmartTvDeviceClassId) { return DeviceManager::DeviceSetupStatusFailure; } TvDevice *tvDevice = new TvDevice(QHostAddress(device->paramValue("host address").toString()), device->paramValue("port").toInt(), this); tvDevice->setUuid(device->paramValue("uuid").toString()); // if the key is missing, this setup call comes from a pairing procedure if (device->paramValue("key") == QString()) { // check if we know the key from the pairing procedure if (!m_tvKeys.contains(device->paramValue("uuid").toString())) { qCWarning(dcLgSmartTv) << "could not find any pairing key"; return DeviceManager::DeviceSetupStatusFailure; } // use the key from the pairing procedure QString key = m_tvKeys.value(device->paramValue("uuid").toString()); tvDevice->setKey(key); device->setParamValue("key", key); } else { // add the key for editing if (!m_tvKeys.contains(device->paramValue("uuid").toString())) { m_tvKeys.insert(tvDevice->uuid(), tvDevice->key()); } } connect(tvDevice, &TvDevice::stateChanged, this, &DevicePluginLgSmartTv::stateChanged); m_tvList.insert(tvDevice, device); pairTvDevice(device, true); return DeviceManager::DeviceSetupStatusAsync; } void DevicePluginLgSmartTv::deviceRemoved(Device *device) { if (!m_tvList.values().contains(device)) { return; } TvDevice *tvDevice= m_tvList.key(device); qCDebug(dcLgSmartTv) << "Remove device" << device->name(); unpairTvDevice(device); m_tvList.remove(tvDevice); delete tvDevice; } void DevicePluginLgSmartTv::upnpDiscoveryFinished(const QList &upnpDeviceDescriptorList) { QList deviceDescriptors; foreach (UpnpDeviceDescriptor upnpDeviceDescriptor, upnpDeviceDescriptorList) { if (!upnpDeviceDescriptor.friendlyName().contains("LG") || !upnpDeviceDescriptor.deviceType().contains("TV")) continue; qCDebug(dcLgSmartTv) << upnpDeviceDescriptor; DeviceDescriptor descriptor(lgSmartTvDeviceClassId, "Lg Smart Tv", upnpDeviceDescriptor.modelName()); ParamList params; params.append(Param("name", upnpDeviceDescriptor.friendlyName())); params.append(Param("uuid", upnpDeviceDescriptor.uuid())); params.append(Param("model", upnpDeviceDescriptor.modelName())); params.append(Param("host address", upnpDeviceDescriptor.hostAddress().toString())); params.append(Param("port", upnpDeviceDescriptor.port())); params.append(Param("key", QString())); descriptor.setParams(params); deviceDescriptors.append(descriptor); } emit devicesDiscovered(lgSmartTvDeviceClassId, deviceDescriptors); } DeviceManager::DeviceError DevicePluginLgSmartTv::executeAction(Device *device, const Action &action) { TvDevice * tvDevice = m_tvList.key(device); if (!tvDevice->reachable()) { qCWarning(dcLgSmartTv) << "Device not reachable"; return DeviceManager::DeviceErrorHardwareNotAvailable; } if (action.actionTypeId() == commandVolumeUpActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::VolUp); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandVolumeDownActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::VolDown); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandMuteActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::Mute); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandChannelUpActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::ChannelUp); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandChannelDownActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::ChannelDown); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandPowerOffActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::Power); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandArrowUpActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::Up); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandArrowDownActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::Down); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandArrowLeftActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::Left); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandArrowRightActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::Right); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandOkActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::Ok); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandBackActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::Back); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandHomeActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::Home); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandInputSourceActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::ExternalInput); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandExitActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::Exit); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandInfoActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::Info); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandMyAppsActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::MyApps); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else if(action.actionTypeId() == commandProgramListActionTypeId) { QPair request = tvDevice->createPressButtonRequest(TvDevice::ProgramList); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_asyncActions.insert(reply, action.id()); } else { return DeviceManager::DeviceErrorActionTypeNotFound; } return DeviceManager::DeviceErrorAsync; } DeviceManager::DeviceError DevicePluginLgSmartTv::displayPin(const PairingTransactionId &pairingTransactionId, const DeviceDescriptor &deviceDescriptor) { Q_UNUSED(pairingTransactionId) QHostAddress host = QHostAddress(deviceDescriptor.params().paramValue("host address").toString()); int port = deviceDescriptor.params().paramValue("port").toInt(); QPair request = TvDevice::createDisplayKeyRequest(host, port); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_showPinReply.append(reply); return DeviceManager::DeviceErrorNoError; } DeviceManager::DeviceSetupStatus DevicePluginLgSmartTv::confirmPairing(const PairingTransactionId &pairingTransactionId, const DeviceClassId &deviceClassId, const ParamList ¶ms, const QString &secret) { Q_UNUSED(deviceClassId) QHostAddress host = QHostAddress(params.paramValue("host address").toString()); int port = params.paramValue("port").toInt(); QPair request = TvDevice::createPairingRequest(host, port, secret); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_setupPairingTv.insert(reply, pairingTransactionId); m_tvKeys.insert(params.paramValue("uuid").toString(), secret); return DeviceManager::DeviceSetupStatusAsync; } void DevicePluginLgSmartTv::networkManagerReplyReady(QNetworkReply *reply) { int status = reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt(); if (m_showPinReply.contains(reply)) { m_showPinReply.removeAll(reply); if (status != 200) { qCWarning(dcLgSmartTv) << "display pin on TV request error:" << status << reply->errorString(); } } else if (m_setupPairingTv.keys().contains(reply)) { PairingTransactionId pairingTransactionId = m_setupPairingTv.take(reply); if(status != 200) { qCWarning(dcLgSmartTv) << "pair TV request error:" << status << reply->errorString(); emit pairingFinished(pairingTransactionId, DeviceManager::DeviceSetupStatusFailure); } else { // End pairing before calling setupDevice, which will always try to pair QPair request = TvDevice::createEndPairingRequest(reply->request().url()); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_setupEndPairingTv.insert(reply, pairingTransactionId); } } else if (m_setupEndPairingTv.keys().contains(reply)) { PairingTransactionId pairingTransactionId = m_setupEndPairingTv.take(reply); if(status != 200) { qCWarning(dcLgSmartTv) << "end pairing TV request error:" << status << reply->errorString(); emit pairingFinished(pairingTransactionId, DeviceManager::DeviceSetupStatusFailure); } else { emit pairingFinished(pairingTransactionId, DeviceManager::DeviceSetupStatusSuccess); } } else if (m_asyncSetup.keys().contains(reply)) { Device *device = m_asyncSetup.take(reply); TvDevice *tv = m_tvList.key(device); if(status != 200) { qCWarning(dcLgSmartTv) << "Pair TV request error:" << status << reply->errorString(); tv->setPaired(false); emit deviceSetupFinished(device, DeviceManager::DeviceSetupStatusFailure); } else { qCDebug(dcLgSmartTv) << "Paired TV successfully."; tv->setPaired(true); refreshTv(device); emit deviceSetupFinished(device, DeviceManager::DeviceSetupStatusSuccess); } } else if (m_deleteTv.contains(reply)) { m_deleteTv.removeAll(reply); if(status != 200) { qCWarning(dcLgSmartTv) << "Rnd pairing TV (device deleted) request error:" << status << reply->errorString(); } else { qCDebug(dcLgSmartTv) << "End pairing TV (device deleted) successfully."; } } else if (m_volumeInfoRequests.keys().contains(reply)) { Device *device = m_volumeInfoRequests.take(reply); TvDevice *tv = m_tvList.key(device); if(status != 200) { tv->setReachable(false); qCWarning(dcLgSmartTv) << "Volume information request error:" << status << reply->errorString(); } else { tv->setReachable(true); tv->onVolumeInformationUpdate(reply->readAll()); } } else if (m_channelInfoRequests.keys().contains(reply)) { Device *device = m_channelInfoRequests.take(reply); TvDevice *tv = m_tvList.key(device); if(status != 200) { tv->setReachable(false); qCWarning(dcLgSmartTv) << "Channel information request error:" << status << reply->errorString(); } else { tv->setReachable(true); tv->onChannelInformationUpdate(reply->readAll()); } } else if (m_asyncActions.keys().contains(reply)) { ActionId actionId = m_asyncActions.value(reply); if(status != 200) { emit actionExecutionFinished(actionId, DeviceManager::DeviceErrorHardwareNotAvailable); qCWarning(dcLgSmartTv) << "Action request error:" << status << reply->errorString(); } else { emit actionExecutionFinished(actionId, DeviceManager::DeviceErrorNoError); } } reply->deleteLater(); } void DevicePluginLgSmartTv::guhTimer() { foreach (Device *device, m_tvList.values()) { TvDevice *tv = m_tvList.key(device); if (tv->paired()) { refreshTv(device); } else { pairTvDevice(device); } } } void DevicePluginLgSmartTv::pairTvDevice(Device *device, const bool &setup) { QHostAddress host = QHostAddress(device->paramValue("host address").toString()); int port = device->paramValue("port").toInt(); QString key = device->paramValue("key").toString(); QPair request = TvDevice::createPairingRequest(host, port, key); QNetworkReply *reply = networkManagerPost(request.first, request.second); if (setup) { m_asyncSetup.insert(reply, device); } else { m_pairRequests.insert(reply, device); } } void DevicePluginLgSmartTv::unpairTvDevice(Device *device) { QHostAddress host = QHostAddress(device->paramValue("host address").toString()); int port = device->paramValue("port").toInt(); QPair request = TvDevice::createEndPairingRequest(host, port); QNetworkReply *reply = networkManagerPost(request.first, request.second); m_deleteTv.append(reply); } void DevicePluginLgSmartTv::refreshTv(Device *device) { TvDevice *tv = m_tvList.key(device); // check volume information QNetworkReply *volumeReply = networkManagerGet(tv->createVolumeInformationRequest()); m_volumeInfoRequests.insert(volumeReply, device); // check channel information QNetworkReply *channelReply = networkManagerGet(tv->createChannelInformationRequest()); m_channelInfoRequests.insert(channelReply, device); } void DevicePluginLgSmartTv::stateChanged() { TvDevice *tvDevice = static_cast(sender()); Device *device = m_tvList.value(tvDevice); device->setStateValue(reachableStateTypeId, tvDevice->reachable()); device->setStateValue(tv3DModeStateTypeId, tvDevice->is3DMode()); device->setStateValue(tvVolumeLevelStateTypeId, tvDevice->volumeLevel()); device->setStateValue(tvMuteStateTypeId, tvDevice->mute()); device->setStateValue(tvChannelTypeStateTypeId, tvDevice->channelType()); device->setStateValue(tvChannelNameStateTypeId, tvDevice->channelName()); device->setStateValue(tvChannelNumberStateTypeId, tvDevice->channelNumber()); device->setStateValue(tvProgramNameStateTypeId, tvDevice->programName()); device->setStateValue(tvInputSourceIndexStateTypeId, tvDevice->inputSourceIndex()); device->setStateValue(tvInputSourceLabelNameStateTypeId, tvDevice->inputSourceLabelName()); }