wouter/Artemis
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs updated and corrected a type in the space weather window

Browse Source
This commit is contained in:
Marco Dalla Tiezza
2024-05-30 18:25:18 +02:00
parent 2a70e42a59
commit e2a48e7a54
22 changed files with 414 additions and 185 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/database/db_acf.md Normal file
View File

@@ -0,0 +1,25 @@
# ACF
The table contains 4 columns explained below.
!!! example
A technical explanation on how autocorrelation function works along with a practical example is reported [HERE](../acf_analysis.md)
## ACF_ID
`INTEGER` :material-key-outline:{ title="Primary key" } :material-upload-outline:{ title="Auto-increment" }
This is a unique identification number for each entry that is assigned during the creation of a new ACF. It is auto-incrementing and is not replaced in the event of deletion.
## SIG_ID
`INTEGER` :material-axis-arrow:{ title="Foreign key" }
This is a direct reference to the specific signal associated with the ACF. It links to the primary key of the [Signals](db_signals.md) table that holds detailed information about the signals.
## VALUE
`FLOAT`
The autocorrelation time expressed in ms.
## DESCRIPTION
`TEXT`
The short description is used to explain the details about the autocorrelation value, e.g. `Frame`, `Superframe`, etc.

22
docs/database/db_bandwidth.md Normal file
View File

@@ -0,0 +1,22 @@
# Bandwidth
The table contains 4 columns explained below.
## BAND_ID
`INTEGER` :material-key-outline:{ title="Primary key" } :material-upload-outline:{ title="Auto-increment" }
This is a unique identification number for each entry that is assigned during the creation of a new bandwidth. It is auto-incrementing and is not replaced in the event of deletion.
## SIG_ID
`INTEGER` :material-axis-arrow:{ title="Foreign key" }
This is a direct reference to the specific signal associated with the bandwidth. It links to the primary key of the [Signals](db_signals.md) table that holds detailed information about the signals.
## VALUE
`INTEGER`
The bandwidth in Hz expressed as an integer.
## DESCRIPTION
`TEXT`
The short description is used to explain the purpose of the bandwidth and any other useful details.

12
docs/database/db_cat_label.md Normal file
View File

@@ -0,0 +1,12 @@
# Category Label
This table contains only the name of the category/tag. The table contains 2 columns explained below.
## CLB_ID
`INTEGER` :material-key-outline:{ title="Primary key" } :material-upload-outline:{ title="Auto-increment" }
This is a unique identification number for each entry that is assigned during the creation of a new category tag. It is auto-incrementing and is not replaced in the event of deletion.
## VALUE
`TEXT`
The name of the category/tag expressed as a string.

17
docs/database/db_category.md Normal file
View File

@@ -0,0 +1,17 @@
# Category
The primary function of this table is to facilitate the classification of the signal by assigning it to its appropriate family or category. Can be used with any tag. The table contains 3 columns explained below.
## CAT_ID
`INTEGER` :material-key-outline:{ title="Primary key" } :material-upload-outline:{ title="Auto-increment" }
This is a unique identification number for each entry that is assigned during the creation of a new category/tag. It is auto-incrementing and is not replaced in the event of deletion.
## SIG_ID
`INTEGER` :material-axis-arrow:{ title="Foreign key" }
This is a direct reference to the specific signal associated with the category. It links to the primary key of the [Signals](db_signals.md) table that holds detailed information about the signals.
## CLB_ID
`INTEGER` :material-axis-arrow:{ title="Foreign key" }
This is a direct reference to the specific **category label** associated with the category. It links to the primary key of the [Category Label](db_cat_label.md) table that holds the name of the category.

22
docs/database/db_frequency.md Normal file
View File

@@ -0,0 +1,22 @@
# Frequency
The table contains 4 columns explained below.
## FREQ_ID
`INTEGER` :material-key-outline:{ title="Primary key" } :material-upload-outline:{ title="Auto-increment" }
This is a unique identification number for each entry that is assigned during the creation of a new frequency. It is auto-incrementing and is not replaced in the event of deletion.
## SIG_ID
`INTEGER` :material-axis-arrow:{ title="Foreign key" }
This is a direct reference to the specific signal associated with the frequency. It links to the primary key of the [Signals](db_signals.md) table that holds detailed information about the signals.
## VALUE
`INTEGER`
The freqeuncy in Hz expressed as an integer.
## DESCRIPTION
`TEXT`
The short description is used to explain the purpose of the bandwidth and any other useful details.

