├── .gitignore ├── AVR-NANO-UNO-MEGA └── AVR-NANO-UNO-MEGA.ino ├── GIGA-R1 └── GIGA-R1.ino ├── LICENSE ├── NPG-LITE-BLE └── NPG-LITE-BLE.ino ├── NPG-LITE-WiFi └── NPG-LITE-WiFi.ino ├── NPG-LITE └── NPG-LITE.ino ├── README.md ├── RPI-PICO-RP2040 └── RPI-PICO-RP2040.ino ├── STM32F4-BLACK-PILL └── STM32F4-BLACK-PILL.ino ├── STM32G4-CORE-BOARD └── STM32G4-CORE-BOARD.ino └── UNO-R4 └── UNO-R4.ino /.gitignore: -------------------------------------------------------------------------------- 1 | # Prerequisites 2 | *.d 3 | 4 | # Compiled Object files 5 | *.slo 6 | *.lo 7 | *.o 8 | *.obj 9 | 10 | # Precompiled Headers 11 | *.gch 12 | *.pch 13 | 14 | # Compiled Dynamic libraries 15 | *.so 16 | *.dylib 17 | *.dll 18 | 19 | # Fortran module files 20 | *.mod 21 | *.smod 22 | 23 | # Compiled Static libraries 24 | *.lai 25 | *.la 26 | *.a 27 | *.lib 28 | 29 | # Executables 30 | *.exe 31 | *.out 32 | *.app 33 | -------------------------------------------------------------------------------- /AVR-NANO-UNO-MEGA/AVR-NANO-UNO-MEGA.ino: -------------------------------------------------------------------------------- 1 | // This program is free software: you can redistribute it and/or modify 2 | // it under the terms of the GNU General Public License as published by 3 | // the Free Software Foundation, either version 3 of the License, or 4 | // (at your option) any later version. 5 | // 6 | // This program is distributed in the hope that it will be useful, 7 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 8 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 9 | // GNU General Public License for more details. 10 | // 11 | // You should have received a copy of the GNU General Public License 12 | // along with this program. If not, see . 13 | // 14 | // Copyright (c) 2024 - 2025 Upside Down Labs - contact@upsidedownlabs.tech 15 | // Author: Deepak Khatri 16 | // 17 | // At Upside Down Labs, we create open-source DIY neuroscience hardware and software. 18 | // Our mission is to make neuroscience affordable and accessible for everyone. 19 | // By supporting us with your purchase, you help spread innovation and open science. 20 | // Thank you for being part of this journey with us! 21 | 22 | #include 23 | 24 | /** 25 | ** Select your board from list below 26 | ** Uncomment only your board macro 27 | **/ 28 | 29 | // #define BOARD_NANO_CLONE 30 | // #define BOARD_MAKER_NANO 31 | // #define BOARD_NANO_CLASSIC 32 | // #define BOARD_UNO_R3 33 | // #define BOARD_GENUINO_UNO 34 | // #define BOARD_UNO_CLONE 35 | // #define BOARD_MAKER_UNO 36 | // #define BOARD_MEGA_2560_R3 37 | // #define BOARD_MEGA_2560_CLONE 38 | 39 | // Board specific macros 40 | // Do not edit anything! 41 | #if defined(BOARD_UNO_R3) 42 | #define BOARD_NAME "UNO-R3" 43 | #define NUM_CHANNELS 6 44 | #elif defined(BOARD_GENUINO_UNO) 45 | #define BOARD_NAME "GENUINO-UNO" 46 | #define NUM_CHANNELS 6 47 | #elif defined(BOARD_UNO_CLONE) || defined(BOARD_MAKER_UNO) 48 | #define BOARD_NAME "UNO-CLONE" 49 | #define NUM_CHANNELS 6 50 | #elif defined(BOARD_NANO_CLASSIC) 51 | #define BOARD_NAME "NANO-CLASSIC" 52 | #define NUM_CHANNELS 8 53 | #elif defined(BOARD_NANO_CLONE) || defined(BOARD_MAKER_NANO) 54 | #define BOARD_NAME "NANO-CLONE" 55 | #define NUM_CHANNELS 8 56 | #elif defined(BOARD_MEGA_2560_R3) 57 | #define BOARD_NAME "MEGA-2560-R3" 58 | #define NUM_CHANNELS 16 59 | #elif defined(BOARD_MEGA_2560_CLONE) 60 | #define BOARD_NAME "MEGA-2560-CLONE" 61 | #define NUM_CHANNELS 16 62 | #else 63 | #error "Board type not selected, please uncomment your BOARD macro!" 64 | #endif 65 | 66 | // Common macros 67 | #define SAMP_RATE 250 68 | #define BAUD_RATE 115200 69 | #define HEADER_LEN 3 // Header = SYNC_BYTE_1 + SYNC_BYTE_2 + Counter 70 | #define PACKET_LEN (NUM_CHANNELS * 2 + HEADER_LEN + 1) // Packet length = Header + Data + END_BYTE 71 | #define SYNC_BYTE_1 0xC7 // Packet first byte 72 | #define SYNC_BYTE_2 0x7C // Packet second byte 73 | #define END_BYTE 0x01 // Packet last byte 74 | 75 | // defines for setting and clearing register bits 76 | #ifndef cbi 77 | #define cbi(sfr, bit) (_SFR_BYTE(sfr) &= ~_BV(bit)) 78 | #endif 79 | #ifndef sbi 80 | #define sbi(sfr, bit) (_SFR_BYTE(sfr) |= _BV(bit)) 81 | #endif 82 | 83 | // Global constants and variables 84 | uint8_t packetBuffer[PACKET_LEN]; // The transmission packet 85 | uint8_t currentChannel; // Current channel being sampled 86 | uint16_t adcValue = 0; // ADC current value 87 | bool timerStatus = false; // SATUS bit 88 | bool bufferReady = false; // Buffer ready status bit 89 | 90 | bool timerStart() { 91 | timerStatus = true; 92 | digitalWrite(LED_BUILTIN, HIGH); 93 | // Enable Timer1 Compare A interrupt 94 | return TIMSK1 |= (1 << OCIE1A); 95 | } 96 | 97 | bool timerStop() { 98 | timerStatus = false; 99 | bufferReady = false; 100 | digitalWrite(LED_BUILTIN, LOW); 101 | // Disable Timer1 Compare A interrupt 102 | return TIMSK1 &= ~(1 << OCIE1A); 103 | } 104 | 105 | // ISR for Timer1 Compare A match (called based on the sampling rate) 106 | ISR(TIMER1_COMPA_vect) { 107 | if (!timerStatus or Serial.available()) { 108 | timerStop(); 109 | return; 110 | } 111 | 112 | // Set bufferReady status bit to true 113 | bufferReady = true; 114 | } 115 | 116 | void timerBegin(float sampling_rate) { 117 | cli(); // Disable global interrupts 118 | 119 | // Set prescaler division factor to 16 120 | sbi(ADCSRA, ADPS2); // 1 121 | cbi(ADCSRA, ADPS1); // 0 122 | cbi(ADCSRA, ADPS0); // 0 123 | 124 | // Calculate OCR1A based on the interval 125 | // OCR1A = (16MHz / (Prescaler * Desired Time)) - 1 126 | // Prescaler options: 1, 8, 64, 256, 1024 127 | unsigned long ocrValue = (16000000 / (8 * sampling_rate)) - 1; 128 | 129 | // Configure Timer1 for CTC mode (Clear Timer on Compare Match) 130 | TCCR1A = 0; // Clear control register A 131 | TCCR1B = 0; // Clear control register B 132 | TCNT1 = 0; // Clear counter value 133 | 134 | // Set the calculated value in OCR1A register 135 | OCR1A = ocrValue; 136 | 137 | // Set CTC mode (WGM12 bit) and set the prescaler to 8 138 | TCCR1B |= (1 << WGM12) | (1 << CS11); // Prescaler = 8 139 | 140 | sei(); // Enable global interrupts 141 | } 142 | 143 | void setup() { 144 | Serial.begin(BAUD_RATE); 145 | while (!Serial) { 146 | ; // Wait for serial port to connect. Needed for native USB 147 | } 148 | 149 | // Status LED 150 | pinMode(LED_BUILTIN, OUTPUT); 151 | digitalWrite(LED_BUILTIN, LOW); 152 | 153 | // Initialize packetBuffer 154 | packetBuffer[0] = SYNC_BYTE_1; // Sync 0 155 | packetBuffer[1] = SYNC_BYTE_2; // Sync 1 156 | packetBuffer[2] = 0; // Packet counter 157 | packetBuffer[PACKET_LEN - 1] = END_BYTE; // End Byte 158 | 159 | // Setup timer 160 | timerBegin(SAMP_RATE); 161 | } 162 | 163 | void loop() { 164 | // Send data if the buffer is ready and the timer is activ 165 | if (timerStatus and bufferReady) { 166 | 167 | // ADC value Reading, Converting, and Storing: 168 | for (currentChannel = 0; currentChannel < NUM_CHANNELS; currentChannel++) { 169 | 170 | // Read ADC input 171 | adcValue = analogRead(currentChannel); 172 | 173 | // Store current values in packetBuffer to send. 174 | packetBuffer[((2 * currentChannel) + HEADER_LEN)] = highByte(adcValue); // Write High Byte 175 | packetBuffer[((2 * currentChannel) + HEADER_LEN + 1)] = lowByte(adcValue); // Write Low Byte 176 | } 177 | 178 | // Increment the packet counter 179 | packetBuffer[2]++; 180 | // Send the packetBuffer to the Serial port 181 | Serial.write(packetBuffer, PACKET_LEN); 182 | // Reset the bufferReady flag 183 | bufferReady = false; 184 | } 185 | 186 | if (Serial.available()) { 187 | String command = Serial.readStringUntil('\n'); 188 | command.trim(); // Remove extra spaces or newline characters 189 | command.toUpperCase(); // Normalize to uppercase for case-insensitivity 190 | 191 | if (command == "WHORU") // Who are you? 192 | { 193 | Serial.println(BOARD_NAME); 194 | } else if (command == "START") // Start data acquisition 195 | { 196 | timerStart(); 197 | } else if (command == "STOP") // Stop data acquisition 198 | { 199 | timerStop(); 200 | } else if (command == "STATUS") // Get status 201 | { 202 | Serial.println(timerStatus ? "RUNNING" : "STOPPED"); 203 | } else { 204 | Serial.println("UNKNOWN COMMAND"); 205 | } 206 | } 207 | } 208 | -------------------------------------------------------------------------------- /GIGA-R1/GIGA-R1.ino: -------------------------------------------------------------------------------- 1 | // This program is free software: you can redistribute it and/or modify 2 | // it under the terms of the GNU General Public License as published by 3 | // the Free Software Foundation, either version 3 of the License, or 4 | // (at your option) any later version. 5 | // 6 | // This program is distributed in the hope that it will be useful, 7 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 8 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 9 | // GNU General Public License for more details. 10 | // 11 | // You should have received a copy of the GNU General Public License 12 | // along with this program. If not, see . 13 | // 14 | // Copyright (c) 2024 - 2025 Upside Down Labs - contact@upsidedownlabs.tech 15 | // Author: Deepak Khatri 16 | // 17 | // At Upside Down Labs, we create open-source DIY neuroscience hardware and software. 18 | // Our mission is to make neuroscience affordable and accessible for everyone. 19 | // By supporting us with your purchase, you help spread innovation and open science. 20 | // Thank you for being part of this journey with us! 21 | 22 | #include 23 | #include 24 | 25 | // Definitions 26 | #define NUM_CHANNELS 6 // Number of channels supported 27 | #define HEADER_LEN 4 // Header = SYNC_BYTE_1 + SYNC_BYTE_2 + Counter + 28 | #define PACKET_LEN (NUM_CHANNELS * 2 + HEADER_LEN) // Packet length = Header + Data + END_BYTE 29 | #define ADC_SAMPLING 16000 // ADC sampling rate 30 | #define ADC_QUEUE 256 // ADC Qeueue depth 31 | #define ADC_RES 16 // ADC Resolutiton 32 | #define SAMPLES_CHANNEL 32 // Samples per channel 33 | #define SAMP_RATE ADC_SAMPLING / SAMPLES_CHANNEL // CHORDS Sampling rate (250/500 for GIGA R1 WiFi) 34 | #define SYNC_BYTE_1 0xC7 // Packet first byte 35 | #define SYNC_BYTE_2 0x7C // Packet second byte 36 | #define BAUD_RATE 230400 // Serial connection baud rate 37 | 38 | // Global constants and variables 39 | uint8_t packetBuffer[PACKET_LEN]; // The transmission packet 40 | uint8_t currentChannel; // Current channel being sampled 41 | bool adcStatus = false; // Timer status bit 42 | uint16_t adcValue = 0; // ADC current value 43 | 44 | // Channel to use from A0 - A11 45 | AdvancedADC adc(A0, A1, A2, A3, A4, A5); 46 | 47 | void adcStart() { 48 | adcStatus = true; 49 | digitalWrite(LED_BUILTIN, LOW); 50 | // Resolution, sample rate, number of samples per channel, queue depth. 51 | if (!adc.begin(AN_RESOLUTION_16, ADC_SAMPLING, SAMPLES_CHANNEL, ADC_QUEUE, true)) { 52 | Serial.println("Failed to start analog acquisition!"); 53 | while (1) 54 | ; 55 | } 56 | } 57 | 58 | void adcStop() { 59 | adcStatus = false; 60 | digitalWrite(LED_BUILTIN, HIGH); 61 | adc.stop(); 62 | } 63 | 64 | void setup() { 65 | Serial.begin(BAUD_RATE); 66 | while (!Serial) { 67 | ; // Wait for serial port to connect. Needed for native USB 68 | } 69 | 70 | // Status LED 71 | pinMode(LED_BUILTIN, OUTPUT); 72 | digitalWrite(LED_BUILTIN, HIGH); 73 | 74 | // Initialize packetBuffer 75 | packetBuffer[0] = SYNC_BYTE_1; // Sync 0 76 | packetBuffer[1] = SYNC_BYTE_2; // Sync 1 77 | packetBuffer[2] = 0; // Packet counter 78 | packetBuffer[3] = ((NUM_CHANNELS << 4) - 1) 79 | | (ADC_RES - 10); // Config Byte 80 | } 81 | 82 | void loop() { 83 | // Send data if the buffer is ready and the timer is activ 84 | if (adcStatus and adc.available()) { 85 | SampleBuffer adcBuffer = adc.read(); 86 | // Read 6ch ADC inputs and store current values in packetBuffer 87 | for (currentChannel = 0; currentChannel < NUM_CHANNELS; currentChannel++) { 88 | adcValue = adcBuffer[currentChannel]; // Read Analog input 89 | packetBuffer[((2 * currentChannel) + HEADER_LEN)] = highByte(adcValue); // Write High Byte 90 | packetBuffer[((2 * currentChannel) + HEADER_LEN + 1)] = lowByte(adcValue); // Write Low Byte 91 | } 92 | 93 | // Increment the packet counter 94 | packetBuffer[2]++; 95 | 96 | // Release the buffer to return it to the pool. 97 | adcBuffer.release(); 98 | 99 | // Write packetBuffer to Serial 100 | Serial.write(packetBuffer, PACKET_LEN); 101 | } 102 | 103 | if (Serial.available()) { 104 | String command = Serial.readStringUntil('\n'); 105 | command.trim(); // Remove extra spaces or newline characters 106 | command.toUpperCase(); // Normalize to uppercase for case-insensitivity 107 | 108 | if (command == "WHORU") // Who are you? 109 | { 110 | Serial.println("GIGA-R1"); 111 | } else if (command == "START") // Start data acquisition 112 | { 113 | adcStart(); 114 | } else if (command == "STOP") // Stop data acquisition 115 | { 116 | adcStop(); 117 | } else if (command == "STATUS") // Get status 118 | { 119 | Serial.println(adcStatus ? "RUNNING" : "STOPPED"); 120 | } else { 121 | Serial.println("UNKNOWN COMMAND"); 122 | } 123 | } 124 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /NPG-LITE-BLE/NPG-LITE-BLE.ino: -------------------------------------------------------------------------------- 1 | /* 2 | This program is free software: you can redistribute it and/or modify 3 | it under the terms of the GNU General Public License as published by 4 | the Free Software Foundation, either version 3 of the License, or 5 | (at your option) any later version. 6 | 7 | This program is distributed in the hope that it will be useful, 8 | but WITHOUT ANY WARRANTY; without even the implied warranty of 9 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 10 | GNU General Public License for more details. 11 | 12 | You should have received a copy of the GNU General Public License 13 | along with this program. If not, see . 14 | 15 | BLE connectivity adapted from the ESP32 BLE Server example by Random Nerd Tutorials: 16 | https://randomnerdtutorials.com/esp32-bluetooth-low-energy-ble-arduino-ide/. 17 | 18 | Copyright (c) 2024 - 2025 Krishnanshu Mittal - karan4g79@gmail.com 19 | Copyright (c) 2024 - 2025 Deepak Khatri - deepak@upsidedownlabs.tech 20 | Copyright (c) 2024 - 2025 Upside Down Labs - contact@upsidedownlabs.tech 21 | 22 | At Upside Down Labs, we create open‐source DIY neuroscience hardware and software. 23 | Our mission is to make neuroscience affordable and accessible for everyone. 24 | By supporting us with your purchase, you help spread innovation and open science. 25 | Thank you for being part of this journey with us! 26 | */ 27 | 28 | // ----- Existing Includes ----- 29 | #include 30 | #include 31 | #include 32 | #include 33 | #include 34 | #include 35 | #include "esp_timer.h" 36 | #include 37 | #include "hal/efuse_hal.h" 38 | 39 | // ----- Chip-specific Pin Definitions ----- 40 | // 41 | // Use the ESP-IDF config macros to detect the chip. 42 | #if defined(CONFIG_IDF_TARGET_ESP32C6) 43 | // Store chip revision number 44 | uint32_t chiprev = efuse_hal_chip_revision(); 45 | #define LED_BUILTIN 7 46 | #define PIXEL_PIN 15 47 | #define PIXEL_COUNT 6 48 | #elif defined(CONFIG_IDF_TARGET_ESP32C3) 49 | #define LED_BUILTIN 6 50 | #define PIXEL_PIN 3 51 | #define PIXEL_COUNT 4 52 | #else 53 | #error "Unsupported board: Please target either ESP32-C6 or ESP32-C3 in your Board Manager." 54 | #endif 55 | 56 | #define PIXEL_BRIGHTNESS 7 // Brightness of Neopixel LED 57 | #define NUM_CHANNELS 3 // Number of ADC channels 58 | #define SINGLE_SAMPLE_LEN 7 // Each sample: 1 counter + (3 channels * 2 bytes) 59 | #define BLOCK_COUNT 10 // Batch size: 10 samples per notification 60 | #define NEW_PACKET_LEN (BLOCK_COUNT * SINGLE_SAMPLE_LEN) // New packet length (70 bytes) 61 | #define SAMP_RATE 500.0 // Sampling rate (500 Hz) 62 | 63 | // Onboard Neopixel at PIXEL_PIN 64 | Adafruit_NeoPixel pixels(PIXEL_COUNT, PIXEL_PIN, NEO_GRB + NEO_KHZ800); 65 | 66 | // BLE UUIDs – change if desired. 67 | #define SERVICE_UUID "4fafc201-1fb5-459e-8fcc-c5c9c331914b" 68 | #define DATA_CHAR_UUID "beb5483e-36e1-4688-b7f5-ea07361b26a8" // For ADC data (Notify only) 69 | #define CONTROL_CHAR_UUID "0000ff01-0000-1000-8000-00805f9b34fb" // For commands (Read/Write/Notify) 70 | 71 | // ----- Global Variables ----- 72 | uint8_t batchBuffer[NEW_PACKET_LEN] = {0}; // Buffer to accumulate BLOCK_COUNT samples 73 | uint8_t samplePacket[SINGLE_SAMPLE_LEN] = {0}; 74 | volatile int sampleIndex = 0; // How many samples accumulated in current batch 75 | volatile bool streaming = false; // True when "START" command is received 76 | volatile bool bufferReady = false; // Flag set by timer callback 77 | 78 | esp_timer_handle_t adcTimer; // Handle for esp_timer 79 | BLECharacteristic *pDataCharacteristic; 80 | BLECharacteristic *pControlCharacteristic; 81 | 82 | // Global sample counter (each sample's packet counter) 83 | uint8_t overallCounter = 0; 84 | 85 | // ----- BLE Server Callbacks ----- 86 | class MyServerCallbacks : public BLEServerCallbacks 87 | { 88 | void onConnect(BLEServer *pServer) override 89 | { 90 | pixels.setPixelColor(0, pixels.Color(0, PIXEL_BRIGHTNESS, 0)); // Green 91 | pixels.show(); 92 | digitalWrite(LED_BUILTIN, HIGH); 93 | delay(400); 94 | digitalWrite(LED_BUILTIN, LOW); 95 | // Serial.println("BLE client connected"); 96 | } 97 | void onDisconnect(BLEServer *pServer) override 98 | { 99 | pixels.setPixelColor(0, pixels.Color(PIXEL_BRIGHTNESS, 0, 0)); // Red 100 | pixels.show(); 101 | digitalWrite(LED_BUILTIN, HIGH); 102 | delay(400); 103 | digitalWrite(LED_BUILTIN, LOW); 104 | delay(200); 105 | digitalWrite(LED_BUILTIN, HIGH); 106 | delay(400); 107 | digitalWrite(LED_BUILTIN, LOW); 108 | // Serial.println("BLE client disconnected"); 109 | streaming = false; 110 | BLEDevice::startAdvertising(); 111 | } 112 | }; 113 | 114 | // ----- BLE Control Characteristic Callback ----- 115 | // Handles incoming commands ("START", "STOP", "WHORU", "STATUS") 116 | class ControlCallback : public BLECharacteristicCallbacks 117 | { 118 | void onWrite(BLECharacteristic *characteristic) override 119 | { 120 | String cmd = characteristic->getValue(); 121 | cmd.trim(); 122 | cmd.toUpperCase(); 123 | if (cmd == "START") 124 | { 125 | pixels.setPixelColor(0, pixels.Color(0, 0, PIXEL_BRIGHTNESS)); // Blue 126 | pixels.show(); 127 | // Reset counters and start streaming 128 | overallCounter = 0; 129 | sampleIndex = 0; 130 | streaming = true; 131 | // Serial.println("Received START command"); 132 | } 133 | else if (cmd == "STOP") 134 | { 135 | pixels.setPixelColor(0, pixels.Color(0, PIXEL_BRIGHTNESS, 0)); // Green 136 | pixels.show(); 137 | streaming = false; 138 | // Serial.println("Received STOP command"); 139 | } 140 | else if (cmd == "WHORU") 141 | { 142 | characteristic->setValue("NPG-LITE"); 143 | characteristic->notify(); 144 | // Serial.println("Received WHORU command"); 145 | } 146 | else if (cmd == "STATUS") 147 | { 148 | characteristic->setValue(streaming ? "RUNNING" : "STOPPED"); 149 | characteristic->notify(); 150 | // Serial.println("Received STATUS command"); 151 | } 152 | else 153 | { 154 | characteristic->setValue("UNKNOWN COMMAND"); 155 | characteristic->notify(); 156 | // Serial.println("Received unknown command"); 157 | } 158 | } 159 | }; 160 | 161 | // ----- Timer Callback ----- 162 | // This callback is executed every (1e6 / SAMP_RATE) microseconds (i.e. every 2000 µs for 500 Hz) 163 | void IRAM_ATTR adcTimerCallback(void *arg) 164 | { 165 | if (streaming) 166 | { 167 | bufferReady = true; 168 | } 169 | } 170 | 171 | void setup() 172 | { 173 | // ----- Initialize Neopixel LED ----- 174 | pixels.begin(); 175 | // Set the Neopixel to red (indicating device turned on) 176 | pixels.setPixelColor(0, pixels.Color(PIXEL_BRIGHTNESS, 0, 0)); 177 | pixels.show(); 178 | 179 | pinMode(LED_BUILTIN, OUTPUT); 180 | digitalWrite(LED_BUILTIN, LOW); 181 | 182 | // Setup packet header is done per sample in the loop. 183 | // Set ADC resolution (12-bit) 184 | analogReadResolution(12); 185 | 186 | // ----- Initialize BLE ----- 187 | BLEDevice::init("NPG"); 188 | 189 | // Retrieve the BLE MAC address 190 | String bleMAC = BLEDevice::getAddress().toString(); 191 | 192 | // Set device name 193 | String deviceName = "NPG-" + bleMAC; 194 | esp_ble_gap_set_device_name(deviceName.c_str()); 195 | 196 | // Optionally, request a larger MTU: 197 | BLEDevice::setMTU(111); 198 | 199 | BLEServer *pServer = BLEDevice::createServer(); 200 | pServer->setCallbacks(new MyServerCallbacks()); 201 | BLEService *pService = pServer->createService(SERVICE_UUID); 202 | 203 | // Create Data Characteristic (Notify only) for ADC data 204 | pDataCharacteristic = pService->createCharacteristic( 205 | DATA_CHAR_UUID, 206 | BLECharacteristic::PROPERTY_NOTIFY); 207 | pDataCharacteristic->addDescriptor(new BLE2902()); 208 | 209 | // Create Control Characteristic (Read/Write/Notify) for command handling 210 | pControlCharacteristic = pService->createCharacteristic( 211 | CONTROL_CHAR_UUID, 212 | BLECharacteristic::PROPERTY_READ | BLECharacteristic::PROPERTY_WRITE | BLECharacteristic::PROPERTY_NOTIFY); 213 | pControlCharacteristic->setCallbacks(new ControlCallback()); 214 | 215 | pService->start(); 216 | BLEAdvertising *pAdvertising = BLEDevice::getAdvertising(); 217 | pAdvertising->start(); 218 | // Serial.println("BLE Advertising started"); 219 | 220 | // Create and start periodic timer using esp_timer API 221 | const esp_timer_create_args_t timerArgs = { 222 | .callback = &adcTimerCallback, 223 | .arg = NULL, 224 | .dispatch_method = ESP_TIMER_TASK, 225 | .name = "adc_timer"}; 226 | esp_timer_create(&timerArgs, &adcTimer); 227 | esp_timer_start_periodic(adcTimer, 1000000 / SAMP_RATE); 228 | } 229 | 230 | void loop() 231 | { 232 | // When streaming is enabled and the timer flag is set... 233 | if (streaming && bufferReady) 234 | { 235 | // Create one sample packet (7 bytes) 236 | memset(samplePacket, 0, SINGLE_SAMPLE_LEN); // Clear buffer before use 237 | samplePacket[0] = overallCounter; 238 | overallCounter = (overallCounter + 1) % 256; 239 | 240 | // Read each ADC channel (channels 0, 1, 2) and store as two bytes (big-endian) 241 | for (uint8_t ch = 0; ch < NUM_CHANNELS; ch++) 242 | { 243 | uint16_t adcValue; 244 | 245 | #if defined(CONFIG_IDF_TARGET_ESP32C6) 246 | if (chiprev == 1) 247 | adcValue = map(analogRead(ch), 0, 3249, 0, 4095); // Scale to 12-bit range 248 | else 249 | adcValue = analogRead(ch); 250 | #else 251 | // Version 0.2 or other chips can use direct reading 252 | adcValue = analogRead(ch); 253 | #endif 254 | 255 | samplePacket[1 + ch * 2] = highByte(adcValue); 256 | samplePacket[1 + ch * 2 + 1] = lowByte(adcValue); 257 | } 258 | 259 | // Append this samplePacket to the batch buffer 260 | memcpy(&batchBuffer[sampleIndex * SINGLE_SAMPLE_LEN], samplePacket, SINGLE_SAMPLE_LEN); 261 | sampleIndex++; 262 | bufferReady = false; 263 | 264 | // Once we've collected BLOCK_COUNT samples, send them as one BLE notification. 265 | if (sampleIndex >= BLOCK_COUNT) 266 | { 267 | pDataCharacteristic->setValue(batchBuffer, NEW_PACKET_LEN); 268 | pDataCharacteristic->notify(); 269 | sampleIndex = 0; 270 | } 271 | } 272 | yield(); 273 | } 274 | -------------------------------------------------------------------------------- /NPG-LITE-WiFi/NPG-LITE-WiFi.ino: -------------------------------------------------------------------------------- 1 | /* 2 | This program is free software: you can redistribute it and/or modify 3 | it under the terms of the GNU General Public License as published by 4 | the Free Software Foundation, either version 3 of the License, or 5 | (at your option) any later version. 6 | 7 | This program is distributed in the hope that it will be useful, 8 | but WITHOUT ANY WARRANTY; without even the implied warranty of 9 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 10 | GNU General Public License for more details. 11 | 12 | You should have received a copy of the GNU General Public License 13 | along with this program. If not, see . 14 | 15 | BLE connectivity adapted from the ESP32 BLE Server example by Random Nerd Tutorials: 16 | https://randomnerdtutorials.com/esp32-bluetooth-low-energy-ble-arduino-ide/. 17 | 18 | Copyright (c) 2024 - 2025 Deepak Khatri - deepak@upsidedownlabs.tech 19 | Copyright (c) 2024 - 2025 Mahesh Tupe - tupemahesh91@gmail.com 20 | Copyright (c) 2024 - 2025 Upside Down Labs - contact@upsidedownlabs.tech 21 | 22 | At Upside Down Labs, we create open‐source DIY neuroscience hardware and software. 23 | Our mission is to make neuroscience affordable and accessible for everyone. 24 | By supporting us with your purchase, you help spread innovation and open science. 25 | Thank you for being part of this journey with us! 26 | */ 27 | 28 | #include 29 | #include 30 | #include 31 | #include 32 | #include 33 | 34 | #define TRIGGER_PIN 9 35 | #define PIXEL_BRIGHTNESS 7 36 | #define TIMER_FREQ 1000000 37 | #define MOTOR_PIN 7 38 | #define PIXEL_PIN 3 39 | #define LED_PIN 6 40 | // Websockets connection on port 81 41 | WebSocketsServer webSocket = WebSocketsServer(81); 42 | // Onboard neopixel at PIXEL_PIN 43 | Adafruit_NeoPixel pixels(4, PIXEL_PIN, NEO_GRB + NEO_KHZ800); 44 | 45 | // Queue for storing ADC data 46 | static int dataQueueLen = 4000; // Queue length for ADC data 47 | static QueueHandle_t dataQueue; // Queue 48 | 49 | hw_timer_t *timer_1 = NULL; 50 | portMUX_TYPE timermux_1 = portMUX_INITIALIZER_UNLOCKED; 51 | 52 | int sampling_rate = 500; // change this to change sampling rate in Hz 53 | int FPS = 25; // change this to change FPS i.e number of packets sent per second 54 | 55 | int total_blocks = (int)(sampling_rate / FPS); 56 | int BLOCK_SIZE = 13; 57 | uint8_t *packetBytes = (uint8_t *)calloc(total_blocks * BLOCK_SIZE, sizeof(uint8_t)); 58 | bool wm = false; // WiFiManager portal access 59 | bool ws_connected = false; 60 | const char *ssid = "npg-lite-2"; 61 | const char *password = ""; 62 | bool istrigger = false; // Trigger for user to do action 63 | 64 | uint8_t adc_pins[] = {0, 1, 2}; 65 | 66 | volatile int interruptCounter = 0; 67 | uint8_t *blockbytes = (uint8_t *)calloc(BLOCK_SIZE - 1, sizeof(uint8_t)); 68 | 69 | void IRAM_ATTR DRDY_ISR() 70 | { 71 | memset(blockbytes, 0, 12); 72 | if (ws_connected) 73 | { 74 | portENTER_CRITICAL_ISR(&timermux_1); 75 | for (int i = 0; i < sizeof(adc_pins) / sizeof(uint8_t); i++) 76 | { 77 | uint16_t res = analogRead(adc_pins[i]); 78 | blockbytes[2 * i] = (uint8_t)(res >> 8); 79 | blockbytes[2 * i + 1] = (uint8_t)(res & 0xFF); 80 | } 81 | xQueueSendFromISR(dataQueue, blockbytes, NULL); 82 | portEXIT_CRITICAL_ISR(&timermux_1); 83 | } 84 | } 85 | 86 | void webSocketEvent(byte num, WStype_t type, uint8_t *payload, size_t length) 87 | { 88 | ESP_LOGD("ws-event", "some event happned"); 89 | switch (type) 90 | { 91 | case WStype_DISCONNECTED: 92 | ESP_LOGD("ws-event", "Client %d disconnected", num); 93 | pixels.setPixelColor(0, pixels.Color(PIXEL_BRIGHTNESS, PIXEL_BRIGHTNESS, 0)); 94 | pixels.show(); 95 | ws_connected = false; 96 | digitalWrite(MOTOR_PIN, HIGH); 97 | delay(500); 98 | digitalWrite(MOTOR_PIN, LOW); 99 | delay(500); 100 | digitalWrite(MOTOR_PIN, HIGH); 101 | delay(500); 102 | digitalWrite(MOTOR_PIN, LOW); 103 | break; 104 | case WStype_CONNECTED: // if a client is connected, then type == WStype_CONNECTED 105 | ESP_LOGD("ws-event", "Client %d connected", num); 106 | pixels.setPixelColor(0, pixels.Color(0, PIXEL_BRIGHTNESS, PIXEL_BRIGHTNESS)); 107 | pixels.show(); 108 | ws_connected = true; 109 | digitalWrite(MOTOR_PIN, HIGH); 110 | delay(500); 111 | digitalWrite(MOTOR_PIN, LOW); 112 | // optionally you can add code here what to do when connected 113 | break; 114 | case WStype_TEXT: // if a client has sent data, then type == WStype_TEXT 115 | break; 116 | case WStype_BIN: 117 | ESP_LOGD("ws-event", "BIN data received"); 118 | if (payload[0] == 0x01) 119 | { 120 | ESP_LOGD("ws-event", "Trigger high"); 121 | istrigger = true; 122 | digitalWrite(MOTOR_PIN, HIGH); 123 | delay(50); 124 | digitalWrite(MOTOR_PIN, LOW); 125 | } 126 | else if (payload[0] == 0x02) 127 | { 128 | ESP_LOGD("ws-event", "Trigger low"); 129 | istrigger = false; 130 | digitalWrite(MOTOR_PIN, HIGH); 131 | delay(30); 132 | digitalWrite(MOTOR_PIN, LOW); 133 | delay(50); 134 | digitalWrite(MOTOR_PIN, HIGH); 135 | delay(30); 136 | digitalWrite(MOTOR_PIN, LOW); 137 | } 138 | case WStype_ERROR: 139 | case WStype_FRAGMENT_TEXT_START: 140 | case WStype_FRAGMENT_BIN_START: 141 | case WStype_FRAGMENT: 142 | case WStype_FRAGMENT_FIN: 143 | default: 144 | break; 145 | } 146 | } 147 | void setup() 148 | { 149 | Serial.begin(115200); 150 | vTaskDelay(100 / portTICK_PERIOD_MS); 151 | // Trigger pin to put device in AP mode 152 | pinMode(TRIGGER_PIN, INPUT_PULLUP); 153 | pinMode(LED_PIN, OUTPUT); 154 | pinMode(MOTOR_PIN, OUTPUT); 155 | WiFi.mode(WIFI_AP_STA); 156 | dataQueue = xQueueCreate(dataQueueLen, BLOCK_SIZE - 1); 157 | 158 | // Initiate wifimanager 159 | WiFiManager wifiManager; 160 | 161 | // Set new pixel 162 | pixels.begin(); 163 | pixels.setPixelColor(0, pixels.Color(PIXEL_BRIGHTNESS, 0, 0)); // RED 164 | pixels.show(); 165 | vTaskDelay(100 / portTICK_PERIOD_MS); 166 | 167 | for (int i = 0; i < 10; i++) 168 | { 169 | vTaskDelay(100 / portTICK_PERIOD_MS); 170 | if (digitalRead(TRIGGER_PIN) == LOW) 171 | { 172 | wm = true; 173 | pixels.setPixelColor(0, pixels.Color(PIXEL_BRIGHTNESS, 0, PIXEL_BRIGHTNESS)); 174 | pixels.show(); 175 | } 176 | vTaskDelay(1 / portTICK_PERIOD_MS); 177 | } 178 | 179 | // Allow to put device into AP mode 180 | for (int i = 0; i < 10; i++) 181 | { 182 | vTaskDelay(100 / portTICK_PERIOD_MS); 183 | if (digitalRead(TRIGGER_PIN) == LOW) 184 | { 185 | wifiManager.resetSettings(); 186 | pixels.setPixelColor(0, pixels.Color(0, 0, PIXEL_BRIGHTNESS)); // BLUE 187 | pixels.show(); 188 | } 189 | vTaskDelay(1 / portTICK_PERIOD_MS); 190 | } 191 | 192 | pixels.setPixelColor(0, pixels.Color(0, PIXEL_BRIGHTNESS, 0)); // Green 193 | pixels.show(); 194 | 195 | // Try to connect 196 | if (wm and !wifiManager.autoConnect("CORTX-FM5", "sleepyeeg")) 197 | { 198 | Serial.println("failed to connect, we should reset and see if it connects"); 199 | vTaskDelay(1 / portTICK_PERIOD_MS); 200 | ESP.restart(); 201 | } 202 | else 203 | { 204 | if (!WiFi.softAP(ssid, password)) 205 | { 206 | ESP_LOGE("APMode", "APModeStatus: %s", "Soft AP creation failed!"); 207 | while (1) 208 | { 209 | vTaskDelay(1 / portTICK_PERIOD_MS); 210 | pixels.setPixelColor(0, pixels.Color(PIXEL_BRIGHTNESS, 0, 0)); // RED 211 | pixels.show(); 212 | ESP.restart(); 213 | } 214 | } 215 | else 216 | { 217 | ESP_LOGE("APMode", "APModeStatus: %s", "Soft AP creation success!"); 218 | pixels.setPixelColor(0, pixels.Color(0, PIXEL_BRIGHTNESS, PIXEL_BRIGHTNESS)); // cyan 219 | pixels.show(); 220 | } 221 | } 222 | 223 | // Initiate MDNS 224 | if (!MDNS.begin("multi-emg")) 225 | { 226 | Serial.println("Error setting up MDNS responder!"); 227 | while (1) 228 | { 229 | vTaskDelay(1 / portTICK_PERIOD_MS); 230 | pixels.setPixelColor(0, pixels.Color(PIXEL_BRIGHTNESS, 0, 0)); // RED 231 | pixels.show(); 232 | ESP.restart(); 233 | } 234 | } 235 | else 236 | { 237 | Serial.println("mDNS responder started"); 238 | pixels.setPixelColor(0, pixels.Color(0, PIXEL_BRIGHTNESS, PIXEL_BRIGHTNESS)); // cyan 239 | pixels.show(); 240 | } 241 | 242 | // Create weboscket connection 243 | webSocket.begin(); 244 | webSocket.onEvent(webSocketEvent); 245 | MDNS.addService("http", "tcp", 80); 246 | 247 | vTaskDelay(100 / portTICK_PERIOD_MS); 248 | 249 | timer_1 = timerBegin(1000000); 250 | timerAttachInterrupt(timer_1, &DRDY_ISR); 251 | timerAlarm(timer_1, (int)(TIMER_FREQ / sampling_rate), true, 0); 252 | analogReadResolution(12); 253 | memset(packetBytes, 0, total_blocks * BLOCK_SIZE); 254 | } 255 | 256 | uint8_t counter = 0; 257 | void loop() 258 | { 259 | if (ws_connected) 260 | { 261 | uint8_t *packetBytes = (uint8_t *)calloc(total_blocks * BLOCK_SIZE, sizeof(uint8_t)); // Single packet of length PACKET_SIZE in Bytes 262 | memset(packetBytes, 0, total_blocks * BLOCK_SIZE); 263 | for (int block = 0; block < total_blocks; block++) 264 | { 265 | // Get data from queue 266 | uint8_t blockBytes[BLOCK_SIZE] = {0}; 267 | blockBytes[0] = counter; 268 | while (xQueueReceive(dataQueue, (void *)&blockBytes[1], 0) != pdTRUE) 269 | vTaskDelay(1 / portTICK_PERIOD_MS); 270 | 271 | blockBytes[BLOCK_SIZE - 1] = istrigger ? 0xFF : 0x00; 272 | blockBytes[BLOCK_SIZE - 2] = istrigger ? 0xFF : 0x00; 273 | unsigned int block_offset = block * BLOCK_SIZE; 274 | memcpy((uint8_t *)&packetBytes[block_offset], (void *)&blockBytes, BLOCK_SIZE); 275 | counter = counter < 255 ? ++counter : 0; 276 | } 277 | webSocket.sendBIN(0, packetBytes, total_blocks * BLOCK_SIZE); 278 | free(packetBytes); 279 | } 280 | webSocket.loop(); 281 | vTaskDelay(1 / portTICK_PERIOD_MS); 282 | } 283 | -------------------------------------------------------------------------------- /NPG-LITE/NPG-LITE.ino: -------------------------------------------------------------------------------- 1 | // This program is free software: you can redistribute it and/or modify 2 | // it under the terms of the GNU General Public License as published by 3 | // the Free Software Foundation, either version 3 of the License, or 4 | // (at your option) any later version. 5 | // 6 | // This program is distributed in the hope that it will be useful, 7 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 8 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 9 | // GNU General Public License for more details. 10 | // 11 | // You should have received a copy of the GNU General Public License 12 | // along with this program. If not, see . 13 | // 14 | // Copyright (c) 2024 - 2025 Upside Down Labs - contact@upsidedownlabs.tech 15 | // Author: Deepak Khatri 16 | // 17 | // At Upside Down Labs, we create open-source DIY neuroscience hardware and software. 18 | // Our mission is to make neuroscience affordable and accessible for everyone. 19 | // By supporting us with your purchase, you help spread innovation and open science. 20 | // Thank you for being part of this journey with us! 21 | 22 | #include 23 | #include 24 | #include "hal/efuse_hal.h" 25 | #include 26 | 27 | // ----- Chip-specific Pin Definitions ----- 28 | // 29 | // Use the ESP-IDF config macros to detect the chip. 30 | #if defined(CONFIG_IDF_TARGET_ESP32C6) 31 | // Store chip revision number 32 | uint32_t chiprev = efuse_hal_chip_revision(); 33 | #define LED_BUILTIN 7 34 | #define PIXEL_PIN 15 35 | #define PIXEL_COUNT 6 36 | #elif defined(CONFIG_IDF_TARGET_ESP32C3) 37 | #define LED_BUILTIN 6 38 | #define PIXEL_PIN 3 39 | #define PIXEL_COUNT 4 40 | #else 41 | #error "Unsupported board: Please target either ESP32-C6 or ESP32-C3 in your Board Manager." 42 | #endif 43 | 44 | // Definitions 45 | #define PIXEL_BRIGHTNESS 7 // Brightness of Neopixel LED 46 | #define TIMER_FREQ 1000000 47 | #define NUM_CHANNELS 3 // Number of channels supported 48 | #define HEADER_LEN 3 // Header = SYNC_BYTE_1 + SYNC_BYTE_2 + Counter 49 | #define PACKET_LEN (NUM_CHANNELS * 2 + HEADER_LEN + 1) // Packet length = Header + Data + END_BYTE 50 | #define SAMP_RATE 500.0 // Sampling rate (250/500 for UNO R4) 51 | #define SYNC_BYTE_1 0xC7 // Packet first byte 52 | #define SYNC_BYTE_2 0x7C // Packet second byte 53 | #define END_BYTE 0x01 // Packet last byte 54 | #define BAUD_RATE 230400 // Serial connection baud rate 55 | 56 | // Onboard Neopixel at PIXEL_PIN 57 | Adafruit_NeoPixel pixels(PIXEL_COUNT, PIXEL_PIN, NEO_GRB + NEO_KHZ800); 58 | 59 | // Global constants and variables 60 | uint8_t packetBuffer[PACKET_LEN]; // The transmission packet 61 | uint8_t currentChannel; // Current channel being sampled 62 | uint16_t adcValue = 0; // ADC current value 63 | bool timerStatus = false; // Timer status bit 64 | bool bufferReady = false; // Buffer ready status bit 65 | 66 | hw_timer_t *timer_1 = NULL; 67 | 68 | void IRAM_ATTR ADC_ISR() 69 | { 70 | if (!timerStatus or Serial.available()) 71 | { 72 | timerStop(); 73 | return; 74 | } 75 | 76 | // Set bufferReady status bit to true 77 | bufferReady = true; 78 | } 79 | 80 | void timerStart() 81 | { 82 | timerStatus = true; 83 | timerStart(timer_1); 84 | pixels.setPixelColor(PIXEL_COUNT-1, pixels.Color(0, 0, PIXEL_BRIGHTNESS)); // Blue 85 | pixels.show(); 86 | digitalWrite(LED_BUILTIN, HIGH); 87 | delay(400); 88 | digitalWrite(LED_BUILTIN, LOW); 89 | } 90 | 91 | void timerStop() 92 | { 93 | timerStatus = false; 94 | bufferReady = false; 95 | timerStop(timer_1); 96 | pixels.setPixelColor(PIXEL_COUNT-1, pixels.Color(PIXEL_BRIGHTNESS, 0, 0)); // Red 97 | pixels.show(); 98 | digitalWrite(LED_BUILTIN, HIGH); 99 | delay(400); 100 | digitalWrite(LED_BUILTIN, LOW); 101 | delay(200); 102 | digitalWrite(LED_BUILTIN, HIGH); 103 | delay(400); 104 | digitalWrite(LED_BUILTIN, LOW); 105 | } 106 | 107 | void setup() 108 | { 109 | 110 | Serial.begin(BAUD_RATE); 111 | Serial.setTimeout(100); 112 | pixels.begin(); //Initialize the NeoPixel library 113 | // Set the Neopixel to red (indicating device turned on) 114 | pixels.setPixelColor(PIXEL_COUNT-1, pixels.Color(PIXEL_BRIGHTNESS, 0, 0)); 115 | pixels.show(); 116 | while (!Serial) 117 | { 118 | ; // Wait for serial port to connect. Needed for native USB 119 | } 120 | 121 | // Status LED 122 | pinMode(LED_BUILTIN, OUTPUT); 123 | digitalWrite(LED_BUILTIN, LOW); 124 | 125 | // Initialize packetBuffer 126 | packetBuffer[0] = SYNC_BYTE_1; // Sync 0 127 | packetBuffer[1] = SYNC_BYTE_2; // Sync 1 128 | packetBuffer[2] = 0; // Packet counter 129 | packetBuffer[PACKET_LEN - 1] = END_BYTE; // End Byte 130 | 131 | timer_1 = timerBegin(1000000); 132 | timerAttachInterrupt(timer_1, &ADC_ISR); 133 | timerAlarm(timer_1, (int)(TIMER_FREQ / SAMP_RATE), true, 0); 134 | timerStop(timer_1); 135 | analogReadResolution(12); 136 | } 137 | 138 | void loop() 139 | { 140 | // Send data if the buffer is ready and the timer is activ 141 | if (timerStatus and bufferReady) 142 | { 143 | 144 | // ADC value Reading, Converting, and Storing: 145 | for (currentChannel = 0; currentChannel < NUM_CHANNELS; currentChannel++) 146 | { 147 | 148 | // Read ADC input 149 | #if defined(CONFIG_IDF_TARGET_ESP32C6) 150 | if (chiprev == 1) 151 | adcValue = map(analogRead(currentChannel), 0, 3249, 0, 4095); // Scale to 12-bit range 152 | else 153 | adcValue = analogRead(currentChannel); 154 | #else 155 | // Version 0.2 or other chips can use direct reading 156 | adcValue = analogRead(currentChannel); 157 | #endif 158 | 159 | // Store current values in packetBuffer to send. 160 | packetBuffer[((2 * currentChannel) + HEADER_LEN)] = highByte(adcValue); // Write High Byte 161 | packetBuffer[((2 * currentChannel) + HEADER_LEN + 1)] = lowByte(adcValue); // Write Low Byte 162 | } 163 | 164 | // Increment the packet counter 165 | packetBuffer[2]++; 166 | // Send the packetBuffer to the Serial port 167 | Serial.write(packetBuffer, PACKET_LEN); 168 | // Reset the bufferReady flag 169 | bufferReady = false; 170 | } 171 | 172 | if (Serial.available()) 173 | { 174 | String command = Serial.readStringUntil('\n'); 175 | command.trim(); // Remove extra spaces or newline characters 176 | command.toUpperCase(); // Normalize to uppercase for case-insensitivity 177 | 178 | if (command == "WHORU") // Who are you? 179 | { 180 | Serial.println("NPG-LITE"); 181 | } 182 | else if (command == "START") // Start data acquisition 183 | { 184 | timerStart(); 185 | } 186 | else if (command == "STOP") // Stop data acquisition 187 | { 188 | timerStop(); 189 | } 190 | else if (command == "STATUS") // Get status 191 | { 192 | Serial.println(timerStatus ? "RUNNING" : "STOPPED"); 193 | } 194 | else 195 | { 196 | Serial.println("UNKNOWN COMMAND"); 197 | } 198 | } 199 | } 200 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Chords Arduino Firmware 2 | 3 | **Chords** is an open-source toolkit developed by Upside Down Labs to transform Arduino-compatible 4 | boards into bio-potential data acquisition devices when paired with BioAmp hardware. 5 | 6 | ## Tools 7 | 8 | 1. [Chords-Web](https://chords.upsidedownlabs.tech/) 9 | 2. [Chords-Python](https://github.com/upsidedownlabs/Chords-Python) 10 | 11 | > [!NOTE] 12 | > You have to flash Arduino code to your hardware from the list below to use these tools. 13 | 14 | ## Supported boards 15 | 16 | > [!IMPORTANT] 17 | > Make sure to select your board type in the firmware file for it to work properly. 18 | 19 | > [!TIP] 20 | > Only use genuine board to avoid noisy (unusable) signals and connection issues. 21 | 22 | | Board | Voltage | Channels | Resolution | SamplingRate | BaudRate | Code | 23 | | ----- | ------- | -------- | ---------- | ------------ | -------- | ---- | 24 | | Neuro Play Ground (NPG) Lite | 2V5 | 3 | 12-bit | 500 | 230400 | [NPG-LITE.ino](NPG-LITE/NPG-LITE.ino) | 25 | | STM32G4 Core Board | 3V3 | 16 | 12-bit | 500 | 230400 | [STM32G4-CORE-BOARD.ino](STM32G4-CORE-BOARD/STM32G4-CORE-BOARD.ino) | 26 | | STM32F4 Black Pill | 3V3 | 8 | 12-bit | 500 | 230400 | [STM32F4-BLACK-PILL.ino](STM32F4-BLACK-PILL/STM32F4-BLACK-PILL.ino) | 27 | | Arduino GIGA R1 (WiFi) | 3V3 | 6 | 16-bit | 500 | 230400 | [GIGA-R1.ino](GIGA-R1/GIGA-R1.ino) | 28 | | Raspberry PI Pico | 3V3 | 3 | 12-bit | 500 | 230400 | [RPI-PICO-RP2040.ino](RPI-PICO-RP2040/RPI-PICO-RP2040.ino) | 29 | | Arduino UNO R4 Minima/WiFi | 5V | 6 | 14-bit | 500 | 230400 | [UNO-R4.ino](UNO-R4/UNO-R4.ino) | 30 | | Arduino NANO Classic | 5V | 8 | 10-bit | 250 | 115200 | [AVR-NANO-UNO-MEGA.ino](AVR-NANO-UNO-MEGA/AVR-NANO-UNO-MEGA.ino) | 31 | | Arduino UNO R3 | 5V | 6 | 10-bit | 250 | 115200 | [AVR-NANO-UNO-MEGA.ino](AVR-NANO-UNO-MEGA/AVR-NANO-UNO-MEGA.ino) | 32 | | Arduino Genuino UNO | 5V | 6 | 10-bit | 250 | 115200 | [AVR-NANO-UNO-MEGA.ino](AVR-NANO-UNO-MEGA/AVR-NANO-UNO-MEGA.ino) | 33 | | Arduino MEGA 2560 R3 | 5V | 16 | 10-bit | 250 | 115200 | [AVR-NANO-UNO-MEGA.ino](AVR-NANO-UNO-MEGA/AVR-NANO-UNO-MEGA.ino) | 34 | | Maker Nano / Nano Clone (CH340) | 5V | 8 | 10-bit | 250 | 115200 | [AVR-NANO-UNO-MEGA.ino](AVR-NANO-UNO-MEGA/AVR-NANO-UNO-MEGA.ino) | 35 | | Maker UNO / UNO R3 Clone (CH340) | 5V | 6 | 10-bit | 250 | 115200 | [AVR-NANO-UNO-MEGA.ino](AVR-NANO-UNO-MEGA/AVR-NANO-UNO-MEGA.ino) | 36 | | MEGA 2560 Clone (CH340) | 5V | 16 | 10-bit | 250 | 115200 | [AVR-NANO-UNO-MEGA.ino](AVR-NANO-UNO-MEGA/AVR-NANO-UNO-MEGA.ino) | -------------------------------------------------------------------------------- /RPI-PICO-RP2040/RPI-PICO-RP2040.ino: -------------------------------------------------------------------------------- 1 | // This program is free software: you can redistribute it and/or modify 2 | // it under the terms of the GNU General Public License as published by 3 | // the Free Software Foundation, either version 3 of the License, or 4 | // (at your option) any later version. 5 | // 6 | // This program is distributed in the hope that it will be useful, 7 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 8 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 9 | // GNU General Public License for more details. 10 | // 11 | // You should have received a copy of the GNU General Public License 12 | // along with this program. If not, see . 13 | // 14 | // Copyright (c) 2024 - 2025 Upside Down Labs - contact@upsidedownlabs.tech 15 | // Author: Deepak Khatri 16 | // 17 | // At Upside Down Labs, we create open-source DIY neuroscience hardware and software. 18 | // Our mission is to make neuroscience affordable and accessible for everyone. 19 | // By supporting us with your purchase, you help spread innovation and open science. 20 | // Thank you for being part of this journey with us! 21 | 22 | #include "mbed.h" 23 | #include 24 | #include "hardware/adc.h" 25 | 26 | // Definitions 27 | #define NUM_CHANNELS 3 // Number of channels supported 28 | #define HEADER_LEN 3 // Header = SYNC_BYTE_1 + SYNC_BYTE_2 + Counter 29 | #define PACKET_LEN (NUM_CHANNELS * 2 + HEADER_LEN + 1) // Packet length = Header + Data + END_BYTE 30 | #define SAMP_RATE 500.0 // Sampling rate (250/500 for UNO R4) 31 | #define SYNC_BYTE_1 0xC7 // Packet first byte 32 | #define SYNC_BYTE_2 0x7C // Packet second byte 33 | #define END_BYTE 0x01 // Packet last byte 34 | #define BAUD_RATE 230400 // Serial connection baud rate 35 | 36 | // Global constants and variables 37 | uint8_t packetBuffer[PACKET_LEN]; // The transmission packet 38 | uint8_t currentChannel; // Current channel being sampled 39 | uint16_t adcValue = 0; // ADC current value 40 | bool timerStatus = false; // Timer status bit 41 | bool bufferReady = false; // Buffer ready status bit 42 | 43 | mbed::Ticker ticker; 44 | 45 | // callback method used by timer 46 | void timerCallback() { 47 | // Read ADC inputs and store current values in packetBuffer 48 | for (currentChannel = 0; currentChannel < NUM_CHANNELS; currentChannel++) { 49 | adc_select_input(currentChannel); 50 | adcValue = adc_read(); // Read Analog input 51 | packetBuffer[((2 * currentChannel) + HEADER_LEN)] = highByte(adcValue); // Write High Byte 52 | packetBuffer[((2 * currentChannel) + HEADER_LEN + 1)] = lowByte(adcValue); // Write Low Byte 53 | } 54 | 55 | // Increment the packet counter 56 | packetBuffer[2]++; 57 | 58 | bufferReady = true; 59 | } 60 | 61 | void timerStart() { 62 | timerStatus = true; 63 | auto interval = std::chrono::microseconds(static_cast(1e6 / SAMP_RATE)); 64 | ticker.attach(&timerCallback, interval); 65 | digitalWrite(LED_BUILTIN, HIGH); 66 | } 67 | 68 | void timerStop() { 69 | timerStatus = false; 70 | bufferReady = false; 71 | ticker.detach(); 72 | digitalWrite(LED_BUILTIN, LOW); 73 | } 74 | 75 | void setup() { 76 | 77 | Serial.begin(BAUD_RATE); 78 | Serial.setTimeout(100); 79 | while (!Serial) { 80 | ; // Wait for serial port to connect. Needed for native USB 81 | } 82 | 83 | // Status LED 84 | pinMode(LED_BUILTIN, OUTPUT); 85 | digitalWrite(LED_BUILTIN, LOW); 86 | 87 | // Initialize packetBuffer 88 | packetBuffer[0] = SYNC_BYTE_1; // Sync 0 89 | packetBuffer[1] = SYNC_BYTE_2; // Sync 1 90 | packetBuffer[2] = 0; // Packet counter 91 | packetBuffer[PACKET_LEN - 1] = END_BYTE; // End Byte 92 | // Initialize ADC 93 | adc_init(); // Initialize the ADC hardware 94 | adc_gpio_init(26); // Initialize GPIO26 -> ADC0 95 | adc_gpio_init(27); // Initialize GPIO27 -> ADC1 96 | adc_gpio_init(28); // Initialize GPIO28 -> ADC2 97 | 98 | // Set ADC resolution (the RP2040 ADC supports native 12-bit resolution) 99 | adc_set_clkdiv(1); // Ensure maximum ADC clock speed 100 | adc_fifo_setup( 101 | true, // Enable FIFO 102 | false, // No DMA requested 103 | 1, // DREQ (threshold for DMA) not used 104 | true, // Set to true to shift results to 12 bits 105 | false // Don't enable error on overflow 106 | ); 107 | } 108 | 109 | void loop() { 110 | // Send data if the buffer is ready and the timer is activ 111 | if (timerStatus and bufferReady) { 112 | Serial.write(packetBuffer, PACKET_LEN); 113 | bufferReady = false; 114 | } 115 | 116 | if (Serial.available()) { 117 | String command = Serial.readStringUntil('\n'); 118 | command.trim(); // Remove extra spaces or newline characters 119 | command.toUpperCase(); // Normalize to uppercase for case-insensitivity 120 | 121 | if (command == "WHORU") // Who are you? 122 | { 123 | Serial.println("RPI-PICO-RP2040"); 124 | } else if (command == "START") // Start data acquisition 125 | { 126 | timerStart(); 127 | } else if (command == "STOP") // Stop data acquisition 128 | { 129 | timerStop(); 130 | } else if (command == "STATUS") // Get status 131 | { 132 | Serial.println(timerStatus ? "RUNNING" : "STOPPED"); 133 | } else { 134 | Serial.println("UNKNOWN COMMAND"); 135 | } 136 | } 137 | } 138 | -------------------------------------------------------------------------------- /STM32F4-BLACK-PILL/STM32F4-BLACK-PILL.ino: -------------------------------------------------------------------------------- 1 | // Chords Firmware for STM32F401 / STM32F411 Black Pill Board 2 | // Use with Chords applications: 3 | // Chords-Web: chords.upsidedownlabs.tech 4 | // Chords-Python: github.com/upsidedownlabs/chords-python 5 | // 6 | // This program is free software: you can redistribute it and/or modify 7 | // it under the terms of the GNU General Public License as published by 8 | // the Free Software Foundation, either version 3 of the License, or 9 | // (at your option) any later version. 10 | // 11 | // This program is distributed in the hope that it will be useful, 12 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | // GNU General Public License for more details. 15 | // 16 | // You should have received a copy of the GNU General Public License 17 | // along with this program. If not, see . 18 | // 19 | // Copyright (c) 2024 - 2025 Upside Down Labs - contact@upsidedownlabs.tech 20 | // Author: Deepak Khatri 21 | // 22 | // At Upside Down Labs, we create open-source DIY neuroscience hardware and software. 23 | // Our mission is to make neuroscience affordable and accessible for everyone. 24 | // By supporting us with your purchase, you help spread innovation and open science. 25 | // Thank you for being part of this journey with us! 26 | 27 | #include 28 | 29 | // Macros Definitions 30 | #define NUM_CHANNELS 8 // Number of channels supported 31 | #define HEADER_LEN 3 // Header: SYNC_BYTE_1 + SYNC_BYTE_2 + Counter 32 | #define PACKET_LEN (HEADER_LEN + (NUM_CHANNELS * 2) + 1) // Packet length = Header + Data + END_BYTE 33 | #define SAMP_RATE 500.0 // Sampling rate 34 | #define SYNC_BYTE_1 0xC7 // Packet first sync byte 35 | #define SYNC_BYTE_2 0x7C // Packet second sync byte 36 | #define END_BYTE 0x01 // Packet last check byte 37 | #define BAUD_RATE 230400 // Serial connection baud rate 38 | 39 | // Hardware Timer for ADC sampling 40 | HardwareTimer *timer = new HardwareTimer(TIM3); 41 | 42 | // Define ADC channels (PA0 to PA7, PB0, PB1) 43 | const int adcPins[] = { PA0, PA1, PA2, PA3, PA4, PA5, PA6, PA7 }; 44 | 45 | // Global constants and variables 46 | uint8_t packetBuffer[PACKET_LEN]; // The transmission packet 47 | uint8_t currentChannel; // Current channel being sampled 48 | uint16_t adcValue = 0; // ADC current value 49 | bool timerStatus = false; // Timer satus flag 50 | bool bufferReady = false; // Buffer ready flag 51 | 52 | void timerStart() { 53 | timerStatus = true; 54 | timer->resume(); 55 | } 56 | 57 | void timerStop() { 58 | timerStatus = false; 59 | timer->pause(); 60 | bufferReady = false; 61 | } 62 | 63 | void timerCallback() { 64 | if (!timerStatus or Serial.available()) { 65 | timerStop(); 66 | return; 67 | } 68 | 69 | // Set buffer ready flag 70 | bufferReady = true; 71 | } 72 | 73 | void setup() { 74 | // Initialize the serial communication 75 | Serial.begin(BAUD_RATE); 76 | while (!Serial) { 77 | ; // Wait for serial port to connect 78 | } 79 | 80 | // Configure ADC pins 81 | for (int i = 0; i < NUM_CHANNELS; i++) { 82 | pinMode(adcPins[i], INPUT_ANALOG); 83 | } 84 | 85 | // Set ADC resolution to 12 bits 86 | analogReadResolution(12); 87 | 88 | // Initialize packetBuffer 89 | packetBuffer[0] = SYNC_BYTE_1; // Sync 0 90 | packetBuffer[1] = SYNC_BYTE_2; // Sync 1 91 | packetBuffer[2] = 0; // Packet counter 92 | packetBuffer[PACKET_LEN - 1] = END_BYTE; // End Byte 93 | 94 | // Configure HardwareTimer for ADC sampling 95 | timer->setOverflow(SAMP_RATE, HERTZ_FORMAT); // Set timer frequency for oversampling 96 | timer->attachInterrupt(timerCallback); // Attach the callback function 97 | } 98 | 99 | void loop() { 100 | // Transmit data if buffer is ready 101 | if (timerStatus && bufferReady) { 102 | // Read 6ch ADC inputs and store current values in packetBuffer 103 | for (currentChannel = 0; currentChannel < NUM_CHANNELS; currentChannel++) { 104 | adcValue = analogRead(adcPins[currentChannel]); // Read Analog input 105 | packetBuffer[((2 * currentChannel) + HEADER_LEN)] = highByte(adcValue); // Write High Byte 106 | packetBuffer[((2 * currentChannel) + HEADER_LEN + 1)] = lowByte(adcValue); // Write Low Byte 107 | } 108 | 109 | // Increment the packet counter 110 | packetBuffer[2]++; 111 | // Transmit the packet 112 | Serial.write(packetBuffer, PACKET_LEN); 113 | // Reset the buffer ready flag 114 | bufferReady = false; 115 | } 116 | 117 | // Handle commands from the serial interface 118 | if (Serial.available()) { 119 | String command = Serial.readStringUntil('\n'); 120 | command.trim(); // Remove extra spaces or newline characters 121 | command.toUpperCase(); // Normalize to uppercase for case-insensitivity 122 | 123 | if (command == "WHORU") // Who are you? 124 | { 125 | Serial.println("STM32F4-BLACK-PILL"); 126 | } else if (command == "START") // Start data acquisition 127 | { 128 | timerStart(); 129 | } else if (command == "STOP") // Stop data acquisition 130 | { 131 | timerStop(); 132 | } else if (command == "STATUS") // Get status 133 | { 134 | Serial.println(timerStatus ? "RUNNING" : "STOPPED"); 135 | } else { 136 | Serial.println("UNKNOWN COMMAND"); 137 | } 138 | } 139 | } 140 | -------------------------------------------------------------------------------- /STM32G4-CORE-BOARD/STM32G4-CORE-BOARD.ino: -------------------------------------------------------------------------------- 1 | // Chords Firmware for STM32G4 Core Board 2 | // Use with Chords applications: 3 | // Chords-Web: chords.upsidedownlabs.tech 4 | // Chords-Python: github.com/upsidedownlabs/chords-python 5 | // 6 | // This program is free software: you can redistribute it and/or modify 7 | // it under the terms of the GNU General Public License as published by 8 | // the Free Software Foundation, either version 3 of the License, or 9 | // (at your option) any later version. 10 | // 11 | // This program is distributed in the hope that it will be useful, 12 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | // GNU General Public License for more details. 15 | // 16 | // You should have received a copy of the GNU General Public License 17 | // along with this program. If not, see . 18 | // 19 | // Copyright (c) 2024 - 2025 Upside Down Labs - contact@upsidedownlabs.tech 20 | // Author: Deepak Khatri 21 | // 22 | // At Upside Down Labs, we create open-source DIY neuroscience hardware and software. 23 | // Our mission is to make neuroscience affordable and accessible for everyone. 24 | // By supporting us with your purchase, you help spread innovation and open science. 25 | // Thank you for being part of this journey with us! 26 | 27 | #include 28 | 29 | // Definitions 30 | #define NUM_CHANNELS 16 // Number of channels supported 31 | #define HEADER_LEN 3 // Header: SYNC_BYTE_1 + SYNC_BYTE_2 + Counter 32 | #define PACKET_LEN (NUM_CHANNELS * 2 + HEADER_LEN + 1) // Packet length = Header + Data + END_BYTE 33 | #define SAMP_RATE 250 // Sampling rate (250 for UNO R3) 34 | #define SYNC_BYTE_1 0xC7 // Packet first byte 35 | #define SYNC_BYTE_2 0x7C // Packet second byte 36 | #define END_BYTE 0x01 // Packet last byte 37 | #define BAUD_RATE 230400 // Serial connection baud rate 38 | 39 | // Hardware Timer for ADC sampling 40 | HardwareTimer *timer = new HardwareTimer(TIM3); 41 | 42 | // Define ADC channels (PA0 to PA7, PB0 to PB2, PB11 to PB15) 43 | const int adcPins[] = { PA0, PA1, PA2, PA3, PA4, PA5, PA6, PA7, PB0, PB1, PB2, PB11, PB12, PB14, PB15, PC4 }; 44 | 45 | // Global constants and variables 46 | uint8_t packetBuffer[PACKET_LEN]; // The transmission packet 47 | uint8_t currentChannel; // Current channel being sampled 48 | uint16_t adcValue = 0; // ADC current value 49 | bool timerStatus = false; // SATUS bit 50 | bool bufferReady = false; // Buffer ready status bit 51 | 52 | void timerStart() { 53 | timerStatus = true; 54 | timer->resume(); 55 | } 56 | 57 | void timerStop() { 58 | timerStatus = false; 59 | timer->pause(); 60 | bufferReady = false; 61 | } 62 | 63 | void timerCallback() { 64 | if (!timerStatus or Serial.available()) { 65 | timerStop(); 66 | return; 67 | } 68 | 69 | // Set buffer ready flag 70 | bufferReady = true; 71 | } 72 | 73 | 74 | 75 | void setup() { 76 | // Initialize the serial communication 77 | Serial.begin(BAUD_RATE); 78 | while (!Serial) { 79 | ; // Wait for serial port to connect 80 | } 81 | 82 | // Configure ADC pins 83 | for (int i = 0; i < NUM_CHANNELS; i++) { 84 | pinMode(adcPins[i], INPUT_ANALOG); 85 | } 86 | 87 | // Set ADC resolution to 12 bits 88 | // analogReadResolution(12); 89 | 90 | // Initialize packetBuffer 91 | packetBuffer[0] = SYNC_BYTE_1; // Sync 0 92 | packetBuffer[1] = SYNC_BYTE_2; // Sync 1 93 | packetBuffer[2] = 0; // Packet counter 94 | packetBuffer[PACKET_LEN - 1] = END_BYTE; // End Byte 95 | 96 | // Configure HardwareTimer for ADC sampling 97 | timer->setOverflow(SAMP_RATE, HERTZ_FORMAT); // Set timer frequency for oversampling 98 | timer->attachInterrupt(timerCallback); // Attach the callback function 99 | } 100 | 101 | void loop() { 102 | // Transmit data if buffer is ready 103 | if (timerStatus && bufferReady) { 104 | // Read 6ch ADC inputs and store current values in packetBuffer 105 | for (currentChannel = 0; currentChannel < NUM_CHANNELS; currentChannel++) { 106 | adcValue = analogRead(adcPins[currentChannel]); // Read Analog input 107 | packetBuffer[((2 * currentChannel) + HEADER_LEN)] = highByte(adcValue); // Write High Byte 108 | packetBuffer[((2 * currentChannel) + HEADER_LEN + 1)] = lowByte(adcValue); // Write Low Byte 109 | } 110 | 111 | // Increment the packet counter 112 | packetBuffer[2]++; 113 | Serial.write(packetBuffer, PACKET_LEN); 114 | bufferReady = false; 115 | } 116 | 117 | // Handle commands from the serial interface 118 | if (Serial.available()) { 119 | String command = Serial.readStringUntil('\n'); 120 | command.trim(); // Remove extra spaces or newline characters 121 | command.toUpperCase(); // Normalize to uppercase for case-insensitivity 122 | 123 | if (command == "WHORU") // Who are you? 124 | { 125 | Serial.println("STM32G4-CORE-BOARD"); 126 | } else if (command == "START") // Start data acquisition 127 | { 128 | timerStart(); 129 | } else if (command == "STOP") // Stop data acquisition 130 | { 131 | timerStop(); 132 | } else if (command == "STATUS") // Get status 133 | { 134 | Serial.println(timerStatus ? "RUNNING" : "STOPPED"); 135 | } else { 136 | Serial.println("UNKNOWN COMMAND"); 137 | } 138 | } 139 | } 140 | -------------------------------------------------------------------------------- /UNO-R4/UNO-R4.ino: -------------------------------------------------------------------------------- 1 | // This program is free software: you can redistribute it and/or modify 2 | // it under the terms of the GNU General Public License as published by 3 | // the Free Software Foundation, either version 3 of the License, or 4 | // (at your option) any later version. 5 | // 6 | // This program is distributed in the hope that it will be useful, 7 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 8 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 9 | // GNU General Public License for more details. 10 | // 11 | // You should have received a copy of the GNU General Public License 12 | // along with this program. If not, see . 13 | // 14 | // Copyright (c) 2024 - 2025 Upside Down Labs - contact@upsidedownlabs.tech 15 | // Author: Deepak Khatri 16 | // 17 | // At Upside Down Labs, we create open-source DIY neuroscience hardware and software. 18 | // Our mission is to make neuroscience affordable and accessible for everyone. 19 | // By supporting us with your purchase, you help spread innovation and open science. 20 | // Thank you for being part of this journey with us! 21 | 22 | #include "FspTimer.h" 23 | #include 24 | 25 | // Definitions 26 | #define NUM_CHANNELS 6 // Number of channels supported 27 | #define HEADER_LEN 3 // Header = SYNC_BYTE_1 + SYNC_BYTE_2 + Counter 28 | #define PACKET_LEN (NUM_CHANNELS * 2 + HEADER_LEN + 1) // Packet length = Header + Data + END_BYTE 29 | #define SAMP_RATE 500.0 // Sampling rate (250/500 for UNO R4) 30 | #define SYNC_BYTE_1 0xC7 // Packet first byte 31 | #define SYNC_BYTE_2 0x7C // Packet second byte 32 | #define END_BYTE 0x01 // Packet last byte 33 | #define BAUD_RATE 230400 // Serial connection baud rate 34 | 35 | // Global constants and variables 36 | uint8_t packetBuffer[PACKET_LEN]; // The transmission packet 37 | uint8_t currentChannel; // Current channel being sampled 38 | uint16_t adcValue = 0; // ADC current value 39 | bool timerStatus = false; // Timer status bit 40 | bool bufferReady = false; // Buffer ready status bit 41 | 42 | FspTimer ChordsTimer; 43 | 44 | bool timerStart() { 45 | timerStatus = true; 46 | digitalWrite(LED_BUILTIN, HIGH); 47 | return ChordsTimer.start(); 48 | } 49 | 50 | bool timerStop() { 51 | timerStatus = false; 52 | bufferReady = false; 53 | digitalWrite(LED_BUILTIN, LOW); 54 | return ChordsTimer.stop(); 55 | } 56 | 57 | void timerCallback(timer_callback_args_t __attribute((unused)) * p_args) { 58 | if (!timerStatus or Serial.available()) { 59 | timerStop(); 60 | return; 61 | } 62 | // Read 6ch ADC inputs and store current values in packetBuffer 63 | for (currentChannel = 0; currentChannel < NUM_CHANNELS; currentChannel++) { 64 | adcValue = analogRead(currentChannel); // Read Analog input 65 | packetBuffer[((2 * currentChannel) + HEADER_LEN)] = highByte(adcValue); // Write High Byte 66 | packetBuffer[((2 * currentChannel) + HEADER_LEN + 1)] = lowByte(adcValue); // Write Low Byte 67 | } 68 | 69 | // Increment the packet counter 70 | packetBuffer[2]++; 71 | 72 | // Set bufferReady status bit to true 73 | bufferReady = true; 74 | } 75 | 76 | bool timerBegin(float sampling_rate) { 77 | uint8_t timer_type = GPT_TIMER; 78 | int8_t timer_channel = FspTimer::get_available_timer(timer_type); 79 | if (timer_channel != -1) { 80 | ChordsTimer.begin(TIMER_MODE_PERIODIC, timer_type, timer_channel, sampling_rate, 0.0f, timerCallback); 81 | ChordsTimer.setup_overflow_irq(); 82 | ChordsTimer.open(); 83 | return true; 84 | } else { 85 | return false; 86 | } 87 | } 88 | 89 | void setup() { 90 | Serial.begin(BAUD_RATE); 91 | while (!Serial) { 92 | ; // Wait for serial port to connect. Needed for native USB 93 | } 94 | 95 | // Status LED 96 | pinMode(LED_BUILTIN, OUTPUT); 97 | digitalWrite(LED_BUILTIN, LOW); 98 | 99 | // Initialize packetBuffer 100 | packetBuffer[0] = SYNC_BYTE_1; // Sync 0 101 | packetBuffer[1] = SYNC_BYTE_2; // Sync 1 102 | packetBuffer[2] = 0; // Packet counter 103 | packetBuffer[PACKET_LEN - 1] = END_BYTE; // End Byte 104 | 105 | // Setup timer 106 | timerBegin(SAMP_RATE); 107 | 108 | // Set ADC resolution to 14bit 109 | analogReadResolution(14); 110 | } 111 | 112 | void loop() { 113 | // Send data if the buffer is ready and the timer is activ 114 | if (timerStatus and bufferReady) { 115 | Serial.write(packetBuffer, PACKET_LEN); 116 | bufferReady = false; 117 | } 118 | 119 | if (Serial.available()) { 120 | String command = Serial.readStringUntil('\n'); 121 | command.trim(); // Remove extra spaces or newline characters 122 | command.toUpperCase(); // Normalize to uppercase for case-insensitivity 123 | 124 | if (command == "WHORU") // Who are you? 125 | { 126 | Serial.println("UNO-R4"); 127 | } else if (command == "START") // Start data acquisition 128 | { 129 | timerStart(); 130 | } else if (command == "STOP") // Stop data acquisition 131 | { 132 | timerStop(); 133 | } else if (command == "STATUS") // Get status 134 | { 135 | Serial.println(timerStatus ? "RUNNING" : "STOPPED"); 136 | } else { 137 | Serial.println("UNKNOWN COMMAND"); 138 | } 139 | } 140 | } --------------------------------------------------------------------------------