-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add setup doc all in one #6
base: All-in-One
Are you sure you want to change the base?
Add setup doc all in one #6
Conversation
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Firmware
* 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
and needs to
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An up to date browser like Chrome
|
||
**Prerequesites** | ||
* An actual Browser such like Chrome | ||
* Web Serial Access allowes (Web Serial API) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
allowed
* 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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
prerequisites
#|Action|Result | ||
---|---|--- | ||
1|**Add additional source**| | ||
1.1| Naviagte to *Datei>Voreinstellungen* | The preferences view is shown. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Navigate
---|---|--- | ||
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
following
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| |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Navigate
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* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As this is a serial connection, it is essential to set the baudrate appropriately.
## 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)** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please Note: Setting the baud rate to any other value than 115200 Baud will result in unreadable output
Description
I did not change anything to the code, just added a setup documentation to the repo (setup.md). The documentation covers fimrware flashing (initial and update), configuring the Arduino IDE and how to get the right sketch
Fixes # (issue)
No setup procedure in the repo. Information is in the forum and on different websites, Having this in the repo directly kick starts the first hands on.
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Not required because of no code has been changed at all.
Checklist: