diff --git a/docs/beginners-guide.md b/docs/beginners-guide.md index 8ae894c..ad7a69e 100644 --- a/docs/beginners-guide.md +++ b/docs/beginners-guide.md @@ -56,13 +56,13 @@ AX.25 is an umbrella term often used for all packet radio, but really it refers It has a long legacy and is rather simple, but is reliable, embedded in a lot of old hardware and will likely be in use until the heat death of the universe. -Learn more [here](detail/ax25.md). +Learn more [here](https://en.wikipedia.org/wiki/AX.25). ##### IL2P IL2P, the 'Improved Layer 2 Protocol' is by Nino KK4HEJ and is an evolution of AX.25. It includes nice things such as error correction of data and allows for, theoretically, more reliable communications but isn't compatible with AX.25 on the air. -There are a number of varieties of IL2P in the wild too - learn more [here](detail/il2p.md). +There are a number of varieties of IL2P in the wild too, most commonly 'With CRC' which includes a check that callsigns are valid. #### Speeds @@ -98,11 +98,11 @@ Phase Shift Keying - Data encoded into changes of phase. Often found on HF links ### Linux -A key component of the systems I'll be discussing in this guide is Linux. If you don't have a great understanding of Linux or it's a bit scary, I've got an overview of things you might want to know [here](linux.md). +A key component of the systems I'll be discussing in this guide is Linux. If you don't have a great understanding of Linux or it's a bit scary, I've written a primer [here](linux.md). -There's a lot to take in, and it can seem overwhelming at first, but feel free to read, ask for help and keep in mind that it's easy to be feel like that when you approach anything new. +There's a lot to take in, and it can seem overwhelming at first, but feel free to read, ask for help and keep in mind that it's easy to feel lost when you approach anything new - there are just so many things to grasp. -A simple starting point is a [Raspberry Pi](https://raspberrypi.org) - it will be a dedicated computer for just packet exploration, and if everything is broken you can easily start again without losing any importnt data. +A simple starting point is a [Raspberry Pi](https://raspberrypi.org) - it will be a dedicated computer for just packet exploration, and if everything is broken you can easily start again without losing any importnt data - you just rewrite the SD card and start again. ## Radio Set Up @@ -114,19 +114,17 @@ If information is available online, also take note of the details of the mode as ## Software Set Up +I'm going to assume that you have a NinoTNC or other KISS hardware modem. If you want to use QtSoundModem, take a look at my [guide](modems/qtsm.md). + ### Installation If you're using Debian, Ubuntu or a Raspberry Pi it will be easiest if you install [hibby's repo](repo.md). -Once you have done that you can install the prerequisites: +Once you have done that you can install the prerequisites - QTTermTCP. -`sudo apt install qtsoundmodem qttermtcp` +If you're a new user, I recommend using a graphical 'app store' - see how [here](linux.md/#graphical-app-store-frontend). -### Configure QtSoundModem - -We shall set up QtSoundModem to understand the type of signal we are trying to receive. - -If you have details of the mode as suggested above, QtSoundModem allows easy configuration of the key details. +If you're more linux aware? `apt install soundmodem` in your terminal of choice! ### Configure QtTermTCP @@ -134,22 +132,31 @@ Open QtTermTCP and set up a Kiss Connection to your Modem. This will work for Qt #### Set up Kiss Connection -Click Setup then KISS Configuration. +Click Setup then KISS Configuration. You will be presented with a window that looks similar to the below: + +![QTTermTCP Kiss Configuration Image](static/img/qttcp_kiss.png) Ensure 'Enable Kiss Interface' is selected, put your callsign in MYCALL and put select your modem from the 'Serial TNC' dropdown. If using a NinoTNC, the speed will be 57600. -Press OK to save setting. +Press OK to save settings. At this stage, I recommend Monitoring the frequency to see if you can decode any information. Local stations will likely be beaconing and this is a good way to test you have set up correctly without interfering with other users transmissions. Decoded data shall look like: +![QtTermTCP Monitor Window](static/img/qttcp.png) + ## Connect -Press Connect and enter the callsign & SSID you are trying to connect to, for example GB7HIB-7 if you're connecting to my node. +Press Connect, then 'Kiss Connect' in the dropdown menu. You'll see something aking to the below - selection session, enter the callsign & SSID you are trying to connect to, for example GB7HIB-7 if you're connecting to my node. Ignore digipeters for the moment - they can be a future challenge. + +![Connect window](static/img/qttcp_connect.png) + You should be presented with some choices in the bottom pane - BBS, Links, Info etc. If not, type `?` in the bottom text box, hit enter and see what the remote system returns with. +![Connection to GB7NRT](static/img/qttcp_nrt.png) + Congratulations, you are on the air! Not seeing anything in the monitor pane? Time to get debugging! diff --git a/docs/linux.md b/docs/linux.md index 0914cb5..69ad91b 100644 --- a/docs/linux.md +++ b/docs/linux.md @@ -31,7 +31,7 @@ Most of my advice will take the form of things to run in the command line, but I If you're running the Raspberry Pi, it's most likely you have [Raspberry Pi OS](https://www.raspberrypi.com/software/) with a desktop - there'll be a background, a menu in the top left etc. It might not look familiar, but to a keen explorer it should look approachable at the very least. -If you're running Debian, during install we'll ask you what graphical desktop environment you want to install, if any. As a beginner, I strongly recommend [KDE](https://kde.org) - it is most Windows like and is pretty full featured. If you're running Ubuntu, typically you install an Ubuntu derivative focussed on a specific desktop environment - perhaps [Kubuntu](https://kubuntu.org) for KDE. +If you're running Debian, during install we'll ask you what graphical desktop environment you want to install, if any. This is the desktop you boot in to - unlike Windows, there are multiples available for Linux. As a beginner, I strongly recommend [KDE](https://kde.org) - it is most Windows like and is pretty full featured. If you're running Ubuntu, typically you install an Ubuntu derivative focussed on a specific desktop environment - perhaps [Kubuntu](https://kubuntu.org) for KDE. ## Applications and Repositories @@ -124,11 +124,9 @@ The GUI offers some choices - my preferred method is below. I recommend installing Featherpad for this - it's lightweight and will only ask for a password when you save the file. -To install it, go to the Raspberry Pi menu, Preferences and select Add/Remove software. +If you use the KDE Desktop, Kate works and has the below functionality inbuilt. -Search for featherpad, select the checkbox and press apply: - -![Featherpad Installation](static/img/install-featherpad.png) +To install it see [above](linux.md/#graphical-app-store-frontend) for more. You can open Featherpad from the application launcher and use the file->open menu to get access to files all round the system: diff --git a/docs/modems/index.md b/docs/modems/index.md index d54fee3..0c45753 100644 --- a/docs/modems/index.md +++ b/docs/modems/index.md @@ -38,4 +38,4 @@ Alternative modem command sets exist - onces I can name easily are: | Command Protocol | Description | ---------------- | ----------- | AGW or AGWPE | From AGW Packet Engine. A properitary command set that was originally released to interact with the software it is named after -| 6pack | Something about 6pack +| 6pack | 6pack offers more control over the radio and more awareness for the PC what is happening at the cost of greater complexity diff --git a/docs/modems/qtsm.md b/docs/modems/qtsm.md index f040d22..f37b883 100644 --- a/docs/modems/qtsm.md +++ b/docs/modems/qtsm.md @@ -4,14 +4,13 @@ QtSoundModem is a soundmodem with a GUI written by John Wiseman G8BPQ. It is a f It has some compelling features - not only does it natively understand IL2P at a number of different baud and bitrates and modulations, it supports multiple modems, each with a different KISS interface. This allows for up to 4 ports with different speeds, protocols and modes in the same channel - a fantastic thing to explore on HF. - ## Software Set Up ### Installation If you're using Debian, Ubuntu or a Raspberry Pi it will be easiest if you install [hibby's repo](../repo.md). -Once you have done that you can install the prerequisites: +Once you have done that you can install the prerequisites, either search for qtsoundmodem in your [app store](linux.md/#graphical-app-store-frontend): `sudo apt install qtsoundmodem` diff --git a/docs/static/img/qttcp_connect.png b/docs/static/img/qttcp_connect.png new file mode 100644 index 0000000..d0d8597 Binary files /dev/null and b/docs/static/img/qttcp_connect.png differ diff --git a/docs/static/img/qttcp_ip.png b/docs/static/img/qttcp_ip.png new file mode 100644 index 0000000..3224e5d Binary files /dev/null and b/docs/static/img/qttcp_ip.png differ diff --git a/docs/static/img/qttcp_nrt.png b/docs/static/img/qttcp_nrt.png new file mode 100644 index 0000000..4630df7 Binary files /dev/null and b/docs/static/img/qttcp_nrt.png differ