Add entry point reporting the firmware version

[Era-Dorta]

It'd be great if we could have a callback that returns the firmware version that is installed in the midge. That way we can do checks on the python side and whatnot. Including showing the version on the python GUI.

This is related to writing a proper specification to the data format that Jose mentioned in the meeting.

What do you think of this @Josfemova?

@harshilbhatt2001 , again, just a fyi

[Josfemova]

This would be nice, and it's somewhat standard to report this version number. We could have an approach that uses semver and considers the ble messages as the API.
Another option to avoid manually having to maintain the version number would be to do something like fetching the current commit hash and embed it in the compiled binary. This provides the secondary benefit of telling you a minimum version of the python software that is expected to work with the firmware

[Era-Dorta]

If we are going for automated version via the hash, I like using hatch-vcs instead. I maintain a python template that uses that as part of the engineering team and I have a little course that explains it, here are the relevant slides https://reit.pages.ewi.tudelft.nl/course-python-project/035-linting-and-versioning.html#/template-recommendation
and the template itself https://gitlab.ewi.tudelft.nl/reit/python-package-template

I was planning on making this repo use that template after merging #4

[Era-Dorta]

For now, I'd be happy to just have a hardcoded version.

[Josfemova]

I think I would need a little bit more guidance to understand if hatch-vcs can be used to accurately track changes in FW because on the surface it looks like something very python specific. It might be of limited usage if at the end it only produces a version identifier that looks like semver but it's not actually following semver (and could also be misleading)

[Era-Dorta]

As we have python and c++ code in the same repo, it should produce the correct version numbers, according to that description. However, as you say they are not semver, in the sense that it doesn't analyse the commit messages for you but it always simply increments the patch version by one.