From 4792ef1216be86ab0dbf6d661585b8ff892516cb Mon Sep 17 00:00:00 2001 From: Nathaniel Wesley Filardo Date: Wed, 6 Feb 2019 00:50:28 +0000 Subject: [PATCH] Update dox --- README.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index fe89ded..29d16af 100644 --- a/README.rst +++ b/README.rst @@ -20,7 +20,13 @@ What's Here startup for user input or at a prompt with the network up and telnetd listening after a panic. Spawns ``init2.lc`` for project-specific code. Note that ``init.lua`` tries very hard to have a minimal footprint in the -non-panic path and registers no globals and leaves no callbacks registered. +non-panic path. It leaves a single global registered in the non-panic path, +``OVL``, which is based on the LFS+SPIFFS loader example shipped with +nodemcu. ``OVL.foo`` or ``OVL["foo"]`` will attempt to fetch ``foo.lua`` or +``foo.lc`` from SPIFFS and then ``foo`` from LFS; the rest of the modules +here tend to reference each other that way. (Unlike ``require``, each +``OVL`` fetch is *a distinct object*, so some modules continue to use the +former when they abuse shared state.) Generic Utilities ----------------- @@ -98,6 +104,9 @@ Timer Queue This module is still used within several modules here, however, for the moment. Its removal and deprecation is being staged. + It will probably never go away because it has proven itself quite useful + in adapting other timer frameworks to emulate nodemcu's dynamic timers! + * ``tq/tq.lua`` -- a tickless event queue wrapping around a single nodemcu timer. Useful for managing complex lifecycles and/or many infrequent events. Enqueue events with ``:queue(time,function,args...)``; ``:queue`` returns -- 2.50.1