summaryrefslogtreecommitdiff
path: root/apps/examples/README.txt
diff options
context:
space:
mode:
authorpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2012-01-09 18:56:05 +0000
committerpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2012-01-09 18:56:05 +0000
commited93fd7399d11571a4cf214fadcd671a8e2f5d50 (patch)
tree1d92beb75346937900f2fbaf4aeeada000e0720d /apps/examples/README.txt
parent547156a0f3f375205e5302432598b83d26bed715 (diff)
downloadnuttx-ed93fd7399d11571a4cf214fadcd671a8e2f5d50.tar.gz
nuttx-ed93fd7399d11571a4cf214fadcd671a8e2f5d50.tar.bz2
nuttx-ed93fd7399d11571a4cf214fadcd671a8e2f5d50.zip
Add pulse count support to apps/examples/pwm
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4286 42af7a65-404d-4744-a932-0658087f49c3
Diffstat (limited to 'apps/examples/README.txt')
-rw-r--r--apps/examples/README.txt8
1 files changed, 7 insertions, 1 deletions
diff --git a/apps/examples/README.txt b/apps/examples/README.txt
index eae8becaf..887266e2a 100644
--- a/apps/examples/README.txt
+++ b/apps/examples/README.txt
@@ -723,6 +723,8 @@ examples/pwm
specific PWM settings might require additional settings).
CONFIG_PWM - Enables PWM support.
+ CONFIG_EXAMPLES_PWM_COUNT - Enabled PWM pulse count support (if the
+ hardware supports it).
CONFIG_NSH_BUILTIN_APPS - Build the PWM test as an NSH built-in function.
Default: Not built! The example can only be used as an NSH built-in
application
@@ -733,7 +735,11 @@ examples/pwm
CONFIG_EXAMPLES_PWM_FREQUENCY - The initial PWM frequency. Default: 100 Hz
CONFIG_EXAMPLES_PWM_DUTYPCT - The initial PWM duty as a percentage. Default: 50%
CONFIG_EXAMPLES_PWM_DURATION - The initial PWM pulse train duration in sectonds.
- as a percentage. Default: 5 seconds
+ as a percentage. Used only if the current pulse count is zero (pulse count
+ is only supported if CONFIG_PWM_PULSECOUNT is defined). Default: 5 seconds
+ CONFIG_EXAMPLES_PWM_COUNT - The initial PWM pulse count. This option is
+ only available if CONFIG_PWM_PULSECOUNT is defined. Default: 0 (i.e., use
+ the duration, not the count).
examples/rgmp
^^^^^^^^^^^^^