From 9b2eea78e926c92eed9e2a5e2f5b3a567ca7fb1e Mon Sep 17 00:00:00 2001 From: aburt2 <32888184+aburt2@users.noreply.github.com> Date: Fri, 26 Jul 2024 21:29:25 +1000 Subject: [PATCH] restructured the technical documentation under a single tab, removed functions page --- docs/engineering/functions.md | 16 ---------------- mkdocs.yml | 8 +++----- 2 files changed, 3 insertions(+), 21 deletions(-) delete mode 100644 docs/engineering/functions.md diff --git a/docs/engineering/functions.md b/docs/engineering/functions.md deleted file mode 100644 index 7bd87e2..0000000 --- a/docs/engineering/functions.md +++ /dev/null @@ -1,16 +0,0 @@ -# T-Stick Functions - -## Introduction - -This page outlines the high level functions the T-Stick does and links previous designs of the T-Stick for inspiration of how the functions were accomplished. - -## Functional Analysis - -As shown in figure below the T-Stick has a relatively straight forward functional flow block diagram. - - - ![functional flow block diagram of T-Stick](../Images/ffbd-tstick.png) - -The sensors must be initialised, and then regularly polled for their raw sensor data. Any sensor errors must be processed and then converted to error messages to be sent to the user. In the fourth generation of T-Sticks this function is not fully developed but still exists, as most errors are at least printed to the serial monitor. The power system of the T-Stick handles charging the instrument, providing power to all components and changing the power state between active operation and deep sleep. The control and communication system output signals and interpret any user inputs/signals such as using the serial monitor to reboot the T-Stick. - - diff --git a/mkdocs.yml b/mkdocs.yml index a1bc0cf..1b4d41f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -73,12 +73,9 @@ nav: - Changing communication protocols: setup/wireless-settings.md - Changing sensor settings: setup/advanced-settings.md - Change settings using json file: setup/json-settings.md - - Technical Documentation: - - T-Stick Design Guidelines: engineering/design-guidelines.md - - T-Stick 5GW Design Requirements: engineering/requirements.md - - T-Stick 4GW/5GW Functions: engineering/functions.md - - T-Stick Gestures: engineering/gestures.md - Design Documentation: + - Design Guidelines: engineering/design-guidelines.md + - T-Stick Gestures: engineering/gestures.md - 4th Generation T-Sticks: - designs/tstick-4gw/index.md - Variants: @@ -90,6 +87,7 @@ nav: - Connecting Guide: designs/tstick-4gw/connection-guide.md - 5th Generation T-Sticks: - designs/tstick-5gw/index.md + - Design Requirements: engineering/requirements.md - Variants: - T-Stick 5GW-Trill: designs/tstick-5gw/specs_5gw_trill.md - T-Stick 5GW-Enchanti: designs/tstick-5gw/specs_5gw_enchanti.md