QSimpleScada

Qt/C++ based simple SCADA library for your IoT projects. We created QSimpleScada to speed up and simplify visualising any data, so we (and you) can concentrate on developing automation algorithms that rock. It completely handles connection to and editing of widgets. Using QSimpleScada, you can easily create a visualization of IoT data with static and dynamic components. After you are satisfied with the layout, save the generated .xml file and use it in your project.

Library is created with Qt/C++ and basic widget is based on C++. There is interface for QML, so you can independently create individual widgets on QML (as when creating classic QML UIs) and upload them to your app on a go.

Installing

Minimum requirements

Qt 5.8

Using qpm:

To install via qpm, run:

qpm install com.indeema.qsimplescada

And add:

 include (../vendor/vendor.pri)

To *.pro file of your project.

As a bonus, try out our preset of widgets:

qpm install com.indeema.eeiot

From GitHub:

To clone the repo, go to: https://github.com/IndeemaSoftware/QSimpleScada To also add preconfigured widgets, clone: https://github.com/IndeemaSoftware/EEIoT

And add:

include($$PWD/com/indeema/eeiot/com_indeema_eeiot.pri)

To the* .pro file. You'll receive QSimpleScadaLib folder with compiled Windows or MacOS libs.

Using binary release:

https://github.com/IndeemaSoftware/QSimpleScada/releases

Structure

One QScadaController can keep many devices with unique IP addresses. IP address is a unique id for each device. Each device can have several dashboards with unique ids. On each board, you can set up many widgets. You can save the architecture to a* .irp file.

Sample of usage

You can check examples of QSimpleScada use at https://github.com/IndeemaSoftware/QSimpleScadaSample

How the dynamic components look in the sample

Using QSimpleScada

Create your device:

   QScadaDeviceInfo *lDeviceInfo = new QScadaDeviceInfo();
   lDeviceInfo->setName("Test Device");
   lDeviceInfo->setIp(QHostAddress("127.0.0.1"));

Init your board controller. Your boardcontroller object is the main contact spot.

   QScadaBoardController *mController = new QScadaBoardController();   
   mController->appendDevice(lDeviceInfo);

Init your board. Board ids are iterators. So if you will create one more board for this device, its id will be 1.

   mController->initBoardForDeviceIp("127.0.0.1");

To handle events, you can connect to signals:

signals:
    void objectDoubleClicked(QScadaObject*);

You can get pointers to specific board by calling methods:

    QList<QScadaBoard*> getBoardList();
    QList<QScadaBoard*> getBoardListForDeviceIp(QString);

And you can create new object by calling method of QScadaBoard object:

    QScadaObject *initNewObject(QScadaObjectInfo *);
    void createNewObject(QScadaObjectInfo *);

    void createQMLObject(int id, QString path);
    void createQMLObject(QString path);

Define the editable or static type for your controller:

    mController->setEditingMode(true);

Include your controller widget to you central widget:

   QGridLayout *mainLayout = new QGridLayout(ui->centralWidget);
   mainLayout->addWidget(mController);

Now your board controller is initialized. Next steps are setting up the widget resources. We’ve also developed a EEIoT library with a set of preconfigured widgets. You can download it at https://github.com/IndeemaSoftware/EEIoT and try it out as a start. Read wiki page to know the rules on how to create qml widgets that can be used by QSimpleScada

To use a widget collection: Call the function with QML resources url to let the controller know the location of QML widgets:

    QMLConfig::instance.appendQMLPath(:/com/indeema/eeiot/EEIoT/);

Path :/com/indeema/eeiot/EEIoT/ is added by default, so you don't need to add it manually. If you call appendQMLPath with different path to EEIoT, it will replace the default path. Also you can add your own custom widgets.

You can use our simple editor to create your first dashboard https://github.com/IndeemaSoftware/QSimpleScadaSample

Then set up QScadaBoardController in your app without any devices and boards and call:

    mController->openProject(QString <file>)

where is a full path to your project file (*.irp)

For example:

    mController->openProject(QString <file>)

Set up flexible connection, streaming, and visualization of widget data

mController->updateValue(deviceIp, boardId, Id, value);

Where:

deviceIp - QString, the IP address of the monitored device (for example, "192.168.1.1");
boardId - integer, unique ID of a dashboard (since 1 device may contain several dashboards);
Id - integer, unique ID of a widget;
value - QVariant, the value you're monitoring on a widget. Its type is undefined (QVariant), so that you can flexibly stream any data when builing different widgets on a board.

Support

If you have suggestions, feedback, or encounter any issues, write to Stackoverflow, Qt forum with QSimpleScada tag, or contact us at support@indeema.com.
If you find a bug, create an issue.
To learn more about our IoT expertise, visit https://indeema.com, follow our news at @IndeemaSoftware or subscribe to our blog.

abhisit/QSimpleScada