File	Date	Author	Commit
GSCN_recorder	2021-02-14	Ben Wojtowicz	[160723] Initial commit
GSCN_scan	2021-02-14	Ben Wojtowicz	[160723] Initial commit
NRARFCN_recorder	2021-02-14	Ben Wojtowicz	[160723] Initial commit
cmake	2021-02-14	Ben Wojtowicz	[160723] Initial commit
lib5g	2021-02-14	Ben Wojtowicz	[160723] Initial commit
libtools	2021-02-14	Ben Wojtowicz	[160723] Initial commit
AUTHORS	2021-02-14	Ben Wojtowicz	[160723] Initial commit
CMakeLists.txt	2021-02-14	Ben Wojtowicz	[160723] Initial commit
COPYING	2021-02-14	Ben Wojtowicz	[160723] Initial commit
ChangeLog	2021-02-14	Ben Wojtowicz	[160723] Initial commit
README	2021-02-14	Ben Wojtowicz	[160723] Initial commit

Read Me

This directory contains the open5G source code.  Details can be found at
sourceforge.net/projects/open5g/.

The directory structure for the project is:
lib5g                 C++ library of common/generic 5G classes/functions
libtools              C++ library of tools needed by the rest of the project
cmake                 Files needed for cmake
NRARFCN_recorder      A gnu-radio application for recording NR-ARFCNs
GSCN_recorder         A gnu-radio application for recording GSCNs
GSCN_scan             A gnu-radio application for scanning GSCNs

open5G is dependant on the following:
1) GNU Radio
2) GrOsmoSDR
3) UHD

To build use the following:

  $ mkdir build
  $ cd build
  $ cmake ../
  $ make

To test use the following:

  $ mkdir build
  $ cd build
  $ cmake ../
  $ make
  $ make test

To install use the following:

  $ mkdir build
  $ cd build
  $ cmake ../
  $ make
  $ sudo make install

######################
#  NRARFCN RECORDER  #
######################
To use the installed NR-ARFCN recorder, make sure LD_LIBRARY_PATH is set appropriately (e.g.
export LD_LIBRARY_PATH=/usr/lib/x86_64-linux-gnu/), plug-in your SDR hardware, run
NRARFCN_recorder, and connect (e.g. telnet, nc) to the control port at port number 35000.
Recording parameters can be changed via the control port and a list of parameters is available
by using the "help" command.  Files are recorded at a sample rate of 15.36MHz.

###################
#  GSCN RECORDER  #
###################
To use the installed GSCN recorder, make sure LD_LIBRARY_PATH is set appropriately (e.g.
export LD_LIBRARY_PATH=/usr/lib/x86_64-linux-gnu/), plug-in your SDR hardware, run
GSCN_recorder, and connect (e.g. telnet, nc) to the control port at port number 36000.
Recording parameters can be changed via the control port and a list of parameters is available
by using the "help" command.  Files are recorded at a sample rate of 15.36MHz.

###############
#  GSCN SCAN  #
###############
To use the installed GSCN scanner, make sure LD_LIBRARY_PATH is set appropriately (e.g.
export LD_LIBRARY_PATH=/usr/lib/x86_64-linux-gnu/), plug-in your SDR hardware, run
GSCN_scan, and connect (e.g. telnet, nc) to the control port at port number 37000.
Scan parameters can be changed via the control port and a list of parameters is available
by using the "help" command.