Skip to content

joohann/Nida

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

169 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ•Œ Nida โ€” Islamic Prayer Times for Home Assistant

HACS Custom HA Version License: MIT

Nida icon

Assalฤmu สฟAlaykum wa Raแธฅmatullฤhi wa Barakฤtuh โ€” Iftikhar Farzan Izz Al Din Muhsin

Nida (ู†ุฏุงุก) means "the call" โ€” a full-featured Home Assistant integration for Islamic prayer times with automatic adhan, pre-adhan reminders, Ramadan features and a beautiful dashboard card.

Prayer times are fetched from the free AlAdhan API โ€” no account or API key required. May Allah reward those who built and maintain it. ๐Ÿคฒ

๐ŸŒ ๐Ÿ‡ฌ๐Ÿ‡ง ๐Ÿ‡ณ๐Ÿ‡ฑ ๐Ÿ‡ฉ๐Ÿ‡ช ๐Ÿ‡ซ๐Ÿ‡ท ๐Ÿ‡ฎ๐Ÿ‡ฉ ๐Ÿ‡ฒ๐Ÿ‡พ ๐Ÿ‡ธ๐Ÿ‡ฆ ๐Ÿ‡ฎ๐Ÿ‡ท ๐Ÿ‡ต๐Ÿ‡ฐ

โœจ Features

  • ๐Ÿ• Prayer Times โ€” Imsak, Fajr, Sunrise, Dhuhr, Asr, Sunset, Maghrib, Isha, Midnight
  • ๐Ÿ“… Hijri Calendar โ€” date, day, month, year and Islamic holidays
  • ๐Ÿ”Š Automatic Adhan โ€” plays at prayer time via any media player
  • ๐Ÿ”” Pre-Adhan Reminders โ€” up to 2 reminders with sound and/or TTS message before each prayer
  • ๐ŸŒ™ Ramadan Features โ€” Tarhim before Fajr and Suhoor alarm
  • ๐ŸŒ™ Night Volume โ€” automatically lower volume after a set hour
  • ๐Ÿ“ฑ Push Notifications โ€” receive a notification at each prayer time
  • โญ๏ธ Next Prayer Sensor โ€” shows which prayer is coming up next
  • ๐ŸŽต Preview Services โ€” test adhans and tarhim directly from the UI
  • ๐Ÿ“Š Dashboard Card โ€” beautiful card with live countdown timer
  • ๐ŸŒ 15+ Calculation Methods โ€” Muslim World League, ISNA, Karachi and more
  • ๐Ÿ—ฃ๏ธ Multi-language โ€” English, Dutch, Arabic, Turkish, German, French, Malay, Indonesian, Urdu and Farsi (Persian).

Nida screens

Nida screens


๐Ÿ“ฆ Installation via HACS

  1. Go to HACS โ†’ Integrations โ†’ โ‹ฎ โ†’ Custom Repositories
  2. Add: https://github.com/joohann/Nida
  3. Category: Integration
  4. Click Download
  5. Restart Home Assistant

โš™๏ธ Configuration

Go to Settings โ†’ Devices & Services โ†’ Add Integration โ†’ Nida

The setup consists of 6 steps:

Step 1 โ€” Location & Method

Field Description Example
City Your city Amsterdam
Country Your country Netherlands
Calculation Method Islamic calculation method Muslim World League

Step 2 โ€” Pre-Adhan Reminders

Configure up to 2 reminders that play before each prayer. Each reminder can have a sound and/or a spoken TTS message.

Field Description
Enable reminder On/off
Minutes before adhan e.g. 10 or 5
Sound Optional jingle sound
Language nl / en / ar / tr
Message e.g. ุจุนุฏ [minutes] ุฏู‚ูŠู‚ุฉ ุญุงู† ูˆู‚ุช ุตู„ุงุฉ [prayer]

Use [minutes] and [prayer] as placeholders in your message.

Step 3 โ€” Fajr Adhan

Separate adhan settings for Fajr (different recitation than daily prayers).

Field Description
Fajr Adhan Sound Choose from available Fajr MP3s
Speaker Your media player entity
Volume 0 โ€” 100%

Step 4 โ€” Daily Adhan

Field Description
Adhan Sound Choose from available day adhan MP3s
Speaker Your media player entity
Volume 0 โ€” 100%
Night volume Optional lower volume after set hour
Night start hour From which hour to use night volume

Step 5 โ€” Notifications

Field Description
Notify at each prayer Send push notification at prayer time
Send notification to Select notify service(s)
Title Notification title
Message Notification message (use {prayer})

