doc: regenerate block documentation

Signed-off-by: Markus Klotzbuecher <mk@mkio.de>
kmarkus · Jun 5, 2020 · baf08b9 · baf08b9
1 parent de0193a
commit baf08b9
Show file tree

Hide file tree

Showing 7 changed files with 80 additions and 51 deletions.
diff --git a/docs/user/block_index.rst b/docs/user/block_index.rst
@@ -1,10 +1,11 @@
 Microblx Module Index
 =====================
 
-.. include:: block_random.rst
 .. include:: block_pid.rst
 .. include:: block_luablock.rst
-.. include:: block_ramp_int32.rst
+.. include:: block_ramp_double.rst
+.. include:: block_rand_double.rst
+.. include:: block_math_double.rst
 .. include:: block_cconst.rst
 .. include:: block_iconst.rst
 .. include:: block_ptrig.rst

diff --git a/docs/user/block_math_double.rst b/docs/user/block_math_double.rst
@@ -0,0 +1,36 @@
+Module math_double
+------------------
+
+Block math_double
+^^^^^^^^^^^^^^^^^
+
+| **Type**:       cblock
+| **Attributes**: 
+| **Meta-data**:   { doc='mathmetric function block',   realtime=true,}
+| **License**:    BSD-3-Clause
+
+
+Configs
+"""""""
+
+.. csv-table::
+   :header: "name", "type", "doc"
+
+   func, ``char``, "math function to compute"
+   data_len, ``long``, "length of output data (def: 1)"
+   mul, ``double``, "optional factor to apply to result of func (def: 1)"
+   add, ``double``, "optional offset to apply to result of func (def: 0)"
+
+
+
+Ports
+"""""
+
+.. csv-table::
+   :header: "name", "out type", "out len", "in type", "in len", "doc"
+
+   x, , , ``double``, 1, "math input"
+   y, ``double``, 1, , , "math output"
+
+
+
diff --git a/docs/user/block_ptrig.rst b/docs/user/block_ptrig.rst
@@ -23,6 +23,7 @@ Configs
    affinity, ``int``, "list of CPUs to set the pthread CPU affinity to"
    thread_name, ``char``, "thread name (for dbg), default is block name"
    trig_blocks, ``struct ubx_trig_spec``, "specification of blocks to trigger"
+   autostop_steps, ``int64_t``, "if set and > 0, block stops itself after X steps"
    tstats_mode, ``int``, "enable timing statistics over all blocks"
    tstats_profile_path, ``char``, "directory to write the timing stats file to"
    tstats_output_rate, ``double``, "throttle output on tstats port"

diff --git a/docs/user/block_ramp_int32.rst → docs/user/block_ramp_double.rst b/docs/user/block_ramp_int32.rst → docs/user/block_ramp_double.rst
@@ -1,8 +1,8 @@
-Module ramp_int32
------------------
+Module ramp_double
+------------------
 
-Block ramp_int32
-^^^^^^^^^^^^^^^^
+Block ramp_double
+^^^^^^^^^^^^^^^^^
 
 | **Type**:       cblock
 | **Attributes**: 
@@ -16,8 +16,8 @@ Configs
 .. csv-table::
    :header: "name", "type", "doc"
 
-   start, ``int32_t``, "ramp starting value (def 0)"
-   slope, ``int32_t``, "rate of change (def: 1)"
+   start, ``double``, "ramp starting value (def 0)"
+   slope, ``double``, "rate of change (def: 1)"
    data_len, ``long``, "length of output data (def: 1)"
 
 
@@ -28,7 +28,7 @@ Ports
 .. csv-table::
    :header: "name", "out type", "out len", "in type", "in len", "doc"
 
-   out, ``int32_t``, 1, , , "ramp generator output"
+   out, ``double``, 1, , , "ramp generator output"
 
 
 
diff --git a/docs/user/block_rand_double.rst b/docs/user/block_rand_double.rst
@@ -0,0 +1,32 @@
+Module rand_double
+------------------
+
+Block rand_double
+^^^^^^^^^^^^^^^^^
+
+| **Type**:       cblock
+| **Attributes**: 
+| **Meta-data**:   { doc='double random number generator block',   realtime=true,}
+| **License**:    BSD-3-Clause
+
+
+Configs
+"""""""
+
+.. csv-table::
+   :header: "name", "type", "doc"
+
+   seed, ``long``, "seed to initialize with"
+
+
+
+Ports
+"""""
+
+.. csv-table::
+   :header: "name", "out type", "out len", "in type", "in len", "doc"
+
+   out, ``double``, 1, , , "rand generator output"
+
+
+
diff --git a/docs/user/block_random.rst b/docs/user/block_random.rst
diff --git a/gen_block_userdoc.sh b/gen_block_userdoc.sh
@@ -1,6 +1,6 @@
 #!/usr/bin/bash
 
-BLOCKS="random pid luablock ramp_int32 cconst iconst ptrig trig lfds_cyclic hexdump mqueue"
+BLOCKS="pid luablock ramp_double rand_double math_double cconst iconst ptrig trig lfds_cyclic hexdump mqueue"
 BLOCK_INDEX=docs/user/block_index.rst
 
 cat <<EOF > $BLOCK_INDEX