diff --git a/Setup/Microcontroller/Microcontroller-Beginner-MC-only.md b/Setup/Microcontroller/Microcontroller-Beginner-MC-only.md new file mode 100644 index 0000000..5662ab2 --- /dev/null +++ b/Setup/Microcontroller/Microcontroller-Beginner-MC-only.md @@ -0,0 +1,156 @@ +# **Part 2b:** Microcontroller setup - running other programs + +| Automation Set-up Guide for Beginners | +| --- | +| [Introduction](/README.md)| +| **Part 1:** [Hardware needed](/Setup/HardwareNeeded/HardwareBeginner.md)| +| **Part 2:** [Microcontroller](/Setup/Microcontroller/Microcontroller-Beginner.md) | +| **Part 2b:** [Microcontroller](/Setup/Microcontroller/Microcontroller-Beginner-MC-only.md) (this page)| +|Video - Guide to Pokemon Automation set-up: https://youtu.be/DFXZzWkOEMs| + +--- + +Now that you have run TurboA on your Arduino, you will now learn how to run other microcontroller programs. + +## Step 1: Install WinAVR + +Download and install [WinAVR](https://sourceforge.net/projects/winavr/files/). + +> It is strongly recommended to install it in the default directory (`C:/WinAVR-20100110`). + +## Step 2: Download QMK Toolbox + +Download QMK if you haven't already done so. + +A few QMK versions are known to work. e.g. 0.1.1, 0.2.2, 0.3.1, 0.3.3. Other versions may not work (e.g. 0.3.2 does not work). + +Download [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases). Ensure you download a version known to work. e.g. 0.3.3. + +You want the file `qmk_toolbox.exe`. You'll find it under `Assets`, under the version number that you choose (e.g. 0.3.3). + +## Step 3: Download the Arduino Programs + +Download the Arduino Programs if you haven't already done so. + +1. Download the latest version of our Arduino programs from [here](https://github.com/PokemonAutomation/Microcontroller/releases). + + * (The link should look like something like `PA-NativePrograms-0.x.x-xxxxxxxx.zip`) + + * If you get a virus or malware warning, ignore it. These are known false positives. If you don't trust us, the [source code is here](https://github.com/PokemonAutomation/Arduino-Source/tree/main/HexGenerator). + +2. Once you have downloaded the package, unzip to somewhere you can access later. Do not put it on Microsoft OneDrive. + +## Step 4: Generate a .hex file. + +1. Open the (unzipped) package from previous step and double-click on `HexGenerator-Windows.cmd` to run it. +2. In the "Board Type" drop-down, change it to "Arduino Leonardo". +3. In the program list, click on "Turbo A". +> We recommend starting with "Turbo A" as it is the simplest program. If you are able to get this running, it is easier to troubleshoot the other programs. + + + +4. Click on "Save and generate .hex file!". + +After a while, you should get a confirmation box saying it was successful. You should now see a file `TurboA-ArduinoLeonardo.hex` in the folder of the programs. + + + +## Step 5: Flash the .hex into the Leonardo. + +1. Run `qmk_toolbox.exe`, which we downloaded earlier in step 2. + - Allow the drivers to install. + - If you don't get a prompt to install drivers. Click `Tools` in the toolbar, then `Install drivers`. +2. Within QMK toolbox, open the .hex you generated in the previous step. +3. Change the MCU to `atmega32u4`. +4. Check the "Auto-Flash" box. + + + +5. Plug the Leonardo into your computer. + + + +6. Press the reset button. + + + +The QMK program will now flash the program to the Leonardo and show a bunch of logging. +Afterwards, the 3 LEDs on the Leonardo should flash in unison for 5 seconds before turning off. + + + +7. Unplug the Leonardo from your computer. + +### Common errors with QMK toolbox +| Error | Solution | +| --- | --- | +| .NET error | First, ensure the drivers are installed (Tools -> Install Drivers). If this fails, try using a different version of QMK toolbox. See below for versions known to work. | +| "Flash complete", but no logging is shown | Unplug and replug the microcontroller into the computer and try flashing again. Try different USB ports. Try a different version of QMK toolbox. See below for versions known to work. | +| "COM port not found!" | Same as the issue where you get "Flash complete", but no logging, try unplugging and replugging the microcontroller into the computer and try different USB ports. Also, double check that the USB cable supports data transfer | + +**Versions of QMK toolbox known to work:** +- 0.1.1 +- 0.2.2 +- 0.3.1 +- 0.3.3 + +If all else fails, you can try flashing the hex file directly with avrdude. See [here](./Microcontroller-Beginner.md#flashing-the-hex-directly-with-avrdude) for instructions. + +## Step 6: Setup and run the program! + +To test that TurboA works: + +1. On your Switch, enter the game and navigate to somewhere you want to mash A in front of (such as the digging duo). Alternatively, you can stand in front of the Pokemon center to repeatedly heal. + + + +2. Navigate to the grip menu without closing the game. This disconnects all controllers from the Switch so that the Leonardo can take over. + + + +3. Plug the Leonardo into your Switch's dock. + + + +The program should now begin running. It will flash its lights for a few seconds, then it will connect to the Switch and navigate its way back into the game. After a brief pause, it will start mashing A. + +**Usage Notes:** + +- To stop the program, simply unplug the Leonardo at any time. +- Do not change video output or mess with the HDMI. These can cause the program to Switch to freeze for multiple seconds and break the program. If you want turn off the TV, do it *before* you start the program. + +## Using Other Programs + +You now know how to run TurboA - the most basic of the programs. You can choose any of the other programs and repeat steps 5-7. + +- [Program List](https://github.com/PokemonAutomation/Microcontroller/blob/master/Wiki/Programs/README.md) + +It is important to read the manual for a program before you use it. Each program has a different set of instructions and startup conditions. +You can find the manual for a program by clicking on the "Online Documentation" link. + +## If you are only doing Microcontroller Automation, your tutorial ends here! + +Congrats! You've learned how to automate! + +## If you are doing Computer Controlled Automation, your next step is [here](/Setup/ComputerControl/ComputerControl-Beginner.md) + +The next step will teach you how to put together and use the Computer Controlled hardware. + + +
+ +**Discord Server:** + +[](https://discord.gg/cQ4gWxN) + + + + + + + + + + + + diff --git a/Setup/Microcontroller/Microcontroller-Beginner.md b/Setup/Microcontroller/Microcontroller-Beginner.md index 0a02085..c19ab44 100644 --- a/Setup/Microcontroller/Microcontroller-Beginner.md +++ b/Setup/Microcontroller/Microcontroller-Beginner.md @@ -16,21 +16,15 @@ Below you will find information on how to setup and use the hardware you bought For macOS and Linux users, use this [tutorial](Microcontroller-Mac.md). The following steps in this page are for Windows user only. -## Step 1: Install WinAVR +## Step 1: Download QMK Toolbox -Download and install [WinAVR](https://sourceforge.net/projects/winavr/files/). +A few QMK versions are known to work. e.g. 0.1.1, 0.2.2, 0.3.1, 0.3.3. Other versions may not work (e.g. 0.3.2 does not work). -> It is strongly recommended to install it in the default directory (`C:/WinAVR-20100110`). +Download [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases). Ensure you download a version known to work. e.g. 0.3.3. -## Step 2: Download QMK Toolbox +You want the file `qmk_toolbox.exe`. You'll find it under `Assets`, under the version number that you choose (e.g. 0.3.3). -A few QMK versions are known to work. e.g. 0.1.1, 0.2.2, and 0.3.1. Other versions may not work (e.g. 0.3.2 does not work). - -Download [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases). Ensure you download a version known to work. e.g. 0.3.1. - -You want the file `qmk_toolbox.exe`. You'll find it under `Assets`, under the version number that you choose (e.g. 0.3.1). - -## Step 3: Download the Arduino Programs +## Step 2: Download the Arduino Programs 1. Download the latest version of our Arduino programs from [here](https://github.com/PokemonAutomation/Microcontroller/releases). @@ -40,27 +34,12 @@ You want the file `qmk_toolbox.exe`. You'll find it under `Assets`, under the ve 2. Once you have downloaded the package, unzip to somewhere you can access later. Do not put it on Microsoft OneDrive. -## Step 4: Generate a .hex file. - -1. Open the (unzipped) package from previous step and double-click on `HexGenerator-Windows.cmd` to run it. -2. In the "Board Type" drop-down, change it to "Arduino Leonardo". -3. In the program list, click on "Turbo A". -> We recommend starting with "Turbo A" as it is the simplest program. If you are able to get this running, it is easier to troubleshoot the other programs. - - - -4. Click on "Save and generate .hex file!". - -After a while, you should get a confirmation box saying it was successful. You should now see a file `TurboA-ArduinoLeonardo.hex` in the folder of the programs. - - - -## Step 5: Flash the .hex into the Leonardo. +## Step 3: Flash the .hex into the Leonardo. 1. Run `qmk_toolbox.exe`, which we downloaded earlier in step 2. - Allow the drivers to install. - If you don't get a prompt to install drivers. Click `Tools` in the toolbar, then `Install drivers`. -2. Within QMK toolbox, open the .hex you generated in the previous step. +2. Within QMK toolbox, open `NintendoSwitch-TurboA-ArduinoLeonardo.hex`, from the folder you unzipped in the previous step. 3. Change the MCU to `atmega32u4`. 4. Check the "Auto-Flash" box. @@ -92,10 +71,11 @@ Afterwards, the 3 LEDs on the Leonardo should flash in unison for 5 seconds befo - 0.1.1 - 0.2.2 - 0.3.1 +- 0.3.3 If all else fails, you can try flashing the hex file directly with avrdude. See [here](./Microcontroller-Beginner.md#flashing-the-hex-directly-with-avrdude) for instructions. -## Step 6: Setup and run the program! +## Step 4: Setup and run the program! To test that TurboA works: @@ -118,19 +98,10 @@ The program should now begin running. It will flash its lights for a few seconds - To stop the program, simply unplug the Leonardo at any time. - Do not change video output or mess with the HDMI. These can cause the program to Switch to freeze for multiple seconds and break the program. If you want turn off the TV, do it *before* you start the program. -## Using Other Programs - -You now know how to run TurboA - the most basic of the programs. You can choose any of the other programs and repeat steps 5-7. - -- [Program List](https://github.com/PokemonAutomation/Microcontroller/blob/master/Wiki/Programs/README.md) - -It is important to read the manual for a program before you use it. Each program has a different set of instructions and startup conditions. -You can find the manual for a program by clicking on the "Online Documentation" link. - -## If you are only doing Microcontroller Automation, your tutorial ends here! +## If you are only doing Microcontroller Automation, your next step is [here](/Setup/Microcontroller/Microcontroller-Beginner-MC-only.md) -Congrats! You've learned how to automate! +Next, you will learn how to run other programs, besides just TurboA.