Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add eclipse countdown API #353

Open
dgarciabriseno opened this issue Feb 20, 2024 · 3 comments
Open

Add eclipse countdown API #353

dgarciabriseno opened this issue Feb 20, 2024 · 3 comments

Comments

@dgarciabriseno
Copy link
Contributor

dgarciabriseno commented Feb 20, 2024

For the upcoming eclipse, we would like to create an embeddable image that gives an idea of the activity we may see during the total solar eclipse.

Tentative mockup of what the API will return:

MicrosoftTeams-image (1)

The image will be created with the existing screenshot API with these modifications:

  • Only LASCO C2 and C3 will be shown in the image
  • LASCO C2 data will be brightened/saturated so it blends somewhat better with the C3 image
  • An eclipse countdown printed on the top of the image
  • Some text near the image dates which show what time is showing relative to the time of the eclipse.

API Parameters:

  • Enable Countdown
    • This way a page may overlay their own dynamic countdown if it's embedded on a page.
  • year
    • We may reuse this feature for future eclipses, so specifying the year can select which countdown to use.

The result of the API cannot be cached since the same API will always return the latest available data.

@wafels
Copy link
Contributor

wafels commented Feb 20, 2024

Add a small circle in the middle to denote the size of the moon.

@wafels
Copy link
Contributor

wafels commented Feb 20, 2024

Also, some explanatory text will have to be added - that's on me.

@dgarciabriseno
Copy link
Contributor Author

After some work and discussion I think this API is going to be a lot simpler.
It should essentially just be a shortcut for the screenshot API with a preset FOV and using grayscale images.

Any extra text can be overlayed by whoever requests the image.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants