diff --git a/Setup.md b/Setup.md new file mode 100644 index 00000000..e7a86ecc --- /dev/null +++ b/Setup.md @@ -0,0 +1,76 @@ +# Overview +The All-in-One PCB is a great improvement and makes the hardware more professional. With this professionalism the Arduino IDE needs to get there too. A few configurations need to be applied to the IDE prior to start such like: +* Fimrware **MUST** be updated prior to anything +* Adding an additional source for the board manager +* Configure the Arduino *alike* processor +* Choose an appropriate *.ino file + +# Firmware +The firmware is an essential part and need to be flashed before any other operation. The good news it is doable directly from your webbrowser. + +**Prerequesites** +* An actual Browser such like Chrome +* Web Serial Access allowes (Web Serial API) +* All-in-One PCB is connected to your PC + +After prereuisites are fulfilled follow the instructions here [Tonuino All-in-One online firmware updater](https://tonuino.de/aio_update.html) + +# Arduino IDE +The main thing is to add the *Leiterkartenpiraten* processor settings to the Arduino IDE. Therefore you need to add an additional source for the board manager. + +## Add Additional Borad Manager Source + +#|Action|Result +---|---|--- +1|**Add additional source**| +1.1| Naviagte to *Datei>Voreinstellungen* | The preferences view is shown. +2.1| Select text box *Zusätzliche Bordverwalter-URLs* and add the the follwing|https://raw.githubusercontent.com/dbuezas/lgt8fx/master/package_lgt8fx_index.json| Additional source is shown in the text box +3.1| Confirm your changes with *OK*| The preferences view closes and the main window of Arduino IDE is shown| + +## Select appropriate board and architecture + +**Please note: Now there are two (or more) menu items in *Werkzeuge>Boards* This is caused by adding the additional URL and is intended** + +#|Action|Result +---|---|--- +1|**Select board**| +1.1|Navigate to *Werkzeuge>Boards>Logic Green Arduino AVR Compatible Boards*| Associated boards are shown such like LT... +1.2|Select *LGT8F328*| The board is selected and the menu closes +2|**Select Clock Source** | +2.1|Navigate to *Werkzeuge>Clock Source:*| The associated clock sources are shown (Internal, External,...) +2.2|Select *External: (assumes 32Mhz crystal)*| The Clock source is selected and the menu closes| +3|**Select Clock**| +3.1|Navigate to *Werkzeuge>Clock*| The associated clock speeds are shown| +3.2|Select *16Mhz*| The clock speed is selected and the menu closes| +4|**Select Variant**| +4.1|Naviagte to *Werkzeuge>Variant:*|The associated variants are shown| +4.2|Select *328P-LQFP32 (e.g. MiniEVB nano-style and WAVGAT)*| The Variant is selected and the menu closes| +5|**Select Arduino as ISP**| +5.1|Navigate to *Werkzeuge>Arduino as ISP*| The associated architectures are shown| +5.2|Select *Default (64)*| The architecture is selected and the menu closes + +## Set Monitor Baudrate +As this is all serial, the baudrate is essentitial to set appropriately. For the All-in-One PCB it is *115200* + +**Please Note: Setting the Baudrate to any other that 115200 Baud the monitor will display a satans dialect directly from hell (hiroglyphs)** + +# TonUINO All-in-One Sketch + +Basically you need an appropriate *.ino file that can be uploaded to the All-in-One PCB. + +**Please Note: There is a seperate Branch to DEV and MAIN for the All-in-One PCB. Using the wrong one (e.g. Classic TonUINO) lead to a very funny behavior ;). Be sure that you have selected the All-in-One Branch when you use the download option** + +You can get the TonUINO.ino either by downloading it from the repository or clone it to local [TonUINO @github](https://github.com/tonuino/TonUINO/tree/All-in-One). + +## Download + +You are already done by dowloading it with *All-in-One* selected + +## Clone + +Clone the repository to local and *checkout* All-in-One Branch +``` +git clone https://github.com/tonuino/TonUINO.git + +git checkout All-in-One +```