Ringinator/README.md

# Ringinator

The repository for my 3D-printed ring-shaped motion-control presentation control and pointer device written in C++ and TinyML and implemented with a TinyS3 microcontroller

## Goals

The goal is to develop a prototype device shaped like a ring that can be used to control presentations and as a laser pointer using only motion controls.

1. Maximum compactness
Everything needs to be small, the software should be minimalistic (ideally as much processing on the TinyS3 as possible)
2. Wirelessness

Planned commands:
Shaking your hand while pointing at the screen | Shaking your hand while pointing down | Pushing your finger towards or away from the screen | swiping your hand left and right | circling with your finger (counter-)clockwise | WIP
---|---|---|---|---|---|---
Activating the laser/computermouse mode | Disabling the laser/computermouse mode | left and right clicking | changing the volume | changing the slides forwards and backwards |  pointing your figer up for 2 seconds


## Project roadmap

- [ ] April: Hardware & Networking
    - [x] Creating a Typst template
    - [x] Creating the model for the ring
    - [x] Wiring the components together
    - [ ] Soldering the components together
    - [x] Creating the hull containing the components
    - [x] Establishing a connection between the TinyS3 and the PC
- [ ] May: Software: 
    - [x] IMU-Visualization 
    - [x] Sensor-fusion
    - [ ] Computer-side API:
        - [ ] Mapping the individual commands to keys
        - [ ] Gyroscope calibration routine
        - [ ] Mouse coordinate mapper (Euler Angles)
        - [ ] Calibrate the mouse
    - [ ] Setting up TinyML
- [ ] June: Training and evaluating the models


## Protoype