Skip to content

Commit

Permalink
updated documentation to reflect latest changes
Browse files Browse the repository at this point in the history
  • Loading branch information
swarnavaghosh04 committed Dec 15, 2023
1 parent e50e54b commit 9fc5da4
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 10 deletions.
12 changes: 8 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,18 @@

## Highlights

- Introduced `ESTTC Header Format` block
- Introduced `ESTTC framer` block
- Marked `HERON RX BB` as deprecated
- Introduced new blocks:
- `ESTTC Header Format`
- `ESTTC Framer`
- `ESTTC Deframer`
- `Tagged Stream Fixed Length Padder`
- Marked `HERON RX BB` block as deprecated

## Features

- `ESTTC Header Format` is the first step in a new method of deframing ESTTC frames. The hope is to utilize GNURadio's inbuilt digital modules to do most of the dirty work. This will make the code much more readable and maintainable in addition to being smaller.
- `ESTTC Framer` is what utilizes the `ESTTC Header Format` object to wrap messages (specifically PDU's) in an ESTTC packet.
- `ESTTC Framer` and `ESTTC Deframer` are what utilize the `ESTTC Header Format` object to wrap/unwrap messages (specifically PDU's).
- `Tagged Stream Fixed Length Padder` is a hack to ensure packets are properly streamed out of an SDR.

# v2.0.0

Expand Down
9 changes: 5 additions & 4 deletions MANIFEST.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
title: The UTAT_HERON OOT Module
brief: Short description of gr-UTAT_HERON
brief: Contains blocks necessary for communicating with HERON Mk. II Satellite designed by the University of Toronto Aerospace Team
tags: # Tags are arbitrary, but look at CGRAN what other authors are using
- sdr
- satellite
author:
- Author Name <[email protected]>
- Swarnava Ghosh <[email protected]>
copyright_owner:
- Copyright Owner 1
- University of Toronto Aerospace Team
license:
gr_supported_version: # Put a comma separated list of supported GR versions here
gr_supported_version: 3.10
#repo: # Put the URL of the repository here, or leave blank for default
#website: <module_website> # If you have a separate project website, put it here
#icon: <icon_url> # Put a URL to a square image here that will be used as an icon on CGRAN
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ The [ground-station](https://github.com/HeronMkII/ground-station) repository has

## Installation

First clone (devel branch) and build using cmake
First clone and build using cmake

```
git clone https://github.com/utat-ss/HERON-gr-utat -b devel
git clone https://github.com/utat-ss/HERON-gr-utat
cd HERON-gr-utat
mkdir build
cd build
Expand Down

0 comments on commit 9fc5da4

Please sign in to comment.