brickInterface.h

Go to the documentation of this file.

/* Copyright 2015 - 2016 CyberTech Labs Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License. */

#pragma once

#include <QtCore/QStringList>

#include "batteryInterface.h"
#include "colorSensorInterface.h"
#include "displayInterface.h"
#include "encoderInterface.h"
#include "eventDeviceInterface.h"
#include "fifoInterface.h"
#include "gamepadInterface.h"
#include "gyroSensorInterface.h"
#include "keysInterface.h"
#include "ledInterface.h"
#include "lineSensorInterface.h"
#include "motorInterface.h"
#include "markerInterface.h"
#include "objectSensorInterface.h"
#include "pwmCaptureInterface.h"
#include "sensorInterface.h"
#include "soundSensorInterface.h"
#include "vectorSensorInterface.h"
#include "cameraDeviceInterface.h"
#include "i2cDeviceInterface.h"

#include "declSpec.h"

namespace trikControl {

class TRIKCONTROL_EXPORT BrickInterface : public QObject
{
    Q_OBJECT

public:
    virtual void reset() = 0;

    virtual DisplayWidgetInterface *graphicsWidget() = 0;

    virtual QString configVersion() const = 0;

public slots:
    virtual void configure(const QString &portName, const QString &deviceName) = 0;

    virtual void playSound(const QString &soundFileName) = 0;

    virtual void playTone(int hzFreq, int msDuration) = 0;

    virtual void say(const QString &text) = 0;

    virtual void stop() = 0;

    virtual trikControl::MotorInterface *motor(const QString &port) = 0;

    virtual trikControl::PwmCaptureInterface *pwmCapture(const QString &port) = 0;

    virtual trikControl::SensorInterface *sensor(const QString &port) = 0;

    virtual QStringList motorPorts(MotorInterface::Type type) const = 0;

    virtual QStringList pwmCapturePorts() const = 0;

    virtual QStringList sensorPorts(SensorInterface::Type type) const = 0;

    virtual QStringList encoderPorts() const = 0;

    virtual trikControl::VectorSensorInterface *accelerometer() = 0;

    virtual trikControl::GyroSensorInterface *gyroscope() = 0;

    virtual trikControl::LineSensorInterface *lineSensor(const QString &port) = 0;

    virtual trikControl::ColorSensorInterface *colorSensor(const QString &port) = 0;

    virtual trikControl::ObjectSensorInterface *objectSensor(const QString &port) = 0;

    virtual trikControl::I2cDeviceInterface *i2c(int bus, int address) = 0;

    virtual QVector<uint8_t> getStillImage() = 0;

    virtual trikControl::SoundSensorInterface *soundSensor(const QString &port) = 0;

    virtual trikControl::EncoderInterface *encoder(const QString &port) = 0;

    virtual trikControl::BatteryInterface *battery() = 0;

    virtual trikControl::KeysInterface *keys() = 0;

    virtual trikControl::DisplayInterface *display() = 0;

    virtual trikControl::LedInterface *led() = 0;

    virtual trikControl::GamepadInterface *gamepad() = 0;

    virtual trikControl::FifoInterface *fifo(const QString &port) = 0;

    virtual trikControl::MarkerInterface *marker() = 0;

    virtual trikControl::EventDeviceInterface *eventDevice(const QString &deviceFile) = 0;

    virtual void stopEventDevice(const QString &deviceFile) = 0;

signals:
    void stopped();
};

}

Q_DECLARE_METATYPE(trikControl::BrickInterface *)