From e0db101016837e1ab6f65eb73b86799340b85f0a Mon Sep 17 00:00:00 2001 From: Alex Date: Mon, 22 Apr 2024 22:06:31 +0100 Subject: [PATCH] Update boilerplate module --- allsky_boilerplate/allsky_boilerplate.py | 60 ++++++++++++++++++++++-- 1 file changed, 56 insertions(+), 4 deletions(-) diff --git a/allsky_boilerplate/allsky_boilerplate.py b/allsky_boilerplate/allsky_boilerplate.py index 17bdd8b..0f5cdcf 100755 --- a/allsky_boilerplate/allsky_boilerplate.py +++ b/allsky_boilerplate/allsky_boilerplate.py @@ -140,7 +140,43 @@ }, "businfo": [ "i2c" - ] + ], + "changelog": { + "v1.0.0" : [ + { + "author": "Alex Greenland", + "authorurl": "https://github.com/allskyteam", + "changes": "Initial Release" + } + ], + "v1.0.1" : [ + { + "author": "Alex Greenland", + "authorurl": "https://github.com/allskyteam", + "changes": [ + "Change 1", + "Change 2", + "Change 3" + ] + } + ], + "v1.0.2" : [ + { + "author": "Alex Greenland", + "authorurl": "https://github.com/allskyteam", + "changes": "Change 1" + }, + { + "author": "JOhn Doe", + "authorurl": "https://github.com/allskyteam", + "changes": [ + "Change 1", + "Change 2", + "Change 3" + ] + } + ] + } } def boilerplate(params, event): @@ -153,9 +189,9 @@ def boilerplate(params, event): params - A list of all parameters, as defined by the 'arguments' entry in the meta data event - The event for which the module is being called for i.e. day, night, endofnight etc - The moule must return a string with some text to indicate the result of the function. This text + The module must return a string with some text to indicate the result of the function. This text is displayed in the module managers debug dialog. This text can be an emptry string but please - consider makinh it more meaningful. + consider making it more meaningful. Notes on Modules @@ -196,6 +232,8 @@ def boilerplate(params, event): s.dbUpdate(key, value) - Updates the key/value pair to the internal database s.isFileWriteable(fileName) - Determines of the file is writeable s.isFileReadable - Determines if the file is readable + + See the Allsky documentation for the most uptodate list of avaiable function ''' result = "" @@ -210,4 +248,18 @@ def boilerplate(params, event): result = "I don't know if its day or night!" s.log(0,f"ERROR: {result}") - return result \ No newline at end of file + return result + +def boilerplate_cleanup(): + moduleData = { + "metaData": metaData, + "cleanup": { + "files": { + "allskyboiler.json" + }, + "env": { + "ALLSKY_BOILERPLATE" + } + } + } + s.cleanupModule(moduleData) \ No newline at end of file