torc1wirebus.cpp

Go to the documentation of this file.

/* Class Torc1WireBus
*
* This file is part of the Torc project.
*
* Copyright (C) Mark Kendall 2014-18
*
* This program 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; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
* USA.
*/

// Qt
#include <QDir>

// Torc
#include "torclogging.h"
#include "torcadminthread.h"
#include "torcinputs.h"
#include "torc1wirebus.h"
#include "torc1wireds18b20.h"

Torc1WireBus* Torc1WireBus::gTorc1WireBus = new Torc1WireBus();

Torc1WireBus::Torc1WireBus()
  : TorcDeviceHandler(),
    m_inputs()
{
}

void Torc1WireBus::Create(const QVariantMap &Details)
{
    QWriteLocker locker(&m_handlerLock);

    // check for the correct directory
    QDir dir(ONE_WIRE_DIRECTORY);
    bool wire1found = dir.exists();

    QVariantMap::const_iterator i = Details.constBegin();
    for ( ; i != Details.constEnd(); ++i)
    {
        // we look for 1Wire devices in <inputs>
        if (i.key() != INPUTS_DIRECTORY)
            continue;

        QVariantMap wire1 = i.value().toMap();
        QVariantMap::iterator it = wire1.begin();
        for ( ; it != wire1.end(); ++it)
        {
            // now we're looking for <wire1>
            // N.B. XML doesn't allow element names to begin with numeric characters - hence wire1

            if (it.key() == ONE_WIRE_NAME)
            {
                // we have found a 1wire device config - make sure 1wire is available
                if (!wire1found)
                {
                    LOG(VB_GENERAL, LOG_ERR, QStringLiteral("1Wire device configured but cannot find 1Wire directory (%1)").arg(ONE_WIRE_DIRECTORY));
                    return;
                }

                QVariantMap devices = it.value().toMap();
                QVariantMap::iterator it2 = devices.begin();
                for ( ; it2 != devices.end(); ++it2)
                {
                    QString devicetype  = it2.key();
                    QVariantMap details = it2.value().toMap();

                    // a 1Wire device must have the <id> field
                    if (!details.contains(QStringLiteral("wire1serial")))
                    {
                        LOG(VB_GENERAL, LOG_ERR, QStringLiteral("Cannot create 1Wire device without unique 1Wire ID ('%1' '%2')")
                            .arg(devicetype, details.value(QStringLiteral("name")).toString()));
                    }
                    else
                    {
                        TorcInput* device = nullptr;
                        Torc1WireDeviceFactory* factory = Torc1WireDeviceFactory::GetTorc1WireDeviceFactory();
                        for ( ; factory; factory = factory->NextFactory())
                        {
                            device = factory->Create(devicetype, details);
                            if (device)
                                break;
                        }

                        if (device)
                        {
                            QString deviceid = details.value(QStringLiteral("wire1serial")).toString();
                            LOG(VB_GENERAL, LOG_INFO, QStringLiteral("New 1Wire device: %1").arg(deviceid));
                            m_inputs.insert(deviceid, device);
                        }
                        else
                        {
                            LOG(VB_GENERAL, LOG_WARNING, QStringLiteral("Unable to find handler for 1Wire device type '%1'").arg(devicetype));
                        }
                    }

                }
            }
        }
    }
}

void Torc1WireBus::Destroy(void)
{
    QWriteLocker locker(&m_handlerLock);

    // delete any extant inputs
    QHash<QString,TorcInput*>::const_iterator it = m_inputs.constBegin();
    for ( ; it != m_inputs.constEnd(); ++it)
    {
        TorcInputs::gInputs->RemoveInput(it.value());
        it.value()->DownRef();
    }
    m_inputs.clear();
}

Torc1WireDeviceFactory* Torc1WireDeviceFactory::gTorc1WireDeviceFactory = nullptr;

Torc1WireDeviceFactory::Torc1WireDeviceFactory()
  : nextTorc1WireDeviceFactory(gTorc1WireDeviceFactory)
{
    gTorc1WireDeviceFactory = this;
}

Torc1WireDeviceFactory* Torc1WireDeviceFactory::GetTorc1WireDeviceFactory(void)
{
    return gTorc1WireDeviceFactory;
}

Torc1WireDeviceFactory* Torc1WireDeviceFactory::NextFactory(void) const
{
    return nextTorc1WireDeviceFactory;
}

static const QString wire1InputTypes =
QStringLiteral("<xs:simpleType name='ds18b20SerialType'>\r\n"
"  <xs:restriction base='xs:string'>\r\n"
"    <xs:pattern value='28-[0-9a-fA-F]{12}'/>\r\n"
"  </xs:restriction>\r\n"
"</xs:simpleType>\r\n"
"<xs:complexType name='ds18b20Type'>\r\n"
"  <xs:all>\r\n"
"    <xs:element name='name'            type='deviceNameType'/>\r\n"
"    <xs:element name='username'        type='userNameType' minOccurs='0' maxOccurs='1'/>\r\n"
"    <xs:element name='userdescription' type='userDescriptionType' minOccurs='0' maxOccurs='1'/>\r\n"
"    <xs:element name='wire1serial'     type='ds18b20SerialType'/>\r\n"
"  </xs:all>\r\n"
"</xs:complexType>\r\n\r\n"
"<xs:complexType name='wire1Type'>\r\n"
"  <xs:choice minOccurs='1' maxOccurs='unbounded'>\r\n"
"    <xs:element name='ds18b20' type='ds18b20Type'/>\r\n"
"  </xs:choice>\r\n"
"</xs:complexType>\r\n");

static const QString wire1Inputs =
QStringLiteral("    <xs:element minOccurs='0' maxOccurs='1' name='wire1'   type='wire1Type'/>\r\n");

static const QString wire1Unique =
QStringLiteral("<!-- enforce unique 1Wire serial numbers -->\r\n"
"<xs:unique name='uniqueWire1Serial'>\r\n"
"<xs:selector xpath='.//wire1serial' />\r\n"
"  <xs:field xpath='.' />\r\n"
"</xs:unique>\r\n");

class Torc1WireXSDFactory : public TorcXSDFactory
{
  public:
    void GetXSD(QMultiMap<QString,QString> &XSD) {
        XSD.insert(XSD_INPUTTYPES, wire1InputTypes);
        XSD.insert(XSD_INPUTS, wire1Inputs);
        XSD.insert(XSD_UNIQUE, wire1Unique);
    }

} Torc1WireXSDFactory;