aboutsummaryrefslogtreecommitdiff
path: root/hsm-pwm
diff options
context:
space:
mode:
authorPaul Oliver <contact@pauloliver.dev>2025-01-27 14:51:28 +0000
committerPaul Oliver <contact@pauloliver.dev>2025-01-29 04:12:57 +0000
commit9d2f95bb58f856aaf9142426e90e5783c98af8f1 (patch)
tree9453d5cbed1ae2165e6c8f0824ded00d2372e7bd /hsm-pwm
parent9310ba7e17f97c4570dce33552b3605155ca5c0c (diff)
Makes doc-comments cleaner/more elegant
Diffstat (limited to 'hsm-pwm')
-rw-r--r--hsm-pwm/Hsm/PWM.hs21
1 files changed, 10 insertions, 11 deletions
diff --git a/hsm-pwm/Hsm/PWM.hs b/hsm-pwm/Hsm/PWM.hs
index a5e1d27..c7bb1e5 100644
--- a/hsm-pwm/Hsm/PWM.hs
+++ b/hsm-pwm/Hsm/PWM.hs
@@ -21,20 +21,19 @@ import GHC.Records (HasField)
import System.FilePath ((</>))
import System.Process (callCommand)
--- The following PWMEffect implementation assumes `dtoverlay=pwm` to be set on
--- `/boot/config.txt`. On the Pi 5, this enables one active PWM on GPIO 18.
--- This is channel 2, so the address attribute will be 2. Alternative
--- configurations with more PWM channels are possible. Consult the following
--- links for more info:
+-- This `PWMEffect` implementation assumes `dtoverlay=pwm` is set in
+-- `/boot/config.txt`, enabling PWM on GPIO 18 (channel 2) for the Pi 5. The
+-- address attribute will be 2. Alternative configurations with additional PWM
+-- channels are possible. For more information, consult the following links:
--
--- Modifications to `config.txt`:
--- https://www.pi4j.com/blog/2024/20240423_pwm_rpi5/#modify-configtxt
+-- - Modifications to `config.txt`:
+-- https://www.pi4j.com/blog/2024/20240423_pwm_rpi5/#modify-configtxt
--
--- SysFS PWM interface:
--- https://forums.raspberrypi.com/viewtopic.php?t=359251
+-- - SysFS PWM interface:
+-- https://forums.raspberrypi.com/viewtopic.php?t=359251
--
--- UDEV setup for non-root access:
--- https://forums.raspberrypi.com/viewtopic.php?t=316514
+-- - UDEV setup for non-root access:
+-- https://forums.raspberrypi.com/viewtopic.php?t=316514
data PWMEffect a b
type instance DispatchOf PWMEffect = Static E.WithSideEffects