NetCube-Systems-Austria/kumquat-readthedocs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add some more info about connectors.

Browse Source
This commit is contained in:
Lukas Schmid 2024-05-15 11:58:32 +02:00
parent 708852f92a
commit 4e67d08841
4 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/01_quickstart.md
View File

@ -23,17 +23,20 @@ Before you begin, make sure you have the following:
## Step 3: Insert SD Card into Kumquat Board
1. Eject the SD card from your computer.
2. Insert the SD card into the "Flash Module Adapter" provided with the Kumquat board.
3. Insert the adapter into the top right pin header just below the audio connectors on the Kumquat board.
3. Insert the adapter into the top right pin header (X16) just below the audio connectors on the Kumquat board.
![Insert Adapter](placeholder_image_link)
## Step 4: Connect USB Cable
1. Connect one end of the USB cable to the right port of the Kumquat board.
1. Connect one end of the USB cable to the right port (X12) of the Kumquat board.
2. Insert the other end of the USB cable into an available USB port on your computer.
![Connect USB Cable](placeholder_image_link)
## Step 5: Open Serial Terminal
See [Serial Console](interfaces/console) for more Information
1. Open a serial terminal application such as PuTTY or GtkTerm on your computer.
2. Select the newly detected serial port with the following settings:
@ -43,7 +46,7 @@ Before you begin, make sure you have the following:
- Stop bits: 1
## Step 6: Connect Power Supply
1. Connect the 12V or 24V power supply to the bottom right terminal block of the Kumquat board.
1. Connect the 12V or 24V power supply to the bottom right terminal block (X1) of the Kumquat board.
2. Ensure that the positive pin of the power connector is on the right side.
![Connect Power Supply](placeholder_image_link)

8
docs/interfaces/console.md
View File

@ -4,7 +4,7 @@ In this document you will find a guide on how to use PuTTY or GtkTerm to connect
| Location | Description |
| -------- | ------------- |
| Xn | USB Console |
| X12 | USB Console |
![USB Console Connector Location](placeholder_image_link)
@ -39,9 +39,9 @@ Connect the USB Cable to the right USB Type-C connector on the Kumquat, and plug
## Using GtkTerm to Connect to a USB-Serial Interface
1. **Install GtkTerm**: If GtkTerm is not already installed on your system, you can install it using your package manager. For example, on Ubuntu-based systems, you can install GtkTerm using the following command:
```sh
sudo apt-get install gtkterm
```
```sh
sudo apt-get install gtkterm
```
2. **Connect the USB-Serial Adapter**: Connect the USB-Serial adapter to your Kumquat device and ensure that the drivers are properly installed on your computer.

2
docs/interfaces/index.md
View File

@ -7,4 +7,4 @@ This section of the documentation contains important information about the inter
For all examples you will need the demonstration image installed on your Kumquat. Please follow the steps below, in order to install it:
1. Download the demonstration-image from [here](https://git.netcubesystems.at/NetCube-Systems-Austria/kumquat-buildroot-releases/releases/tag/demo-build)
2. Install the downloaded image as explained in the [Quickstart](quickstart) guide, and start the Kumquat with a console connection.
2. Install the downloaded image as explained in the [Quickstart](../01_quickstart) guide, and start the Kumquat with a console connection.

2
docs/interfaces/usb-otg.md
View File

@ -1,3 +1,3 @@
# USB
To be documented...
To be documented... X11