Skip to content

Commit da3c29a

Browse files
committed
Merge branch 'release/6.0.0' of rmc-github.robotic.dlr.de:robotkernel/module_posix_timer into release/6.0.0
2 parents 75337c3 + 6072806 commit da3c29a

File tree

1 file changed

+30
-25
lines changed

1 file changed

+30
-25
lines changed

README.md

Lines changed: 30 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Two different modes are supported by **module_posix_timer**.
1010

1111
* ***nanosleep :*** In this mode the **module_posix_timer** main thread just does a nanosleep until the period time has been elapsed. If the nanosleep call was interrupted by some signal it will sleep until the calculated period end time has been reached. This mode is easy and efficient as well. The **module_posix_timer*** thread should run at a very high priority to ensure, that it will be waken up when it's necessary.
1212
* ***posix_timer :*** This mode creates a timer with timer_create. It configures the timer and connects it to the given signal number from the configuration string.
13-
* ***busywait :*** In busywait the timer threads does active wait on the cpu and consumes all cpu time. This can cause higher power usage and higher temperature (But on a PREEMPT-RT system that should not matter).
13+
* ***busywait :*** In busywait the timer threads does active wait on the cpu and consumes all cpu time. This can cause higher power consumption and higher temperature (But on a PREEMPT-RT system that should not matter).
1414

1515
## Example config file
1616

@@ -22,49 +22,54 @@ This example config file can be used as a template for own configurations.
2222
# vim: ft=yaml
2323

2424
#########################################################
25-
# timer settings
25+
# logging settings
2626

27-
# Defines the tick interval in seconds for the trigger device.
28-
interval: 0.002
27+
# Standard robotkernel module local loglevel.
28+
#loglevel: verbose
2929

30-
# Sets the operating mode of the module.
31-
# Values can be "nanosleep", "busywait" or "timer".
32-
#mode: nanosleep
30+
#########################################################
31+
# timer settings
32+
# module_posix_timer can create multiple timers. For each specified list
33+
# entry in timers a new timer with <name> is created.
3334

34-
# Signal number to be used in "timer"-mode for timer_create.
35-
#signo: 35
35+
timers:
36+
# Unique timer name
37+
- name: <timer_name>
3638

37-
# Setting realtime priorities for the timer thread.
38-
prio: 60
39-
affinity: 0x01
39+
# Defines the tick interval in seconds for the trigger device.
40+
interval: 0.002
4041

41-
# Enable skipping missed cycles (Usually a bad option, e.g. something wrong, bad realtime , ..)
42-
# Values can be:
43-
# "none" - no skipping is done, every tick will be generated.
44-
# "normal" - skip all ticks which ly in the past minus the next.
45-
# "strict" - skip all ticks which ly in the past.
46-
#skip_missed: none
42+
# Sets the operating mode of the module.
43+
# Values can be "nanosleep", "busywait" or "timer".
44+
#mode: nanosleep
4745

48-
#########################################################
49-
# logging settings
46+
# Signal number to be used in "timer"-mode for timer_create.
47+
#signo: 35
5048

51-
# Standard robotkernel module local loglevel.
52-
#loglevel: verbose
49+
# Setting realtime priorities for the timer thread ("nanosleep" or "busywait" mode).
50+
prio: 60
51+
affinity: 0x01
5352

53+
# Enable skipping missed cycles (Usually a bad option, e.g. something wrong, bad realtime , ..)
54+
# Values can be:
55+
# "none" - no skipping is done, every tick will be generated.
56+
# "normal" - skip all ticks which ly in the past minus the next.
57+
# "strict" - skip all ticks which ly in the past.
58+
#skip_missed: none
5459
```
5560

5661
## Trigger device
5762

58-
This module registers a trigger device to the robotkernel with the following naming schemeː
63+
This module registers a trigger device for each timer to robotkernel with the following naming schemeː
5964

6065
```
61-
<name>.posix_timer.trigger
66+
<module_name>.<timer_name>.trigger
6267
```
6368

6469
## Process data device
6570

6671
The module also provides a cyclic process. It contains the actual timer interval.
6772

6873
```
69-
<name>.inputs.pd
74+
<module_name>.<timer_name>.inputs.pd
7075
```

0 commit comments

Comments
 (0)