nymea/libnymea-core/scriptengine/scriptstate.cpp

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright 2013 - 2020, nymea GmbH
* Contact: contact@nymea.io
*
* This file is part of nymea.
* This project including source code and documentation is protected by
* copyright law, and remains the property of nymea GmbH. All rights, including
* reproduction, publication, editing and translation, are reserved. The use of
* this project is subject to the terms of a license agreement to be concluded
* with nymea GmbH in accordance with the terms of use of nymea GmbH, available
* under https://nymea.io/license
*
* GNU General Public License Usage
* Alternatively, this project may be redistributed and/or modified under the
* terms of the GNU General Public License as published by the Free Software
* Foundation, GNU version 3. This project 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 project. If not, see <https://www.gnu.org/licenses/>.
*
* For any further details and any questions please contact us under
* contact@nymea.io or see our FAQ/Licensing Information on
* https://nymea.io/license/faq
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#include "scriptstate.h"

#include "loggingcategories.h"

#include <QColor>
#include <qqml.h>
#include <QQmlEngine>

namespace nymeaserver {

ScriptState::ScriptState(QObject *parent) : QObject(parent)
{

}

void ScriptState::classBegin()
{
    m_thingManager = reinterpret_cast<ThingManager*>(qmlEngine(this)->property("thingManager").toULongLong());
    connect(m_thingManager, &ThingManager::thingStateChanged, this, &ScriptState::onThingStateChanged);

    connect(m_thingManager, &ThingManager::thingAdded, this, [this](Thing *newThing){
        if (newThing->id() == ThingId(m_thingId)) {
            qCDebug(dcScriptEngine()) << "Thing" << newThing->name() << "appeared in system";
            connectToThing();
        }
    });
}

void ScriptState::componentComplete()
{

}

QString ScriptState::thingId() const
{
    return m_thingId;
}

void ScriptState::setThingId(const QString &thingId)
{
    if (m_thingId != thingId) {
        m_thingId = thingId;
        emit thingIdChanged();
        store();
        if (!m_valueCache.isNull()) {
            setValue(m_valueCache);
        }

        connectToThing();
    }
}

QString ScriptState::stateTypeId() const
{
    return m_stateTypeId;
}

void ScriptState::setStateTypeId(const QString &stateTypeId)
{
    if (m_stateTypeId != stateTypeId) {
        m_stateTypeId = stateTypeId;
        emit stateTypeChanged();
        store();
        if (!m_valueCache.isNull()) {
            setValue(m_valueCache);
        }
    }
}

QString ScriptState::stateName() const
{
    return m_stateName;
}

void ScriptState::setStateName(const QString &stateName)
{
    if (m_stateName != stateName) {
        m_stateName = stateName;
        emit stateTypeChanged();
        store();
        if (!m_valueCache.isNull()) {
            setValue(m_valueCache);
        }
    }
}

QVariant ScriptState::value() const
{
    Thing* thing = m_thingManager->findConfiguredThing(ThingId(m_thingId));
    if (!thing) {
        return QVariant();
    }
    StateTypeId stateTypeId = StateTypeId(m_stateTypeId);
    if (stateTypeId.isNull()) {
        stateTypeId = thing->thingClass().stateTypes().findByName(m_stateName).id();
    }

    return thing->stateValue(stateTypeId);
}

void ScriptState::setValue(const QVariant &value)
{
    if (m_pendingActionInfo) {
        m_valueCache = value;
        return;
    }

    Thing* thing = m_thingManager->findConfiguredThing(ThingId(m_thingId));
    if (!thing) {
        m_valueCache = value;
        qCDebug(dcScriptEngine()) << "No thing with id" << m_thingId << "found.";
        return;
    }

    if (thing->setupStatus() != Thing::ThingSetupStatusComplete) {
        m_valueCache = value;
        qCDebug(dcScriptEngine()) << "Thing is not ready yet...";
        return;
    }

    ActionTypeId actionTypeId;
    if (!m_stateTypeId.isNull()) {
        actionTypeId = thing->thingClass().stateTypes().findById(StateTypeId(m_stateTypeId)).id();
        if (actionTypeId.isNull()) {
            qCDebug(dcScriptEngine) << "Thing" << thing->name() << "does not have a state with type id" << m_stateTypeId;
        }
    }
    if (actionTypeId.isNull()) {
        actionTypeId = thing->thingClass().stateTypes().findByName(stateName()).id();
        if (actionTypeId.isNull()) {
            qCDebug(dcScriptEngine) << "Thing" << thing->name() << "does not have a state named" << m_stateName;
        }
    }

    if (actionTypeId.isNull()) {
        m_valueCache = value;
        qCDebug(dcScriptEngine()) << "Either stateTypeId or stateName is required to be valid.";
        return;
    }

    Action action(ActionTypeId(actionTypeId), ThingId(m_thingId), Action::TriggeredByScript);
    ParamList params = ParamList() << Param(ParamTypeId(actionTypeId), value);
    action.setParams(params);

    qCDebug(dcScriptEngine()) << "Executing action on" << thing->name();
    m_valueCache = QVariant();
    m_pendingActionInfo = m_thingManager->executeAction(action);
    connect(m_pendingActionInfo, &ThingActionInfo::finished, this, [this](){
        m_pendingActionInfo = nullptr;
        if (!m_valueCache.isNull()) {
            setValue(m_valueCache);
        }
    });
}

QVariant ScriptState::minimumValue() const
{
    Thing *thing = m_thingManager->configuredThings().findById(ThingId(m_thingId));
    if (!thing) {
        return QVariant();
    }
    StateType stateType = thing->thingClass().stateTypes().findById(StateTypeId(m_stateTypeId));
    if (stateType.id().isNull()) {
        stateType = thing->thingClass().stateTypes().findByName(m_stateName);
    }
    return stateType.minValue();
}

QVariant ScriptState::maximumValue() const
{
    Thing *thing = m_thingManager->configuredThings().findById(ThingId(m_thingId));
    if (!thing) {
        return QVariant();
    }
    StateType stateType = thing->thingClass().stateTypes().findById(StateTypeId(m_stateTypeId));
    if (stateType.id().isNull()) {
        stateType = thing->thingClass().stateTypes().findByName(m_stateName);
    }
    return stateType.maxValue();
}

void ScriptState::store()
{
    m_valueStore = value();
}

void ScriptState::restore()
{
    setValue(m_valueStore);
}

void ScriptState::onThingStateChanged(Thing *thing, const StateTypeId &stateTypeId)
{
    if (thing->id() != ThingId(m_thingId)) {
        return;
    }
    StateTypeId localStateTypeId = StateTypeId(m_stateTypeId);
    if (localStateTypeId.isNull()) {
        localStateTypeId = thing->thingClass().stateTypes().findByName(m_stateName).id();
    }
    if (localStateTypeId.isNull()) {
        return;
    }
    if (stateTypeId == localStateTypeId) {
        emit valueChanged();
    }
}

void ScriptState::connectToThing()
{
    Thing *thing = m_thingManager->findConfiguredThing(ThingId(m_thingId));
    if (!thing) {
        qCDebug(dcScriptEngine()) << "Can't find thing with id" << m_thingId << "(yet)";
        return;
    }

    if (thing->setupStatus() == Thing::ThingSetupStatusComplete) {
        if (!m_valueCache.isNull()) {
            setValue(m_valueCache);
        }
    } else {
        qCDebug(dcScriptEngine()) << "Thing setup for" << thing->name() << "not complete yet";
    }

    connect(thing, &Thing::setupStatusChanged, this, [this, thing](){
        if (thing->setupStatus() == Thing::ThingSetupStatusComplete) {
            qCDebug(dcScriptEngine()) << "Thing setup for" << thing->name() << "completed";
            if (!m_valueCache.isNull()) {
                setValue(m_valueCache);
            }
        }
    });
}

}