Initial code drop.

Author: ricmoo

Diff for: .gitignore

@@ -0,0 +1,2 @@
+build/**
+obsolete/**

Diff for: CMakeLists.txt

@@ -0,0 +1,10 @@
+cmake_minimum_required(VERSION 3.16)
+
+idf_component_register(
+  SRCS
+    "firefly-display.c"
+  INCLUDE_DIRS
+    "include"
+  REQUIRES
+    driver
+)

Diff for: README.md

@@ -3,6 +3,30 @@ Firefly Display
 
 A simple display driver for the ST7789 240x240 display.
 
+
+Example
+-------
+
+See the [example project](./examples/test-app) which merely
+displays a static image on the display.
+
+
+Using Locally
+-------------
+
+Due to the way ESP IDF uses a component's folder name to determine
+its package name, the default folder when checking out from GitHub
+(i.e. `component-display`) prevents the component from working.
+
+To resolve this, for example if contributing to the repository,
+checkout out the component in a target folder named `firefly-display`:
+
+```shell
+/home/ricmoo> git clone [email protected]:firefly/component-display.git firefly-display
+# This is important!! -----------------------------------------------^
+```
+
+
 License
 -------
 

Diff for: examples/test-app/.gitignore

@@ -0,0 +1,3 @@
+build/**
+sdkconfig.old
+dependencies.lock

Diff for: examples/test-app/CMakeLists.txt

@@ -0,0 +1,4 @@
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(test-app)

Diff for: examples/test-app/README.md

@@ -0,0 +1,10 @@
+Test App
+========
+
+Very simple app that loads a static image and shows it on the
+display.
+
+License
+-------
+
+MIT License.

Diff for: examples/test-app/main/CMakeLists.txt

@@ -0,0 +1,6 @@
+idf_component_register(
+  SRCS
+    "main.c"
+  INCLUDE_DIRS
+    "."
+)

Diff for: examples/test-app/main/idf_component.yml

@@ -0,0 +1,8 @@
+
+dependencies:
+  idf:
+    version: ">=4.1.0"
+
+  # The local component being tested
+  firefly-display:
+    path: ../../..

Diff for: examples/test-app/main/logo-color.h

@@ -0,0 +1,44 @@
+
+#include <stdio.h>
+
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+
+
+#include "firefly-display.h"
+
+#include "logo-color.h"
+
+
+#define DISPLAY_BUS        (DisplaySpiBus2)
+#define PIN_DISPLAY_DC     (4)
+#define PIN_DISPLAY_RESET  (5)
+
+static void delay(uint32_t duration) {
+    vTaskDelay((duration + portTICK_PERIOD_MS - 1) / portTICK_PERIOD_MS);
+}
+
+void renderFunc(uint8_t *buffer, uint32_t y0, void *context) {
+  uint8_t *dst = &buffer[0];
+  for (int y = y0; y < MIN(logo_height, y0 + DisplayFragmentHeight); y++) {
+    const uint8_t *src = &logo[y * logo_width * 2];
+    for (int x = 0; x < MIN(logo_width, DisplayFragmentWidth); x++) {
+      *dst++ = *src++;
+      *dst++ = *src++;
+    }
+  }
+}
+
+void app_main(void) {
+  printf("HELLO %d\n", display_fps(NULL));
+
+  DisplayContext display = display_init(DISPLAY_BUS, PIN_DISPLAY_DC, PIN_DISPLAY_RESET, DisplayRotationPinsLeft, renderFunc, NULL);
+
+  while (1) {
+    uint32_t frameDone = display_renderFragment(display);
+    if (frameDone) {
+      printf("done!\n");
+      while(1) { delay(1000); }
+    }
+  }
+}