add rusty_hangulclock

suapapa · suapapa · commit 1588db545b67 · 2024-12-19T06:26:41.000+09:00
diff --git a/go_hangulclock/LICENSE b/go_hangulclock/LICENSE
diff --git a/go_hangulclock/deploy.sh b/go_hangulclock/deploy.sh
diff --git a/go_hangulclock/display.go b/go_hangulclock/display.go
diff --git a/go_hangulclock/go.mod b/go_hangulclock/go.mod
@@ -1,4 +1,4 @@
-module github.com/suapapa/HangulClock/sbc_hangulclock
+module github.com/suapapa/HangulClock/go_hangulclock
 
 go 1.19
 
diff --git a/go_hangulclock/go.sum b/go_hangulclock/go.sum
diff --git a/go_hangulclock/hangulclock.service b/go_hangulclock/hangulclock.service
diff --git a/go_hangulclock/main.go b/go_hangulclock/main.go
diff --git a/rusty_hangulclock/.cargo/config.toml b/rusty_hangulclock/.cargo/config.toml
@@ -0,0 +1,18 @@
+[build]
+target = "xtensa-esp32s2-espidf"
+
+[target.xtensa-esp32s2-espidf]
+linker = "ldproxy"
+runner = "espflash flash --monitor" # Select this runner for espflash v3.x.x
+rustflags = [ "--cfg",  "espidf_time64"] # Extending time_t for ESP IDF 5: https://github.com/esp-rs/rust/issues/110
+
+[unstable]
+build-std = ["std", "panic_abort"]
+
+[env]
+MCU="esp32s2"
+# Note: this variable is not used by the pio builder (`cargo build --features pio`)
+ESP_IDF_VERSION = "v5.2.2"
+
+# Workaround for https://github.com/esp-rs/esp-idf-template/issues/174 
+CRATE_CC_NO_DEFAULTS = "1"
diff --git a/rusty_hangulclock/.devcontainer/Dockerfile b/rusty_hangulclock/.devcontainer/Dockerfile
@@ -0,0 +1,66 @@
+ARG VARIANT=bookworm-slim
+FROM debian:${VARIANT}
+ENV DEBIAN_FRONTEND=noninteractive
+ENV LC_ALL=C.UTF-8
+ENV LANG=C.UTF-8
+
+# Arguments
+ARG CONTAINER_USER=esp
+ARG CONTAINER_GROUP=esp
+ARG ESP_BOARD=all
+ARG GITHUB_TOKEN
+
+# Install dependencies
+RUN apt-get update \
+    && apt-get install -y pkg-config curl gcc clang libudev-dev unzip xz-utils \
+    git wget flex bison gperf python3 python3-pip python3-venv cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0 \
+    && apt-get clean -y && rm -rf /var/lib/apt/lists/* /tmp/library-scripts
+
+# Set users
+RUN adduser --disabled-password --gecos "" ${CONTAINER_USER}
+USER ${CONTAINER_USER}
+WORKDIR /home/${CONTAINER_USER}
+
+# Install rustup
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- \
+    --default-toolchain none -y --profile minimal
+
+# Update envs
+ENV PATH=${PATH}:/home/${CONTAINER_USER}/.cargo/bin
+
+# Install extra crates
+RUN ARCH=$($HOME/.cargo/bin/rustup show | grep "Default host" | sed -e 's/.* //') && \
+    curl -L "https://github.com/esp-rs/espup/releases/latest/download/espup-${ARCH}" -o "${HOME}/.cargo/bin/espup" && \
+    chmod u+x "${HOME}/.cargo/bin/espup" && \
+    curl -L "https://github.com/esp-rs/espflash/releases/latest/download/cargo-espflash-${ARCH}.zip" -o "${HOME}/.cargo/bin/cargo-espflash.zip" && \
+    unzip "${HOME}/.cargo/bin/cargo-espflash.zip" -d "${HOME}/.cargo/bin/" && \
+    rm "${HOME}/.cargo/bin/cargo-espflash.zip" && \
+    chmod u+x "${HOME}/.cargo/bin/cargo-espflash" && \
+    curl -L "https://github.com/esp-rs/espflash/releases/latest/download/espflash-${ARCH}.zip" -o "${HOME}/.cargo/bin/espflash.zip" && \
+    unzip "${HOME}/.cargo/bin/espflash.zip" -d "${HOME}/.cargo/bin/" && \
+    rm "${HOME}/.cargo/bin/espflash.zip" && \
+    chmod u+x "${HOME}/.cargo/bin/espflash" && \
+    curl -L "https://github.com/esp-rs/embuild/releases/latest/download/ldproxy-${ARCH}.zip" -o "${HOME}/.cargo/bin/ldproxy.zip" && \
+    unzip "${HOME}/.cargo/bin/ldproxy.zip" -d "${HOME}/.cargo/bin/" && \
+    rm "${HOME}/.cargo/bin/ldproxy.zip" && \
+    chmod u+x "${HOME}/.cargo/bin/ldproxy" && \
+    curl -L "https://github.com/esp-rs/esp-web-flash-server/releases/latest/download/web-flash-${ARCH}.zip" -o "${HOME}/.cargo/bin/web-flash.zip" && \
+    unzip "${HOME}/.cargo/bin/web-flash.zip" -d "${HOME}/.cargo/bin/" && \
+    rm "${HOME}/.cargo/bin/web-flash.zip" && \
+    chmod u+x "${HOME}/.cargo/bin/web-flash"
+
+# Install Xtensa Rust
+RUN if [ -n "${GITHUB_TOKEN}" ]; then export GITHUB_TOKEN=${GITHUB_TOKEN}; fi  \
+    && ${HOME}/.cargo/bin/espup install\
+    --targets "${ESP_BOARD}" \
+    --log-level debug \
+    --export-file /home/${CONTAINER_USER}/export-esp.sh
+
+# Set default toolchain
+RUN rustup default esp
+
+
+# Activate ESP environment
+RUN echo "source /home/${CONTAINER_USER}/export-esp.sh" >> ~/.bashrc
+
+CMD [ "/bin/bash" ]
diff --git a/rusty_hangulclock/.devcontainer/devcontainer.json b/rusty_hangulclock/.devcontainer/devcontainer.json
@@ -0,0 +1,53 @@
+{
+  "name": "hangulclock_rs",
+  // Select between image and build propieties to pull or build the image.
+  // "image": "docker.io/espressif/idf-rust:esp32s2_latest",
+  "build": {
+    "dockerfile": "Dockerfile",
+    "args": {
+      "CONTAINER_USER": "esp",
+      "CONTAINER_GROUP": "esp",
+      "ESP_BOARD": "esp32s2"
+    }
+  },
+  // https://github.com/serialport/serialport-rs/issues/153
+  "runArgs": [
+    "--mount",
+    "type=bind,source=/run/udev,target=/run/udev,readonly"
+  ],
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "editor.formatOnPaste": true,
+        "editor.formatOnSave": true,
+        "editor.formatOnSaveMode": "file",
+        "editor.formatOnType": true,
+        "lldb.executable": "/usr/bin/lldb",
+        "files.watcherExclude": {
+          "**/target/**": true
+        },
+        "rust-analyzer.checkOnSave.command": "clippy",
+        "rust-analyzer.checkOnSave.allTargets": false,
+        "[rust]": {
+          "editor.defaultFormatter": "rust-lang.rust-analyzer"
+        }
+      },
+      "extensions": [
+        "rust-lang.rust-analyzer",
+        "tamasfe.even-better-toml",
+        "serayuzgur.crates",
+        "mutantdino.resourcemonitor",
+        "yzhang.markdown-all-in-one",
+        "ms-vscode.cpptools",
+        "actboy168.tasks",
+        "Wokwi.wokwi-vscode"
+      ]
+    }
+  },
+  "forwardPorts": [
+    3333,
+    8000
+  ],
+  "workspaceMount": "source=${localWorkspaceFolder},target=/home/esp/hangulclock_rs,type=bind,consistency=cached",
+  "workspaceFolder": "/home/esp/hangulclock_rs"
+}
diff --git a/rusty_hangulclock/.gitignore b/rusty_hangulclock/.gitignore
@@ -0,0 +1,4 @@
+/.vscode
+/.embuild
+/target
+/Cargo.lock
diff --git a/rusty_hangulclock/Cargo.toml b/rusty_hangulclock/Cargo.toml
@@ -0,0 +1,36 @@
+[package]
+name = "rusty-hangulclock"
+version = "0.1.0"
+authors = ["Homin Lee <ff4500@gmail.com>"]
+edition = "2021"
+resolver = "2"
+rust-version = "1.77"
+
+[[bin]]
+name = "rusty-hangulclock"
+harness = false # do not use the built in cargo test harness -> resolve rust-analyzer errors
+
+[profile.release]
+opt-level = "s"
+
+[profile.dev]
+debug = true    # Symbols are nice and they don't increase the size on Flash
+opt-level = "z"
+
+[features]
+default = []
+
+experimental = ["esp-idf-svc/experimental"]
+
+[dependencies]
+log = "0.4"
+esp-idf-svc = { version = "0.49.1" }
+chrono = "0.4.39"
+sh1106 = "0.5.0"
+embedded-graphics = "0.8.1"
+anyhow = "1.0.94"
+embedded-svc = "0.28.0"
+
+[build-dependencies]
+embuild = "0.32.0"
+cc = "=1.1.30" # Version "1.1.30" necessary until a new version of `esp-idf-sys` is released
diff --git a/rusty_hangulclock/LICENSE b/rusty_hangulclock/LICENSE
@@ -0,0 +1,25 @@
+Copyright (c) 2022, Homin Lee <ff4500@gmail.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+
+    Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
diff --git a/rusty_hangulclock/README.md b/rusty_hangulclock/README.md
@@ -0,0 +1,27 @@
+# Rusty HangulClock
+
+HangulClock written in Rust on ESP32S2 board
+
+## Build and flash
+
+Install toolchain (only for one time):
+
+```sh
+cargo install espup
+espup install
+```
+
+Build:
+```sh
+source $HOME/export-esp.sh
+export WIFI_SSID="YOUR_WIFI_SSID"
+export WIFI_PASS="YOUR_WIFI_PASS"
+cargo build --release
+```
+
+Flash:
+```sh
+export WIFI_SSID="YOUR_WIFI_SSID"
+export WIFI_PASS="YOUR_WIFI_PASS"
+cargo espflash flash --release
+```
diff --git a/rusty_hangulclock/build.rs b/rusty_hangulclock/build.rs
@@ -0,0 +1,3 @@
+fn main() {
+    embuild::espidf::sysenv::output();
+}
diff --git a/rusty_hangulclock/docs/README.md b/rusty_hangulclock/docs/README.md
@@ -0,0 +1,77 @@
+# hangulclock_rs
+
+## Dev Containers
+This repository offers Dev Containers supports for:
+-  [VS Code Dev Containers](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-an-existing-folder-in-a-container)
+-  [GitHub Codespaces](https://docs.github.com/en/codespaces/developing-in-codespaces/creating-a-codespace)
+> **Note**
+>
+> In [order to use GitHub Codespaces](https://github.com/features/codespaces#faq)
+> the project needs to be published in a GitHub repository and the user needs
+> to be part of the Codespaces beta or have the project under an organization.
+
+If using VS Code or GitHub Codespaces, you can pull the image instead of building it
+from the Dockerfile by selecting the `image` property instead of `build` in
+`.devcontainer/devcontainer.json`. Further customization of the Dev Container can
+be achived, see [.devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference).
+
+When using Dev Containers, some tooling to facilitate building, flashing and
+simulating in Wokwi is also added.
+### Build
+- Terminal approach:
+
+    ```
+    scripts/build.sh  [debug | release]
+    ```
+    > If no argument is passed, `release` will be used as default
+
+
+-  UI approach:
+
+    The default build task is already set to build the project, and it can be used
+    in VS Code and GitHub Codespaces:
+    - From the [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) (`Ctrl-Shift-P` or `Cmd-Shift-P`) run the `Tasks: Run Build Task` command.
+    - `Terminal`-> `Run Build Task` in the menu.
+    - With `Ctrl-Shift-B` or `Cmd-Shift-B`.
+    - From the [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) (`Ctrl-Shift-P` or `Cmd-Shift-P`) run the `Tasks: Run Task` command and
+    select `Build`.
+    - From UI: Press `Build` on the left side of the Status Bar.
+
+### Flash
+
+> **Note**
+>
+> When using GitHub Codespaces, we need to make the ports
+> public, [see instructions](https://docs.github.com/en/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace#sharing-a-port).
+
+- Terminal approach:
+  - Using `flash.sh` script:
+
+    ```
+    scripts/flash.sh [debug | release]
+    ```
+    > If no argument is passed, `release` will be used as default
+
+- UI approach:
+    - From the [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) (`Ctrl-Shift-P` or `Cmd-Shift-P`) run the `Tasks: Run Task` command and
+    select `Build & Flash`.
+    - From UI: Press `Build & Flash` on the left side of the Status Bar.
+- Any alternative flashing method from host machine.
+
+
+### Wokwi Simulation
+
+#### VS Code Dev Containers and GitHub Codespaces
+
+The Dev Container includes the Wokwi Vs Code installed, hence you can simulate your built projects doing the following:
+1. Press `F1`
+2. Run `Wokwi: Start Simulator`
+
+> **Note**
+>
+>  We assume that the project is built in `debug` mode, if you want to simulate projects in release, please update the `elf` and  `firmware` proprieties in `wokwi.toml`.
+
+For more information and details on how to use the Wokwi extension, see [Getting Started] and [Debugging your code] Chapter of the Wokwi documentation.
+
+[Getting Started]: https://docs.wokwi.com/vscode/getting-started
+[Debugging your code]: https://docs.wokwi.com/vscode/debugging
diff --git a/rusty_hangulclock/rust-toolchain.toml b/rusty_hangulclock/rust-toolchain.toml
@@ -0,0 +1,2 @@
+[toolchain]
+channel = "esp"
diff --git a/rusty_hangulclock/scripts/build.sh b/rusty_hangulclock/scripts/build.sh
@@ -0,0 +1,18 @@
+#!/bin/bash
+
+which idf.py >/dev/null || {
+    source ~/export-esp.sh >/dev/null 2>&1
+}
+
+case "$1" in
+"" | "release")
+    cargo build --release
+    ;;
+"debug")
+    cargo build
+    ;;
+*)
+    echo "Wrong argument. Only \"debug\"/\"release\" arguments are supported"
+    exit 1
+    ;;
+esac
diff --git a/rusty_hangulclock/scripts/flash.sh b/rusty_hangulclock/scripts/flash.sh
@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+set -e
+
+BUILD_MODE=""
+case "$1" in
+"" | "release")
+    bash scripts/build.sh
+    BUILD_MODE="release"
+    ;;
+"debug")
+    bash scripts/build.sh debug
+    BUILD_MODE="debug"
+    ;;
+*)
+    echo "Wrong argument. Only \"debug\"/\"release\" arguments are supported"
+    exit 1
+    ;;
+esac
+
+web-flash --chip esp32s2 target/xtensa-esp32s2-espidf/${BUILD_MODE}/hangulclock-rs
diff --git a/rusty_hangulclock/sdkconfig.defaults b/rusty_hangulclock/sdkconfig.defaults
@@ -0,0 +1,10 @@
+# Rust often needs a bit of an extra main task stack size compared to C (the default is 3K)
+CONFIG_ESP_MAIN_TASK_STACK_SIZE=8000
+
+# Use this to set FreeRTOS kernel tick frequency to 1000 Hz (100 Hz by default).
+# This allows to use 1 ms granularity for thread sleeps (10 ms by default).
+#CONFIG_FREERTOS_HZ=1000
+
+# Workaround for https://github.com/espressif/esp-idf/issues/7631
+#CONFIG_MBEDTLS_CERTIFICATE_BUNDLE=n
+#CONFIG_MBEDTLS_CERTIFICATE_BUNDLE_DEFAULT_FULL=n
diff --git a/rusty_hangulclock/src/main.rs b/rusty_hangulclock/src/main.rs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-module github.com/suapapa/HangulClock/sbc_hangulclock`
	`1`	`+module github.com/suapapa/HangulClock/go_hangulclock`
`2`	`2`
`3`	`3`	`go 1.19`
`4`	`4`