28
docs/database/db_info.md Normal file
View File

@@ -0,0 +1,28 @@
# Info
This is the database meta table and contains 4 columns explained below.
## NAME
`TEXT`
This is the name of the database.
## DATA
`TEXT`
The creation date when the database has been initialised.
## VERSION
`INTEGER`
A simple integer to denote the database version.
## EDITABLE
`INTEGER`
This field should serve as a writing protection on the database.
* **0**: read-only database
* **1**: database can be edited with no restrictions
!!! example "Experimental"
This feature is experimental and not yet implemented.

22
docs/database/db_location.md Normal file
View File

@@ -0,0 +1,22 @@
# Location
This is the location where the signal is distributed/received. Avoid the usage of the precise location of the TX station or very small town (very rare). It's a good habit to use **nations/continents** or special location (like `Worldwide`). The table contains 4 columns explained below.
## LOC_ID
`INTEGER` :material-key-outline:{ title="Primary key" } :material-upload-outline:{ title="Auto-increment" }
This is a unique identification number for each entry that is assigned during the creation of a new location. It is auto-incrementing and is not replaced in the event of deletion.
## SIG_ID
`INTEGER` :material-axis-arrow:{ title="Foreign key" }
This is a direct reference to the specific signal associated with the location. It links to the primary key of the [Signals](db_signals.md) table that holds detailed information about the signals.
## VALUE
`TEXT`
The location expressed as a string.
## DESCRIPTION
`TEXT`
The short description is used to explain further details about the location.

22
docs/database/db_mode.md Normal file
View File

@@ -0,0 +1,22 @@
# Mode
This field reports the way how a signals has been decoded during the reception. The table contains 4 columns explained below.
## MOD_ID
`INTEGER` :material-key-outline:{ title="Primary key" } :material-upload-outline:{ title="Auto-increment" }
This is a unique identification number for each entry that is assigned during the creation of a new mode. It is auto-incrementing and is not replaced in the event of deletion.
## SIG_ID
`INTEGER` :material-axis-arrow:{ title="Foreign key" }
This is a direct reference to the specific signal associated with the modulation. It links to the primary key of the [Signals](db_signals.md) table that holds detailed information about the signals.
## VALUE
`TEXT`
The mode expressed as a string.
## DESCRIPTION
`TEXT`
The short description is used to explain the purpose of the mode and any other useful details.

22
docs/database/db_modulation.md Normal file
View File

@@ -0,0 +1,22 @@
# Modulation
Modulation refers to the method by which information is encoded into the main signal (carrier). This process involves altering various properties of the carrier signal, such as amplitude, frequency, or phase. Multiple modulation techniques can be employed, and a TX station has the capability to utilize different modulation schemes. The table contains 4 columns explained below.
## MDL_ID
`INTEGER` :material-key-outline:{ title="Primary key" } :material-upload-outline:{ title="Auto-increment" }
This is a unique identification number for each entry that is assigned during the creation of a new modulation. It is auto-incrementing and is not replaced in the event of deletion.
## SIG_ID
`INTEGER` :material-axis-arrow:{ title="Foreign key" }
This is a direct reference to the specific signal associated with the modulation. It links to the primary key of the [Signals](db_signals.md) table that holds detailed information about the signals.
## VALUE
`TEXT`
The modulation expressed as a string.
## DESCRIPTION
`TEXT`
The short description is used to explain the purpose of the modulation and any other useful details.

8
docs/database/db_overview.md Normal file
View File

@@ -0,0 +1,8 @@
# Database
With the release of Artemis 4, we have made a significant upgrade in our data management system by transitioning from a CSV file to a full relational SQL database. This change brings a multitude of advantages that enhance the efficiency, scalability, and reliability of our system. In the following sections, we will explore, table by table, the structure of the new database.
![Screenshot](../assets/sql_schema.webp)

28
docs/database/db_signals.md Normal file
View File

