Initial Checkin

.gitignore

@@ -0,0 +1,18 @@
+# Ignore vim recovery files
+.*.swp
+*.bak
+
+# Ignore build artifacts
+**/build/**
+
+/dependencies.lock
+/managed_components/
+
+# Ignore the NVS prototypes
+/nvs*.bin
+/nvs*.csv
+
+/sdkconfig.old
+
+**/.nfs*
+**/.DS_Store

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "components/libnsgif"]
+	path = components/libnsgif
+	url = https://github.com/UncleRus/esp-idf-libnsgif.git
+[submodule "components/libwebp/libwebp"]
+	path = components/libwebp/libwebp
+	url = https://chromium.googlesource.com/webm/libwebp

CMakeLists.txt

@@ -0,0 +1,8 @@
+# For more information about build system see
+# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html
+# The following five lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.5)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(PixelClient)

LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

README.md

@@ -0,0 +1,74 @@
+PixelClient: Firmware for an ESP-32 board to drive a 32x64 HUB 75 display,
+by subscribing to a websocket and streaming pushed images. The corresponding
+server is located at https://github.com/joe714/pixelgw
+
+Mainter: Joe Sunday [email protected]
+GitHub: https://github.com/joe714/pixelfirmware
+
+# Build and Install
+
+Pinout for the display is set in components/Hub75Display/Hub75Display.c,
+note this is not the same pinout as official Tidbyt hardware and needs
+to be set for particular devices. (TODO, make this more configurable at
+build time) . Reference schematic / board coming soon.
+
+To build, you'll need a working Linux machine with Docker installed and
+your user in the docker group. After cloning the repository, fetch the
+required submodules:
+
+    $ git submodule init
+    $ git submodule update
+
+To compile the firmware:
+
+    $ ./build.sh build
+
+For first setup, copy nvs.csv.sample to nvs.csv and set your WiFi credentials
+and endpoint / pixelgw IP address on the appropriate lines, and generate the
+initial NVS partion data:
+
+    $ ./build.sh nvs
+
+To flash, connect the device via USB and flash everything. Note that you
+should only flash the NVS data on the first install. Once the device has
+registered with the gateway, reflashing NVS will cause the device UUID to
+change.
+
+    $ ./build.sh flash
+    $ ./build.sh flash_nvs
+
+To do OTA updates once already installed, start a temporary web server:
+
+    $ ./build.sh ota-server
+
+Then navigate to http://*device-ip*/, verify OTA URL listed, and click "Update Firmware".
+Currently it assumes you're running the OTA update from the same machine as the
+gateway endpoint, otherwise you'll need to change the IP in the firmware URL.
+
+# FAQ
+- What hardware does this need?
+
+  An ESP-32 board with the HUB75 display wired according to the pin
+  definitions in components/Hub75Display/Hub75Display.c.
+
+  I'm working on a V1.5 board revision, but I'll publish the
+  v1 board design when I can.
+
+- Do you sell hardware?
+
+  Not currently, but inquire and if there's demand I'll see what I can do.
+
+- Can I run this on Tidbyt Hardware?
+
+  Theoretically, yes but I have not tried it or determined the right
+  compile options, or determined how to reset it back to factory firmware.
+  At a minimum, the pin definitions need to be tweaked. If you want to try,
+  feel free and give me a pull request with changes and instructions, but
+  I take no responsibility if you brick it.
+
+# TODO
+- Integrate firmware management into the server.
+- Web interface to bootstrap / modify configuration
+- More device support (including pre-canned config for Tidbyt 1 devices)
+
+

build.sh

@@ -0,0 +1,53 @@
+#/bin/bash
+# Run the build in a docker image
+# https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-docker-image.html#
+#
+# Run HTTP server for OTA update:
+#   python -m http.server --directory build
+
+ESPTOOL="python /mnt/code/esp32/esptool/esptool.py"
+if [ -z "$IDF_DOCKER_IMAGE" ]; then
+    IDF_DOCKER_IMAGE="espressif/idf:release-v5.2"
+fi
+echo "Using esp-idf image: $IDF_DOCKER_IMAGE"
+
+if [ -z "$ESPTOOL_PORT" ] ; then
+    ESPTOOL_PORT=/dev/ttyUSB0
+fi
+echo "Using serial port: $ESPTOOL_PORT"
+
+DOCKER_ARGS="--rm -v ${PWD}:/project -e HOME=/tmp"
+
+# Build we run as the user to not trash permissions in build/
+DOCKER_BUILD_ARGS="${DOCKER_ARGS} -w /project -u `id -u`:`id -g`"
+
+# Flash we just run as root to use the serial port without a bunch of permissions issues
+DOCKER_FLASH_ARGS="${DOCKER_ARGS} -w /project/build --device=${ESPTOOL_PORT}"
+
+if [ "$1" == "build" ]; then
+    docker run ${DOCKER_BUILD_ARGS} ${IDF_DOCKER_IMAGE} idf.py build
+elif [ $1 == "nvs" ]; then
+    docker run ${DOCKER_BUILD_ARGS} ${IDF_DOCKER_IMAGE} ./nvs.sh
+elif [ "$1" == "interactive" ]; then
+    docker run ${DOCKER_BUILD_ARGS} -it ${IDF_DOCKER_IMAGE} 
+elif [ "$1" == "flash" ]; then
+    docker run ${DOCKER_FLASH_ARGS} ${IDF_DOCKER_IMAGE} \
+	esptool.py -p $ESPTOOL_PORT --chip esp32 -b 460800 --before default_reset --after hard_reset \
+	write_flash "@flash_args"
+elif [ "$1" == "flash_app" ]; then
+    docker run ${DOCKER_FLASH_ARGS} ${IDF_DOCKER_IMAGE} \
+	esptool.py -p $ESPTOOL_PORT --chip esp32 -b 460800 --before default_reset --after hard_reset \
+	write_flash "@flash_app_args"
+elif [ "$1" == "flash_nvs" ]; then
+    docker run ${DOCKER_FLASH_ARGS} ${IDF_DOCKER_IMAGE} \
+	esptool.py -p $ESPTOOL_PORT --chip esp32 -b 460800 --before default_reset --after hard_reset \
+	write_flash "@flash_nvs_args"
+elif [ "$1" == "ota-server" ] ; then
+    python -m http.server --directory build
+elif [ "$1" == "monitor" ] ; then
+     python -m serial.tools.miniterm --rts 0 --dtr 0 --filter direct $ESPTOOL_PORT 115200
+else
+    echo "Usage: $0 [build|nvs|interactive|ota-server|flash|flash-app|flash-nvs|monitor]"
+    exit 1;
+fi
+

components/HttpServer/CMakeLists.txt

@@ -0,0 +1,8 @@
+idf_component_register(
+                      SRCS "HttpServer.cc"
+                           "StaticAssetHandler.cc"
+                           "WebSockets.cc"
+              INCLUDE_DIRS "include"
+                  REQUIRES "esp_http_server")
+
+target_compile_options(${COMPONENT_LIB} PRIVATE "-std=gnu++17")