Microblx Module Index¶
Module const_int¶
Module random¶
Block random/random¶
Type: cblock
Attributes:
Meta-data: { doc=’A random number generator function block’, realtime=true,}
License: BSD-3-Clause
Configs¶
| name | type | doc |
|---|---|---|
| loglevel | int |
|
| min_max_config | struct random_config |
Ports¶
| name | out type | out len | in type | in len | doc |
|---|---|---|---|---|---|
| seed | unsigned int |
1 | |||
| rnd | unsigned int |
1 |
Module pid¶
Block pid¶
Type: cblock
Attributes:
Meta-data: { doc=’‘, realtime=true,}
License: BSD-3-Clause
Configs¶
| name | type | doc |
|---|---|---|
| Kp | double |
P-gain (def: 0) |
| Ki | double |
I-gain (def: 0) |
| Kd | double |
D-gain (def: 0) |
| data_len | long |
length of signal array (def: 1) |
Ports¶
| name | out type | out len | in type | in len | doc |
|---|---|---|---|---|---|
| msr | double |
1 | measured input signal | ||
| des | double |
1 | desired input signal | ||
| out | double |
1 | controller output |
Module luablock¶
Module ramp_int32¶
Block ramp_int32¶
Type: cblock
Attributes:
Meta-data: { doc=’Ramp generator block’, realtime=true,}
License: BSD-3-Clause
Configs¶
| name | type | doc |
|---|---|---|
| start | int32_t |
ramp starting value (def 0) |
| slope | int32_t |
rate of change (def: 1) |
| data_len | long |
length of output data (def: 1) |
Ports¶
| name | out type | out len | in type | in len | doc |
|---|---|---|---|---|---|
| out | int32_t |
1 | ramp generator output |
Module ptrig¶
Block std_triggers/ptrig¶
Type: cblock
Attributes: trigger, active
Meta-data: { doc=’pthread based trigger’, realtime=true,}
License: BSD-3-Clause
Configs¶
| name | type | doc |
|---|---|---|
| period | struct ptrig_period |
trigger period in { sec, ns } |
| stacksize | size_t |
stacksize as per pthread_attr_setstacksize(3) |
| sched_priority | int |
pthread priority |
| sched_policy | char |
pthread scheduling policy |
| thread_name | char |
thread name (for dbg), default is block name |
| trig_blocks | struct ubx_trig_spec |
specification of blocks to trigger |
| 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 |
| loglevel | int |
Ports¶
| name | out type | out len | in type | in len | doc |
|---|---|---|---|---|---|
| tstats | struct ubx_tstat |
1 | out port for totals and per block timing statistics | ||
| shutdown | int |
1 | input port for stopping ptrig |
Module trig¶
Block std_triggers/trig¶
Type: cblock
Attributes: trigger
Meta-data: { doc=’simple, activity-less trigger’, realtime=true,}
License: BSD-3-Clause
Configs¶
| name | type | doc |
|---|---|---|
| trig_blocks | struct ubx_trig_spec |
list of blocks to trigger |
| tstats_mode | int |
0: off (def), 1: global only, 2: per block |
| tstats_profile_path | char |
directory to write the timing stats file to |
| tstats_output_rate | double |
throttle output on tstats port |
| loglevel | int |
Ports¶
| name | out type | out len | in type | in len | doc |
|---|---|---|---|---|---|
| tstats | struct ubx_tstat |
1 | timing statistics (if enabled) |
Module lfds_cyclic¶
Block lfds_buffers/cyclic¶
Type: iblock
Attributes:
Meta-data: { doc=’High performance scalable, lock-free cyclic, buffered in process communication description=[[ This version is stongly typed and should be preferred This microblx iblock is based on based on liblfds ringbuffer (v0.6.1.1) (www.liblfds.org)]], version=0.01, hard_real_time=true,}
License: BSD-3-Clause
Configs¶
| name | type | doc |
|---|---|---|
| type_name | char |
name of registered microblx type to transport |
| data_len | uint32_t |
array length (multiplier) of data (default: 1) |
| buffer_len | uint32_t |
max number of data elements the buffer shall hold |
Ports¶
| name | out type | out len | in type | in len | doc |
|---|---|---|---|---|---|
| overruns | unsigned long |
1 | Number of buffer overruns. Value is output only upon change. |
Module hexdump¶
Block hexdump/hexdump¶
Type: iblock
Attributes:
Meta-data: { doc=’hexdump interaction’, realtime=false,}
License: BSD-3-Clause
Module mqueue¶
Block mqueue¶
Type: iblock
Attributes:
Meta-data: { doc=’POSIX mqueue interaction’, realtime=true,}
License: BSD-3-Clause
Configs¶
| name | type | doc |
|---|---|---|
| mq_id | char |
mqueue base id |
| type_name | char |
name of registered microblx type to transport |
| data_len | long |
array length (multiplier) of data (default: 1) |
| buffer_len | long |
max number of data elements the buffer shall hold |
| blocking | uint32_t |
enable blocking mode (def: 0) |