Merge branch 'master' of github:/tiyn/wiki

- changed wi-fi entry in linux folder for a general one
- improved linking of hardware entries via sections
- added bluez troubleshooting

wiki/bluetooth.md

@@ -1,8 +1,8 @@
 # Bluetooth
 
-[Bluetooth](https://www.bluetooth.com/) is a short-range technology for wireless
+[Bluetooth](https://www.bluetooth.com/) is a short-range technology for wireless data transfer.
-data transfer.
+From a [hardware](/wiki/hardware_%28general%29.md) perspective Bluetooth requires a compatible
+adapter to work which may be integrated or external.
 
-For [Linux](/wiki/linux.md) based operating systems the
+Informations on Bluetooth usage on [Linux](/wiki/linux.md)-based operating systems are described in
-[bluez package](/wiki/linux/bluez.md) is used as the implementation of the
+the [Bluetooth section of the Linux hardware entry](/wiki/linux/hardware_%28linux%29.md#bluetooth).
-bluetooth standard.

wiki/hardware_(general).md

@@ -4,7 +4,21 @@ This entry focusses on various hardware components of a general desktop PC or a
 For [Linux](/wiki/linux.md) Systems see
 [the corresponding entry](/wiki/linux/hardware_%28linux%29.md).
 
-## Contents of Technic Bag
+## Hardware Functionality
+
+The following subsections address functions that rely on dedicated hardware modules or adapters.
+
+### Bluetooth
+
+Configuration and troubleshooting for Bluetooth functionality are described in the
+[corresponding Bluetooth entry](/wiki/bluetooth.md).
+
+### Wi-Fi
+
+Configuration and troubleshooting for Wi-Fi functionality are described in the
+[corresponding Wi-Fi entry](/wiki/wi-fi.md).
+
+## Technic Bag
 
 The following are components that are useful to be included in cable- and technic bags to.
 For power banks and power supplies it is useful to check for the power delivery standard.

wiki/linux/bluez.md

@@ -1,7 +1,7 @@
 # BlueZ
 
-[BlueZ](http://www.bluez.org/) is an implementation of the
+[BlueZ](http://www.bluez.org/) is an implementation of the [Bluetooth](/wiki/bluetooth.md)
-[Bluetooth](/wiki/bluetooth.md) standard.
+standard.
 This entry features the BlueZ package and all software that is based on it.
 
 ## Setup
@@ -20,6 +20,10 @@ systemctl enable bluetooth.service
 
 ## Usage
 
+This section addresses the usage of Bluez.
+
+### Connecting and Pairing of Devices
+
 The Bluetooth features can be managed by different types of front-ends.
 
 - `bluetoothctl` is a command-line interface included in the `bluez-utils`
@@ -31,3 +35,44 @@ The Bluetooth features can be managed by different types of front-ends.
   Using `bluetuith` the [Bluetooth](/wiki/bluetooth.md) can be turned on (or off) by pressing `o`,
   devices can be searched for by pressing `s`, a selected device can be paired by pressing `p` and
   finally connected by pressing `c` before `bluetuith` can be left with `Q`.
+
+## Troubleshooting
+
+This section will focus on errors and the fixing of errors of Bluez.
+
+### `bluetuith: no adapter found` or `bluetoothctl: No default controller available`
+
+When this error occurs the adapter is not recognized by the software.
+This can be confirmed using the following command and looking for the bluetooth adapter.
+
+```sh
+lsusb
+```
+
+If it is indeed not found it may be blocked by `rfkill`.
+To check this run the following command.
+
+```sh
+rfkill
+```
+
+This command will display something similar to the following.
+
+```txt
+0: hci0: Bluetooth
+        Soft blocked: no
+        Hard blocked: no
+```
+
+If the command displays `Soft blocked: yes` or `Hard blocked: yes` beneath the Bluetooth device it
+has to be unblocked to use it.
+For this run the following command where `<bluetooth-adapter>` is the name of the Bluetooth adapter
+(in this case it would be `hci0`).
+
+```sh
+rfkill unblock <bluetooth-adapter>
+```
+
+Afterwards the adapter will probably be recognized again but a restart of service
+`bluetooth.service` eventually has to be restarted as described in the
+[systemd entry](/wiki/linux/systemd.md#startstopenabledisable-a-service-and-retrieve-its-logs).

wiki/linux/hardware_(linux).md

@@ -5,7 +5,11 @@ laptop.
 For non-Linux specific or general topics in hardware see the
 [corresponding entry](/wiki/hardware_%28general%29.md)
 
-## Battery
+## Hardware Functionality
+
+The following subsections address functions that rely on dedicated hardware modules or adapters.
+
+### Battery
 
 The battery of a notebook can be inspected by using the `upower` command.
 To use it the tool needs to be installed.
@@ -40,24 +44,34 @@ For this run the following command.
 acpi -b
 ```
 
-## Power Management
+### Bluetooth
+
+[Bluetooth](/wiki/bluetooth.md) on [Linux](/wiki/linux.md) is generally managed by
+[Bluez](/wiki/linux/bluez.md).
+
+### Wi-Fi
+
+Wi-Fi functionality on [Linux](/wiki/linux.md) is handled by various tools such as
+[WPA Supplicant](/wiki/linux/wpa_supplicant.md) or [NetworkManager](/wiki/linux/networkmanager.md).
+
+### Power Management
 
 Tools, programs and guides to manage the power usage and improve battery life are described in the
 [power management entry](/wiki/linux/power_management.md).
 
-## (Liquid) Coolers
+### (Liquid) Coolers
 
 The viewing of temperatures of coolers as well as the selection of RGB-settings can be achieved by
 using [liquidctl](https://github.com/liquidctl/liquidctl).
 
-## Temperature
+### Temperature
 
 To check the temperature the command `sensors` can be used which (on most distributions) is a part
 of the `lm_sensors` package.
 It will then display all the available temperature sensors available as well as many other sensors
 like the RPM for fans.
 
-## ThinkPad TrackPoint
+### ThinkPad TrackPoint
 
 This section is based on a
 [Reddit comment by zedbraxmen](https://www.reddit.com/r/thinkpad/comments/wjb8qz/configuring_trackpoint_in_wayland/).
@@ -75,7 +89,7 @@ ATTR{device/sensitivity}="275",
 ATTR{device/speed}="215",
 ```
 
-## Fingerprint Readers
+### Fingerprint Readers
 
 Many modern laptops include fingerprint sensors which can be used for authentication on
 [Linux](/wiki/linux.md).

wiki/linux/nerd-dictation.md

@@ -0,0 +1,48 @@
+# Nerd Dictation
+
+[Nerd Dictation](https://github.com/ideasman42/nerd-dictation/) is a real-time offline speech
+recognition software for [Linux](/wiki/linux.md)-based operating systems which uses the
+[VOSK API](/wiki/speech_recognition_and_synthesis.md#vosk-api).
+
+## Setup
+
+The Nerd Dictation program can be installed from source as described
+[on GitHub](https://github.com/ideasman42/nerd-dictation/).
+Some [Linux](/wiki/linux.md) [package managers](/wiki/linux/package_manager.md) package Nerd
+Dictation in the `nerd-dictation` package.
+
+### Configuration
+
+Nerd Dictation needs a model to recognize and transcribe speech.
+The default path for this is `~/.config/nerd-dictation/model`.
+In this directory a VOSK model can be placed to use as default model.
+
+## Usage
+
+This section addresses the usage of Nerd Dictation.
+
+### Basic Usage
+
+Nerd Dictation can be started using the following command.
+
+```sh 
+nerd-dictation begin
+```
+
+The model can also be specified using the `--vosk-model-dir` flag.
+Assuming the path to the model is `<model-path>` a command will look like the following.
+If no model path is specified it uses the default model as described in
+[the setup section](#configuration).
+
+```sh 
+nerd-dictation begin --vosk-model-dir=<model-path>
+```
+
+
+```sh 
+nerd-dictation end
+```
+
+## Troubleshooting 
+
+This section will focus on errors and the fixing of errors of /name/.

wiki/linux/networkmanager.md

@@ -2,7 +2,7 @@
 
 NetworkManager - short NM - is a program to automatically detect and connect to
 networks by providing options for various configuration.
-It is used to set up [Wi-Fi](/wiki/linux/wi-fi.md).
+It is used to set up [Wi-Fi](/wiki/linux/hardware_%28linux%29.md#wi-fi).
 
 ## Setup
 
@@ -50,3 +50,6 @@ It will restart the [SystemD](/wiki/linux/systemd.md) service and enable the Wi-
 systemctl restart NetworkManager
 nmcli radio wifi on
 ```
+
+If the error still persists afterwards it may be useful to also restart WPA Supplicant as explained
+[in the corresponding section of its entry](/wiki/linux/wpa_supplicant.md#restarting-wpa-supplicant).

wiki/linux/systemd.md

@@ -52,7 +52,7 @@ To start the service after boot it has to be enabled.
 This works accordingly with the keyword `enable`.
 The `disable` keyword stops the service from starting automatically.
 
-Logs of the last start of the service can be found by running `systemctl status <service-name>`. 
+Logs of the last start of the service can be found by running `systemctl status <service-name>`.
 
 ### Retrieving the SystemD Logs
 
@@ -72,7 +72,7 @@ This time will be used to determine the time that is taken from suspend to hiber
 suspend-to-hibernate is called.
 The following line will set this to 10 minutes.
 
-```txt 
+```txt
 HibernateDelaySec=10min
 ```
 
@@ -102,7 +102,7 @@ ignore.
 As [machetie writes on Reddit](https://www.reddit.com/r/framework/comments/185035i/how_to_use_the_laptop_with_lid_closed_linux/)
 the following settings need to be set.
 
-```txt 
+```txt
 HandleLidSwitch=ignore
 HandleLidSwitchExternalPower=ignore
 HandleLidSwitchDocked=ignore
@@ -125,6 +125,6 @@ This error signals problems with the trusted platform module.
 This however usually can be fixed easily by masking the service and is done like the following
 command shows.
 
-```sh 
+```sh
 systemctl mark dev-tpmrm0.device
 ```

wiki/linux/whisper-cli.md

@@ -0,0 +1,44 @@
+# Whisper CLI
+
+[Whisper CLI](https://github.com/vatsalaggarwal/whisper-cli) is a non-real-time offline speech
+transcription software for [Linux](/wiki/linux.md)-based operating systems which uses the
+[Whisper API](/wiki/speech_recognition_and_synthesis.md#whisper-api).
+
+## Setup
+
+The Whisper CLI program can be installed from source as described
+[on GitHub](https://github.com/vatsalaggarwal/whisper-cli).
+Some [Linux](/wiki/linux.md) [package managers](/wiki/linux/package_manager.md) package Whisper CLI
+in the `whisper.cpp` package.
+
+### Configuration
+
+By default, Whisper CLI does not feature a global default model path.
+If not model path is given as shown in the [basic usage section](#basic-usage) the path
+`./models/ggml-base.en.bin` will be used.
+The behavior can not be changed using configuration of the program, but a simple alias can set a
+default path as shown below.
+
+```sh
+alias whisper="whisper-cli -m ~/.config/whisper-cli/ggml-large-v3-turbo-german-q5_0.bin"
+```
+
+## Usage
+
+This section addresses the usage of Whisper CLI.
+
+### Basic Usage
+
+Whisper CLI can be used to transcribe an [audio](/wiki/audio.md) file as shown in the following
+command.
+In this example `<model-path>` is the path to the Whisper model.
+
+```sh
+whisper-cli -m <model-path>
+```
+
+Additionally, a `.txt` file can be generated as shown below.
+
+```sh
+whisper-cli -m <model-path> -otxt
+```

wiki/linux/wi-fi.md

@@ -1,27 +0,0 @@
-# Wi-Fi
-
-Wi-Fi is a type of wireless network protocol that is used for local area networks.
-On [Linux-based systems](/wiki/linux.md) there are different programs that handle the Wi-Fi
-connection.
-
-- [WPA Supplicant](/wiki/linux/wpa_supplicant.md) is used for WPA2 and WPA3 connections among
-  others.
-- [NetworkManager](/wiki/linux/networkmanager.md) is used for various network connections.
-
-## Usage
-
-Tipps for usage can be found under the corresponding entries.
-
-## Troubleshooting
-
-Tipps for troubleshooting can be found under the corresponding entries, but the ones that use
-multiple programs to fix are listed here.
-
-### Restart WPA Supplicant and Reenable the Wi-Fi device
-
-A simple fix for many problems is a restart of [WPA Supplicant](/wiki/linux/wpa_supplicant.md)
-aswell as reenabling the Wi-Fi device using [NetworkManager](/wiki/linux/networkmanager.md).
-This can be done by first restarting WPA Supplicant as explained in the
-[corresponding section](/wiki/linux/wpa_supplicant.md#restarting-wpa-supplicant) and then
-reenabling the Wi-Fi device as explained in the
-[section of NetworkManagers entry](/wiki/linux/networkmanager.md#restarting-and-reenabling-wi-fi).

wiki/linux/wpa_supplicant.md

@@ -3,7 +3,7 @@
 `wpa_supplicant` is a free implementation of an IEEE 802.11i supplicant.
 It is especially interesting due to its WPA2 and WPA3 capabilities in contrast
 to other networking software.
-It is used to set up [Wi-Fi](/wiki/linux/wi-fi.md).
+It is used to set up [Wi-Fi](/wiki/linux/hardware_%28linux%29.md#wi-fi).
 
 ## Usage
 
@@ -32,3 +32,7 @@ Most of the problems regarding WPA Supplicant can be fixed by restarting the
 ```sh
 systemctl restart wpa_supplicant
 ```
+
+Afterwards - if the error still persists - it may be useful to reenable the Wi-Fi device as
+explained in the 
+[section of the NetworkManager entry](/wiki/linux/networkmanager.md#restarting-and-reenabling-wi-fi).

wiki/speech_recognition_and_synthesis.md

@@ -4,14 +4,42 @@ Speech recognition describes the process of understanding and interpreting spoke
 The most common form of this is speech-to-text (STT) programs, that convert spoken language into
 text.
 On the other hand speech synthesis describes the artificial production of human speech.
-A Text-to-speech (TTS) program is one, that converts an input text to speech. 
+A Text-to-speech (TTS) program is one, that converts an input text to speech.
 
 ## Speech-to-Text Programs
 
 The following is a list of STT programs.
 
-- [Nerd Dictation](https://github.com/ideasman42/nerd-dictation/) is an offline speech recognition
+- [Nerd Dictation](/wiki/linux/nerd-dictation.md) is a real-time offline speech recognition
-    software for [Linux](/wiki/linux.md)-based operating systems.
+    software for [Linux](/wiki/linux.md)-based operating systems which uses the
+    [VOSK API](#vosk-api).
+- [Whisper CLI](/wiki/linux/whisper-cli.md) is a non-real-time offline speech transcription
+    software for [Linux](/wiki/linux.md)-based operating systems which uses the
+    [Whisper API](#whisper-api).
 
 Some alternatives mostly for Linux systems were listed in a
 [Reddit post by tuananh_org](https://www.reddit.com/r/archlinux/comments/1j77921/speech_to_text_app/).
+
+## Model APIs
+
+There are various APIs that are used to do speech recognition.
+
+### VOSK API
+
+The VOSK API mostly does not include punctuation and is not case-sensitive.
+However, it is generally real-time capable.
+A good source for VOSK models is [alphacephei](https://alphacephei.com/vosk/models).
+
+For the german language the 900k model from the Tuda-DE project is recommended.
+It is also available from the [corresponding GitHub page](https://github.com/uhh-lt/kaldi-tuda-de).
+This model is mostly not capable of transcribing English words.
+
+### Whisper API
+
+The Whisper API mostly includes punctuation and is case-sensitive.
+However, it is generally not real-time capable.
+Many models are available on [Hugging Face](https://huggingface.co/).
+
+A good model for the German language is the
+[GGML Q5_0 quantization of primelines whisper-large-v3-turbo-german](https://huggingface.co/F1sk/whisper-large-v3-turbo-german-ggml-q5_0).
+This model is also capable of transcribing some English words.

wiki/wi-fi.md

@@ -0,0 +1,9 @@
+# Wi-Fi (General)
+
+Wi-Fi is a wireless networking technology used for wireless local area networks also called WLAN.
+It allows devices to communicate over radio frequencies without physical cables.
+It needs a module or adapter and therefore relies on dedicated
+[hardware](/wiki/hardware_%28general%29.md).
+
+Informations on Wi-Fi usage on [Linux](/wiki/linux.md)-based operating systems are described in
+the [Wi-Fi section of the Linux hardware entry](/wiki/linux/hardware_%28linux%29.md#wi-fi).