Merge branch 'InfiniTimeOrg:develop' into dice

CMakeLists.txt

@@ -54,6 +54,10 @@ if(BUILD_DFU)
   set(BUILD_DFU true)
 endif()
 
+if(BUILD_RESOURCES)
+  set(BUILD_RESOURCES true)
+endif()
+
 set(TARGET_DEVICE "PINETIME" CACHE STRING "Target device")
 set_property(CACHE TARGET_DEVICE PROPERTY STRINGS PINETIME MOY-TFK5 MOY-TIN5 MOY-TON5 MOY-UNK)
 
@@ -98,6 +102,11 @@ if(BUILD_DFU)
 else()
   message("    * Build DFU (using adafruit-nrfutil) : Disabled")
 endif()
+if(BUILD_RESOURCES)
+  message("    * Build resources : Enabled")
+else()
+  message("    * Build resources : Disabled")
+endif()
 
 set(VERSION_EDIT_WARNING "// Do not edit this file, it is automatically generated by CMAKE!")
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/src/Version.h.in ${CMAKE_CURRENT_BINARY_DIR}/src/Version.h)

doc/buildAndProgram.md

@@ -46,6 +46,7 @@ CMake configures the project according to variables you specify the command line
 **GDB_CLIENT_BIN_PATH**|Path to arm-none-eabi-gdb executable. Used only if `USE_GDB_CLIENT` is 1.|`-DGDB_CLIENT_BIN_PATH=/home/jf/nrf52/gcc-arm-none-eabi-9-2019-q4-major/bin/arm-none-eabi-gdb`
 **GDB_CLIENT_TARGET_REMOTE**|Target remote connection string. Used only if `USE_GDB_CLIENT` is 1.|`-DGDB_CLIENT_TARGET_REMOTE=/dev/ttyACM0`
 **BUILD_DFU (\*\*)**|Build DFU files while building (needs [adafruit-nrfutil](https://github.com/adafruit/Adafruit_nRF52_nrfutil)).|`-DBUILD_DFU=1`
+**BUILD_RESOURCES (\*\*)**| Generate external resource while building (needs [lv_font_conv](https://github.com/lvgl/lv_font_conv) and [lv_img_conv](https://github.com/lvgl/lv_img_conv). |`-DBUILD_RESOURCES=1`
 **TARGET_DEVICE**|Target device, used for hardware configuration. Allowed: `PINETIME, MOY-TFK5, MOY-TIN5, MOY-TON5, MOY-UNK`|`-DTARGET_DEVICE=PINETIME` (Default)
 
 #### (\*) Note about **CMAKE_BUILD_TYPE**

docker/Dockerfile

@@ -22,6 +22,12 @@ RUN apt-get update -qq \
       python3-dev \
       git \
       apt-utils \
+      pkg-config \
+      libpixman-1-dev \
+      libcairo2-dev \
+      libpango-1.0-0 \
+      ibpango1.0-dev \
+      libpangocairo-1.0-0 \
     && curl -sL https://deb.nodesource.com/setup_18.x | bash - \
     && apt-get install -y nodejs \
     && rm -rf /var/cache/apt/* /var/lib/apt/lists/*;
@@ -33,6 +39,10 @@ RUN pip3 install -Iv cryptography==3.3
 RUN pip3 install cbor
 RUN npm i [email protected] -g
 
+RUN npm i [email protected] -g
+RUN npm i @swc/core -g
+RUN npm i [email protected] -g
+
 # build.sh knows how to compile
 COPY build.sh /opt/
 

docker/build.sh

@@ -11,6 +11,10 @@ export SOURCES_DIR="${SOURCES_DIR:=/sources}"
 export BUILD_DIR="${BUILD_DIR:=$SOURCES_DIR/build}"
 export OUTPUT_DIR="${OUTPUT_DIR:=$SOURCES_DIR/build/output}"
 
+# Specify a folder with read/write access to NPM
+export NPM_DIR="$BUILD_DIR/npm"
+export npm_config_cache="${NPM_DIR}"
+
 export BUILD_TYPE=${BUILD_TYPE:=Release}
 export GCC_ARM_VER=${GCC_ARM_VER:="10.3-2021.10"}
 export NRF_SDK_VER=${NRF_SDK_VER:="nRF5_SDK_15.3.0_59ac345"}
@@ -62,7 +66,8 @@ CmakeGenerate() {
     -DUSE_OPENOCD=1 \
     -DARM_NONE_EABI_TOOLCHAIN_PATH="$TOOLS_DIR/$GCC_ARM_PATH" \
     -DNRF5_SDK_PATH="$TOOLS_DIR/$NRF_SDK_VER" \
-    -DBUILD_DFU=1
+    -DBUILD_DFU=1 \
+    -DBUILD_RESOURCES=1
 }
 
 CmakeBuild() {

docker/post_build.sh.in

@@ -15,6 +15,8 @@ cp "$BUILD_DIR/src/pinetime-mcuboot-app-dfu-$PROJECT_VERSION.zip" "$OUTPUT_DIR/p
 cp "$BUILD_DIR/src/pinetime-mcuboot-recovery-loader-image-$PROJECT_VERSION.bin" "$OUTPUT_DIR/pinetime-mcuboot-recovery-loader-image-$PROJECT_VERSION.bin"
 cp "$BUILD_DIR/src/pinetime-mcuboot-recovery-loader-dfu-$PROJECT_VERSION.zip" "$OUTPUT_DIR/pinetime-mcuboot-recovery-loader-dfu-$PROJECT_VERSION.zip"
 
+cp "$BUILD_DIR/src/resources/infinitime-resources-$PROJECT_VERSION.zip" "$OUTPUT_DIR/infinitime-resources-$PROJECT_VERSION.zip"
+
 mkdir -p "$OUTPUT_DIR/src"
 cp $BUILD_DIR/src/*.bin "$OUTPUT_DIR/src/"
 cp $BUILD_DIR/src/*.hex "$OUTPUT_DIR/src/"

src/CMakeLists.txt

@@ -942,6 +942,10 @@ add_custom_command(TARGET ${EXECUTABLE_NAME}
         COMMAND ${CMAKE_OBJCOPY} -O ihex ${EXECUTABLE_FILE_NAME}.out "${EXECUTABLE_FILE_NAME}.hex"
         COMMENT "post build steps for ${EXECUTABLE_FILE_NAME}")
 
+if(BUILD_RESOURCES)
+  add_dependencies(${EXECUTABLE_NAME} GenerateResources)
+endif()
+
 # Build binary intended to be used by bootloader
 set(EXECUTABLE_MCUBOOT_NAME "pinetime-mcuboot-app")
 set(EXECUTABLE_MCUBOOT_FILE_NAME ${EXECUTABLE_MCUBOOT_NAME}-${pinetime_VERSION_MAJOR}.${pinetime_VERSION_MINOR}.${pinetime_VERSION_PATCH})
@@ -975,6 +979,10 @@ add_custom_command(TARGET ${EXECUTABLE_MCUBOOT_NAME}
         COMMENT "post build steps for ${EXECUTABLE_MCUBOOT_FILE_NAME}"
         )
 
+if(BUILD_RESOURCES)
+  add_dependencies(${EXECUTABLE_MCUBOOT_NAME} GenerateResources)
+endif()
+
 if(BUILD_DFU)
   add_custom_command(TARGET ${EXECUTABLE_MCUBOOT_NAME}
           POST_BUILD
@@ -1129,6 +1137,10 @@ if(BUILD_DFU)
           )
 endif()
 
+if(BUILD_RESOURCES)
+  add_subdirectory(resources)
+endif()
+
 
 # FLASH
 if (USE_JLINK)

src/resources/CMakeLists.txt

@@ -0,0 +1,29 @@
+
+find_program(LV_FONT_CONV "lv_font_conv" NO_CACHE REQUIRED
+    HINTS "${CMAKE_SOURCE_DIR}/node_modules/.bin")
+message(STATUS "Using ${LV_FONT_CONV} to generate font files")
+
+find_program(LV_IMG_CONV "lv_img_conv" NO_CACHE REQUIRED
+    HINTS "${CMAKE_SOURCE_DIR}/node_modules/.bin")
+message(STATUS "Using ${LV_IMG_CONV} to generate font files")
+
+if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.12)
+   # FindPython3 module introduces with CMake 3.12
+   # https://cmake.org/cmake/help/latest/module/FindPython3.html
+   find_package(Python3 REQUIRED)
+else()
+   set(Python3_EXECUTABLE "python")
+endif()
+
+# generate fonts
+add_custom_target(GenerateResources
+    COMMAND "${Python3_EXECUTABLE}" ${CMAKE_CURRENT_SOURCE_DIR}/generate-fonts.py  --lv-font-conv "${LV_FONT_CONV}" ${CMAKE_CURRENT_SOURCE_DIR}/fonts.json
+    COMMAND "${Python3_EXECUTABLE}" ${CMAKE_CURRENT_SOURCE_DIR}/generate-img.py  --lv-img-conv "${LV_IMG_CONV}" ${CMAKE_CURRENT_SOURCE_DIR}/images.json
+    COMMAND "${Python3_EXECUTABLE}" ${CMAKE_CURRENT_SOURCE_DIR}/generate-package.py --config  ${CMAKE_CURRENT_SOURCE_DIR}/fonts.json --config  ${CMAKE_CURRENT_SOURCE_DIR}/images.json --obsolete obsolete_files.json --output infinitime-resources-${pinetime_VERSION_MAJOR}.${pinetime_VERSION_MINOR}.${pinetime_VERSION_PATCH}.zip
+    DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/fonts.json
+    DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/images.json
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+
+    COMMENT "Generate fonts and images for resource package"
+)
+

src/resources/fonts.json

@@ -0,0 +1,62 @@
+{
+   "teko" : {
+      "sources": [
+         {
+            "file": "fonts/Teko-Light.ttf",
+            "symbols": "0123456789:/amp"
+         }
+      ],
+      "bpp": 1,
+      "size": 28,
+      "format": "bin",
+      "target_path": "/fonts/"
+   },
+   "bebas" : {
+      "sources": [
+         {
+            "file": "fonts/BebasNeue-Regular.ttf",
+            "symbols": "0123456789:"
+         }
+      ],
+      "bpp": 1,
+      "size": 120,
+      "format": "bin",
+      "target_path": "/fonts/"
+   },
+   "lv_font_dots_40": {
+      "sources": [
+         {
+            "file": "fonts/repetitionscrolling.ttf",
+            "symbols": "0123456789-MONTUEWEDTHUFRISATSUN WK"
+         }
+      ],
+      "bpp": 1,
+      "size": 40,
+      "format": "bin",
+      "target_path": "/fonts/"
+   },
+   "7segments_40" : {
+      "sources": [
+         {
+            "file": "fonts/7segment.woff",
+            "symbols": "0123456789: -"
+         }
+      ],
+      "bpp": 1,
+      "size": 40,
+      "format": "bin",
+      "target_path": "/fonts/"
+   },
+   "7segments_115" : {
+      "sources": [
+         {
+            "file": "fonts/7segment.woff",
+            "symbols": "0123456789: -"
+         }
+      ],
+      "bpp": 1,
+      "size": 115,
+      "format": "bin",
+      "target_path": "/fonts/"
+   }
+}

src/resources/generate-fonts.py

@@ -0,0 +1,80 @@
+#!/usr/bin/env python
+
+import io
+import sys
+import json
+import shutil
+import typing
+import os.path
+import argparse
+import subprocess
+
+class Source(object):
+    def __init__(self, d):
+        self.file = d['file']
+        if not os.path.exists(self.file):
+            self.file = os.path.join(os.path.dirname(sys.argv[0]), self.file)
+        self.range = d.get('range')
+        self.symbols = d.get('symbols')
+
+
+def gen_lvconv_line(lv_font_conv: str, dest: str, size: int, bpp: int, format: str, sources: typing.List[Source], compress:bool=False):
+    if format != "lvgl" and format != "bin":
+        format = "bin" if dest.lower().endswith(".bin") else "lvgl"
+
+    args = [lv_font_conv, '--size', str(size), '--output', dest, '--bpp', str(bpp), '--format', format]
+    if not compress:
+        args.append('--no-compress')
+    for source in sources:
+        args.extend(['--font', source.file])
+        if source.range:
+            args.extend(['--range', source.range])
+        if source.symbols:
+            args.extend(['--symbols', source.symbols])
+
+    return args
+
+def main():
+    ap = argparse.ArgumentParser(description='auto generate LVGL font files from fonts')
+    ap.add_argument('config', type=str, help='config file to use')
+    ap.add_argument('-f', '--font', type=str, action='append', help='Choose specific fonts to generate (default: all)', default=[])
+    ap.add_argument('--lv-font-conv', type=str, help='Path to "lv_font_conf" executable', default="lv_font_conv")
+    args = ap.parse_args()
+
+    if not shutil.which(args.lv_font_conv):
+        sys.exit(f"Missing lv_font_conv. Make sure it's findable (in PATH) or specify it manually")
+    if not os.path.exists(args.config):
+        sys.exit(f'Error: the config file {args.config} does not exist.')
+    if not os.access(args.config, os.R_OK):
+        sys.exit(f'Error: the config file {args.config} is not accessible (permissions?).')
+    with open(args.config, 'r') as fd:
+        data = json.load(fd)
+
+    fonts_to_run = set(data.keys())
+
+    if args.font:
+        enabled_fonts = set()
+        for font in args.font:
+            enabled_fonts.add(font[:-2] if font.endswith('.c') else font)
+        d = enabled_fonts.difference(fonts_to_run)
+        if d:
+            print(f'Warning: requested font{"s" if len(d)>1 else ""} missing: {" ".join(d)}')
+        fonts_to_run = fonts_to_run.intersection(enabled_fonts)
+
+    for name in fonts_to_run:
+        font = data[name]
+        sources = font.pop('sources')
+        patches = font.pop('patches') if 'patches' in font else  []
+        font['sources'] = [Source(thing) for thing in sources]
+        extension = 'c' if font['format'] != 'bin' else 'bin'
+        font.pop('target_path')
+        line = gen_lvconv_line(args.lv_font_conv, f'{name}.{extension}', **font)
+        subprocess.check_call(line)
+        if patches:
+            for patch in patches:
+                subprocess.check_call(['/usr/bin/env', 'patch', name+'.'+extension, patch])
+
+
+
+if __name__ == '__main__':
+    main()

src/resources/generate-img.py

@@ -0,0 +1,56 @@
+#!/usr/bin/env python
+
+import io
+import sys
+import json
+import shutil
+import typing
+import os.path
+import argparse
+import subprocess
+
+def gen_lvconv_line(lv_img_conv: str, dest: str, color_format: str, output_format: str, binary_format: str, sources: str):
+    args = [lv_img_conv, sources, '--force', '--output-file', dest, '--color-format', color_format, '--output-format', output_format, '--binary-format', binary_format]
+
+    return args
+
+def main():
+    ap = argparse.ArgumentParser(description='auto generate LVGL font files from fonts')
+    ap.add_argument('config', type=str, help='config file to use')
+    ap.add_argument('-i', '--image', type=str, action='append', help='Choose specific images to generate (default: all)', default=[])
+    ap.add_argument('--lv-img-conv', type=str, help='Path to "lv_img_conf" executable', default="lv_img_conv")
+    args = ap.parse_args()
+
+    if not shutil.which(args.lv_img_conv):
+        sys.exit(f"Missing lv_img_conv. Make sure it's findable (in PATH) or specify it manually")
+    if not os.path.exists(args.config):
+        sys.exit(f'Error: the config file {args.config} does not exist.')
+    if not os.access(args.config, os.R_OK):
+        sys.exit(f'Error: the config file {args.config} is not accessible (permissions?).')
+    with open(args.config, 'r') as fd:
+        data = json.load(fd)
+
+    images_to_run = set(data.keys())
+
+    if args.image:
+        enabled_images = set()
+        for image in args.image:
+            enabled_images.add(image[:-2] if image.endswith('.c') else image)
+        d = enabled_images.difference(images_to_run)
+        if d:
+            print(f'Warning: requested image{"s" if len(d)>1 else ""} missing: {" ".join(d)}')
+        images_to_run = images_to_run.intersection(enabled_images)
+
+    for name in images_to_run:
+        image = data[name]
+        if not os.path.exists(image['sources']):
+            image['sources'] = os.path.join(os.path.dirname(sys.argv[0]), image['sources'])
+        extension = 'bin'
+        image.pop('target_path')
+        line = gen_lvconv_line(args.lv_img_conv, f'{name}.{extension}', **image)
+        subprocess.check_call(line)
+
+
+
+if __name__ == '__main__':
+    main()