summaryrefslogtreecommitdiff
path: root/apps/examples/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'apps/examples/README.txt')
-rw-r--r--apps/examples/README.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/apps/examples/README.txt b/apps/examples/README.txt
index 4460e2c66..ff8dcead1 100644
--- a/apps/examples/README.txt
+++ b/apps/examples/README.txt
@@ -678,6 +678,22 @@ examples/poll
CONFIGURED_APPS += uiplib
+examples/pwm
+^^^^^^^^^^^^
+
+ A test of a PWM device driver. It simply enables a pulsed output for
+ a specified frequency and duty for a specified period of time. This
+ example can ONLY be built as an NSH built-in function.
+
+ 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
+ CONFIG_EXAMPLES_PWM_DEVPATH - The path to the PWM device. Default: /dev/pwm0
+ 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
+
examples/rgmp
^^^^^^^^^^^^^