diff --git a/README.md b/README.md
index 6741418..3e03aeb 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,7 @@ if __name__ == '__main__':
- **TOKEN**: Authentication token.
### Optional Env Vars
+- **HEART_BEAT**: Defaults to `None` - _If # of seconds is set, background health check with the server will be enabled_
- **DEBUG**: Defaults to `False` - _Enable debug level logging_
- **SPEECH_TIMEOUT**: Defaults to `0` for macOS, `10` for Windows - _Timeout for speech synthesis_
diff --git a/doc_generator/index.rst b/doc_generator/index.rst
index 082a127..b9bc7fd 100644
--- a/doc_generator/index.rst
+++ b/doc_generator/index.rst
@@ -66,6 +66,13 @@ Models
:members:
:undoc-members:
+Repeated Timer
+==============
+
+.. automodule:: jarvis_ui.modules.timer
+ :members:
+ :undoc-members:
+
Speaker
=======
diff --git a/docs/README.html b/docs/README.html
index e44cd42..01970c0 100644
--- a/docs/README.html
+++ b/docs/README.html
@@ -74,6 +74,7 @@
HEART_BEAT: Defaults to None
- If # of seconds is set, background health check with the server will be enabled
DEBUG: Defaults to False
- Enable debug level logging
SPEECH_TIMEOUT: Defaults to 0
for macOS, 10
for Windows - Timeout for speech synthesis
diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt
index 6741418..3e03aeb 100644
--- a/docs/_sources/README.md.txt
+++ b/docs/_sources/README.md.txt
@@ -29,6 +29,7 @@ if __name__ == '__main__':
- **TOKEN**: Authentication token.
### Optional Env Vars
+- **HEART_BEAT**: Defaults to `None` - _If # of seconds is set, background health check with the server will be enabled_
- **DEBUG**: Defaults to `False` - _Enable debug level logging_
- **SPEECH_TIMEOUT**: Defaults to `0` for macOS, `10` for Windows - _Timeout for speech synthesis_
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
index 082a127..b9bc7fd 100644
--- a/docs/_sources/index.rst.txt
+++ b/docs/_sources/index.rst.txt
@@ -66,6 +66,13 @@ Models
:members:
:undoc-members:
+Repeated Timer
+==============
+
+.. automodule:: jarvis_ui.modules.timer
+ :members:
+ :undoc-members:
+
Speaker
=======
diff --git a/docs/genindex.html b/docs/genindex.html
index ddb494f..07baccd 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -48,6 +48,7 @@
+ | + |
@@ -282,6 +304,8 @@ |
|
- + |
Instantiates RepeatedTimer object to kick off the threading.Timer object with custom intervals.
+>>> RepeatedTimer
+
Repeats the Timer
object from threading.
interval – Interval in seconds.
function – Function to trigger with intervals.
args – Arguments for the function.
kwargs – Keyword arguments for the function.
Initiate cancellation.
+Trigger target function if timer isn’t running already.
+Stop the timer and cancel all futures.
+Initiate health check with the server.
+status_manager – Shared multiprocessing dict to update in case of failed health check.
+See also
+Heart beat should be set no lesser than 5 seconds to avoid throttling and no longer than an hour.
Maintains a consecutive failure threshold of 5, as a single failed health check doesn’t warrant a restart.
jarvis_ui.modules.peripherals
jarvis_ui.modules.timer