feat(mindmachine): implement Android MVP app scaffold, session flows, safety gating, and tests
This commit is contained in:
Tretzi
181
USER_MANUAL.md
Normal file
181
USER_MANUAL.md
Normal file
@@ -0,0 +1,181 @@
|
||||
# MindMachine - User Manual
|
||||
|
||||
## 1. What MindMachine Does
|
||||
|
||||
MindMachine turns your smartphone into a simple audiovisual mind machine.
|
||||
|
||||
During a session:
|
||||
- the screen displays blinking or pulsing light patterns,
|
||||
- stereo headphones play binaural audio,
|
||||
- the phone is placed in front of your eyes using a simple holder.
|
||||
|
||||
MindMachine is intended for relaxation, focus, meditation support, or experimentation. It is not a medical device.
|
||||
|
||||
---
|
||||
|
||||
## 2. Before You Begin
|
||||
|
||||
You will need:
|
||||
- a smartphone with the MindMachine app installed,
|
||||
- stereo headphones,
|
||||
- a simple cardboard phone holder or face-mounted support,
|
||||
- a safe, comfortable place to sit or lie down.
|
||||
|
||||
Do not use the app while walking, driving, cycling, or operating machinery.
|
||||
|
||||
---
|
||||
|
||||
## 3. Important Safety Information
|
||||
|
||||
Do not use visual stimulation mode if:
|
||||
- you are sensitive to flashing lights,
|
||||
- you have epilepsy or a seizure disorder,
|
||||
- flashing lights trigger migraines or discomfort for you,
|
||||
- you feel dizzy, nauseous, anxious, or unwell.
|
||||
|
||||
Stop the session immediately if you experience:
|
||||
- eye strain,
|
||||
- headache,
|
||||
- dizziness,
|
||||
- nausea,
|
||||
- panic,
|
||||
- discomfort of any kind.
|
||||
|
||||
Use stereo headphones for binaural sound sessions.
|
||||
|
||||
---
|
||||
|
||||
## 4. Building a Simple Cardboard Holder
|
||||
|
||||
You can create a simple holder from stiff cardboard.
|
||||
|
||||
The holder should:
|
||||
- keep the phone in front of your eyes without using your hands,
|
||||
- hold the phone securely,
|
||||
- avoid pressure on the eyes,
|
||||
- sit comfortably on the nose or forehead area,
|
||||
- allow enough airflow and comfort.
|
||||
|
||||
Think of it like very simple cardboard glasses or a visor.
|
||||
|
||||
Important:
|
||||
- do not press the phone tightly against your face,
|
||||
- do not block breathing,
|
||||
- make sure the phone cannot fall into your eyes,
|
||||
- test comfort before starting a session.
|
||||
|
||||
---
|
||||
|
||||
## 5. Starting a Session
|
||||
|
||||
1. Open MindMachine.
|
||||
2. Read the safety information.
|
||||
3. Connect stereo headphones.
|
||||
4. Choose a session preset.
|
||||
5. Review the session duration and settings.
|
||||
6. Place the phone into the holder.
|
||||
7. Position the phone in front of your eyes.
|
||||
8. Press **Start**.
|
||||
|
||||
A short countdown may appear before the session begins.
|
||||
|
||||
---
|
||||
|
||||
## 6. Choosing a Session
|
||||
|
||||
MindMachine may provide presets such as:
|
||||
- **Relax**
|
||||
- **Focus**
|
||||
- **Meditation**
|
||||
- **Sleep Prep**
|
||||
|
||||
Each preset may use different:
|
||||
- blinking speeds,
|
||||
- light patterns,
|
||||
- session lengths,
|
||||
- binaural beat settings.
|
||||
|
||||
If custom sessions are supported, you can adjust these settings yourself.
|
||||
|
||||
---
|
||||
|
||||
## 7. During a Session
|
||||
|
||||
During a session:
|
||||
- the screen will blink, flash, or pulse,
|
||||
- the audio will play through the headphones,
|
||||
- the app will keep the screen awake,
|
||||
- the remaining time may be shown.
|
||||
|
||||
You can usually:
|
||||
- pause the session,
|
||||
- resume the session,
|
||||
- stop the session at any time.
|
||||
|
||||
If anything feels uncomfortable, stop immediately.
|
||||
|
||||
---
|
||||
|
||||
## 8. After a Session
|
||||
|
||||
When the session ends, the app will:
|
||||
- stop the sound,
|
||||
- stop the visual pattern,
|
||||
- show a completion screen.
|
||||
|
||||
You may then:
|
||||
- repeat the same session,
|
||||
- return to the home screen,
|
||||
- choose a different preset.
|
||||
|
||||
---
|
||||
|
||||
## 9. Tips for Best Results
|
||||
|
||||
- Use the app in a calm environment.
|
||||
- Start with shorter sessions.
|
||||
- Use moderate brightness first.
|
||||
- Make sure your headphones are truly stereo.
|
||||
- Sit or lie down comfortably before starting.
|
||||
- Test your cardboard holder before a full session.
|
||||
|
||||
---
|
||||
|
||||
## 10. Troubleshooting
|
||||
|
||||
### No binaural effect
|
||||
Possible causes:
|
||||
- headphones are not connected,
|
||||
- audio is playing through speaker instead of headphones,
|
||||
- headphones are mono instead of stereo.
|
||||
|
||||
What to do:
|
||||
- reconnect headphones,
|
||||
- verify left/right stereo output,
|
||||
- restart the session.
|
||||
|
||||
### Screen turns off
|
||||
What to do:
|
||||
- reopen the app,
|
||||
- restart the session,
|
||||
- check battery-saving settings if needed.
|
||||
|
||||
### The session feels too intense
|
||||
What to do:
|
||||
- lower brightness,
|
||||
- choose a gentler preset,
|
||||
- shorten the session,
|
||||
- use audio-only mode if available.
|
||||
|
||||
### Phone holder is uncomfortable
|
||||
What to do:
|
||||
- adjust the cardboard shape,
|
||||
- reduce pressure points,
|
||||
- increase spacing from the face,
|
||||
- shorten the session until fit improves.
|
||||
|
||||
---
|
||||
|
||||
## 11. Best Practice Reminder
|
||||
|
||||
Use MindMachine carefully, start gently, and prioritize comfort and safety over intensity.
|
||||
Reference in New Issue
Block a user