@@ -0,0 +1,28 @@
# Signals
This is the main table and contains 4 columns explained below.
## SIG_ID
`INTEGER` :material-key-outline:{ title="Primary key" } :material-upload-outline:{ title="Auto-increment" }
This is a unique identification number for each entry that is assigned during the creation of a signal. It is auto-incrementing and is not replaced in the event of signal deletion.
## NAME
`TEXT`
The name of the signal. A simple string that describes in short the analyzed signal. Special characters are allowed.
## DESCRIPTION
`TEXT`
The short description is used to explain the purpose of the signal and some other useful details.
!!! tip
The DESCRIPTION field supports **Markdown**, a simple markup language for creating rich text using plain text. Headers, emphasis, lists, links, code blocks and many more features for advanced text formtting. [Markdown Basic Syntax :simple-markdown:](https://www.markdownguide.org/basic-syntax/)
## URL
`TEXT`
The sigidwiki (SigID) URL of the selected signal. This is a direct connection to the online database where further details of the signal are collected.
!!! info
**Internal Use Only** This field is for the SigID database and not intended for user viewing or editing. Personal URLs can be stored in the signal description.

54
docs/database/sigid.md Normal file
View File

@@ -0,0 +1,54 @@
# SigID Wiki Database
<div align="center" markdown>
![GitHub Release](https://img.shields.io/github/v/release/AresValley/Artemis-DB?label=Latest%20release)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/AresValley/Artemis-DB/total?label=DB%20requests)
![GitHub Release Date](https://img.shields.io/github/release-date/AresValley/Artemis-DB)
</div>
Artemis serves as a valuable resource for both personal signal collection and leveraging a vast repository of pre-identified signals. This software application allows users to curate their own collections, but its true strength lies in its integration with a comprehensive database of known signals. This database is directly sourced from the [Signal Identification Wiki](https://www.sigidwiki.com/wiki/Signal_Identification_Guide), an open-source resource collaboratively maintained by a global community of radio enthusiasts.
!!! tip "Database Revision"
For quality control purposes, the database undergoes a rigorous review process before integration into Artemis. This review adheres to established [guidelines](https://github.com/AresValley/Artemis-DB), ensuring the accuracy and completeness of the information presented to users. The specifics of this review process are outlined in the following section.
## Modulation
A good practise (reported also on ) is to write the primary type of modulation (if known) and not all the possible variants. A practical example is reported on [Signal Identification Wiki](https://www.sigidwiki.com/wiki/Signal_Identification_Guide): there is no need to write **8-PSK** or **QPSK**, **PSK** is enough. The Artemis SigID database is provided without any modulation variants included. The recognized modulations are listed below:
### Analog
* **AM:** Amplitude Modulation
* **FM:** Frequency Modulation
* **PM:** Phase Modulation
* **LSB:** Lower Sideband
* **USB:** Upper Sideband
* **VSB:** Vestigial Sideband
* **CW:** Continuous Wave
### Digital
* **QAM:** Quadrature Amplitude Modulation
* **PSK:** Phase-Shift Keying
* **FSK:** Frequency-Shift Keying
* **ASK:** Amplitude-Shift Keying
* **MSK:** Minimum-Shift Keying
* **IFK:** Incremental Frequency Keying
* **OOK:** On-Off Keying
* **FDM:** Frequency-Division Multiplexing
* **BOC:** Binary Offset Carrier Modulation
* **CDMA:** Code Division Multiple Access
* **TDMA:** Time Division Multiple Access
* **FBMC:** Filter Bank Multi Carrier
* **UFMC:** Universal Filtered Multi Carrier
* **PCM:** Pulse Code Modulation
* **PPM:** Pulse Position Modulation
* **FMCW:** Frequency-Modulated Continuous Wave
* **Pulse:** Pulse
### Spread Spectrum
* **CSS:** Chirp Spread Spectrum
* **DSSS:** Direct Sequence Spread Spectrum
* **FHSS:** Frequency Hopping Spread Spectrum
* **THSS:** Time Hopping Spread Spectrum
## Locations
Locations are either countries or special token (`Worldwide`, `Europe`, etc.) . Precise location of the TX station, towns and cities are converted to their respective countries.