summaryrefslogtreecommitdiff
path: root/grc/grc_gnuradio
diff options
context:
space:
mode:
Diffstat (limited to 'grc/grc_gnuradio')
-rw-r--r--grc/grc_gnuradio/blks2/error_rate.py2
-rw-r--r--grc/grc_gnuradio/blks2/packet.py6
-rw-r--r--grc/grc_gnuradio/blks2/selector.py12
-rw-r--r--grc/grc_gnuradio/blks2/tcp.py4
4 files changed, 12 insertions, 12 deletions
diff --git a/grc/grc_gnuradio/blks2/error_rate.py b/grc/grc_gnuradio/blks2/error_rate.py
index 77347ef9e3..9bf387030a 100644
--- a/grc/grc_gnuradio/blks2/error_rate.py
+++ b/grc/grc_gnuradio/blks2/error_rate.py
@@ -63,7 +63,7 @@ class error_rate(gr.hier_block2):
def __init__(self, type='BER', win_size=default_win_size, bits_per_symbol=2):
"""
Error rate constructor.
-
+
Args:
type: a string 'BER' or 'SER'
win_size: the number of samples to calculate over
diff --git a/grc/grc_gnuradio/blks2/packet.py b/grc/grc_gnuradio/blks2/packet.py
index dde3ec722f..25ed3e4dce 100644
--- a/grc/grc_gnuradio/blks2/packet.py
+++ b/grc/grc_gnuradio/blks2/packet.py
@@ -71,7 +71,7 @@ class packet_encoder(gr.hier_block2):
def __init__(self, samples_per_symbol, bits_per_symbol, preamble='', access_code='', pad_for_usrp=True):
"""
packet_mod constructor.
-
+
Args:
samples_per_symbol: number of samples per symbol
bits_per_symbol: number of bits per symbol
@@ -110,7 +110,7 @@ class packet_encoder(gr.hier_block2):
def send_pkt(self, payload):
"""
Wrap the payload in a packet and push onto the message queue.
-
+
Args:
payload: string, data to send
"""
@@ -153,7 +153,7 @@ class packet_decoder(gr.hier_block2):
def __init__(self, access_code='', threshold=-1, callback=None):
"""
packet_demod constructor.
-
+
Args:
access_code: AKA sync vector
threshold: detect access_code with up to threshold bits wrong (0 -> use default)
diff --git a/grc/grc_gnuradio/blks2/selector.py b/grc/grc_gnuradio/blks2/selector.py
index 7ae664823b..24e3844658 100644
--- a/grc/grc_gnuradio/blks2/selector.py
+++ b/grc/grc_gnuradio/blks2/selector.py
@@ -27,7 +27,7 @@ class selector(gr.hier_block2):
def __init__(self, item_size, num_inputs, num_outputs, input_index, output_index):
"""
Selector constructor.
-
+
Args:
item_size: the size of the gr data stream in bytes
num_inputs: the number of inputs (integer)
@@ -58,7 +58,7 @@ class selector(gr.hier_block2):
def _indexes_valid(self):
"""
Are the input and output indexes within range of the number of inputs and outputs?
-
+
Returns:
true if input index and output index are in range
"""
@@ -90,7 +90,7 @@ class selector(gr.hier_block2):
def set_input_index(self, input_index):
"""
Change the block to the new input index if the index changed.
-
+
Args:
input_index: the new input index
"""
@@ -104,7 +104,7 @@ class selector(gr.hier_block2):
def set_output_index(self, output_index):
"""
Change the block to the new output index if the index changed.
-
+
Args:
output_index: the new output index
"""
@@ -121,7 +121,7 @@ class valve(selector):
def __init__(self, item_size, open):
"""
Constructor for valve.
-
+
Args:
item_size: the size of the gr data stream in bytes
open: true if initial valve state is open
@@ -133,7 +133,7 @@ class valve(selector):
def set_open(self, open):
"""
Callback to set open state.
-
+
Args:
open: true to set valve state to open
"""
diff --git a/grc/grc_gnuradio/blks2/tcp.py b/grc/grc_gnuradio/blks2/tcp.py
index 8613c02a17..aee90fad2c 100644
--- a/grc/grc_gnuradio/blks2/tcp.py
+++ b/grc/grc_gnuradio/blks2/tcp.py
@@ -28,12 +28,12 @@ def _get_sock_fd(addr, port, server):
Get the file descriptor for the socket.
As a client, block on connect, dup the socket descriptor.
As a server, block on accept, dup the client descriptor.
-
+
Args:
addr: the ip address string
port: the tcp port number
server: true for server mode, false for client mode
-
+
Returns:
the file descriptor number
"""