Merge pull request #8 from kons-9/develop

For Tei2024

Author: kons-9

.cargo/config.toml.org

@@ -0,0 +1,18 @@
+[build]
+target = "riscv32imc-esp-espidf"
+
+# [target.riscv32imc-esp-espidf]
+# linker = "ldproxy"
+# runner = "espflash --monitor" # Select this runner for espflash v1.x.x
+# runner = "espflash flash --monitor /dev/ttyACM0" # Select this runner for espflash v2.x.x
+# rustflags = ["-C", "default-linker-libraries"]
+# rustflags = ["--cfg", "espidf_time64", "-C", "default-linker-libraries"]
+
+[unstable]
+build-std = ["std", "panic_abort"]
+
+[env]
+# Note: these variables are not used when using pio builder (`cargo build --features pio`)
+ESP_IDF_VERSION = "release/v4.4"
+# ESP_IDF_VERSION = "v5.1"
+

.gitignore

@@ -1,6 +1,9 @@
-/.vscode
-/.embuild
-/target
-/Cargo.lock
+.vscode
+.embuild
+.cache
+target
+Cargo.lock
 cfg.toml
-src/bin/write_efuse_localnet_*.rs
+tmp
+
+shapechangeable-display/src/bin/write_efuse_localnet_*.rs

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "shapechangeable-display/gen_asset/raw_translater"]
+	path = shapechangeable-display/gen_asset/raw_translater
+	url = https://github.com/kons-9/raw_translater

Cargo.toml

@@ -1,63 +1,19 @@
-[package]
-name = "std-display"
-version = "0.1.0"
-authors = ["toshiki goto <[email protected]>"]
-edition = "2021"
+[workspace]
 resolver = "2"
-rust-version = "1.66"
 
