Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/ClusterM/omega2-pwm.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexey 'Cluster' Avdyukhin <ClusterM@users.noreply.github.com>2017-07-22 01:27:13 +0300
committerGitHub <noreply@github.com>2017-07-22 01:27:13 +0300
commitf2305e2c40ce1feac1fcc98281d5254ebdc94921 (patch)
tree115be54179bb53e1b63864d797d0642bb42c9bdb
parent929ce76343d36e12f514180b5091691a33a7f7ec (diff)
Update README.md0.1
-rw-r--r--README.md26
1 files changed, 24 insertions, 2 deletions
diff --git a/README.md b/README.md
index 894a26b..95b077d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,24 @@
-# omega2_pwm
-Simple program to control hardware PWM on Omega2
+# Omega2 PWM
+This is simple program to control hardware PWM on Omega2. For some reason Omega2 has not any util to control **hardware** PWM. There is only **fast-gpio** tool, it uses software PWM which is awful for sound generation.
+
+
+## Usage
+
+Channel #0 is pin #18, channel #1 is pin #19. Channels #2 and #3 are available on Omega2S only (UART2 pins).
+
+Before usage you must set GPIO muxing using **omega2-ctrl** tool:
+
+ omega2-ctrl gpiomux set pwm0 pwm
+
+or
+
+ omega2-ctrl gpiomux set pwm1 pwm
+
+Then use this tool:
+
+ pwm <channel> <frequency> [duty]
+
+Example to generate 3000Hz on channel #1 with 50% duty:
+
+ pwm 1 3000 50
+