adding files

Author: machinekoder

.gitignore

@@ -0,0 +1,2 @@
+*.pro.user
+*.qmlc

README.md

@@ -0,0 +1,80 @@
+# QML OLED Renderer
+
+Renders a QML application to a **SSD1309 OLED display**.
+
+![OLED Display](./doc/OLED-qml.jpg)
+
+```qml
+import QtQuick 2.6
+
+Item {
+    id: root
+    visible: true
+    width: 128
+    height: 64
+
+    Rectangle {
+        id: indicator
+        anchors.bottom: parent.bottom
+        anchors.bottomMargin: 5
+        x: 5
+        width: 15
+        height: width
+        radius: width / 2
+        color: "black"
+    }
+
+    Text {
+        anchors.centerIn: parent
+        text: "Hello World!"
+    }
+}
+```
+
+Tested on the [CHIP single board computer](https://getchip.com/) conected to TWI2.
+
+![CHIP Setup](./doc/CHIP-SSD1309.jpg)
+
+## Install
+
+Requires Qt Version 5.4 or higher. For the Debian package install this means that you need at least the packages from Debian Stretch.
+
+```bash
+sudo apt install qtdeclarative5-dev qt5-default qtchooser qtbase5-dev qml-module-qtquick2
+```
+
+Then you can install the `qml-oled-renderer` with:
+```bash
+qmake
+make
+sudo make install
+```
+
+## Usage
+
+```
+sage: qml-oled-renderer [options] source
+Renders QML applications to a SSD1306 OLED display
+
+Options:
+  -h, --help               Displays this help.
+  -w, --width <weight>     OLED screen width
+  -b, --bus <bus>          I2C bus to which the OLED is connected
+  -a, --address <address>  I2C address of the OLED screen
+  -f, --fps <fps>          Number of frames to render per second
+
+Arguments:
+  source                   QML source file`
+```
+
+The OLED renderer does not work without any display device. You can easily create visual framebuffer device using `XVfb`:
+
+```bash
+sudo apt-get install xvfb
+```
+
+And the start the application as follows:
+```bash
+Xvfb -shmem -screen 0 128x64x16 &
+DISPLAY=:0 qml-oled-renderer main.qml
+```

animationdriver.cpp

@@ -0,0 +1,20 @@
+#include "animationdriver.h"
+
+AnimationDriver::AnimationDriver(int msPerStep)
+    : m_step(msPerStep)
+    , m_elapsed(0)
+{
+
+}
+
+void AnimationDriver::advance()
+{
+    m_elapsed += m_step;
+    advanceAnimation();
+}
+
+qint64 AnimationDriver::elapsed() const
+{
+    return m_elapsed;
+}
+

animationdriver.h

@@ -0,0 +1,20 @@
+#ifndef ANIMATIONDRIVER_H
+#define ANIMATIONDRIVER_H
+
+#include <QtCore/QAnimationDriver>
+
+class AnimationDriver : public QAnimationDriver
+{
+public:
+    AnimationDriver(int msPerStep);
+
+    void advance() override;
+    qint64 elapsed() const override;
+
+private:
+    int m_step;
+    qint64 m_elapsed;
+
+};
+
+#endif // ANIMATIONDRIVER_H

doc/CHIP-SSD1309.jpg

@@ -0,0 +1,54 @@
+#include <QGuiApplication>
+#include <QCommandLineParser>
+#include <QStringList>
+#include "oledrenderer.h"
+#include "ssd1306driver.h"
+
+int main(int argc, char *argv[])
+{
+    QGuiApplication app(argc, argv);
+    qApp->setApplicationName("QML OLED Renderer");
+
+    QCommandLineParser parser;
+    parser.setApplicationDescription("Renders QML applications to a SSD1306 OLED display");
+    parser.addHelpOption();
+    parser.addPositionalArgument("source", "QML source file");
+    parser.addOptions({
+                          {{"w", "width"}, "OLED screen width", "weight"},
+                          {{"h", "height"}, "OLED screen height", "height"},
+                          {{"b", "bus"}, "I2C bus to which the OLED is connected", "bus"},
+                          {{"a", "address"}, "I2C address of the OLED screen", "address"},
+                          {{"f", "fps"}, "Number of frames to render per second", "fps"}
+                      });
+
+    parser.process(app);
+
+    const QStringList args = parser.positionalArguments();
+    if (args.length() < 1) {
+        qCritical() << "please specify a source file";
+        return -1;
+    }
+    QString sourceFile = args.first();
+
+    int width = parser.isSet("w") ? parser.value("w").toInt() : 128;
+    int height = parser.isSet("h") ? parser.value("h").toInt() : 64;
+    int bus = parser.isSet("b") ? parser.value("b").toInt() : 2;
+    int address = parser.isSet("a") ? parser.value("a").toInt() : 0x3c;
+    int fps = parser.isSet("f") ? parser.value("f").toInt() : 10;
+
+    Ssd1306Driver driver;
+    if (!driver.openDevice(QSize(width, height), bus, address)) {
+        qCritical() << "cannot open OLED display";
+        return -1;
+    }
+    QObject::connect(qApp, &QGuiApplication::aboutToQuit, &driver, &Ssd1306Driver::clearScreen);
+
+    OledRenderer renderer;
+    QObject::connect(&renderer, &OledRenderer::imageRendered, [&driver](const QImage &image) {
+       const auto mono = image.convertToFormat(QImage::Format_Mono, Qt::MonoOnly | Qt::ThresholdDither);
+       driver.writeImage(mono);
+    });
+    renderer.loadQmlFile(sourceFile, QSize(width, height), 1.0, fps);
+
+    return app.exec();
+}

doc/OLED-qml.jpg

@@ -0,0 +1,40 @@
+import QtQuick 2.6
+
+Item {
+    id: root
+    visible: true
+    width: 128
+    height: 64
+
+    Rectangle {
+        property bool isRight: false
+
+        id: indicator
+        anchors.bottom: parent.bottom
+        anchors.bottomMargin: 5
+        x: (isRight ? 5 : (root.width - width) - 5)
+        width: 15
+        height: width
+        radius: width / 2
+        color: "black"
+
+        Behavior on x {
+            PropertyAnimation {
+                duration: 500
+            }
+        }
+
+        Timer {
+            id: moveTimer
+            running: true
+            repeat: true
+            interval: 500
+            onTriggered: indicator.isRight = !indicator.isRight
+        }
+    }
+
+    Text {
+        anchors.centerIn: parent
+        text: "Hello World!"
+    }
+}