Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for islamic_prayer_times sensor platform #7783

Merged
merged 8 commits into from
Dec 23, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions source/_components/sensor.islamic_prayer_times.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
layout: page
title: "Islamic Prayer Times"
description: "Instructions on how to integrate the Islamic Prayer Times sensor within Home Assistant."
date: 2018-12-09 00:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_iot_class: "Cloud Polling"
ha_release: "0.85"
---

The Islamic Prayer Times (`islamic_prayer_times`) sensor platform displays the various prayer times for Muslims as sensors.

This platform calculates prayer times using the following calculation methods:

- University of Islamic Sciences in Karachi
- Islamic Society of North America
- Muslim World League
- Umm Al-Qura University in Makkah

## {% linkable_title Configuration %}

To enable this sensor in your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
sensor:
- platform: islamic_prayer_times
```

{% configuration %}
sensors:
required: false
default: "['fajr', 'dhuhr', 'asr', 'maghrib', 'isha']"
type: list
description: List of available sensors.
keys:
fajr:
description: Show the fajr prayer time for today.
sunrise:
description: Show the sunrise for today which is the end of fajr prayer. This is a calculated field and may not necessarily be the same as the astronomical sunrise.
dhuhr:
description: Show the dhuhr prayer time for today.
asr:
description: Show the asr prayer time for today.
maghrib:
description: Show the maghrib prayer time for today.
isha:
description: Show the isha prayer time for today.
midnight:
description: Show the midnight for today which is the end of isha prayer. This is a calculated field and is not the same as 12AM.
calculation_method:
required: false
default: 'isna'
type: string
description: "The calculation method used for prayer times. Must be one of: `karachi`, `isna`, `mwl`, `makkah`."
{% endconfiguration %}

```yaml
# Example configuration.yaml entry for all available sensors using a non-default calculation method
sensor:
- platform: islamic_prayer_times
calculation_method: makkah
sensors:
- fajr
- sunrise
- dhuhr
- asr
- maghrib
- isha
- midnight
```