Mirrors/cartreader
2
0
Fork 0
mirror of https://github.com/sanni/cartreader.git synced 2024-12-02 01:14:13 +01:00
Code Issues Projects Releases Wiki Activity

Updated How to flash the Arduino (markdown)

sanni 2024-08-14 10:40:28 +02:00
parent 2c7a241740
commit 27e52503b0
1 changed files with 31 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
How-to-flash-the-Arduino.md

@ -5,10 +5,10 @@ Before updating ensure all cartridges are removed from the OSCR. If you don't se
Currently, the Firmware Updater cannot be used to flash a new Arduino for the first time or to update very old OSCR firmware versions. Use the manual method described below for that.
# Updating Manually
# Using the Arduino IDE
The Cart Reader's firmware is released as source code and needs to be compiled before flashing. Both compiling and flashing can be done with the **Arduino IDE**.
You can either use the [Portable Release](https://github.com/sanni/cartreader/wiki/How-to-flash-the-Arduino#portable-release) or the [official Arduino IDE installer](https://github.com/sanni/cartreader/wiki/How-to-flash-the-Arduino#official-arduino-ide-installer).
The Cart Reader's firmware is released as source code and needs to be compiled before flashing. Unlike other projects that usually just provide you with a *.hex file this method allows you to easily modify the firmware and hopefully sparks your interest in contributing to this project. 🔧🔨😊
Both compiling and flashing can be done with the **Arduino IDE**. You can either use the [Portable Release](https://github.com/sanni/cartreader/wiki/How-to-flash-the-Arduino#portable-release) or the [official Arduino IDE installer](https://github.com/sanni/cartreader/wiki/How-to-flash-the-Arduino#official-arduino-ide-installer).
## Portable Release:
@ -50,7 +50,7 @@ You can tell which hardware version you got by comparing your OSCR with this ima
![image](https://dl.dropboxusercontent.com/s/wrffv9ldzfu3qv9/telllhwversion.jpeg?dl=1)
**8)** In case you do not have the Clock Generator installed you need to change the line "#define clockgen_installed" to "//#define clockgen_installed".
**8)** In case you do **not** have the Clock Generator installed you need to change the line "#define clockgen_installed" to "//#define clockgen_installed".
![image](https://dl.dropboxusercontent.com/s/cj8qe8ewilflknj/clockgeninstalled.jpg?dl=1)
@ -64,10 +64,35 @@ You can tell if you have the clock generator installed by comparing your OSCR wi
**10)** Also don't forget to update the SD database files like described [here](https://github.com/sanni/cartreader/wiki/Preparing-the-SD-card)
## Updating in-between portable releases:
The latest portable release will always be some commits behind the current development code in the master branch. If you want to use the latest fixes/features you can update the portable release by either launching the included UPDATE.bat (Windows 10/11 only) or by [downloading and extracting the current master branch](https://github.com/sanni/cartreader/archive/refs/heads/master.zip) into the portable release overwriting the old files.
Copy the Cart_Reader folder from:
````
cartreader-master.zip\cartreader-master\
````
to:
````
VX.X_Portable\Arduino IDE\portable\sketchbook\
````
And then copy the files from:
````
cartreader-master.zip\cartreader-master\sd\
````
to your SD card like described [here](https://github.com/sanni/cartreader/wiki/Preparing-the-SD-card).
## Official Arduino IDE Installer:
Alternatively you can download and install the [Arduino IDE](https://www.arduino.cc/en/software) and then copy the "libraries" and "Cart_Reader" folder from the current release "VX.X_Portable\Arduino IDE\portable\sketchbook" to "C:\Users\your_username\Documents\Arduino" and launch the Arduino IDE from the start menu.
It should look like this when done:
````
C:\Users\your_username\Documents\Arduino\Cart_Reader
C:\Users\your_username\Documents\Arduino\libraries
````
If you want to use the latest fixes and features you can [download and extract the current master branch](https://github.com/sanni/cartreader/archive/refs/heads/master.zip) and copy the Cart_Reader folder to:
````
C:\Users\your_username\Documents\Arduino\
````
In both cases don't forget to also copy the files in the SD directory to your SD card like described [here](https://github.com/sanni/cartreader/wiki/Preparing-the-SD-card).