Skip to content

Commit

Permalink
update of documentation and version 0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
martynvdijke committed Feb 8, 2021
1 parent f0e7847 commit 32c8495
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 10 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Changelog

## v0.2
- Made seperate git modules for test-case-generator and profiler
- Large improbments and updates of profiler
- Revamped system to use gnuradio stream tagging function in order to close simulation mode
- Added new data_source_sim block for simulation mode
- Made Tx and Rx block that house all individual components of the receiving and transmitting side.
- Added new assertions in grc
## v0.1

#### Enhancements:
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ endif(CMAKE_BUILD_TYPE STREQUAL "Debug")
list(INSERT CMAKE_MODULE_PATH 0 ${CMAKE_SOURCE_DIR}/cmake/Modules)

# Set the version information here
set(VERSION_MAJOR 1)
set(VERSION_MAJOR 2)
set(VERSION_API 0)
set(VERSION_ABI 0)
set(VERSION_PATCH git)
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@
## Summary

This is the fully-functional GNU Radio software-defined radio (SDR) implementation of a LoRa transceiver with all the necessary receiver components to operate correctly even at very low SNRs. This work has been originally conducted at the Telecommunication Circuits Laboratory, EPFL and later the code has been extended at the Technical University of Eindhoven.
The extension of this project is to implement a simulated multi-stream gateway, this is currently implemented in an experimental version.
More information on this extended work is available in the [paper](main.pdf) in this repo.


In the GNU Radio implementation of the LoRa Tx and Rx chains the user can choose all the parameters of the transmission, such as the spreading factor, the coding rate, the bandwidth, the presence of a header and a CRC, the message to be transmitted, etc.

Expand Down Expand Up @@ -59,7 +62,7 @@ Which can be found at [arxiv.org/abs/2002.08208](https://arxiv.org/abs/2002.0820
Both are WIP

### Installation

There is an Arch Linux package called **_gr-lora_sdr-git_** simply it using your favourite aur helper.
Similarly to any GNU Radio OOT module, it can be build using Cmake and make.

1. Clone the repo
Expand All @@ -85,14 +88,12 @@ Similarly to any GNU Radio OOT module, it can be build using Cmake and make.
You will need root or sudo access in order to properly install the repo, since it will add module blocks to be used in gnuradio-companian and makes a local python package. Be sure to have the following requirements installed:

### Requirements

- Gnuradio 3.8
- python >2.7
- cmake >3.8
- swig >4.0
- libvolk
- UHD
- cppunit
- doxygen (optional for documentation)
- log4cpp (optional for logging/debugging)
## Changelog
Expand All @@ -101,4 +102,4 @@ For changelog checkout [Changelog](CHANGELOG.md)
For TODO list checkout [TODO](TODO.md)
## License

Distributed under the GPL-3.0 License License. See `LICENSE` for more information.
Distributed under the GPL-3.0 License License. See [LICENSE](LICENSE) for more information.
5 changes: 0 additions & 5 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
### Todo

- [ ] Fix that for sf=11,sf=12 reduce rate mode is used.
- [ ] Fix and imporve script for test-case-generator

### In Progress


Binary file added main.pdf
Binary file not shown.

0 comments on commit 32c8495

Please sign in to comment.