From 42134e20ebad45fb4365b1567219fab6c2c7b896 Mon Sep 17 00:00:00 2001 From: aburt2 <32888184+aburt2@users.noreply.github.com> Date: Fri, 27 Oct 2023 15:32:22 -0400 Subject: [PATCH] added links to puara gestures library, added status table for designs indicating whether it is still recommended --- README.md | 11 +++++++++++ docs/Technical Requirements and Constraints.md | 4 ++-- docs/algorithms/Puara Gestures.md | 5 +++++ docs/designs/T-Stick 4GW/Technical Information.md | 1 + docs/designs/T-Stick 5GW.md | 2 +- docs/designs/T-Stick 5GW/Technical Information.md | 1 + 6 files changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d6373e4..5fc04db 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,14 @@ Repository for T-Stick documentation at https://idmil.github.io/tstick-docs/ Pages generated using Docsify.js To learn more about using Docsify, visit https://docsify.js.org. + +## TODO +- [ ] Finish Detailed Technical Information for T-Stick 4GW/5GW +- [ ] Add High level Puara Gestures information +- [ ] Finish writing justifications for the technical equirements +- [ ] Write Contributer's Guide +- [ ] Create page templates +- [ ] Check all links are functioning +- [ ] Check all images display properly +- [ ] Move information from [T-Stick Archive Github repository](https://github.com/IDMIL/T-Stick-Archive/tree/510e0442aa7dcef755de2b2bd9c8bcb03a8b61f5) for the older T-Stick Designs + diff --git a/docs/Technical Requirements and Constraints.md b/docs/Technical Requirements and Constraints.md index 9bf2e5a..cabd3af 100644 --- a/docs/Technical Requirements and Constraints.md +++ b/docs/Technical Requirements and Constraints.md @@ -1,6 +1,6 @@ # Technical Requirements and Constraints -This page outline the technical requirements of the T-Stick as well as constraints inherited from previous designs. The goal is that with these technical requirements and constraints someone will be able to build a T-Stick that is functionally identical to the designs that have previously been built. +This page outline the technical requirements of the T-Stick as well as constraints inherited from previous designs. The goal is that with these technical requirements and constraints someone will be able to build a T-Stick that is functionally similar to the designs that have previously been built. ## Verification Method table @@ -125,7 +125,7 @@ Calibration is important, as it improves sensor accuracy and precision, artist s ### 4. Reliability and Maintainability -As the name suggests this section contains all requirements relating to reliability and availability. This includes a PIR and PMR target for the T-Stick. We use the model defined in INSERTREFERENCEHERE for computing the PIR and PMR of the T-Stick. The robustness requirements are to ensure the T-Stick can handle elevated levels of shaking and jabbing for short periods of time without permanent failures. +As the name suggests this section contains all requirements relating to reliability and availability. This includes a PIR and PMR target for the T-Stick. We use the model defined in the [Availability Modelling](./Availability%20Modelling.md) page for computing the PIR and PMR of the T-Stick. The robustness requirements are to ensure the T-Stick can handle elevated levels of shaking and jabbing for short periods of time without permanent failures. | **ID** | **Requirements** | **Verification Method (IADT)** | |----|----|----| diff --git a/docs/algorithms/Puara Gestures.md b/docs/algorithms/Puara Gestures.md index 619b1f0..657f19b 100644 --- a/docs/algorithms/Puara Gestures.md +++ b/docs/algorithms/Puara Gestures.md @@ -2,6 +2,10 @@ Note: Article still a Work in Progress +## Read More +- [Source Code](https://github.com/Puara/puara-gestures) +- Documentation + ## High-Level gesture vocabulary for the T-Stick Presented codes are arduino compatible. @@ -9,6 +13,7 @@ Presented codes are arduino compatible. ### Summary: - [Puara Gestures](#puara-gestures) + - [Read More](#read-more) - [High-Level gesture vocabulary for the T-Stick](#high-level-gesture-vocabulary-for-the-t-stick) - [Summary:](#summary) - [Signal structures and global variables:](#signal-structures-and-global-variables) diff --git a/docs/designs/T-Stick 4GW/Technical Information.md b/docs/designs/T-Stick 4GW/Technical Information.md index 1684fb4..9595e40 100644 --- a/docs/designs/T-Stick 4GW/Technical Information.md +++ b/docs/designs/T-Stick 4GW/Technical Information.md @@ -6,6 +6,7 @@ | Feature | Details | |----|----| +| Status | Not recommended for new builds | | Communication Type | Wi-Fi, 802.11 b/g/n | | Compatible protocols | Open Sound Control (OSC)/Libmapper | | Touch Sensing Density | 1 channel per 2cm | diff --git a/docs/designs/T-Stick 5GW.md b/docs/designs/T-Stick 5GW.md index a462dfe..ae476b7 100644 --- a/docs/designs/T-Stick 5GW.md +++ b/docs/designs/T-Stick 5GW.md @@ -25,7 +25,7 @@ The Trill Craft board is kept as the capacitive sensor solution of choice. A mor Note: Section is still a Work in Progress -Like the fourth generation T-Sticks this 5th generation of T-Sticks also includes embedded gestures. It also uses the Puara Gestures Library for gesture extraction. The table below lists all the properties that are extracted for the high-level gesture. +Like the fourth generation T-Sticks this 5th generation of T-Sticks also includes embedded gestures. It also uses the Puara Gestures Library for gesture extraction. The table below lists all the properties that are extracted. ### Table 1: High Level Gestures diff --git a/docs/designs/T-Stick 5GW/Technical Information.md b/docs/designs/T-Stick 5GW/Technical Information.md index 1c3093c..5b0ad5b 100644 --- a/docs/designs/T-Stick 5GW/Technical Information.md +++ b/docs/designs/T-Stick 5GW/Technical Information.md @@ -6,6 +6,7 @@ | Feature | Details | |----|----| +| Status | In Development | | Communication Type | Wi-Fi, 802.11 b/g/n | | Compatible protocols | Open Sound Control (OSC)/Libmapper | | Touch Sensing Density | 1 channel per 1cm |