From cb222f6a8a1e790d0995d8446ea23b4c5728d5bc Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Mon, 12 Aug 2019 17:37:53 +0200
Subject: [PATCH] docs: Document ledfx module
Signed-off-by: Rahix <rahix@rahix.de>
---
Documentation/pycardium/leds.rst | 8 +++++++-
pycardium/modules/py/ledfx.py | 4 +++-
2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/Documentation/pycardium/leds.rst b/Documentation/pycardium/leds.rst
index e3cae9ab..d658fb93 100644
--- a/Documentation/pycardium/leds.rst
+++ b/Documentation/pycardium/leds.rst
@@ -5,4 +5,10 @@ This is the 11 LEDs above the display and 4 LEDs on the underside of the
top-board, in the four corners.
.. automodule:: leds
- :members:
+ :members:
+
+``ledfx`` - LED Effects
+=======================
+
+.. automodule:: ledfx
+ :members:
diff --git a/pycardium/modules/py/ledfx.py b/pycardium/modules/py/ledfx.py
index 2181f19c..94a40c2c 100644
--- a/pycardium/modules/py/ledfx.py
+++ b/pycardium/modules/py/ledfx.py
@@ -24,7 +24,9 @@ def kitt(
spectrum=[],
halo=False,
):
-
+ """
+ LED Animation.
+ """
kitt_table = [((-math.cos(math.pi * (x / 10.0))) + 1) / 2.0 for x in range(21)]
kitt_table = [math.pow(x, power) * (1 - minimum) + minimum for x in kitt_table]
--
GitLab