cartreader/Cart_Reader
2021-11-17 21:49:20 +01:00
..
atoi32.cpp Corrected type 2021-02-07 23:07:02 -08:00
atoi32.h Implemented custom atoi methods, as the included one only has 16-bit precision 2021-02-07 20:34:39 -08:00
Cart_Reader.ino Fix Progressbar line break on LCD 2021-11-17 21:49:20 +01:00
clkcal.ino Add Clock generator calibration option 2021-10-28 14:26:10 -07:00
FLASH.ino Fix Led and missing word wrap 2021-10-26 17:13:42 +02:00
GB.ino Fix Led and missing word wrap 2021-10-26 17:13:42 +02:00
GBA.ino Fix Led and missing word wrap 2021-10-26 17:13:42 +02:00
GBM.ino Fix Led and missing word wrap 2021-10-26 17:13:42 +02:00
GBSmart.ino Fix Led and missing word wrap 2021-10-26 17:13:42 +02:00
MD.ino V7.2: LCD bugfix #2 2021-11-17 21:31:18 +01:00
N64.ino Fix Progressbar line break on LCD 2021-11-17 21:49:20 +01:00
NES.ino V7.2: LCD bugfix #2 2021-11-17 21:31:18 +01:00
NGP.ino Fix Led and missing word wrap 2021-10-26 17:13:42 +02:00
NP.ino V7.0: Add basic support for MKS MINI12864 V3 2021-10-24 00:41:18 +02:00
options.h V7.2: LCD bugfix #2 2021-11-17 21:31:18 +01:00
PCE.ino V6.1: Add support for exFAT SD cards (>32GB) 2021-04-26 18:20:30 +02:00
README.md Prepare for new hardware version 2021-11-15 12:34:18 +01:00
RTC.cpp V7.0: Add basic support for MKS MINI12864 V3 2021-10-24 00:41:18 +02:00
RTC.h V7.0: Add basic support for MKS MINI12864 V3 2021-10-24 00:41:18 +02:00
SMS.ino V7.2: LCD bugfix #2 2021-11-17 21:31:18 +01:00
snes_clk.cpp Updated snes_clk for exFAT changes 2021-04-28 00:44:11 -07:00
snes_clk.h Make clockgen calibration optional 2021-10-14 09:53:07 +02:00
SNES.ino V7.2: LCD bugfix #2 2021-11-17 21:31:18 +01:00
SV.ino add #ifdef enable_XXX check to each module 2020-07-05 00:07:14 +09:00
WS.ino Fix Led and missing word wrap 2021-10-26 17:13:42 +02:00

This Arduino code is written by a beginner for beginners, therefore I tried to comment every line of code. To an experienced coder this probably will seem very wrong but it really helps if you're just starting out.

Every submodule has it's own setup_XX() function that configures the needed pins and a submenu that lets you choose what you want to do. The code directly addresses the pins via the DDR, PIN and PORT registers.
Please also refer to the pinout Excel sheet.

void setup_N64_Controller() {  
  // Output a low signal  
  PORTH &= ~(1 << 4);  
  // Set Controller Data Pin(PH4) to Input  
  DDRH &= ~(1 << 4);  
}  

Would be the same as this in a more traditional Arduino sketch:

int dataPin = 7;   

void setup(){    
  // Output a low signal   
  digitalWrite(dataPin, LOW);   
  // Set controller data pin to input  
  pinMode(dataPin, INPUT);  
}  

To preserve memory every string is saved into the flash of the Arduino, also called progmem. This is done by using the F() macro.

println_Msg(F("Press Button."));  

Also all the menus are stored in progmem and are only recalled to sram when needed.

// N64 controller menu items  
const char N64ContMenuItem1[] PROGMEM = "Test Controller";  
const char N64ContMenuItem2[] PROGMEM = "Read ControllerPak";  
const char N64ContMenuItem3[] PROGMEM = "Write ControllerPak";  
const char N64ContMenuItem4[] PROGMEM = "Reset";  
const char* const menuOptionsN64Controller[] PROGMEM = {N64ContMenuItem1, N64ContMenuItem2, N64ContMenuItem3, N64ContMenuItem4};  

In an effort to keep the codebase as portable as possible instead of using the functions supplied by the OLED library directly to print out text, auxiliary functions like println_Msg are being used. So if you want to change to another display library you don't need to change all the code but only the helper functions.

void print_Msg(long unsigned int message) {
  if (enable_OLED)
    display.print(message);
  if (enable_Serial)
    Serial.print(message);
}

Before uploading the code to your Arduino you need to select your hardware version in options.h

//******************************************     
// CHOOSE HARDWARE VERSION     
//******************************************    
#define HW4    
//#define HW3    
//#define HW2    
//#define HW1    
//#define SERIAL_MONITOR    

For more info please have a look at this wiki article.

Needed libraries(already included in the portable Arduino IDE under Releases)

SD lib: https://github.com/greiman/SdFat
OLED lib: https://github.com/adafruit/Adafruit_SSD1306
GFX Lib: https://github.com/adafruit/Adafruit-GFX-Library
BusIO: https://github.com/adafruit/Adafruit_BusIO
LCD lib: https://github.com/olikraus/u8g2
RGB Tools lib: https://github.com/joushx/Arduino-RGB-Tools
Neopixel lib: https://github.com/adafruit/Adafruit_NeoPixel
Rotary Enc lib: https://github.com/mathertel/RotaryEncoder
SI5351 lib: https://github.com/etherkit/Si5351Arduino
RTC lib: https://github.com/adafruit/RTClib