SonicOPT

orbitalsonic · Jan 7, 2025 · 5808ea2 · 5808ea2
1 parent fc53ffd
commit 5808ea2
Show file tree

Hide file tree

Showing 9 changed files with 248 additions and 67 deletions.
diff --git a/README.md b/README.md
@@ -77,8 +77,17 @@ val prayerTimeManager = PrayerTimeManager()
 ---
 
 ### Fetching Prayer Times
+
 Prayer times are calculated based on the provided latitude, longitude, high latitude adjustment, Asr juristic method, prayer time convention, and time format.
 
+- **Manual Corrections**: You can adjust prayer times manually within a range of -59 to +59 minutes. If the adjustment exceeds this range, it defaults to 0 (no correction).
+- **Custom Angles**: When the `PrayerTimeConvention` is set to CUSTOM, you can define specific angles for Fajr and Isha prayers. The default custom angles are:
+    - **Fajr**: 9.0°
+    - **Isha**: 14.0°
+
+By utilizing these features, you can calculate accurate and tailored prayer times for any location and customize them to meet your specific needs.
+
+
 #### Fetch Today Prayer Times
 ```kotlin
 prayerTimeManager.fetchTodayPrayerTimes(
@@ -87,7 +96,9 @@ prayerTimeManager.fetchTodayPrayerTimes(
     highLatitudeAdjustment = HighLatitudeAdjustment.NO_ADJUSTMENT,
     asrJuristicMethod = AsrJuristicMethod.HANAFI,
     prayerTimeConvention = PrayerTimeConvention.KARACHI,
-    timeFormat = TimeFormat.HOUR_12
+    timeFormat = TimeFormat.HOUR_12,
+    prayerManualCorrection = PrayerManualCorrection(fajrMinute = 0, zuhrMinute = 0, asrMinute = 0, maghribMinute = 0, ishaMinute = 2),
+    prayerCustomAngle = PrayerCustomAngle(fajrAngle = 9.0, ishaAngle = 14.0)
 ) { result ->
     result.onSuccess { prayerItem ->
         val date = Date(prayerItem.date)
@@ -109,7 +120,9 @@ prayerTimeManager.fetchCurrentMonthPrayerTimes(
     highLatitudeAdjustment = HighLatitudeAdjustment.NO_ADJUSTMENT,
     asrJuristicMethod = AsrJuristicMethod.HANAFI,
     prayerTimeConvention = PrayerTimeConvention.KARACHI,
-    timeFormat = TimeFormat.HOUR_12
+    timeFormat = TimeFormat.HOUR_12,
+    prayerManualCorrection = PrayerManualCorrection(fajrMinute = 0, zuhrMinute = 0, asrMinute = 0, maghribMinute = 0, ishaMinute = 2),
+    prayerCustomAngle = PrayerCustomAngle(fajrAngle = 9.0, ishaAngle = 14.0)
 ) { result ->
     result.onSuccess { prayerItems ->
         prayerItems.forEachIndexed { index, prayerItem ->
@@ -133,7 +146,9 @@ prayerTimeManager.fetchCurrentYearPrayerTimes(
     highLatitudeAdjustment = HighLatitudeAdjustment.NO_ADJUSTMENT,
     asrJuristicMethod = AsrJuristicMethod.HANAFI,
     prayerTimeConvention = PrayerTimeConvention.KARACHI,
-    timeFormat = TimeFormat.HOUR_12
+    timeFormat = TimeFormat.HOUR_12,
+    prayerManualCorrection = PrayerManualCorrection(fajrMinute = 0, zuhrMinute = 0, asrMinute = 0, maghribMinute = 0, ishaMinute = 2),
+    prayerCustomAngle = PrayerCustomAngle(fajrAngle = 9.0, ishaAngle = 14.0)
 ) { result ->
     result.onSuccess { prayerItems ->
         prayerItems.forEachIndexed { monthIndex, monthlyPrayerItems ->
@@ -154,9 +169,19 @@ prayerTimeManager.fetchCurrentYearPrayerTimes(
 
 ---
 
-
 ## Fetching Fasting Times
-Fasting times are calculated based on Fajr and Maghrib prayers, Sehri ends at Fajr start time, and Iftar begins at Maghrib time. To calculate these times, provide the latitude, longitude, high latitude adjustment, and prayer time convention.
+
+Fasting times are calculated based on the Fajr and Maghrib prayer times. Sehri ends at the start time of the Fajr prayer, and Iftar begins at the start time of the Maghrib prayer. To calculate these times, provide the latitude, longitude, high latitude adjustment, and prayer time convention.
+
+- **Fasting Times**:
+    - **Sehri (Pre-Dawn Meal)**: Ends at the start time of the Fajr prayer.
+    - **Iftar (Breaking Fast)**: Begins at the start time of the Maghrib prayer.
+
+- **Manual Corrections**: Fasting times can be adjusted using manual corrections within a range of -59 to +59 minutes. If the adjustment exceeds this range, it defaults to 0 (no correction).
+
+- **Custom Angles**: When `PrayerTimeConvention` is set to CUSTOM, specific angles for Fajr and Isha prayers can be defined. The default custom angles are:
+    - **Fajr**: 9.0°
+    - **Isha**: 14.0°
 
 #### Fetch Today Fasting Times
 ```kotlin
