-
Notifications
You must be signed in to change notification settings - Fork 1
/
_readme_8md_source.html
99 lines (97 loc) · 11.1 KB
/
_readme_8md_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>free5GRAN: Readme.md Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">free5GRAN
 <span id="projectnumber">V1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('_readme_8md.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Readme.md</div> </div>
</div><!--header-->
<div class="contents">
<a href="_readme_8md.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> # free5GRAN</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> free5GRAN is an open-source 5G RAN stack. The current version includes a receiver which decodes MIB & SIB1 data. It also acts as a cell scanner. free5GRAN works in SA mode.</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> free5GRAN includes a library which can be reused for further developments. Documentation is available HERE.</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> ## Installation & Running</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> ### Requirements</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> Before compiling, make sure that the following libraries are installed:</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> * cmake</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> * libfftw3</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> * libconfig++</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> * boost</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> On ubuntu, those libraries can be installed via:</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> ```</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> sudo apt-get install cmake libfftw3-dev libconfig++-dev libboost-program-options-dev libboost-log-dev</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> ```</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> ### Radio frontend</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> We currently support USRP B210. `libuhd` and `libuhd-dev` are required. They can be installed on Ubuntu via:</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> ```</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> sudo apt-get install libuhd libuhd-dev</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> ```</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> ### Compiling</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> free5GRAN executable can be compiled from sources with the following commands:</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> ```</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> git clone https://github.com/free5G/free5GRAN.git</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> cd free5GRAN</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> mkdir files</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> mkdir build</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> cd build</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> mkdir output_files</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> cmake ..</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> make</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> ```</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> ### Configuration and running</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> Two functions are supported by free5GRAN.</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> #### Cell search</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> Searching a cell with pre-defined parameters. Example config file is provided (`free5GRAN/config/search_cell.cfg`).</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> #### Band scanning</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> Scanning one or more 5G NR bands. Example config file is provided (`free5GRAN/config/scan_band.cfg`).</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> ### USRP configuration</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> Before running free5GRAN, USRP B210 device has to be configured:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> * Run `uhd_find_devices`</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> * Find the device you want to use</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> * Copy the `serial` field of the device and paste it in the config file.</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> To run free5GRAN: `sudo ./free5GRAN ../config/CONFIG_FILE`</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> ### Debugging</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> free5GRAN writes logs in `build/free5GRAN.log`. It can be used for debugging. Foremost, free5RGAN writes some data files in `free5gran/build/output_files` directory. For plotting those files, run `python analyse.py` in project `free5gran/` directory. This python script generates files that are stored in `free5gran/files` directory.</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> ## Testing note </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> free5GRAN has been successfully tested on Ubuntu 18.04 with USRP B210. It is currently under active development, which means that it might not be fully stable. </div></div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="_readme_8md.html">Readme.md</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>