Implement keolapse

[EricClaeys]

Implement a "keolapse" which is a timelapse with a circular keogram around it.

[NiteRide]

Okay- so one of my ideas is to make it easier to get the keo-ring in the right place on the image. The setup is quite fiddly and tedious using periodic flow and checking and changing image and settings. Do-able, but a barrier to entry.

I envision something like this “keolapse-sizer” that people could use to get close in one step before testing out other parameters: https://allskywelly.great-site.net/allsky2/keolapse_sizer.php. (I don’t think this works on a mobile browser). Basically:

1. load an image
2. drag around the circle and resize with corner until it’s in pretty much the right spot
3. type the numbers into the module setup
4. test and see, etc

It might make more sense to be hosted somewhere rather than a part of the module itself?
Also, that link is very bare bones, it might be nice if the fields were input-able not just using the single drag handle.
*note, although I do have some ability to review or create code, I am not php nor web developer. I was able to do this with some prompt engineering, then tweaking bits. It “works” as is, but could use some refinement, maybe I’ll keep at it a little… also, it’s just in the root of an allsky site, but that is not really the right place for it at all!
Thoughts?

[NiteRide]

A couple thoughts of the day:

1. Might be faster and better on SD usage to to build the keolapse*_temp.mp4 file in the allsky/tmp folder (which is in memory, I think?) or in memory outright instead of building "on disk" in the images/keolapse folder? <-- actually, not sure, but allsky/tmp might need more space for this. on my system page it shows that folder as up to 75mb.

2. Would "keolapse" be a module to create in-addition to normal timelapse, or instead of?
   Either way, I bet that people would want to automatically share or upload the keolapse to their website. If keolapse overrides or is in-lieu of regular timelapse then could use existing flow to upload it to website at end of night, except, I think modules run after end_of_night.sh?
   So maybe module should have an option to "Upload to websites or server as timelapse" (filename as timelapse standard and put into timelapse folder on website?) that might be easier than having to manage separate folder structures on the website, etc. I think the existing upload.sh script can be called with parameters for this if needed?

[EricClaeys]

Do you have a Discord login, or can you create one? I'd like you to join the Allsky Discord channel so we can discuss your ideas with Jim, the developer of the allsky_keolapse module.

1. allsky/tmp IS in memory keolapse*_temp.mp4 should be built there. I'm surprised I didn't catch it, but am glad you did.
   For new installs the size is 75 MB for Pi's with 0.5 GB memory and it goes up to 400 MB for Pi's with 8 GB memory.
   For upgrades, the current size is kept, but I have a comment in the code to # TODO: set to new, larger size if not already there.
   Increasing 75 MB to 100 MB would probably be ok.

2. Hmmm. The answer has some far-reaching consequences - glad you asked. I originally was thinking the WebUI would have a new setting to "Build a keolapse", so a user could build it AND build a normal timelapse. But that would require changes to the Allsky Website to add another icon on the left to view keolapse, and all the associated changes that implies, as you mentioned. I'd vote to initially to make it an either / or thing and just a new setting to make the timelapse a keolapse instead. The file name would not change.

I think modules run after end_of_night.sh?

Correct. The capture_??? programs (the ones that actually take the images) calls endOfNight.sh when transitioning from nighttime to daytime. It creates the timelapse, keogram, etc. and removes "old" files, THEN invokes the Night to Day module flow. It would need to check if a keolapse is being created, then not create the normal timelapse.

Some people have asked for the option to not keep ANY images at the end of night. Currently a Days To Keep of 0 mean "keep ALL images forever" and that would probably change to -1 means "keep ALL images forever" and 0 means "don't keep any images".
Assuming we implement that, endOfNight.sh would also need to make sure it doesn't remove the prior day's images if a keolapse is being created. Maybe the fix is to just delete the "old" images AFTER running the modules.

[NiteRide]

Do you have a Discord login, or can you create one? I'd like you to join the Allsky Discord channel so we can discuss your ideas with Jim, the developer of the allsky_keolapse module.

I haven’t used Discord in the past, but you can now reach me at (redacted). Happy to help out, and noting that like most everyone else, this is a hobby so commitment will come and go as life allows!

[AndyOfLinux]

Couple of thoughts:

1. the docs say that there is a pink crosshairs to help with alignment BUT, I did not see this and it sure would help.
2. I like Niteride's thought about drag and drop circle for alignment - waiting on temp images is a pain.
3. The current 720p or 1080p choices really distort my allsky images. I realize that you can use Timelapse settings to alleviate this. Better explanation is in order.
4. The docs say that "periodic" module should be used but that fires build all the time (depending on test setting). Needs better explanation (and options?) as to when the mp4 file will be produced because it does eat CPU :)
5. I also was thinking of having a dynamic keolapse - i.e. have the keogram ring being built around the "live image" as the image is being updated.
   FWIW, Andy

[EricClaeys]

@AndyOfLinux,

Thanks for your comments. Hope you don't mind that I made them into a list - it was hard to read.

Could you describe more your "dynamic keolapse" idea?

The docs say that "periodic" module should be used

You only want to enable the keolapse in "Periodic" flow while testing. By default a keolapse will then be created every 60 seconds (in addition to the one at the end of night) until you disable the Periodic flow.
I suspect Jim added this because it's an easy way to force a keolapse to be created without having to manually enter some command.

@Alex-developer, in v2025.xx.xx, modules will have a "Test" button. Can that be used to create a keolapse? And then can the "Test" button be pressed multiple times?
If so, then the "Periodic" stuff in the keolapse module can be removed, which will make @AndyOfLinux happy!!

[Alex-developer]

@Alex-developer, in v2025.xx.xx, modules will have a "Test" button. Can that be used to create a keolapse? And then can the "Test" button be pressed multiple times? If so, then the "Periodic" stuff in the keolapse module can be removed, which will make @AndyOfLinux happy!!

No ...... The test function doesn't support any form of image manipulation.

What this needs is the similar logic to the 'Mask Editor' thats coming in the next release, the one I briefly showed you last night.

I would add a new field type for modules that allows the keogram circle to be drawn and then generated to test it, so it can be done in real time. Once happy the relevant values would be added to the modules settings.

This is an older video of how the mask editor works but I think you should be able to get the idea

ScreenRecording2025-03-15at23.52.04-ezgif.com-resize-video.mp4

[jcauthen78]

I'm not sure if this will help anyone kickstart the project - its something I managed to get working on my system a while back.

allsky_keolapse_py.txt