@@ -165,7 +190,9 @@ prayerTimeManager.fetchTodayFastingTimes(
     longitude = 73.0722461, // Example longitude (Islamabad, Pakistan)
     highLatitudeAdjustment = HighLatitudeAdjustment.NO_ADJUSTMENT,
     prayerTimeConvention = PrayerTimeConvention.KARACHI,
-    timeFormat = TimeFormat.HOUR_12
+    timeFormat = TimeFormat.HOUR_12,
+    prayerManualCorrection = PrayerManualCorrection(fajrMinute = 0,maghribMinute = 0),
+    prayerCustomAngle = PrayerCustomAngle(fajrAngle = 9.0, ishaAngle = 14.0)
 ) { result ->
     result.onSuccess { fastingItem ->
         val date = Date(fastingItem.date)
@@ -184,7 +211,9 @@ prayerTimeManager.fetchCurrentMonthFastingTimes(
     longitude = 73.0722461, // Example longitude (Islamabad, Pakistan)
     highLatitudeAdjustment = HighLatitudeAdjustment.NO_ADJUSTMENT,
     prayerTimeConvention = PrayerTimeConvention.KARACHI,
-    timeFormat = TimeFormat.HOUR_12
+    timeFormat = TimeFormat.HOUR_12,
+    prayerManualCorrection = PrayerManualCorrection(fajrMinute = 0,maghribMinute = 0),
+    prayerCustomAngle = PrayerCustomAngle(fajrAngle = 9.0, ishaAngle = 14.0)
 ) { result ->
     result.onSuccess { fastingTimes ->
         fastingTimes.forEachIndexed { index, fastingItem ->
@@ -204,7 +233,9 @@ prayerTimeManager.fetchCurrentYearFastingTimes(
    longitude = 73.0722461, // Example longitude (Islamabad, Pakistan)
     highLatitudeAdjustment = HighLatitudeAdjustment.NO_ADJUSTMENT,
     prayerTimeConvention = PrayerTimeConvention.KARACHI,
-   timeFormat = TimeFormat.HOUR_12
+   timeFormat = TimeFormat.HOUR_12,
+    prayerManualCorrection = PrayerManualCorrection(fajrMinute = 0,maghribMinute = 0),
+    prayerCustomAngle = PrayerCustomAngle(fajrAngle = 9.0, ishaAngle = 14.0)
 ) { result ->
    result.onSuccess { fastingTimes ->
       fastingTimes.forEachIndexed { monthIndex, monthlyFastingList ->

diff --git a/app/src/main/java/com/orbitalsonic/offlineprayertime/fasting/DailyFastingTimeFragment.kt b/app/src/main/java/com/orbitalsonic/offlineprayertime/fasting/DailyFastingTimeFragment.kt
@@ -12,6 +12,7 @@ import com.orbitalsonic.sonicopt.enums.AsrJuristicMethod
 import com.orbitalsonic.sonicopt.enums.PrayerTimeConvention
 import com.orbitalsonic.sonicopt.enums.TimeFormat
 import com.orbitalsonic.sonicopt.manager.PrayerTimeManager
+import com.orbitalsonic.sonicopt.models.PrayerCustomAngle
 import com.orbitalsonic.sonicopt.models.PrayerManualCorrection
 import java.text.SimpleDateFormat
 import java.util.Date
@@ -47,17 +48,28 @@ class DailyFastingTimeFragment : Fragment() {
         super.onViewCreated(view, savedInstanceState)
 
         /**
-         * Fetch current yearly fasting times.
-         * Fasting times are calculated based on Fajr and Maghrib prayers,
-         * Sehri ends at Fajr start time, and Iftar begins at Maghrib time.
+         * Fetch today's fasting times.
+         *
+         * - **Fasting Times**: Fasting times are derived from the Fajr and Maghrib prayer times.
+         *   - **Sehri (Pre-Dawn Meal)**: Ends at the start time of the Fajr prayer.
+         *   - **Iftar (Breaking Fast)**: Begins at the start time of the Maghrib prayer.
+         *
+         * - **Manual Corrections**: For `PrayerManualCorrection`, only allow manual corrections within the range of -59 to 59 minutes.
+         *   If the correction is outside this range, it will default to 0 (no correction).
+         *
+         * - **Custom Angles**: If `PrayerTimeConvention` is set to CUSTOM, the method will use custom angles for Fajr and Isha prayers.
+         *   The default custom angles are:
+         *      - Fajr: 9.0°
+         *      - Isha: 14.0°
          */
         prayerTimeManager.fetchTodayFastingTimes(
             latitude = latitude,
             longitude = longitude,
             highLatitudeAdjustment = HighLatitudeAdjustment.NO_ADJUSTMENT,
             prayerTimeConvention = PrayerTimeConvention.KARACHI,
             timeFormat = TimeFormat.HOUR_12,
-            prayerManualCorrection = PrayerManualCorrection(fajrMinute = 0,maghribMinute = 0)
+            prayerManualCorrection = PrayerManualCorrection(fajrMinute = 0,maghribMinute = 0),
+            prayerCustomAngle = PrayerCustomAngle(fajrAngle = 9.0, ishaAngle = 14.0)
         ) { result ->
             result.onSuccess { fastingItem ->
                 val formattedDate = dateFormatter.format(Date(fastingItem.date))

diff --git a/app/src/main/java/com/orbitalsonic/offlineprayertime/fasting/MonthlyFastingTimeFragment.kt b/app/src/main/java/com/orbitalsonic/offlineprayertime/fasting/MonthlyFastingTimeFragment.kt
@@ -12,6 +12,7 @@ import com.orbitalsonic.sonicopt.enums.AsrJuristicMethod
 import com.orbitalsonic.sonicopt.enums.PrayerTimeConvention
 import com.orbitalsonic.sonicopt.enums.TimeFormat
 import com.orbitalsonic.sonicopt.manager.PrayerTimeManager
+import com.orbitalsonic.sonicopt.models.PrayerCustomAngle
 import com.orbitalsonic.sonicopt.models.PrayerManualCorrection
 import java.text.SimpleDateFormat
 import java.util.Date
@@ -47,17 +48,28 @@ class MonthlyFastingTimeFragment : Fragment() {
         super.onViewCreated(view, savedInstanceState)
 
         /**
-         * Fetch current yearly fasting times.
-         * Fasting times are calculated based on Fajr and Maghrib prayers,
-         * Sehri ends at Fajr start time, and Iftar begins at Maghrib time.
+         * Fetch current month fasting times.
+         *
+         * - **Fasting Times**: Fasting times are derived from the Fajr and Maghrib prayer times.
+         *   - **Sehri (Pre-Dawn Meal)**: Ends at the start time of the Fajr prayer.
+         *   - **Iftar (Breaking Fast)**: Begins at the start time of the Maghrib prayer.
+         *
+         * - **Manual Corrections**: For `PrayerManualCorrection`, only allow manual corrections within the range of -59 to 59 minutes.
+         *   If the correction is outside this range, it will default to 0 (no correction).
+         *
+         * - **Custom Angles**: If `PrayerTimeConvention` is set to CUSTOM, the method will use custom angles for Fajr and Isha prayers.
+         *   The default custom angles are:
+         *      - Fajr: 9.0°
+         *      - Isha: 14.0°
          */
         prayerTimeManager.fetchCurrentMonthFastingTimes(
             latitude = latitude,
             longitude = longitude,
             highLatitudeAdjustment = HighLatitudeAdjustment.NO_ADJUSTMENT,
             prayerTimeConvention = PrayerTimeConvention.KARACHI,
             timeFormat = TimeFormat.HOUR_12,
-            prayerManualCorrection = PrayerManualCorrection(fajrMinute = 0,maghribMinute = 0)
+            prayerManualCorrection = PrayerManualCorrection(fajrMinute = 0,maghribMinute = 0),
+            prayerCustomAngle = PrayerCustomAngle(fajrAngle = 9.0, ishaAngle = 14.0)
         ) { result ->
             result.onSuccess { fastingTimes ->
                 logBuilder.appendLine("----Monthly Fasting Times----")

diff --git a/app/src/main/java/com/orbitalsonic/offlineprayertime/fasting/YearlyFastingTimeFragment.kt b/app/src/main/java/com/orbitalsonic/offlineprayertime/fasting/YearlyFastingTimeFragment.kt
@@ -12,6 +12,7 @@ import com.orbitalsonic.sonicopt.enums.AsrJuristicMethod
 import com.orbitalsonic.sonicopt.enums.PrayerTimeConvention
 import com.orbitalsonic.sonicopt.enums.TimeFormat
 import com.orbitalsonic.sonicopt.manager.PrayerTimeManager
+import com.orbitalsonic.sonicopt.models.PrayerCustomAngle
 import com.orbitalsonic.sonicopt.models.PrayerManualCorrection
 import java.text.SimpleDateFormat
 import java.util.Date
@@ -47,17 +48,28 @@ class YearlyFastingTimeFragment : Fragment() {
         super.onViewCreated(view, savedInstanceState)
 
         /**
-         * Fetch current yearly fasting times.
-         * Fasting times are calculated based on Fajr and Maghrib prayers,
-         * Sehri ends at Fajr start time, and Iftar begins at Maghrib time.
+         * Fetch current year fasting times.
+         *
+         * - **Fasting Times**: Fasting times are derived from the Fajr and Maghrib prayer times.
+         *   - **Sehri (Pre-Dawn Meal)**: Ends at the start time of the Fajr prayer.
+         *   - **Iftar (Breaking Fast)**: Begins at the start time of the Maghrib prayer.
+         *
+         * - **Manual Corrections**: For `PrayerManualCorrection`, only allow manual corrections within the range of -59 to 59 minutes.
+         *   If the correction is outside this range, it will default to 0 (no correction).
+         *
+         * - **Custom Angles**: If `PrayerTimeConvention` is set to CUSTOM, the method will use custom angles for Fajr and Isha prayers.
+         *   The default custom angles are:
+         *      - Fajr: 9.0°
+         *      - Isha: 14.0°
          */
         prayerTimeManager.fetchCurrentYearFastingTimes(
             latitude = latitude,
             longitude = longitude,
             highLatitudeAdjustment = HighLatitudeAdjustment.NO_ADJUSTMENT,
             prayerTimeConvention = PrayerTimeConvention.KARACHI,
             timeFormat = TimeFormat.HOUR_12,
-            prayerManualCorrection = PrayerManualCorrection(fajrMinute = 0,maghribMinute = 0)
+            prayerManualCorrection = PrayerManualCorrection(fajrMinute = 0,maghribMinute = 0),
+            prayerCustomAngle = PrayerCustomAngle(fajrAngle = 9.0, ishaAngle = 14.0)
         ) { result ->
             result.onSuccess { fastingTimes ->
                 logBuilder.appendLine("----Yearly Fasting Times----")

diff --git a/app/src/main/java/com/orbitalsonic/offlineprayertime/prayer/DailyPrayerTimeFragment.kt b/app/src/main/java/com/orbitalsonic/offlineprayertime/prayer/DailyPrayerTimeFragment.kt
@@ -12,6 +12,7 @@ import com.orbitalsonic.sonicopt.enums.AsrJuristicMethod
 import com.orbitalsonic.sonicopt.enums.PrayerTimeConvention
 import com.orbitalsonic.sonicopt.enums.TimeFormat
 import com.orbitalsonic.sonicopt.manager.PrayerTimeManager
+import com.orbitalsonic.sonicopt.models.PrayerCustomAngle
 import com.orbitalsonic.sonicopt.models.PrayerManualCorrection
 import java.text.SimpleDateFormat
 import java.util.Date
@@ -48,9 +49,15 @@ class DailyPrayerTimeFragment : Fragment() {
 
 
         /**
-         * Fetch and display daily prayer times
-         * Only allow manual corrections within the range of -59 to 59 minutes.
-         * If the correction is outside this range, set it to 0 (no correction).
+         * Fetch Today prayer times.
+         *
+         * - **Manual Corrections**: For `PrayerManualCorrection`, only allow manual corrections within the range of -59 to 59 minutes.
+         *   If the correction is outside this range, it will default to 0 (no correction).
+         *
+         * - **Custom Angles**: If `PrayerTimeConvention` is set to CUSTOM, the method will use custom angles for Fajr and Isha prayers.
+         *   The default custom angles are:
+         *      - Fajr: 9.0°
+         *      - Isha: 14.0°
          */
         prayerTimeManager.fetchTodayPrayerTimes(
             latitude = latitude,
@@ -59,13 +66,8 @@ class DailyPrayerTimeFragment : Fragment() {
             asrJuristicMethod = AsrJuristicMethod.HANAFI,
             prayerTimeConvention = PrayerTimeConvention.KARACHI,
             timeFormat = TimeFormat.HOUR_12,
-            prayerManualCorrection = PrayerManualCorrection(
-                fajrMinute = 0,
-                zuhrMinute = 0,
-                asrMinute = 0,
-                maghribMinute = 0,
-                ishaMinute = 2
-            )
+            prayerManualCorrection = PrayerManualCorrection(fajrMinute = 0, zuhrMinute = 0, asrMinute = 0, maghribMinute = 0, ishaMinute = 2),
+            prayerCustomAngle = PrayerCustomAngle(fajrAngle = 9.0, ishaAngle = 14.0)
         ) { result ->
             result.onSuccess { prayerItem ->
                 val formattedDate = dateFormatter.format(Date(prayerItem.date))

diff --git a/app/src/main/java/com/orbitalsonic/offlineprayertime/prayer/MonthlyPrayerTimeFragment.kt b/app/src/main/java/com/orbitalsonic/offlineprayertime/prayer/MonthlyPrayerTimeFragment.kt
@@ -12,6 +12,7 @@ import com.orbitalsonic.sonicopt.enums.AsrJuristicMethod
 import com.orbitalsonic.sonicopt.enums.PrayerTimeConvention
 import com.orbitalsonic.sonicopt.enums.TimeFormat
 import com.orbitalsonic.sonicopt.manager.PrayerTimeManager
+import com.orbitalsonic.sonicopt.models.PrayerCustomAngle
 import com.orbitalsonic.sonicopt.models.PrayerManualCorrection
 import java.text.SimpleDateFormat
 import java.util.Date
@@ -46,7 +47,17 @@ class MonthlyPrayerTimeFragment : Fragment() {
     override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
         super.onViewCreated(view, savedInstanceState)
 
-        // Fetch and display monthly prayer times
+        /**
+         * Fetch current month prayer times.
+         *
+         * - **Manual Corrections**: For `PrayerManualCorrection`, only allow manual corrections within the range of -59 to 59 minutes.
+         *   If the correction is outside this range, it will default to 0 (no correction).
+         *
+         * - **Custom Angles**: If `PrayerTimeConvention` is set to CUSTOM, the method will use custom angles for Fajr and Isha prayers.
+         *   The default custom angles are:
+         *      - Fajr: 9.0°
+         *      - Isha: 14.0°
+         */
         prayerTimeManager.fetchCurrentMonthPrayerTimes(
             latitude = latitude,
             longitude = longitude,
@@ -60,7 +71,8 @@ class MonthlyPrayerTimeFragment : Fragment() {
                 asrMinute = 0,
                 maghribMinute = 0,
                 ishaMinute = 0
-            )
+            ),
+            prayerCustomAngle = PrayerCustomAngle(fajrAngle = 9.0, ishaAngle = 14.0)
         ) { result ->
             result.onSuccess { prayerItems ->
                 logBuilder.appendLine("----Monthly Prayer Times----")

diff --git a/app/src/main/java/com/orbitalsonic/offlineprayertime/prayer/YearlyPrayerTimeFragment.kt b/app/src/main/java/com/orbitalsonic/offlineprayertime/prayer/YearlyPrayerTimeFragment.kt
@@ -12,6 +12,7 @@ import com.orbitalsonic.sonicopt.enums.AsrJuristicMethod
 import com.orbitalsonic.sonicopt.enums.PrayerTimeConvention
 import com.orbitalsonic.sonicopt.enums.TimeFormat
 import com.orbitalsonic.sonicopt.manager.PrayerTimeManager
+import com.orbitalsonic.sonicopt.models.PrayerCustomAngle
 import com.orbitalsonic.sonicopt.models.PrayerManualCorrection
 import java.text.SimpleDateFormat
 import java.util.Date
@@ -46,7 +47,17 @@ class YearlyPrayerTimeFragment : Fragment() {
     override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
         super.onViewCreated(view, savedInstanceState)
 
-        // Fetch and display yearly prayer times
+        /**
+         * Fetch current year prayer times.
+         *
+         * - **Manual Corrections**: For `PrayerManualCorrection`, only allow manual corrections within the range of -59 to 59 minutes.
+         *   If the correction is outside this range, it will default to 0 (no correction).
+         *
+         * - **Custom Angles**: If `PrayerTimeConvention` is set to CUSTOM, the method will use custom angles for Fajr and Isha prayers.
+         *   The default custom angles are:
+         *      - Fajr: 9.0°
+         *      - Isha: 14.0°
+         */
         prayerTimeManager.fetchCurrentYearPrayerTimes(
             latitude = latitude,
             longitude = longitude,
@@ -60,7 +71,8 @@ class YearlyPrayerTimeFragment : Fragment() {
                 asrMinute = 0,
                 maghribMinute = 0,
                 ishaMinute = 0
-            )
+            ),
+            prayerCustomAngle = PrayerCustomAngle(fajrAngle = 9.0, ishaAngle = 14.0)
         ) { result ->
             result.onSuccess { yearlyPrayerItems ->
                 logBuilder.appendLine("----Yearly Prayer Times----")