mirror of
https://github.com/gnss-sdr/gnss-sdr
synced 2025-01-27 09:24:52 +00:00
Add pointers to the documentation pages
This commit is contained in:
Carles Fernandez
parent
b5ac8fa837
commit
565d6adf24
49
README.md
49
README.md
@ -11,7 +11,7 @@ If you have questions about GNSS-SDR, please [subscribe to the gnss-sdr-develope
|
||||
# How to build GNSS-SDR
|
||||
|
||||
|
||||
This section describes how to set up the compilation environment in GNU/Linux or [macOS / Mac OS X](#macosx), and to build GNSS-SDR. See also [our Building Guide](http://gnss-sdr.org/build-and-install/ "GNSS-SDR's Build and Install").
|
||||
This section describes how to set up the compilation environment in GNU/Linux or [macOS / Mac OS X](#macosx), and to build GNSS-SDR. See also our [build and install page](http://gnss-sdr.org/build-and-install/ "GNSS-SDR's Build and Install").
|
||||
|
||||
|
||||
GNU/Linux
|
||||
@ -314,7 +314,7 @@ $ sudo make install
|
||||
$ sudo ldconfig
|
||||
~~~~~~
|
||||
|
||||
Then configure GNSS-SDR to build the GN3S_Signal_Source by:
|
||||
Then configure GNSS-SDR to build the `GN3S_Signal_Source` by:
|
||||
|
||||
~~~~~~
|
||||
$ cd gnss-sdr/build
|
||||
@ -326,7 +326,7 @@ $ sudo make install
|
||||
In order to gain access to USB ports, gnss-sdr should be used as root. In addition, the driver requires access to the GN3S firmware binary file. It should be available in the same path where the application is called.
|
||||
GNSS-SDR comes with a pre-compiled custom GN3S firmware available at gr-gn3s/firmware/GN3S_v2/bin/gn3s_firmware.ihx. Please copy this file to the application path.
|
||||
|
||||
(in order to disable the GN3S_Signal_Source compilation, you can pass -DENABLE_GN3S=OFF to cmake and build GNSS-SDR again).
|
||||
(in order to disable the `GN3S_Signal_Source` compilation, you can pass `-DENABLE_GN3S=OFF` to cmake and build GNSS-SDR again).
|
||||
|
||||
More info at https://github.com/gnss-sdr/gr-gn3s
|
||||
|
||||
@ -357,7 +357,7 @@ $ sudo ldconfig
|
||||
~~~~~~
|
||||
|
||||
|
||||
Then, configure GNSS-SDR to build the Osmosdr_Signal_Source by:
|
||||
Then, configure GNSS-SDR to build the `Osmosdr_Signal_Source` by:
|
||||
|
||||
~~~~~~
|
||||
$ cmake -DENABLE_OSMOSDR=ON ../
|
||||
@ -365,7 +365,7 @@ $ make
|
||||
$ sudo make install
|
||||
~~~~~~
|
||||
|
||||
(in order to disable the Osmosdr_Signal_Source compilation, you can pass -DENABLE_OSMOSDR=OFF to cmake and build GNSS-SDR again).
|
||||
(in order to disable the `Osmosdr_Signal_Source` compilation, you can pass `DENABLE_OSMOSDR=OFF` to cmake and build GNSS-SDR again).
|
||||
|
||||
|
||||
|
||||
@ -503,7 +503,7 @@ GNSS-SDR comes with a library which is a module of the Vector-Optimized Library
|
||||
|
||||
###### Other package managers
|
||||
|
||||
GNU Radio and other dependencies can also be installed using other package managers than Macports, such as [Fink](http://www.finkproject.org/ "Fink") or [Homebrew](http://brew.sh/ "Homebrew"). Since the version of Python that ships with OS X is great for learning but it is not good for development, you could have another Python executable in a non-standard location. If that is the case, you need to inform GNSS-SDR's configuration system by defining the PYTHON_EXECUTABLE variable as:
|
||||
GNU Radio and other dependencies can also be installed using other package managers than Macports, such as [Fink](http://www.finkproject.org/ "Fink") or [Homebrew](http://brew.sh/ "Homebrew"). Since the version of Python that ships with OS X is great for learning but it is not good for development, you could have another Python executable in a non-standard location. If that is the case, you need to inform GNSS-SDR's configuration system by defining the `PYTHON_EXECUTABLE` variable as:
|
||||
|
||||
~~~~~~
|
||||
cmake -DPYTHON_EXECUTABLE=/path/to/bin/python ../
|
||||
@ -538,7 +538,7 @@ $ git checkout master # Switch to branch you want to update
|
||||
$ git pull origin master # Download the newest code from our repository
|
||||
~~~~~~
|
||||
|
||||
or, if you want to test the lastest developments:
|
||||
or, if you want to test the latest developments:
|
||||
|
||||
~~~~~~
|
||||
$ git checkout next
|
||||
@ -584,7 +584,7 @@ We use a [DBSRX2](https://www.ettus.com/product/details/DBSRX2) to do the task,
|
||||
```$ gnss-sdr --config_file=/path/to/my_receiver.conf```
|
||||
The program reports the current status in text mode, directly to the terminal window. If all goes well, and GNSS-SDR is able to successfully track and decode at least 4 satellites, you will get PVT fixes. The program will write .kml, .geojson and RINEX files in the folder from which ```gnss-sdr``` was run. In addition to the console output, GNSS-SDR also writes log files at /tmp/ (configurable with the commandline flag ```./gnss-sdr --log_dir=/path/to/log```).
|
||||
|
||||
|
||||
For more information, check out our [quick start guide](http://gnss-sdr.org/quick-start-guide/).
|
||||
|
||||
|
||||
Using GNSS-SDR
|
||||
@ -596,8 +596,6 @@ With GNSS-SDR, you can define you own receiver, work with captured raw data or f
|
||||
$ gnss-sdr --config_file=/path/to/my_receiver.conf
|
||||
~~~~~~
|
||||
|
||||
You can see a guide of available implementations at ```gnss-sdr/conf/master.conf```. That folder contains other working examples as well. If you have a working configuration and want to share it will others, please tell us and we will be happy to upload it to the server.
|
||||
|
||||
You can use a single configuration file for processing different data files, specifying the file to be processed with the ```--signal_source``` flag:
|
||||
|
||||
~~~~~~
|
||||
@ -646,7 +644,7 @@ Since the configuration is just a set of property names and values without any m
|
||||
|
||||
Hence, the application defines a simple accessor class to fetch the configuration pairs of values and passes them to a factory class called [GNSSBlockFactory](./src/core/receiver/gnss_block_factory.h). This factory decides, according to the configuration, which class needs to be instantiated and which parameters should be passed to the constructor. Hence, the factory encapsulates the complexity of blocks' instantiation. With that approach, adding a new block that requires new parameters will be as simple as adding the block class and modifying the factory to be able to instantiate it. This loose coupling between the blocks' implementations and the syntax of the configuration enables extending the application capacities in a high degree. It also allows to produce fully customized receivers, for instance a testbed for acquisition algorithms, and to place observers at any point of the receiver chain.
|
||||
|
||||
|
||||
More information can be found at the [Control Plane page](http://gnss-sdr.org/docs/control-plane/).
|
||||
|
||||
|
||||
Signal Processing plane
|
||||
@ -674,7 +672,7 @@ Internally, GNSS-SDR makes use of the complex data types defined by [VOLK](http:
|
||||
- **`gr_complex`**: Complex samples, with real and imaginary parts of type `float`. C++ type name: `std::complex<float>`.
|
||||
|
||||
|
||||
|
||||
More information about the available processing blocks and their configuration parameters can be found at the [Signal Processing Blocks documentation page](http://gnss-sdr.org/docs/sp-blocks/).
|
||||
|
||||
### Signal Source
|
||||
|
||||
@ -855,7 +853,7 @@ SignalSource.dump1=false
|
||||
~~~~~~
|
||||
|
||||
|
||||
Other examples are available at [gnss-sdr/conf/](./conf/).
|
||||
More documentation and examples are available at the [Signal Source Blocks page](http://gnss-sdr.org/docs/sp-blocks/signal-source/).
|
||||
|
||||
### Signal Conditioner
|
||||
|
||||
@ -876,6 +874,7 @@ If you need to adapt some aspect of you signal, you can enable the Signal Condit
|
||||
SignalConditioner.implementation=Signal_Conditioner
|
||||
~~~~~~
|
||||
|
||||
More documentation at the [Signal Conditioner Blokcs page](http://gnss-sdr.org/docs/sp-blocks/signal-conditioner/).
|
||||
|
||||
#### Data type adapter
|
||||
|
||||
@ -887,11 +886,11 @@ This block changes the type of input data samples. If your signal source deliver
|
||||
DataTypeAdapter.implementation=Ishort_To_Complex
|
||||
~~~~~~
|
||||
|
||||
|
||||
More documentation at the [Data Type Adapter Blocks page](http://gnss-sdr.org/docs/sp-blocks/data-type-adapter/).
|
||||
|
||||
#### Input filter
|
||||
|
||||
This blocks filters the input data. It can be combined with frequency translation for IF signals. The computation of the filter taps is based on parameters of GNU Radio's function [pm_remez](http://gnuradio.org/doc/doxygen/pm__remez_8h.html), that calculates the optimal (in the Chebyshev/minimax sense) FIR filter impulse response given a set of band edges, the desired reponse on those bands, and the weight given to the error in those bands.
|
||||
This block filters the input data. It can be combined with frequency translation for IF signals. The computation of the filter taps is based on parameters of GNU Radio's function [pm_remez](http://gnuradio.org/doc/doxygen/pm__remez_8h.html), that calculates the optimal (in the Chebyshev/minimax sense) FIR filter impulse response given a set of band edges, the desired reponse on those bands, and the weight given to the error in those bands.
|
||||
|
||||
The block can be configured like this:
|
||||
|
||||
@ -942,7 +941,7 @@ InputFilter.IF=0
|
||||
InputFilter.decimation_factor=1
|
||||
~~~~~~
|
||||
|
||||
|
||||
More documentation at the [Input Filter Blocks page](http://gnss-sdr.org/docs/sp-blocks/input-filter/).
|
||||
|
||||
#### Resampler
|
||||
|
||||
@ -960,7 +959,7 @@ Resampler.sample_freq_in=8000000 ; sample frequency of the input signal
|
||||
Resampler.sample_freq_out=4000000 ; desired sample frequency of the output signal
|
||||
~~~~~~
|
||||
|
||||
|
||||
More documentation at the [Resampler Blocks page](http://gnss-sdr.org/docs/sp-blocks/resampler/).
|
||||
|
||||
### Channel
|
||||
|
||||
@ -1006,6 +1005,9 @@ This module is also in charge of managing the interplay between acquisition and
|
||||
|
||||
The abstract class [ChannelInterface](./src/core/interfaces/channel_interface.h) represents an interface to a channel GNSS block. Check [Channel](./src/algorithms/channel/adapters/channel.h) for an actual implementation.
|
||||
|
||||
More documentation at the [Channels page](http://gnss-sdr.org/docs/sp-blocks/channels/).
|
||||
|
||||
|
||||
|
||||
#### Acquisition
|
||||
|
||||
@ -1054,6 +1056,7 @@ Acquisition_1B.dump=false
|
||||
Acquisition_1B.dump_filename=./acq_dump.dat
|
||||
~~~~~~
|
||||
|
||||
More documentation at the [Acquisition Blocks page](http://gnss-sdr.org/docs/sp-blocks/acquisition/).
|
||||
|
||||
|
||||
#### Tracking
|
||||
@ -1103,6 +1106,9 @@ Tracking_1B.dump=false
|
||||
Tracking_1B.dump_filename=../data/veml_tracking_ch_
|
||||
~~~~~~
|
||||
|
||||
More documentation at the [Tracking Blocks page](http://gnss-sdr.org/docs/sp-blocks/tracking/).
|
||||
|
||||
|
||||
#### Decoding of the navigation message
|
||||
|
||||
Most of GNSS signal links are modulated by a navigation message containing the time the message was transmitted, orbital parameters of satellites (also known as ephemeris) and an almanac (information about the general system health, rough orbits of all satellites in the network as well as data related to error correction). Navigation data bits are structured in words, pages, subframes, frames and superframes. Sometimes, bits corresponding to a single parameter are spread over different words, and values extracted from different frames are required for proper decoding. Some words are for synchronization purposes, others for error control an others contain actual information. There are also error control mechanisms, from parity checks to forward error correction (FEC) encoding and interleaving, depending on the system. All this decoding complexity is managed by a finite state machine implemented with the [Boost.Statechart library](http://www.boost.org/libs/statechart/doc/tutorial.html).
|
||||
@ -1130,6 +1136,8 @@ TelemetryDecoder_1B.dump=false
|
||||
TelemetryDecoder_1B.decimation_factor=1;
|
||||
~~~~~~
|
||||
|
||||
More documentation at the [Telemetry Decoder Blocks page](http://gnss-sdr.org/docs/sp-blocks/telemetry-decoder/).
|
||||
|
||||
|
||||
#### Observables
|
||||
|
||||
@ -1164,6 +1172,8 @@ Observables.dump=false
|
||||
Observables.dump_filename=./observables.dat
|
||||
~~~~~~
|
||||
|
||||
More documentation at the [Observables Blocks page](http://gnss-sdr.org/docs/sp-blocks/observables/).
|
||||
|
||||
|
||||
#### Computation of Position, Velocity and Time
|
||||
Although data processing for obtaining high-accuracy PVT solutions is out of the scope of GNSS-SDR, we provide a module that can compute simple least square solutions (stored in GIS-friendly formats such as [GeoJSON](http://geojson.org/geojson-spec.html) and [KML](http://www.opengeospatial.org/standards/kml), or transmitted via serial port as [NMEA 0183](https://en.wikipedia.org/wiki/NMEA_0183) messages), and leaves room for more sophisticated positioning methods by storing observables and navigation data in [RINEX](https://en.wikipedia.org/wiki/RINEX) files (v2.11 or v3.02), and generating [RTCM](http://www.rtcm.org "Radio Technical Commission for Maritime Services") 3.2 messages that can be disseminated through the Internet in real time.
|
||||
@ -1246,6 +1256,8 @@ PVT.rtcm_station_id=1111
|
||||
|
||||
In order to get well-formatted GeoJSON, KML and RINEX files, always terminate ```gnss-sdr``` execution by pressing key ```q``` and then key ```ENTER```. Those files will be automatically deleted if no position fix have been obtained during the execution of the software receiver.
|
||||
|
||||
More documentation at the [PVT Blocks page](http://gnss-sdr.org/docs/sp-blocks/pvt/).
|
||||
|
||||
|
||||
About the software license
|
||||
==========================
|
||||
@ -1367,6 +1379,3 @@ You are also very welcome to contribute to the project, there are many ways to [
|
||||
**Enjoy GNSS-SDR!**
|
||||
|
||||
The Developer Team.
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user