From 36371ca9ecbb40a25ae28546904250fbc8278fc0 Mon Sep 17 00:00:00 2001 From: BigTire Date: Sat, 17 Dec 2022 19:56:05 +0100 Subject: [PATCH] Added more information to readme. --- Readme.md | 39 +++++++++++++++++++++++++++++++++++---- 1 file changed, 35 insertions(+), 4 deletions(-) diff --git a/Readme.md b/Readme.md index 4512197..709356c 100644 --- a/Readme.md +++ b/Readme.md @@ -1,4 +1,35 @@ -# Neurosky Mindwave M5Stack Core2 connection -- Neusky Mindwave MAC Address: 98:07:2d:7f:ea:15 -- documentation: http://developer.neurosky.com/docs/doku.php?id=thinkgear_communications_protocol -- quick start guide: http://download.neurosky.com/public/Products/MindWave%20Mobile%202/MindWave%20Mobile%202%20Quick%20Start%20Guide.pdf \ No newline at end of file +# NeuroSky MindWave Mobile 2 and M5Stack Core2 connection +- Semester work for subject ZPI at faculty of applied sciences at the University of West Bohemia. Winter semester 2022. + +- **M1**: main controller that connects to the EEG headset, parse data and output them to Serial (terminal) and to the second controller M2 through UART + - ```/M1/M1.ino``` - main, actual version + - ```/M1/icons.cpp``` - icons in bitmap for GUI + - ```/M1/other_versions/2_threads``` - verison with 2 threads and loop but not working properly + - ```/M1/other_versions/without_multithreading``` - older verison just with loop, it doesn't have all features +- **M2**: second controller that send request to M1 for data (```0-4```) and output them on the screen + - ```/M2/M2.ino``` - main, actual version + - ```/M2/icons.cpp``` - icons in bitmap for GUI + +## DEVICES +- 2x M5Stack Core2 (https://shop.m5stack.com/products/m5stack-core2-esp32-iot-development-kit) +- NeuroSky MindWave Mobile 2 (https://store.neurosky.com/pages/mindwave) + - MAC Address of our headset: ```98:07:2d:7f:ea:15``` + +## FEATURES +- **M1**: bluetooth recovery (after disconnecting) +- **M1**: paring with device that has specific MAC address (declared in the beginning of code) +- **M1**: battery status icon (4 levels and charging icon) +- **M1**: signal quality icon (how poor the signal measured by the headset is) +- **M1**: screen mode button (light mode / dark mode switch) +- **M1**: brightness button (4 levels of brightness) +- **M1**: saving screen mode and brightness into the memory of microcontroller (then it boots up with last settings) + +## CONTACTS +- **Vojtěch Pour** - pourv@gapps.zcu.cz +- **Sebastián Hájek** - sebhajek@gapps.zcu.cz +- **Tomáš Hrbek** - tomhrbek@gapps.zcu.cz + +## SOURCES +- NeuroSky MindWave official documentation: http://developer.neurosky.com/docs/doku.php?id=thinkgear_communications_protocol +- NeuroSky MindWave quick start guide: http://download.neurosky.com/public/Products/MindWave%20Mobile%202/MindWave%20Mobile%202%20Quick%20Start%20Guide.pdf +- Bluetooth library: https://github.com/espressif/arduino-esp32/tree/master/libraries/BluetoothSerial \ No newline at end of file