From df247dd049bd3ccc99c6c57dde5e98f3613f53b4 Mon Sep 17 00:00:00 2001 From: NicK4rT Date: Sat, 23 Nov 2024 19:35:58 +0000 Subject: [PATCH] Render README.qmd files to Markdown [skip ci] --- README.md | 43 +++++++++++++++++++------ docs/README.md | 4 +-- firmware/README.md | 4 +-- hardware/README.md | 4 +-- overleaf/README.md | 4 +-- rstudio/README.md | 4 +-- software/README.md | 5 +-- software/applications/README.md | 47 +++++++++++++++++++++------ software/libraries/README.md | 26 ++++++++++++--- software/networking/README.md | 56 +++++++++++++++++++++++++++------ 10 files changed, 151 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index ee746c1..899d246 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,17 @@ - +--- +editor: visual +editor_options: + chunk_output_type: console +execute: + echo: false + message: false + warning: false +toc-title: Table of contents +--- # Smart System Education Platform -## Location: /README.qmd +## Location: /work/Smart-System-Platform/Smart-System-Platform/README.qmd ### Description @@ -12,6 +21,8 @@ This is the main directory. The repository has the following directory tree. +:::: cell +::: {.cell-output .cell-output-stdout} . ├── LICENSE ├── README.md @@ -24,14 +35,26 @@ The repository has the following directory tree. ├── project.Rproj ├── rstudio └── software +::: +:::: A short description of the directories can be found below. -| name | description | contribution | -|----|----|----| -| docs | This directory hosts the files for the website | Nick | -| firmware | This directory hosts the firmware | Nick | -| hardware | This directory hosts files and information about the hardware | Nick | -| software | This directory includes libraries, custom libraries and example code, such as the for example the networking library | Nick | -| overleaf | Latex Report Code | Nick | -| rstudio | R Code | Nick | + ------------------------------------------------------------------------------------- + name description contribution + ---------- ----------------------------------------------------------- -------------- + docs This directory hosts the files for the website Nick + + firmware This directory hosts the firmware Nick + + hardware This directory hosts files and information about the Nick + hardware + + software This directory includes libraries, custom libraries and Nick + example code, such as the for example the networking + library + + overleaf Latex Report Code Nick + + rstudio R Code Nick + ------------------------------------------------------------------------------------- diff --git a/docs/README.md b/docs/README.md index 5cf5c68..1799c30 100644 --- a/docs/README.md +++ b/docs/README.md @@ -21,7 +21,7 @@ This directory hosts the website. The repository has the following directory tree. -::: cell +:::: cell ::: {.cell-output .cell-output-stdout} . ├── README.md @@ -35,7 +35,7 @@ The repository has the following directory tree. ├── technology.html └── tools.html ::: -::: +:::: A short description of the directories can be found below. diff --git a/firmware/README.md b/firmware/README.md index 2a9b208..958aa06 100644 --- a/firmware/README.md +++ b/firmware/README.md @@ -21,14 +21,14 @@ This directory will host the custom firmware. The repository has the following directory tree. -::: cell +:::: cell ::: {.cell-output .cell-output-stdout} . ├── README.md ├── README.qmd └── README.rmarkdown ::: -::: +:::: A short description of the directories can be found below. diff --git a/hardware/README.md b/hardware/README.md index e052599..0992794 100644 --- a/hardware/README.md +++ b/hardware/README.md @@ -21,14 +21,14 @@ This directory will host files about the smart system hardware. The repository has the following directory tree. -::: cell +:::: cell ::: {.cell-output .cell-output-stdout} . ├── README.md ├── README.qmd └── README.rmarkdown ::: -::: +:::: A short description of the directories can be found below. diff --git a/overleaf/README.md b/overleaf/README.md index bebe73a..8992e12 100644 --- a/overleaf/README.md +++ b/overleaf/README.md @@ -21,14 +21,14 @@ This directory hosts the latex thesis report. The repository has the following directory tree. -::: cell +:::: cell ::: {.cell-output .cell-output-stdout} . ├── README.md ├── README.qmd └── README.rmarkdown ::: -::: +:::: A short description of the directories can be found below. diff --git a/rstudio/README.md b/rstudio/README.md index de41211..af79de5 100644 --- a/rstudio/README.md +++ b/rstudio/README.md @@ -21,7 +21,7 @@ This directory hosts the rstudio files. The repository has the following directory tree. -::: cell +:::: cell ::: {.cell-output .cell-output-stdout} . ├── README.md @@ -29,7 +29,7 @@ The repository has the following directory tree. ├── README.rmarkdown └── exampleREADME.qmd ::: -::: +:::: A short description of the directories can be found below. diff --git a/software/README.md b/software/README.md index e9d2ee0..4c8a59e 100644 --- a/software/README.md +++ b/software/README.md @@ -21,7 +21,7 @@ This directory hosts code for the smart modules. The repository has the following directory tree. -::: cell +:::: cell ::: {.cell-output .cell-output-stdout} . ├── README.md @@ -33,6 +33,7 @@ The repository has the following directory tree. │ ├── README.qmd │ ├── boop-o-meters │ ├── display + │ ├── githubfiledownload │ ├── p2p │ └── ping ├── archive @@ -58,7 +59,7 @@ The repository has the following directory tree. ├── examples └── networking.py ::: -::: +:::: A short description of the directories can be found below. diff --git a/software/applications/README.md b/software/applications/README.md index 332f049..4000a00 100644 --- a/software/applications/README.md +++ b/software/applications/README.md @@ -1,8 +1,17 @@ - +--- +editor: visual +editor_options: + chunk_output_type: console +execute: + echo: false + message: false + warning: false +toc-title: Table of contents +--- # -#### Location: /software/tools/README.qmd +#### Location: /work/Smart-System-Platform/Smart-System-Platform/software/applications/README.qmd ##### Description @@ -12,6 +21,8 @@ This directory hosts the code. The repository has the following directory tree. +:::: cell +::: {.cell-output .cell-output-stdout} . ├── MnS │ ├── master.py @@ -26,20 +37,38 @@ The repository has the following directory tree. ├── display │ ├── display.py │ └── networking_display.py + ├── githubfiledownload + │ └── filedownload.py ├── p2p │ └── main.py └── ping ├── echo.py └── shout.py +::: +:::: A short description of the directories can be found below. A short description of the directories can be found below. -| name | description | contribution | -|----|----|----| -| boop-o-meters | This code will allow you to send “boops” to any discovered mac address (i.e. every running smart motor that has networking.py initialised). It counts how many “boops” were sent and received. | Nick | -| display | Displays discovered smart modules with networking enabled. | Nick | -| MnS | This uses the networking code to control multiple smart motor using the sensor inputs of a “master” smart motor. The MAC is hard-coded. | Nick | -| p2p | This uses the networking code to have smart motors use their partners sensor inputs. The MAC is hard-coded. If there is no stream of sensor data received from the partner, the smart motor reverts back and uses their own inputs. | Nick | -| ping | Example code for pings and for returning pings (echo) | Nick | + ---------------------------------------------------------------------------------------------- + name description contribution + --------------- --------------------------------------------------------------- -------------- + boop-o-meters This code will allow you to send "boops" to any discovered mac Nick + address (i.e. every running smart motor that has networking.py + initialised). It counts how many "boops" were sent and + received. + + display Displays discovered smart modules with networking enabled. Nick + + MnS This uses the networking code to control multiple smart motor Nick + using the sensor inputs of a "master" smart motor. The MAC is + hard-coded. + + p2p This uses the networking code to have smart motors use their Nick + partners sensor inputs. The MAC is hard-coded. If there is no + stream of sensor data received from the partner, the smart + motor reverts back and uses their own inputs. + + ping Example code for pings and for returning pings (echo) Nick + ---------------------------------------------------------------------------------------------- diff --git a/software/libraries/README.md b/software/libraries/README.md index 663d340..c0e4187 100644 --- a/software/libraries/README.md +++ b/software/libraries/README.md @@ -1,8 +1,17 @@ - +--- +editor: visual +editor_options: + chunk_output_type: console +execute: + echo: false + message: false + warning: false +toc-title: Table of contents +--- # Smart System Education Platform -## Location: /software/libraries/README.qmd +## Location: /work/Smart-System-Platform/Smart-System-Platform/software/libraries/README.qmd ### Description @@ -12,14 +21,21 @@ This directory hosts used and useful libraries. The repository has the following directory tree. +:::: cell +::: {.cell-output .cell-output-stdout} . ├── README.md ├── README.qmd ├── README.rmarkdown └── variableLED.py +::: +:::: A short description of the directories can be found below. -| name | description | contribution | -|----------------|-------------------------------------------|--------------| -| variableLED.py | Library that powers the variable LED grid | Sophie | + ------------------------------------------------------------------------- + name description contribution + ---------------- ----------------------------------------- -------------- + variableLED.py Library that powers the variable LED grid Sophie + + ------------------------------------------------------------------------- diff --git a/software/networking/README.md b/software/networking/README.md index 2b5db9b..972f4aa 100644 --- a/software/networking/README.md +++ b/software/networking/README.md @@ -1,8 +1,17 @@ - +--- +editor: visual +editor_options: + chunk_output_type: console +execute: + echo: false + message: false + warning: false +toc-title: Table of contents +--- # Smart System Education Platform -## Location: /software/networking/README.qmd +## Location: /work/Smart-System-Platform/Smart-System-Platform/software/networking/README.qmd ### Description @@ -22,22 +31,49 @@ Channels: 14 The repository has the following directory tree. +:::: cell +::: {.cell-output .cell-output-stdout} . ├── README.md ├── README.qmd ├── README.rmarkdown ├── config.py ├── examples + │ ├── default_main.py │ ├── example.py - │ └── long_message_example.py + │ ├── long_message_example.py + │ └── pyscript_main.py └── networking.py +::: +:::: A short description of the directories can be found below. -| name | description | contribution | -|----|----|----| -| config.py | This file hosts configurations and secrets, such as the board name, WiFi name and password, as well as handshake keys which is used by some of the legacy networking code. | Nick | -| examples | This directory hosts example code | Nick | -| examples/example.py | This is some basic example code on how to use my networking library | Nick | -| examples/long_message_example.py | This code showcases the long message capabilities built into my code. By sending multiple messages that are then stitched back together by the recipient the max payload can be increased from 241 bytes to 256 x 238 = 60928 bytes, although in reality the ESP32 boards will start running out of memory with messages above 30 kilobytes. | Nick | -| networking.py | This is the main networking code that builds on ESP-NOW. There are many prepared functionalities (and some more that I am working on), such as long message support, sending of various variable types (bytes, bytearray, dicts, lists, int, float, char, string), as well as different types of messages such as ping, echo and more. There are also various features in place to make the networking more robust. It needs config.py to function. | Nick | + ----------------------------------------------------------------------------------------------------------------- + name description contribution + ---------------------------------- --------------------------------------------------------------- -------------- + config.py This file hosts configurations and secrets, such as the board Nick + name, WiFi name and password, as well as handshake keys which + is used by some of the legacy networking code. + + examples This directory hosts example code Nick + + examples/example.py This is some basic example code on how to use my networking Nick + library + + examples/long_message_example.py This code showcases the long message capabilities built into my Nick + code. By sending multiple messages that are then stitched back + together by the recipient the max payload can be increased from + 241 bytes to 256 x 238 = 60928 bytes, although in reality the + ESP32 boards will start running out of memory with messages + above 30 kilobytes. + + networking.py This is the main networking code that builds on ESP-NOW. There Nick + are many prepared functionalities (and some more that I am + working on), such as long message support, sending of various + variable types (bytes, bytearray, dicts, lists, int, float, + char, string), as well as different types of messages such as + ping, echo and more. There are also various features in place + to make the networking more robust. It needs config.py to + function. + -----------------------------------------------------------------------------------------------------------------