From 720f55287c5fe5cd3d7d6541f13382f3500f7f85 Mon Sep 17 00:00:00 2001
From: Tom Rondeau <tom@trondeau.com>
Date: Wed, 23 Apr 2014 18:34:11 -0400
Subject: docs: more documentation.

Stealing some of Martin Braun's PMT tutorial work for the pmt page. Added more info on constellations.
---
 gr-digital/doc/digital.dox | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'gr-digital/doc/digital.dox')

diff --git a/gr-digital/doc/digital.dox b/gr-digital/doc/digital.dox
index 48feda3485..5f2b3bb2fb 100644
--- a/gr-digital/doc/digital.dox
+++ b/gr-digital/doc/digital.dox
@@ -348,6 +348,28 @@ single bit of data. A block like 'pack_k_bits' can be used following
 this to convert the data back into bytes.
 
 
+\section digital_constellation_modulator Constellation Modulator
+
+The Constellation Modulator, Constellation Receiver, and Constellation
+Decoder can all take Constellation Objects to define what they are
+meant to transmit and receive.
+
+The gr::digital::constellation_modulator block takes as a parameter
+the reference to the constellation object. The block is very generic
+in that the mapping from bits to symbols is done based on the
+constellation object passed to it. The modulator block requires packed
+bits as the input stream (that is, all 8 bits of the stream contain
+information).
+
+The other parameters of this block include a setting as to whether or
+not to differentially encode the symbols, the number of samples per
+symbols, and the excess bandwidth of the transmitted pulse-shaped
+signal.
+
+We can set up the transmitter using the constellation modulator block
+and use the same constellation object at the receiver so we know the
+same constellation settings are being used.
+
 \section digital_softbits Support for Soft Decisions
 
 To support soft decisions of the receivers instead of the current hard
-- 
cgit v1.2.3