Repository navigation
Releases: OpenAthan-Project/openathan
Release list
OpenAthan v0.5.0
OpenAthan v0.5.0
OpenAthan now supports Waveshare ESP32-S3-Touch-LCD-1.85C-BOX V2, alongside the AtomS3R C126 + Voice Pyramid A167. Waveshare V1 is not supported.
What’s included
- Standalone scheduled Athan with stored normal and Fajr recordings, plus setup and settings from your phone.
- Waveshare’s round display with saved brightness and a 12- or 24-hour clock.
- BOOT button controls to stop playback, skip the next Athan or cancel a skip.
- Clock recovery after a restart using the onboard RTC, after initial internet time synchronization and while RTC power is retained.
- Signed Wi-Fi firmware updates for each supported board, preserving settings, Wi-Fi credentials, prayer history and recordings.
- USB setup that recognizes hardware running compatible OpenAthan. For a blank device or other firmware, you select the model before installation.
Install and update
Install and set up OpenAthan using desktop Chrome or Edge. For Waveshare Box V2, connect a USB data cable to the rear USB-C port.
Fresh installation erases existing firmware, Wi-Fi credentials, settings and prayer history. To preserve saved data, use the Wi-Fi updater in your existing production device’s settings. USB firmware updates that preserve saved data are not yet available through the public installer.
Start at a low volume. Waveshare now uses its full software volume range, so saved volume settings can sound louder than before.
Current limitations
Touch input, microphones and SD card storage are not yet supported. RTC backup-battery operation, time retention while unplugged and long-term clock drift have not yet been verified.
Waveshare Box V2 installation, setup, signed updates, recovery from a power interruption before the update takes effect, and rollback when an update fails to start passed hardware testing.
For technical details, see the firmware update documentation and the manifests, build reports and checksums in Assets below.
Recordings: Mishary Rashid Alafasy, via AlAdhan.com / Islamic Network. See audio attribution and permissions.
OpenAthan v0.4.0
OpenAthan v0.4.0
The speaker's local device page now puts the next prayer and everyday controls
within easy reach on phones and desktops.
What's new
- Today shows the next scheduled prayer, its device-local time and whether
its Athan will play. Skipping an announcement keeps that prayer visible until
its time passes, with a named Restore action. - Volume and Skip sit directly below the next prayer. Stop remains available
from Today and Settings while audio is playing. - The timetable identifies enabled, disabled and skipped announcements, and
marks Sunrise as having no Athan. Lost contact marks displayed information
stale without claiming that the speaker stopped. - Settings groups Athan preferences, prayer calculations, screen and lights,
time format and updates. Everyday preferences save automatically, with nearby
feedback. Location and calculation changes require timetable preview and
confirmation. - First-run setup guides you through location, calculation conventions and
timetable review. Manual setup works locally; the location helper is optional. - Saved 12/24-hour formatting applies to the device page and optional display.
Screen brightness is adjustable and defaults to 50% when no preference is saved.
Existing saved preferences are retained.
The device page uses local, compressed assets. The approved Athan recordings,
partition layout and Home Assistant independence are unchanged.
Updating your speaker
Speakers running v0.2.1 or v0.3.0 can check for
updates on their device page and choose Install update. Compatible application
updates preserve settings, credentials, prayer history and stored audio.
Fresh USB installation erases saved settings, credentials and prayer history.
Existing speakers should follow the preserving update guidance.
The reference hardware remains AtomS3R C126 with GC9107 + Voice Pyramid A167.
ST7735 display revisions remain unqualified.
See the preparation and acceptance record
for measured builds and the current physical-validation status.
OpenAthan v0.3.0
OpenAthan v0.3.0
A dim, always-on display now shows your local clock, next prayer and Athan playback status.
What’s new
- See the next prayer and time, whether it will be skipped, and when Athan is playing. The screen also shows disabled prayers and when setup or time synchronization is needed.
- Place the Pyramid’s ports and power cord at the back. Text is upright when viewed from the opposite side, with brightness set to 10% by default.
- If Wi-Fi disconnects, an Offline footer appears. Scheduled Athan continues while the clock remains valid.
The Athan recordings and existing controls are unchanged. Display problems do not stop scheduling, audio or device controls.
Updating your speaker
For speakers running v0.2.1, open the speaker’s device page, check for updates and choose Install update. Compatible updates keep your settings, Wi-Fi credentials, prayer history and stored audio.
Fresh USB installation erases saved settings, credentials and prayer history. For an existing speaker, follow the preserving update guidance.
Supported hardware
Validated on the M5Stack AtomS3R C126 with a GC9107 display and Voice Pyramid A167. Newer ST7735 display revisions have not been validated.
Technical validation and limitations
- All eight jobs in the release-source CI run passed. Source/build, signature, recording approval and bundle validation passed.
- The application is 1,249,440 bytes, leaving 323,424 bytes below the 1.5 MiB budget. Both 2 MiB application slots and the separate shared-audio partition are retained. See the build report.
- Application-only installation on the reference unit preserved saved records and protected flash regions. Startup on Pyramid bottom power confirmed synchronized, healthy normal scheduling. Display direction was confirmed on both the isolated test image and installed production firmware.
- Earlier attended checks covered both complete recordings, device controls and scheduled playback while offline. The focused longer run completed three normal/Fajr pairs with stable memory recovery and the same observed boot.
- That capture includes a 13m50s observation gap; it does not establish an uninterrupted one-hour soak. Instrumented results do not establish maximum-load production headroom, long-term stability or broader hardware/network coverage.
Recording credits and licenses.
Source: 1915fe0a161640518f25d967ea3e58d5bc65b93d.
Manifest SHA-256: 287eff3cae08719205140e5cfbd62e5bb6f333d9481b5288aea3b0109430dbaf.
OpenAthan v0.2.1
OpenAthan v0.2.1 fixes update checks that could fail when GitHub redirected a release download. It retains the features and recordings from v0.2.0.
Upgrading an existing speaker
If your v0.2.0 speaker cannot check for updates, it needs a preserving USB application update to receive this fix. Follow the existing-device upgrade guidance.
Firmware updates preserve Wi-Fi, settings, prayer history, light preferences and installed recordings. Wi-Fi installation requires a compatible rollback-enabled bootloader; an application update alone does not upgrade an older bootloader.
Fresh installation erases saved settings, credentials and prayer history. Use the preserving procedure for an existing speaker.
This release targets M5Stack AtomS3R C126 with Voice/Echo Pyramid A167. Use Atom USB-C for USB installation and only Pyramid bottom power for normal playback. The website installer selects releases separately from device update discovery.
Validation
All automated checks passed. The v0.2.1 production application passed preserving installation, startup and a real public update check on the reference speaker.
Earlier playback, interruption, rollback and one-hour audio/network results are retained with their documented scope and limits. These results do not establish broader device/network coverage or long-term stability. The exact factory bundle has not received a new physical fresh-install test.
Audio attribution
Normal and Fajr Adhan recited by Mishary Rashid Alafasy, sourced from AlAdhan.com / Islamic Network. Copyright remains with the respective rights holders. See recording permission and attribution.
Manifest SHA-256: b6ef1cd38e8feb75ed90d0aeb454ea7ae033d49ded439ab293b29ec510eeb437.
OpenAthan v0.2.0
OpenAthan v0.2.0 adds signed firmware updates from the local device page and an updated normal Adhan recording for fresh installations.
What’s new
- Check for updates and approve installation from the device page. Installation waits until playback ends and the next Athan is at least 15 minutes away.
- Firmware updates preserve Wi-Fi, settings, prayer history and installed recordings.
- Fresh-install audio includes a new 3-minute 54-second normal Adhan by Mishary Rashid Alafasy. Fajr is unchanged. Firmware updates keep your existing recordings.
Installation and compatibility
This release targets M5Stack AtomS3R C126 with Voice/Echo Pyramid A167. Use Atom USB-C for USB installation and only Pyramid bottom power for normal playback.
Wi-Fi updates require a compatible rollback-enabled bootloader. Existing speakers with an older bootloader need the preserving USB transition procedure; an application update alone does not upgrade the bootloader.
Fresh installation erases saved settings, credentials and prayer history. Use the preserving upgrade procedure for an existing speaker.
Device update discovery follows GitHub’s selected latest release. The website installer selects releases separately.
Validation and known limits
Automated firmware and installer checks passed. The release firmware was tested on the reference speaker for installation preservation, startup, cold restart and real scheduled playback. Fajr was reported clear, and the new normal recording was confirmed complete, clear and comfortable. Automatic playback waits for time synchronization after startup.
Power interruption, rollback and a one-hour audio/network test were checked using separate test firmware; see the qualification results and limits. These results do not establish longer-term stability or coverage of other devices and networks.
The exact factory bundle still needs a physical fresh-install test. Public GitHub downloads and HTTPS redirects were verified against the reviewed artifacts. Known issue: the reference speaker’s public update check failed both during playback and while idle, despite verified public downloads. The cause is under investigation. Scheduled playback remains operational.
Audio attribution
Adhan and Fajr Adhan recited by Mishary Rashid Alafasy. Audio source: AlAdhan.com / Islamic Network. Copyright remains with the respective rights holders. See recording permission and attribution.
Manifest SHA-256: a51cbe67d9c76cb326a85a0f732d304798d1e760eef093882df679c8cb7c5e4a.
OpenAthan v0.1.0
OpenAthan v0.1.0 is the first release for M5Stack AtomS3R C126 + Pyramid A167.
- Automatic prayer times and scheduled Athan playback, with separate normal and Fajr recordings stored on the speaker.
- Prayer settings, volume, Stop and Skip controls from your phone’s browser.
- USB Wi-Fi and password setup and recovery through desktop Chrome or Edge.
The speaker operates independently of the public website and Home Assistant. It needs internet access to synchronize its clock after a restart before scheduled playback can begin.
Getting started
Follow the parts and setup instructions. Install through USB setup using desktop Chrome or Edge.
Fresh installation erases existing firmware, credentials, settings and playback history. If OpenAthan is already installed, use USB recovery for Wi-Fi or password changes. Firmware upgrades on existing devices are not supported by this installer.
Testing
The release bundle passed physical Chrome installation, interrupted-installation recovery and device setup. Equivalent Edge tests passed as reported by the maintainer. Firmware CI, artifact integrity and capacity checks passed.
Earlier device testing covered scheduled normal/Fajr playback, phone controls, replay protection and interrupted operations. Those checks were not repeated for this exact bundle; the selected recording quality was accepted by the maintainer.
Recordings and downloads
Normal and Fajr Athan: Mishary Rashid Alafasy. See recording attribution and redistribution terms.
Downloads include the factory firmware, shared audio image, installer manifest, checksums and build report.
Build identity
Source commit: aa3410907f30c28682fbf496bd316fbc2fd5cabe.
Manifest SHA-256: 53b8c1ef870fbabcc36ed697c13491bf94623f81342402a7e0bdb26a6c7e9879.