-[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 = ["std", "hal", "esp-idf-sys/native"]
-
-
-pio = ["esp-idf-sys/pio"]
-all = ["std", "nightly", "experimental", "embassy"]
-hal = ["esp-idf-hal", "embedded-svc", "esp-idf-svc"]
-std = ["alloc", "esp-idf-sys/std", "esp-idf-sys/binstart", "embedded-svc?/std", "esp-idf-hal?/std", "esp-idf-svc?/std"]
-alloc = ["embedded-svc?/alloc", "esp-idf-hal?/alloc", "esp-idf-svc?/alloc"]
-nightly = ["embedded-svc?/nightly", "esp-idf-svc?/nightly"] # Future: "esp-idf-hal?/nightly"
-experimental = ["embedded-svc?/experimental", "esp-idf-svc?/experimental"]
-embassy = ["esp-idf-hal?/embassy-sync", "esp-idf-hal?/critical-section", "esp-idf-hal?/edge-executor", "esp-idf-svc?/embassy-time-driver", "esp-idf-svc?/embassy-time-isr-queue"]
-
-[dependencies]
-log = { version = "0.4.19", default-features = false }
-esp-idf-sys = { version = "0.33", default-features = false }
-esp-idf-hal = { version = "0.41", optional = true, default-features = false }
-esp-idf-svc = { version = "0.46", optional = true, default-features = false }
-embedded-svc = { version = "0.25", optional = true, default-features = false }
-anyhow = "1.0.71"
-shtcx = "0.11.0"
-toml-cfg = "0.1.3"
-rand = "0.8.5"
-esp32c3 = "0.15.0"
-num_enum = "0.6.1"
-st7735-lcd = "0.9.0"
-embedded-graphics = "0.8.0"
-embedded-hal = "0.2.7"
-
-[build-dependencies]
-embuild = "0.31.2"
-anyhow = "1.0.71"
-toml-cfg = "0.1.3"
-num_enum = "0.6.1"
-
-# [[bin]]
-# name = "read_efuse"
-# path = "examples/read_efuse.rs"
-#
-# [[bin]]
-# name = "st7735_display"
-# path = "examples/st7735_display.rs"
-#
-# [[bin]]
-# name = "uartex"
-# path = "examples/uartex.rs"
+members = [
+  "ota",
+  "shapechangeable-display",
+  "network-node",
+  "global-network",
+  "applications",
+]
+# resolver = "2"
+
+# [profile.release]
+# opt-level = "s"
 #
+# [profile.dev]
+# debug = true
+# opt-level = "z"
+

README.md

@@ -1,131 +1,14 @@
-# Shape changeable display
+# ShapeChangeable Display
 
-## WIP
+## Overview
+This project is a reference implementation of the shapechangeable display.
 
-## test of hardware
-You can use example/\*.rs as test of hardware.  
-But be careful using efuse-write function. it is not recoverable after you execute it.(you can generate using generate.zsh)
-<!-- But you should not use efuse.rs before  -->
+## Usage
+### Prerequisites
+you should install tools following [ESP Book](https://esp-rs.github.io/book/introduction.html)
 
-# documents
-## Flit
-Flit consists of 64 bits. Flit type is only four types, basic three types, head, body and tail, and irregular one type, nope flit.
-A header of flit(packet) that need only head flit begin with H.
-An ack flit (, which header is HAck) is generally sent by the system when it receive a flit.
-Nope flit will used for timing adjustment.  
-
-### HeadFlit
-HeadFlit id is 0.
-
-FlitType(2) | LengthOfFlit(6) | Header(8) | SourceId(16) | DestinationId(16) | PacketId(8) | Checksum(8)
-:--:|:--:|:--:|:--:|:--:|:--:|:--:
-### Body and TailFlit
-
-FlitType(2) | FlitId(6) | Message(48) | Checksum(8)
-:--:|:--:|:--:|:--:
-### NopeFlit
-
- FlitType(2) | (undefined)(62) 
-:--:|:--:
-
-todo: flitId and length of flit is mod 6bit.
-
-## Packet
-General packet, which means the packet have body and tail flit, has packetid, global sourceId, global destinationId and checksum like below.
-
- packetId(8) | checksum(8) | globalDestinationId(16) | globalDestinationId(16) | data(...)
-:--:|:--:|:--:|:--:|:--:
-
-This means first body flit doesn't have any messages.
-
-## Network Protocol
-Network Protocol must implement `network::protocol::Protocol` trait.
-
-## About Each Process and detail of Packets
-This section explains processes and their packets.
-Note that explanations of these packets is data region of Packet.
-
-### General case
-If you want to use the library with other application, you use these packets.
-
-#### General ack
-##### Explanation
-If you want to make ack packet in system such as TCP, you can use this packet.
-##### Implementation
-Only head flit. 
-Header is `GeneralAck`, not `HAck`, which is used for the system flit.
-
-#### General data
-##### Explanation
-This library is not process this packet.
-So, you should reshape it into any form you want.
-##### Implementation
-Header is `Data`.
-
-#### Error
-##### Explanation
-Flit error is mainly processed by the library, but packet error isn't.
-So, you should handle with this packet.
-This error may occur in checksum process of packet. 
-So, you should resend packet, but it's optional.
-##### Implementation
-Header is `Error`.
-
-### Making local network
-These packets are used for making local network by system.
-The process is this:
-1. the system sent check connection packet periodically, and then, receive check connection.
-2. If the system receive check connection packet, then sent request confirmed coordinate packet.
-3. If the system receive sufficient number of confirm coordinate packets, the system can analyse coordinate.
-
-#### Check connection
-##### Explanation
-In this system, because unit of shapechangeable display is 4 nodes, these nodes connect each others. But, the unit should connect other units. This packet is used then firstly. 
-##### Implementation
-Only head flit. This packet is broadcast but processed only in other local networks.
-Header is `HCheckConnection`.
-
-#### Request confirmed coordinate
-##### Explanation
-Due to get global coordinate, you should access other nodes' coordinate.
-##### Implementation
-Only head flit. This packet is sent by broadcast.
-Header is `HRequestConfirmedCoordinate`
-
-#### Reply for request confirmed coordinate
-##### Explanation
-this packet is reply for request confirmed coordinate packet.
-
-##### Implementation
-When the system receive this packet, system will check the global source address of packet. 
-If it is sent from a node which is in the same local network and is not confirmed, the packet has information of nodes which is next to the node not in local network. Otherwise, the packet is only sent by confirmed node.
-
-Data form is like this:
-
-is confirmed(8) | id(16) | x(16) | y(16) | id(16) | ...
-:--:|:--:|:--:|:--:|:--:|:--:
-
-Node that received this packet is in the same node as local 
-This packet is sent by broadcast.
-Header is `ConfirmCoordinate`
-
-### Joining global network
-Todo: These packets are used for making global network by system.
-
-#### Request join network
-##### Explanation
-##### Implementation
-
-#### Reply for request join network
-##### Explanation
-##### Implementation
-
-# Note
-* a requirement of packet that has only headflit is that
-** this data doesn't need to have a address that specify original source id, or this data is sent to just next node and this information is included in header.
-
-# todo
-I put `todo:` in source file in detail. Others are below.
-* Handle uart interruption
-* Handle uart buffer overflow 
-* Use flit buffer
+### Run Example
+```
+% cd shapechangeable-display
+% cargo espflash flash --monitor --release --example estimate_coordinate_tei
+```

applications/Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "applications"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+embedded-graphics = "0.8.1"
+anyhow = "1.0.72"
+network-node = { path = "../network-node" }

applications/src/application/mod.rs

@@ -0,0 +1 @@
+

applications/src/lib.rs

@@ -0,0 +1,80 @@
+use crate::manager::MessageQueue;
+use anyhow::Result;
+use network_node::header::Header;
+use std::sync::Arc;
+use std::thread;
+use std::thread::JoinHandle;
+
+pub mod manager;
+pub mod task;
+
+// App is Sized
+pub trait App {
+    // interface of network
+    // type Output;
+    fn process_messages(&mut self, messages: Vec<u8>) -> Result<()>;
+
+    /// default do nothing
+    fn set_priority(&mut self, priority: u8) {
+        eprintln!("priority: {}, but not implemented", priority);
+        ()
+    }
+
+    /// default error handler is just ignore it
+    fn error_handler(&mut self, error: anyhow::Error) -> Result<()> {
+        eprintln!("error: {}", error);
+        Ok(())
+    }
+
+    /// if this app is related to a specific header, return it
+    fn my_headers(&self) -> Option<Vec<Header>> {
+        None
+    }
+
+    /// default app wake up only when message is received and host notifys it
+    fn create_task(mut self, message: &Arc<MessageQueue>, priority: u8) -> JoinHandle<()>
+    where
+        Self: Sized + Send + 'static,
+    {
+        let message = Arc::clone(message);
+        self.set_priority(priority);
+        thread::spawn(move || loop {
+            let old_message = {
+                // swap message and release lock
+                let message_queue = message.queue.lock().unwrap();
+                let mut message = message
+                    .condvar
+                    .wait_while(message_queue, |q| q.is_empty())
+                    .unwrap();
+                let mut old_message = Vec::new();
+                std::mem::swap(&mut *message, &mut old_message);
+                old_message
+            };
+
+            self.process_messages(old_message)
+                .map_err(|e| self.error_handler(e))
+                .unwrap();
+        })
+    }
+}
+
+pub struct Output();
+
+pub mod image {
+    use anyhow::Result;
+
+    pub struct GetImageApp {}
+    impl GetImageApp {
+        pub fn new() -> Self {
+            Self {}
+        }
+    }
+    impl super::App for GetImageApp {
+        // type Output = (Vec<u8>, u32, Option<Point>);
+
+        fn process_messages(&mut self, messages: Vec<u8>) -> Result<()> {
+            println!("get image: {:?}", messages);
+            unimplemented!()
+        }
+    }
+}