--------------------------
- Improvement: Version comparison between package and local files in '~/.config/pibooth/oled_display/' folder. Now it do an 'AutoUpdate' of the files 'Date-Time_Format_Codes.rst' and 'pibooth_oled_display_2.py' installed in the local pibooth config folder, if the version are older than the packages version.
- Improvement: Do a WARNING log in terminal, If OLED display is not connected to the Pi.
- Removed: 'clear()' in pibooth_cleanup, as it sometimes gave an wierd error in terminal when closing Pibooth. It´s not a bug, but anooring
- Added: New docstring for more info on the plugin in Pypi search.
------------------------------------------------
**Introduction**:
**pibooth-oled-display** is a plugin that enhances the [pibooth ](https://pypi.org/project/pibooth/) experience by adding support for 1 or 2 small OLED displays. This first stable release is packed with features and customization options that make it a versatile addition to your pibooth setup.
After several experimental iterations, I'm excited to present this first stable release!
**Features**:
* Support for 1 or 2 OLED displays, expanding your pibooth's visual outputs.
* Support for a wide range of OLED display models.
For a list of OLED displays supported by the luma.oled driver, please refer to this section in the README:
[`Testet OLED Displays`](https://github.com/DJ-Dingo/pibooth-oled-display/blob/master/README.rst#testet-oled-displays). If you dont see your display, and you know it is supported by luma.oled let me know.
* Display options for up to 3 lines of text, including optional counters showing ``Photos Taken``, ``Printed Photos``, ``Forgotten Photos``, ``Remaining Duplicates``
* Additional display options for the current ``Date-Time``, ``Text_Only`` display, or an `Empty` line when needed. You can see here [`How to change the Date-Time format`](https://github.com/DJ-Dingo/pibooth-oled-display/blob/master/README.rst#how-to-change-the-date-time-format)
* Support for displaying custom or default pibooth state images for each state. You can see here [`How to show your own States images`](https://github.com/DJ-Dingo/pibooth-oled-display/blob/master/README.rst#how-to-show-your-own-states-images)
* Ability to display custom images or animated GIFs, including logos, adding a personal touch to your pibooth. You can see here [`How to show your own Logo`](https://github.com/DJ-Dingo/pibooth-oled-display/blob/master/README.rst#how-to-show-your-own-logo) and [`How to show your own Animated Gif`](https://github.com/DJ-Dingo/pibooth-oled-display/blob/master/README.rst#how-to-show-your-own-animated-gif)
* User-friendly changes can be made via the Pibooth Menu or directly in the `config.cfg` file.
* Extensive customization options for text and counters, including size adjustments, centering, and position offsets to fit your specific display. See more here [`OLED Display - (MODIFY) - Pibooth Menu`](https://github.com/DJ-Dingo/pibooth-oled-display/blob/master/README.rst#oled-display-modify-pibooth-menu)
* Add your own fonts or just use the defaults. See [`How to add your own Fonts`](https://github.com/DJ-Dingo/pibooth-oled-display/blob/master/README.rst#how-to-add-your-own-fonts)
**Getting Started**:
After installing the plugin via PyPi, navigate to... [`OLED Display - (SETUP) - Pibooth Menu`](https://github.com/DJ-Dingo/pibooth-oled-display/blob/master/README.rst#oled-display-setup-pibooth-menu), and setup your display setting. And then enter the [`OLED Display - (MODIFY) - Pibooth Menu` ](https://github.com/DJ-Dingo/pibooth-oled-display/blob/master/README.rst#oled-display-modify-pibooth-menu)to choose what to display.
**Future Possibilities**:
While the plugin currently supports a range of OLED displays and features, the landscape of technology is always evolving. As new OLED displays or functionalities become supported by the luma.oled driver or gain popularity within the community, there's potential for the plugin to evolve and incorporate them. Your feedback and suggestions, especially regarding new displays or functionalities you'd like to see supported, are always welcome!
**Acknowledgments**:
Thanks to the pibooth developers for making such a great program
**Feedback and Contribution**:
Your feedback is invaluable. Please report any bugs or suggestions under the GitHub repository's "Issues" section. Contributions are also welcome!