From 2dbbc52892163cba54fec57247c11b4d84aa8959 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Fri, 10 Jan 2020 13:49:38 +0100 Subject: [PATCH] Add USB relay plugin --- nymea-plugins.pro | 1 + usbrelay/LICENSE | 503 ++++++++++++++++++ usbrelay/README.md | 4 + usbrelay/devicepluginusbrelay.cpp | 298 +++++++++++ usbrelay/devicepluginusbrelay.h | 58 ++ usbrelay/devicepluginusbrelay.json | 88 +++ usbrelay/rawhiddevicewatcher.cpp | 163 ++++++ usbrelay/rawhiddevicewatcher.h | 53 ++ ...4823d-0918-498e-87bc-6ae1a652538c-en_US.ts | 100 ++++ usbrelay/usbrelay.cpp | 188 +++++++ usbrelay/usbrelay.h | 77 +++ usbrelay/usbrelay.pro | 14 + 12 files changed, 1547 insertions(+) create mode 100644 usbrelay/LICENSE create mode 100644 usbrelay/README.md create mode 100644 usbrelay/devicepluginusbrelay.cpp create mode 100644 usbrelay/devicepluginusbrelay.h create mode 100644 usbrelay/devicepluginusbrelay.json create mode 100644 usbrelay/rawhiddevicewatcher.cpp create mode 100644 usbrelay/rawhiddevicewatcher.h create mode 100644 usbrelay/translations/ddb4823d-0918-498e-87bc-6ae1a652538c-en_US.ts create mode 100644 usbrelay/usbrelay.cpp create mode 100644 usbrelay/usbrelay.h create mode 100644 usbrelay/usbrelay.pro diff --git a/nymea-plugins.pro b/nymea-plugins.pro index b24bdf29..14118dbd 100644 --- a/nymea-plugins.pro +++ b/nymea-plugins.pro @@ -51,6 +51,7 @@ PLUGIN_DIRS = \ udpcommander \ unifi \ unitec \ + usbrelay \ wakeonlan \ wemo \ ws2812fx \ diff --git a/usbrelay/LICENSE b/usbrelay/LICENSE new file mode 100644 index 00000000..e8c3f505 --- /dev/null +++ b/usbrelay/LICENSE @@ -0,0 +1,503 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + diff --git a/usbrelay/README.md b/usbrelay/README.md new file mode 100644 index 00000000..2116b91f --- /dev/null +++ b/usbrelay/README.md @@ -0,0 +1,4 @@ +# usbrelay +-------------------------------- + +Description of the plugin... diff --git a/usbrelay/devicepluginusbrelay.cpp b/usbrelay/devicepluginusbrelay.cpp new file mode 100644 index 00000000..1d8728bd --- /dev/null +++ b/usbrelay/devicepluginusbrelay.cpp @@ -0,0 +1,298 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * * + * Copyright (C) 2019 Simon Stürz * + * * + * This file is part of nymea. * + * * + * This library is free software; you can redistribute it and/or * + * modify it under the terms of the GNU Lesser General Public * + * License as published by the Free Software Foundation; either * + * version 2.1 of the License, or (at your option) any later version. * + * * + * This library 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 * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this library; If not, see * + * . * + * * + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#include "plugininfo.h" +#include "devicepluginusbrelay.h" + +#include +#include + +DevicePluginUsbRelay::DevicePluginUsbRelay() +{ + +} + +void DevicePluginUsbRelay::init() +{ + // Initialize/create objects +} + +void DevicePluginUsbRelay::startMonitoringAutoDevices() +{ + // Start seaching for devices which can be discovered and added automatically +} + +void DevicePluginUsbRelay::postSetupDevice(Device *device) +{ + qCDebug(dcUsbRelay()) << "Post setup device" << device; + + if (device->deviceClassId() == usbRelayConnectorDeviceClassId) { + + // Initialize the states + UsbRelay *relay = m_relayDevices.key(device); + if (!relay) { + qCWarning(dcUsbRelay()) << "Could not find relay in post setup."; + return; + } + + device->setStateValue(usbRelayConnectorConnectedStateTypeId, relay->connected()); + + // Check if we have to create child devices (relays) + if (myDevices().filterByParentDeviceId(device->id()).isEmpty()) { + + DeviceDescriptors descriptors; + for (int i = 0; i < relay->relayCount(); i++) { + int relayNumber = i + 1; + DeviceDescriptor descriptor(usbRelayDeviceClassId, QString("Relay %1").arg(relayNumber), QString(), device->id()); + ParamList params; + params.append(Param(usbRelayDeviceRelayNumberParamTypeId, relayNumber)); + descriptor.setParams(params); + descriptors.append(descriptor); + } + + emit autoDevicesAppeared(descriptors); + } + } else if (device->deviceClassId() == usbRelayDeviceClassId) { + + UsbRelay *relay = getRelayForDevice(device); + if (!relay) return; + + // Set the current states + int relayNumber = device->paramValue(usbRelayDeviceRelayNumberParamTypeId).toInt(); + device->setStateValue(usbRelayConnectedStateTypeId, relay->connected()); + device->setStateValue(usbRelayPowerStateTypeId, relay->relayPower(relayNumber)); + } +} + +void DevicePluginUsbRelay::deviceRemoved(Device *device) +{ + qCDebug(dcUsbRelay()) << "Remove device" << device; + if (device->deviceClassId() == usbRelayConnectorDeviceClassId) { + UsbRelay *relay = m_relayDevices.key(device); + if (!relay) return; + m_relayDevices.remove(relay); + relay->deleteLater(); + } +} + +void DevicePluginUsbRelay::discoverDevices(DeviceDiscoveryInfo *info) +{ + // Init + if (hid_init() < 0) { + qCWarning(dcUsbRelay()) << "Could not initialize HID."; + info->finish(Device::DeviceErrorHardwareFailure, QT_TR_NOOP("Cannot discover USB devices. HID initialisation failed on this system.")); + return; + } + + // Enumerate hid devices + struct hid_device_info *devices = nullptr; + struct hid_device_info *currentDevice = nullptr; + devices = hid_enumerate(0x16c0, 0x05df); + int relayCount = 0; + currentDevice = devices; + + for (relayCount = 0; currentDevice != nullptr; relayCount++) { + currentDevice = currentDevice->next; + } + + qCDebug(dcUsbRelay()) << "Found" << relayCount << "usb relay devices"; + currentDevice = devices; + for (int i = 0; i < relayCount; i++) { + QString path = QString::fromLatin1(currentDevice->path); + QString manufacturer = QString::fromWCharArray(currentDevice->manufacturer_string); + QString product = QString::fromWCharArray(currentDevice->product_string); + QString serialnumber = QString::fromWCharArray(currentDevice->serial_number); + quint16 releaseNumber = static_cast(currentDevice->release_number); + quint16 productId = static_cast(currentDevice->product_id); + quint16 vendorId = static_cast(currentDevice->vendor_id); + int relayCount = QString(product.at(product.count() -1)).toInt(); + + qCDebug(dcUsbRelay()) << path << manufacturer << product << serialnumber << "Relay count" << relayCount << QString("%1:%2").arg(QString::number(vendorId, 16)).arg(QString::number(productId, 16)) << releaseNumber; + + // Open it to get more details + hid_device *hidDevice = nullptr; + hidDevice = hid_open_path(currentDevice->path); + if (!hidDevice) { + qCWarning(dcUsbRelay()) << "Could not create HID device for" << path; + continue; + } + + unsigned char buf[9]; + buf[0] = 0x01; + int ret = hid_get_feature_report(hidDevice, buf, sizeof(buf)); + if (ret < 0) { + qCWarning(dcUsbRelay()) << "Could not create HID device hidDevice for" << path; + continue; + } + + quint8 relayStatus = static_cast(buf[7]); + for (int i = 0; i < relayCount; i++) { + int relayNumber = i + 1; + bool power = static_cast(relayStatus & 1 << i); + qCDebug(dcUsbRelay()) << "--> Relay" << relayNumber << ":" << power; + } + + hid_close(hidDevice); + + DeviceDescriptor descriptor(usbRelayConnectorDeviceClassId, "USB Relay Connector", QString("%1 (%2)").arg(product).arg(path)); + ParamList params; + params.append(Param(usbRelayConnectorDevicePathParamTypeId, path)); + params.append(Param(usbRelayConnectorDeviceRelayCountParamTypeId, relayCount)); + descriptor.setParams(params); + + // Set the current device id if we already have a device on this path + foreach (Device *existingDevice, myDevices()) { + if (existingDevice->paramValue(usbRelayConnectorDevicePathParamTypeId).toString() == path && + existingDevice->paramValue(usbRelayConnectorDeviceRelayCountParamTypeId).toInt() == relayCount) { + descriptor.setDeviceId(existingDevice->id()); + break; + } + } + info->addDeviceDescriptor(descriptor); + } + + hid_free_enumeration(devices); + hid_exit(); + + info->finish(Device::DeviceErrorNoError); +} + +void DevicePluginUsbRelay::setupDevice(DeviceSetupInfo *info) +{ + qCDebug(dcUsbRelay()) << "Setup device" << info->device(); + + // Relay connector + if (info->device()->deviceClassId() == usbRelayConnectorDeviceClassId) { + Device *device = info->device(); + QString path = device->paramValue(usbRelayConnectorDevicePathParamTypeId).toString(); + int relayCount = device->paramValue(usbRelayConnectorDeviceRelayCountParamTypeId).toInt(); + + UsbRelay *relay = new UsbRelay(path, relayCount, this); + m_relayDevices.insert(relay, device); + + connect(relay, &UsbRelay::connectedChanged, [this, device, relay](bool connected) { + qCDebug(dcUsbRelay()) << "Device" << device->name() << (connected ? "connected" : "disconnected"); + device->setStateValue(usbRelayConnectorConnectedStateTypeId, connected); + + // Set the connected state of all child devices + foreach (Device *childDevice, myDevices().filterByParentDeviceId(device->id())) { + if (childDevice->deviceClassId() == usbRelayDeviceClassId && childDevice->setupComplete()) { + childDevice->setStateValue(usbRelayConnectedStateTypeId, connected); + if (connected) { + childDevice->setStateValue(usbRelayPowerStateTypeId, relay->relayPower(childDevice->paramValue(usbRelayDeviceRelayNumberParamTypeId).toInt())); + } + } + } + }); + + connect(relay, &UsbRelay::relayPowerChanged, [this, device](int relayNumber, bool power) { + Device *relayDevice = getRelayDevice(device, relayNumber); + if (!relayDevice) { + // Note: probably not set up yet + qCWarning(dcUsbRelay()) << "Could not find USB relay child device for" << device << relayNumber; + return; + } + + relayDevice->setStateValue(usbRelayPowerStateTypeId, power); + }); + + info->finish(Device::DeviceErrorNoError); + return; + } + + // Relay + if (info->device()->deviceClassId() == usbRelayDeviceClassId) { + info->finish(Device::DeviceErrorNoError); + return; + } + + info->finish(Device::DeviceErrorSetupFailed); +} + +void DevicePluginUsbRelay::executeAction(DeviceActionInfo *info) +{ + qCDebug(dcUsbRelay()) << "Executing action for device" << info->device() << info->action().actionTypeId().toString() << info->action().params(); + + if (info->device()->deviceClassId() == usbRelayDeviceClassId) { + + Device *device = info->device(); + UsbRelay *relay = getRelayForDevice(device); + + if (!relay) { + qCWarning(dcUsbRelay()) << "Could execute action because could not find USB relay for" << device; + info->finish(Device::DeviceErrorHardwareNotAvailable); + return; + } + + if (!relay->connected()) { + qCWarning(dcUsbRelay()) << "Relay is not connected"; + info->finish(Device::DeviceErrorHardwareNotAvailable); + return; + } + + int relayNumber = device->paramValue(usbRelayDeviceRelayNumberParamTypeId).toInt(); + + if (info->action().actionTypeId() == usbRelayPowerActionTypeId) { + bool power = info->action().param(usbRelayPowerActionPowerParamTypeId).value().toBool(); + if (!relay->setRelayPower(relayNumber, power)) { + info->finish(Device::DeviceErrorHardwareFailure); + return; + } + info->finish(Device::DeviceErrorNoError); + return; + } + + info->finish(Device::DeviceErrorActionTypeNotFound); + } + + info->finish(Device::DeviceErrorDeviceClassNotFound); +} + +Device *DevicePluginUsbRelay::getRelayDevice(Device *parentDevice, int relayNumber) +{ + foreach (Device *childDevice, myDevices().filterByParentDeviceId(parentDevice->id())) { + if (childDevice->deviceClassId() == usbRelayDeviceClassId) { + if (childDevice->paramValue(usbRelayDeviceRelayNumberParamTypeId).toInt() == relayNumber) { + return childDevice; + } + } + } + + return nullptr; +} + +UsbRelay *DevicePluginUsbRelay::getRelayForDevice(Device *relayDevice) +{ + Device *parentDevice = myDevices().findById(relayDevice->parentId()); + if (!parentDevice) { + qCWarning(dcUsbRelay()) << "Could not find the parent device for" << relayDevice; + return nullptr; + } + + UsbRelay *relay = m_relayDevices.key(parentDevice); + if (!relay) { + qCWarning(dcUsbRelay()) << "Could not find USB relay for" << relayDevice; + return nullptr; + } + + return relay; +} diff --git a/usbrelay/devicepluginusbrelay.h b/usbrelay/devicepluginusbrelay.h new file mode 100644 index 00000000..d477468e --- /dev/null +++ b/usbrelay/devicepluginusbrelay.h @@ -0,0 +1,58 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * * + * Copyright (C) 2019 Simon Stürz * + * * + * This file is part of nymea. * + * * + * This library is free software; you can redistribute it and/or * + * modify it under the terms of the GNU Lesser General Public * + * License as published by the Free Software Foundation; either * + * version 2.1 of the License, or (at your option) any later version. * + * * + * This library 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 * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this library; If not, see * + * . * + * * + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#ifndef DEVICEPLUGINUSBRELAY_H +#define DEVICEPLUGINUSBRELAY_H + +#include "usbrelay.h" +#include "devices/deviceplugin.h" + +class DevicePluginUsbRelay: public DevicePlugin +{ + Q_OBJECT + + Q_PLUGIN_METADATA(IID "io.nymea.DevicePlugin" FILE "devicepluginusbrelay.json") + Q_INTERFACES(DevicePlugin) + + +public: + explicit DevicePluginUsbRelay(); + + void init() override; + void startMonitoringAutoDevices() override; + void postSetupDevice(Device *device) override; + void deviceRemoved(Device *device) override; + + void discoverDevices(DeviceDiscoveryInfo *info) override; + void setupDevice(DeviceSetupInfo *info) override; + void executeAction(DeviceActionInfo *info) override; + +private: + QHash m_relayDevices; + + Device *getRelayDevice(Device *parentDevice, int relayNumber); + UsbRelay *getRelayForDevice(Device *relayDevice); +private slots: + +}; + +#endif // DEVICEPLUGINUSBRELAY_H diff --git a/usbrelay/devicepluginusbrelay.json b/usbrelay/devicepluginusbrelay.json new file mode 100644 index 00000000..a388ff48 --- /dev/null +++ b/usbrelay/devicepluginusbrelay.json @@ -0,0 +1,88 @@ +{ + "name": "UsbRelay", + "displayName": "USB relay", + "id": "ed0035d3-561c-498e-bdb2-2b574cbd0a2f", + "vendors": [ + { + "displayName": "USB Relay", + "name": "usbrelay", + "id": "d699b81a-621a-4db6-a137-6adbb5c9c091", + "deviceClasses": [ + { + "name": "usbRelayConnector", + "displayName": "USB Relay Connector", + "id": "f48ff4db-d207-4221-963a-3fcb635102d8", + "setupMethod": "JustAdd", + "createMethods": ["Discovery"], + "interfaces": [ "gateway" ], + "paramTypes": [ + { + "id": "a9fffbb9-f1c3-439c-9168-8c3fdfab29c8", + "name": "path", + "displayName": "System path", + "type": "QString", + "defaultValue": "" + }, + { + "id": "406e1396-e3a3-4200-9045-2146381041b3", + "name": "relayCount", + "displayName": "Relay count", + "type": "uint", + "defaultValue": 2 + } + ], + "stateTypes": [ + { + "id": "4cb1cf1f-76fd-4a9c-9397-b5f07b123050", + "name": "connected", + "displayName": "Connected", + "displayNameEvent": "Connected changed", + "type": "bool", + "defaultValue": false + } + ] + }, + { + "name": "usbRelay", + "displayName": "USB Relay", + "id": "6e01190d-ed9e-4dab-97d1-dc357c740db8", + "setupMethod": "JustAdd", + "createMethods": ["Auto"], + "interfaces": [ "power", "connectable" ], + "paramTypes": [ + { + "id": "48d6e667-643f-4f9f-ae12-5308d23a36d7", + "name": "relayNumber", + "displayName": "Relay number", + "type": "uint", + "defaultValue": 1 + } + ], + "stateTypes": [ + { + "id": "fd5338f8-f02b-4f99-8677-365cfc98221d", + "name": "connected", + "displayName": "Connected", + "displayNameEvent": "Connected changed", + "type": "bool", + "defaultValue": false + }, + { + "id": "b22ec763-cb41-4d1b-846d-7b2cbe5e433d", + "name": "power", + "displayName": "Power", + "displayNameEvent": "Power", + "displayNameAction": "Set power", + "type": "bool", + "defaultValue": false, + "writable": true + } + ] + } + ] + } + ] +} + + + diff --git a/usbrelay/rawhiddevicewatcher.cpp b/usbrelay/rawhiddevicewatcher.cpp new file mode 100644 index 00000000..7534aa6a --- /dev/null +++ b/usbrelay/rawhiddevicewatcher.cpp @@ -0,0 +1,163 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * * + * Copyright (C) 2019 Simon Stürz * + * * + * This file is part of nymea. * + * * + * This library is free software; you can redistribute it and/or * + * modify it under the terms of the GNU Lesser General Public * + * License as published by the Free Software Foundation; either * + * version 2.1 of the License, or (at your option) any later version. * + * * + * This library 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 * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this library; If not, see * + * . * + * * + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#include "rawhiddevicewatcher.h" +#include "extern-plugininfo.h" + +RawHidDeviceWatcher::RawHidDeviceWatcher(QObject *parent) : QObject(parent) +{ + m_udev = udev_new(); + if (!m_udev) { + qCWarning(dcUsbRelay()) << "Could not initialize udev"; + return; + } + + // Create udev monitor + m_monitor = udev_monitor_new_from_netlink(m_udev, "udev"); + if (!m_monitor) { + qCWarning(dcUsbRelay()) << "Could not initialize udev monitor."; + udev_unref(m_udev); + m_udev = nullptr; + return; + } + + // Set monitor filter to USB subsystem + if (udev_monitor_filter_add_match_subsystem_devtype(m_monitor, "hidraw", nullptr) < 0) { + qCWarning(dcUsbRelay()) << "Could not set seubsystem device type filter to usb_device."; + udev_monitor_unref(m_monitor); + m_monitor = nullptr; + udev_unref(m_udev); + m_udev = nullptr; + return; + } + + // Enable the monitor + if (udev_monitor_enable_receiving(m_monitor) < 0) { + qCWarning(dcUsbRelay()) << "Could not enable udev monitor."; + udev_monitor_unref(m_monitor); + m_monitor = nullptr; + udev_unref(m_udev); + m_udev = nullptr; + return; + } + + // Read initially all devices + struct udev_enumerate *enumerate; + struct udev_list_entry *devices, *dev_list_entry; + enumerate = udev_enumerate_new(m_udev); + if (!enumerate) { + qCWarning(dcUsbRelay()) << "Could not create udev enumerate for initial device reading."; + udev_monitor_unref(m_monitor); + m_monitor = nullptr; + udev_unref(m_udev); + m_udev = nullptr; + return; + } + + + udev_enumerate_add_match_subsystem(enumerate, "hidraw"); + udev_enumerate_scan_devices(enumerate); + + devices = udev_enumerate_get_list_entry(enumerate); + if (!devices) { + qCWarning(dcUsbRelay()) << "Failed to get hidraw devices from udev enumerate."; + udev_monitor_unref(m_monitor); + m_monitor = nullptr; + udev_unref(m_udev); + m_udev = nullptr; + return; + } + + udev_list_entry_foreach(dev_list_entry, devices) { + struct udev_device *device; + const char *path; + path = udev_list_entry_get_name(dev_list_entry); + device = udev_device_new_from_syspath(m_udev, path); + + QString devicePath = QString::fromLatin1(udev_device_get_property_value(device,"DEVNAME")); + udev_device_unref(device); + + qCDebug(dcUsbRelay()) << "[+]" << devicePath; + m_devicePaths.append(devicePath); + emit deviceAdded(devicePath); + } + + udev_enumerate_unref(enumerate); + + // Create socket notifier for read + m_notifier = new QSocketNotifier(udev_monitor_get_fd(m_monitor), QSocketNotifier::Read, this ); + connect(m_notifier, &QSocketNotifier::activated, this, [this](int socket){ + + Q_UNUSED(socket) + + // Create udev device + udev_device *device = udev_monitor_receive_device(m_monitor); + if (!device) { + qCWarning(dcUsbRelay()) << "Got socket sotification but could not read device information."; + return; + } + + QString actionString = QString::fromLatin1(udev_device_get_action(device)); + QString devicePath = QString::fromLatin1(udev_device_get_property_value(device,"DEVNAME")); + + // Clean udev device + udev_device_unref(device); + + if (actionString.isEmpty()) + return; + + if (actionString == "add") { + qCDebug(dcUsbRelay()) << "[+]" << devicePath; + if (!m_devicePaths.contains(devicePath)) { + m_devicePaths.append(devicePath); + emit deviceAdded(devicePath); + } + } + + if (actionString == "remove") { + qCDebug(dcUsbRelay()) << "[-]" << devicePath; + if (m_devicePaths.contains(devicePath)) { + m_devicePaths.removeAll(devicePath); + emit deviceRemoved(devicePath); + } + } + + }); + + m_notifier->setEnabled(true); + qCDebug(dcUsbRelay()) << "Usb device watcher initialized successfully."; +} + +RawHidDeviceWatcher::~RawHidDeviceWatcher() +{ + if (m_monitor) + udev_monitor_unref(m_monitor); + + if (m_udev) + udev_unref(m_udev); +} + +QStringList RawHidDeviceWatcher::devicePaths() const +{ + return m_devicePaths; +} + diff --git a/usbrelay/rawhiddevicewatcher.h b/usbrelay/rawhiddevicewatcher.h new file mode 100644 index 00000000..22636e83 --- /dev/null +++ b/usbrelay/rawhiddevicewatcher.h @@ -0,0 +1,53 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * * + * Copyright (C) 2019 Simon Stürz * + * * + * This file is part of nymea. * + * * + * This library is free software; you can redistribute it and/or * + * modify it under the terms of the GNU Lesser General Public * + * License as published by the Free Software Foundation; either * + * version 2.1 of the License, or (at your option) any later version. * + * * + * This library 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 * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this library; If not, see * + * . * + * * + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#ifndef USBDEVICEWATCHER_H +#define USBDEVICEWATCHER_H + +#include +#include +#include + +#include + +class RawHidDeviceWatcher : public QObject +{ + Q_OBJECT +public: + explicit RawHidDeviceWatcher(QObject *parent = nullptr); + ~RawHidDeviceWatcher(); + + QStringList devicePaths() const; + +private: + struct udev *m_udev = nullptr; + struct udev_monitor *m_monitor = nullptr; + QSocketNotifier *m_notifier = nullptr; + QStringList m_devicePaths; + +signals: + void deviceAdded(const QString &devicePath); + void deviceRemoved(const QString &devicePath); + +}; + +#endif // USBDEVICEWATCHER_H diff --git a/usbrelay/translations/ddb4823d-0918-498e-87bc-6ae1a652538c-en_US.ts b/usbrelay/translations/ddb4823d-0918-498e-87bc-6ae1a652538c-en_US.ts new file mode 100644 index 00000000..9cb782af --- /dev/null +++ b/usbrelay/translations/ddb4823d-0918-498e-87bc-6ae1a652538c-en_US.ts @@ -0,0 +1,100 @@ + + + + + MaveoUsbRelay + + + + Connected + The name of the ParamType (DeviceClass: usbRelay, EventType: connected, ID: {ccb0ab2e-5507-4742-b2e0-0cd2aec95df6}) +---------- +The name of the StateType ({ccb0ab2e-5507-4742-b2e0-0cd2aec95df6}) of DeviceClass usbRelay + + + + + Connected changed + The name of the EventType ({ccb0ab2e-5507-4742-b2e0-0cd2aec95df6}) of DeviceClass usbRelay + + + + + Impulse relay 1 + The name of the ActionType ({35590728-12ff-4afe-a6be-7ba69ce81b63}) of DeviceClass usbRelay + + + + + Impulse relay 2 + The name of the ActionType ({63bfdae2-1c0f-4548-81cd-f64be5303f20}) of DeviceClass usbRelay + + + + + Maveo USB Relay + The name of the DeviceClass ({942a187f-bdec-4527-8696-45d4891e7d6b}) + + + + + Maveo USB relay + The name of the plugin MaveoUsbRelay ({ddb4823d-0918-498e-87bc-6ae1a652538c}) + + + + + + + + Power relay 1 + The name of the ParamType (DeviceClass: usbRelay, ActionType: powerOne, ID: {39d85190-739f-474f-b04c-e0627d681bb2}) +---------- +The name of the ParamType (DeviceClass: usbRelay, EventType: powerOne, ID: {39d85190-739f-474f-b04c-e0627d681bb2}) +---------- +The name of the EventType ({39d85190-739f-474f-b04c-e0627d681bb2}) of DeviceClass usbRelay +---------- +The name of the StateType ({39d85190-739f-474f-b04c-e0627d681bb2}) of DeviceClass usbRelay + + + + + + + + Power relay 2 + The name of the ParamType (DeviceClass: usbRelay, ActionType: powerTwo, ID: {294376f7-7d21-4989-8803-ad5bffe08c48}) +---------- +The name of the ParamType (DeviceClass: usbRelay, EventType: powerTwo, ID: {294376f7-7d21-4989-8803-ad5bffe08c48}) +---------- +The name of the EventType ({294376f7-7d21-4989-8803-ad5bffe08c48}) of DeviceClass usbRelay +---------- +The name of the StateType ({294376f7-7d21-4989-8803-ad5bffe08c48}) of DeviceClass usbRelay + + + + + Set power relay 1 + The name of the ActionType ({39d85190-739f-474f-b04c-e0627d681bb2}) of DeviceClass usbRelay + + + + + Set power relay 2 + The name of the ActionType ({294376f7-7d21-4989-8803-ad5bffe08c48}) of DeviceClass usbRelay + + + + + System path + The name of the ParamType (DeviceClass: usbRelay, Type: device, ID: {a3644b93-1c37-472e-9303-a116feb33067}) + + + + + maveo + The name of the vendor ({e77e72ae-1228-42a3-85cd-34c6f3a8d494}) + + + + diff --git a/usbrelay/usbrelay.cpp b/usbrelay/usbrelay.cpp new file mode 100644 index 00000000..a7c43116 --- /dev/null +++ b/usbrelay/usbrelay.cpp @@ -0,0 +1,188 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * * + * Copyright (C) 2019 Simon Stürz * + * * + * This file is part of nymea. * + * * + * This library is free software; you can redistribute it and/or * + * modify it under the terms of the GNU Lesser General Public * + * License as published by the Free Software Foundation; either * + * version 2.1 of the License, or (at your option) any later version. * + * * + * This library 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 * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this library; If not, see * + * . * + * * + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#include "usbrelay.h" +#include "extern-plugininfo.h" + +UsbRelay::UsbRelay(const QString &path, int relayCount, QObject *parent) : + QObject(parent), + m_path(path), + m_relayCount(relayCount) +{ + m_deviceWatcher = new RawHidDeviceWatcher(this); + + connect(m_deviceWatcher, &RawHidDeviceWatcher::deviceAdded, this, &UsbRelay::onDeviceAdded); + connect(m_deviceWatcher, &RawHidDeviceWatcher::deviceRemoved, this, &UsbRelay::onDeviceRemoved); + + if (m_deviceWatcher->devicePaths().contains(m_path)) { + setConnected(true); + } + + // Create initial relay map + for (int i = 0; i < m_relayCount; i++) { + m_relayMap.insert(i + 1, false); + } +} + +UsbRelay::~UsbRelay() +{ + if (m_hidDevice) + hid_close(m_hidDevice); + + hid_exit(); +} + +QString UsbRelay::path() const +{ + return m_path; +} + +int UsbRelay::relayCount() const +{ + return m_relayCount; +} + +bool UsbRelay::connected() const +{ + return m_connected; +} + +bool UsbRelay::relayPower(int relayNumber) const +{ + return m_relayMap[relayNumber]; +} + +bool UsbRelay::setRelayPower(int relayNumber, bool power) +{ + if (!m_connected) { + qCWarning(dcUsbRelay()) << "Could not set power of relay" << relayNumber << "because the device is not connected."; + return false; + } + + if (relayNumber > m_relayCount) { + qCWarning(dcUsbRelay()) << "Could not set power of relay power because the relay number is invalid" << relayNumber << ">" << m_relayCount; + return false; + } + + return switchRelay(relayNumber, power); +} + +void UsbRelay::setConnected(bool connected) +{ + if (m_connected == connected) + return; + + qCDebug(dcUsbRelay()) << m_path << (connected ? "connected" : "disconnected"); + if (connected) { + // Initialize the device + m_hidDevice = hid_open_path(m_path.toLatin1().data()); + if (!m_hidDevice) { + qCWarning(dcUsbRelay()) << "Could nor open HID device for" << m_path; + m_connected = false; + emit connectedChanged(m_connected); + } + + readStatus(); + + } else { + // Deinitialize + if (m_hidDevice) { + hid_close(m_hidDevice); + m_hidDevice = nullptr; + hid_exit(); + } + } + + m_connected = connected; + emit connectedChanged(m_connected); +} + +void UsbRelay::setRelayPowerInternally(int relayNumber, bool power) +{ + if (m_relayMap[relayNumber] == power) + return; + + qCDebug(dcUsbRelay()) << "Relay power changed" << relayNumber << power; + m_relayMap[relayNumber] = power; + emit relayPowerChanged(relayNumber, power); +} + +void UsbRelay::readStatus() +{ + qCDebug(dcUsbRelay()) << "Read relay status of" << m_path; + unsigned char buf[9]; + buf[0] = 0x01; + int ret = hid_get_feature_report(m_hidDevice, buf, sizeof(buf)); + if (ret < 0) { + qCWarning(dcUsbRelay()) << "Could not create HID device for reading" << m_path; + hid_close(m_hidDevice); + m_hidDevice = nullptr; + + m_connected = false; + emit connectedChanged(m_connected); + return; + } + + quint8 relayStatus = static_cast(buf[7]); + + for (int i = 0; i < m_relayCount; i++) { + int relayNumber = i + 1; + bool power = static_cast(relayStatus & 1 << i); + qCDebug(dcUsbRelay()) << "--> Relay" << relayNumber << power; + setRelayPowerInternally(relayNumber, power); + } +} + +bool UsbRelay::switchRelay(int relayNumber, bool power) +{ + if (!m_hidDevice) { + qCWarning(dcUsbRelay()) << "Cannot switch power for" << m_path << "because there is no HID device."; + return false; + } + + unsigned char buf[9]; // 1 extra byte for the report ID + memset(buf, 0x00, sizeof (buf)); + buf[1] = power ? 0xff : 0xfd; + buf[2] = static_cast(relayNumber); // Relay number + + if (hid_write(m_hidDevice, buf, sizeof(buf)) <= 0) { + qCWarning(dcUsbRelay()) << "Cannot switch power for" << m_path << "because could not write to HID device."; + return false; + } + + readStatus(); + return true; +} + +void UsbRelay::onDeviceAdded(const QString &devicePath) +{ + if (devicePath == m_path) { + setConnected(true); + } +} + +void UsbRelay::onDeviceRemoved(const QString &devicePath) +{ + if (devicePath == m_path) { + setConnected(false); + } +} diff --git a/usbrelay/usbrelay.h b/usbrelay/usbrelay.h new file mode 100644 index 00000000..a2a3bad8 --- /dev/null +++ b/usbrelay/usbrelay.h @@ -0,0 +1,77 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * * + * Copyright (C) 2019 Simon Stürz * + * * + * This file is part of nymea. * + * * + * This library is free software; you can redistribute it and/or * + * modify it under the terms of the GNU Lesser General Public * + * License as published by the Free Software Foundation; either * + * version 2.1 of the License, or (at your option) any later version. * + * * + * This library 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 * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this library; If not, see * + * . * + * * + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#ifndef USBRELAY_H +#define USBRELAY_H + +#include +#include + +#include "rawhiddevicewatcher.h" + +class UsbRelay : public QObject +{ + Q_OBJECT +public: + explicit UsbRelay(const QString &path, int relayCount, QObject *parent = nullptr); + ~UsbRelay(); + + QString path() const; + int relayCount() const; + + bool connected() const; + + bool relayPower(int relayNumber) const; + bool setRelayPower(int relayNumber, bool power); + +private: + RawHidDeviceWatcher *m_deviceWatcher = nullptr; + hid_device *m_hidDevice = nullptr; + + QString m_path; + int m_relayCount = 0; + bool m_connected = false; + bool m_relayOnePower = false; + bool m_relayTwoPower = false; + + void setConnected(bool connected); + + // Relay map , bool value + QHash m_relayMap; + + void setRelayPowerInternally(int relayNumber, bool power); + + void readStatus(); + + bool switchRelay(int relayNumber, bool power); + +signals: + void connectedChanged(bool connected); + void relayPowerChanged(int relayNumber, bool power); + +private slots: + void onDeviceAdded(const QString &devicePath); + void onDeviceRemoved(const QString &devicePath); + +}; + +#endif // USBRELAY_H diff --git a/usbrelay/usbrelay.pro b/usbrelay/usbrelay.pro new file mode 100644 index 00000000..9c0827ac --- /dev/null +++ b/usbrelay/usbrelay.pro @@ -0,0 +1,14 @@ +include(../plugins.pri) + +PKGCONFIG += hidapi-hidraw libudev + +SOURCES += \ + devicepluginusbrelay.cpp \ + rawhiddevicewatcher.cpp \ + usbrelay.cpp + +HEADERS += \ + devicepluginusbrelay.h \ + rawhiddevicewatcher.h \ + usbrelay.h +