map out a simple system architecture

[mbz4]

• [x] explore options for mapping out sys arch
• [x] explore tools: mkdocs, markmap in VS Code
• [x] prep Github Page for docs hosting
• [x] visually represent the ideal RSC as a mindmap
• [x] note & explore key systems
• [x] simplify the graphing as much as possible
• [x] extend mindmap with current status
• [x] highlight present developments

https://github.com/orgs/RobotStudyCompanion/discussions/2

https://github.com/RobotStudyCompanion/Documentation/tree/main/RSC_docs

[mbz4]

[mbz4]

markmap docs (api): https://markmap.js.org/api/functions/markmap_common.walkTree.html

[mbz4]

https://markmap.js.org/docs/faq

[mbz4]

==latest version== Hosted here: https://robotstudycompanion.github.io/Documentation/RSC_docs/docs/rsc_sys_arch_map.html

---

title:

Robot[ic]
Study
Companion

markmap: colorFreezeLevel: 5 initialExpandLevel: -1

Interaction

Audio

• [ ] PyAudio 0.2.14

  • [x] (IN) Respeaker 2 Mics HAT
  • [ ] (IN) AIY Voice Bonnet v2
  • [ ] (IN) USB Mic
  • [x] (OUT) Built-In Speaker
  • [ ] (OUT) BT Speaker

• [ ] Speech

  • [ ] Speech-To-Text

  • [x] SpeechRecognition 3.10.4

  • [ ] OpenAI/Whisper v20231117

  • [ ] LLM Inference

  • [ ] (Local) Ollama

  • [x] (Remote) OpenAI API

  • [ ] (Remote) Anthropic API

  • [ ] (Remote) Google Gemini API

  • [x] Text-To-Speech

  • [x] pyttsx3 2.91

  • [ ] OpenAI TTS

• [ ] RSC Status

  • [ ] loading
  • [ ] sentiment
  • [ ] error
  • [ ] waiting

Visual

• [x] 16x NeoPixel Ring: RSC Status

  • [ ] loading
  • [ ] sentiment
  • [ ] error
  • [ ] waiting

• [x] NX3224T024: touch display

  • [ ] conversations
  • [ ] logs
  • [ ] sentiment
  • [ ] settings
  • [ ] menus

Tactile

• [x] Arcade Push Button (24mm)
  • [ ] start/stop conversation
  • [ ] quick input
  • [ ] settings control

Gestures

• [x] SG90: Servo
  • [ ] greeting
  • [ ] excitement
  • [ ] encouragement

Environment

• [ ] MR60BHA1: mmWave Radar
  • user presence
  • heart rate
  • respiratory rate
• [ ] SCD4x: Photoacoustic NDIR CO2 sensor
  • air quality
  • temperature
  • humidity
• [ ] TMF882X multizone dToF proximity sensor
  • surface albedo
  • surface slope
  • surface distance
  • ambient light
• [ ] Mic: ambient noise level

Dev

Docs

• [ ] Assembly
• [ ] Configuration
• [ ] Troubleshooting
• [ ] FAQ

CodeStation

Interaction Engine

• [ ] LLM inferencing
• [ ] sentiment inferencing
• [ ] affect recognition inferencing

Device Manager

• [ ] motion control
• [ ] environment sensing
• [ ] audio control
• [ ] display manager
• [ ] service server
• [ ] web app hosting

Test Suite

• [x] mic
• [x] NeoPixel LED Ring
• [x] speaker
• [ ] Touch Display
• [ ] sensors
• [x] motor test

(Web) App

• [ ] profile management
• [ ] chat interface
• [ ] study planner
• [ ] course tracker
• [ ] progress monitor
• [ ] device management
• [ ] troubleshooting
• [ ] support

MechDesign

• modular design
• guide grooves
• snap-fit construction
• 3D printed enclosure

ElectroCircuits

• [x] expansion board schematic
• [ ] expansion board PCB
• [x] wiring diagram
• [ ] troubleshoot guide

Publishing

Publications

• MDPI repl. pkgs
• ICSR repl. pkgs
• UniTartu MSc repl. pkgs
• UniGuyana BSc repl. pkgs

Media

• Videos
  • raw, short clips
  • rendered examples
  • video documentation
  • tutorial videos
  • gif clips
• Albums
  • product photos
  • profile photos
• Posters
• Blogs
  • Short articles
  • Reviews

Promoting

• online sharing
  • track reach
  • AdSense
  • plan posts
  • posts catalog
  • platforms
  • LinkedIn
  • YouTube
  • OpenSauced
  • GitHub Education
• RSC - Discussions
• releases

Funding

• Crowdfunding
  • [ ] crowdsupply
• Sponsorship
  • [ ] Kofi
  • [ ] Patreon
• Donations

[mbz4]

[mbz4]

latest version

[mbz4]

testing next url href links open in new tab instead of current tab

Docs

[mbz4]

https://markmap.js.org/docs/json-options