Step 6 โ€” Ramadan

Field Description
Suhoor alarm Play a sound before Suhoor ends
Suhoor alarm minutes How many minutes before Imsak
Suhoor alarm sound Choose sound
Suhoor alarm volume 0 โ€” 100%
Enable Tarhim Play tarhim before Fajr during Ramadan
Tarhim Sound Choose tarhim MP3
Tarhim Speaker Your media player entity
Tarhim Volume 0 โ€” 100%

Tarhim plays automatically 6.5 minutes before Fajr during Ramadan.


๐Ÿ”Š Sound Files

Place your MP3 files in the sounds/ folder of the integration. Files are automatically scanned and categorized by name:

Pattern Type
*fajr*.mp3 Fajr adhan
*adhan*.mp3 Daily adhan
*tarhim*.mp3 Tarhim
*suhoor*.mp3 Suhoor alarm
*jingle*.mp3 Pre-adhan reminder sound

Recommended naming:

sounds/
  01-adhan-fajr.mp3
  02-adhan-fajr.mp3
  01-adhan-day.mp3
  02-adhan-day.mp3
  01-tarhim.mp3
  01-suhoor.mp3
  01-jingle.mp3

Sound files are automatically copied to /www/nida/sounds/ on installation so media players can access them without authentication issues.


๐Ÿ“Š Sensors

๐Ÿ•Œ Prayer Times

Sensor Description
sensor.01_imsak Imsak time
sensor.02_fajr Fajr time
sensor.03_sunrise Sunrise time
sensor.04_dhuhr Dhuhr time
sensor.05_asr Asr time
sensor.06_sunset Sunset time
sensor.07_maghrib Maghrib time
sensor.08_isha Isha time
sensor.09_midnight Midnight time
sensor.next_prayer Next upcoming prayer with time
sensor.last_played_adhan Last played adhan

Readable versions (e.g. 05:41) are also available as sensor.01_imsak_readable, etc.

๐Ÿ“… Hijri Calendar

Sensor Description
sensor.hijri_date Full Hijri date (e.g. 04-09-1447)
sensor.hijri_day Day number
sensor.hijri_month Month name (e.g. Ramaแธฤn)
sensor.hijri_year Year
sensor.islamic_holiday_today Islamic holiday today (if any)

๐Ÿ› ๏ธ Services

nida.preview_adhan

Play an adhan as a preview.

service: nida.preview_adhan
data:
  sound: 01-adhan-day.mp3
  speaker: media_player.living_room
  volume: 0.5

nida.test_prayer

Test the adhan for a specific prayer.

service: nida.test_prayer
data:
  prayer: dhuhr

nida.test_tarhim

Test the tarhim recitation.

service: nida.test_tarhim
data:
  sound: 01-tarhim.mp3
  speaker: media_player.bedroom
  volume: 0.4

๐Ÿ“Š Dashboard Card

Nida includes a beautiful custom Lovelace card (nida-card.js) with a live countdown timer that automatically adapts to your Home Assistant light or dark theme.

The card is automatically copied to /www/nida/nida-card.js on installation.

Image Image

Step 1 โ€” Add the resource (once):

Go to Settings โ†’ Dashboards โ†’ โ‹ฎ โ†’ Resources โ†’ Add Resource

Field Value
URL /local/nida/nida-card.js
Resource type JavaScript Module

Step 2 โ€” Add the card to your dashboard:

type: custom:nida-card

Optional configuration:

type: custom:nida-card
theme: auto   # auto (default), light, or dark

๐ŸŒ Calculation Methods

ID Method
0 Shia Ithna-Ashari
1 University of Islamic Sciences, Karachi
2 Islamic Society of North America (ISNA)
3 Muslim World League
4 Umm Al-Qura University, Makkah
5 Egyptian General Authority of Survey
7 Institute of Geophysics, University of Tehran
8 Gulf Region
9 Kuwait
10 Qatar
11 Majlis Ugama Islam Singapura
12 Union Organization Islamic de France
13 Diyanet ฤฐลŸleri BaลŸkanlฤฑฤŸฤฑ, Turkey
14 Spiritual Administration of Muslims of Russia
15 Moonsighting Committee Worldwide

๐Ÿค Contributing

Pull requests are welcome! Feel free to add new adhan sounds, translations or features.


ุจูุณู’ู…ู ุงู„ู„ูŽู‘ู‡ู ุงู„ุฑูŽู‘ุญู’ู…ูŽูฐู†ู ุงู„ุฑูŽู‘ุญููŠู…ู โ€” Made with โค๏ธ for the Muslim community