IsItPayday - Home Assistant Integration

---

📌 Overview

IsItPayday is a custom integration for Home Assistant that calculates and displays your next payday based on your country's holidays and your specified pay frequency.

---

🚀 Features

• Device-based integration: All sensors are grouped under a single device for each configured instance.

• Binary Sensor: binary_sensor.<instance_name>_is_it_payday

  • Indicates whether today is a payday (on or off).
  • Icons:
    • mdi:cash-fast if it is payday.
    • mdi:cash-clock if it is not payday.

• Sensor: sensor.<instance_name>_next_payday

  • Displays the date of the next payday.
  • Icon: mdi:calendar-clock.

• Custom Payday Calculation:

  • Supports various pay frequencies:
    • Monthly: Options include:
      • Last bank day of the month.
      • First bank day of the month.
      • Specific day of the month.
    • Every 28 days.
    • Every 14 days.
    • Weekly.

• Automatic Adjustment for Holidays and Weekends:

  • Fetches public holidays from the Nager.Date API.
  • Adjusts payday if it falls on a weekend or public holiday.

• Reconfiguration Support:

  • After initial setup, you can adjust all settings via the Configure button in the Devices & Services section.

• Persistent Notification After Reconfiguration:

  • When settings are updated, you will see a persistent notification confirming the change.

---

📥 Installation

1. Manual Installation

1. Download the latest release from the GitHub releases.
2. Copy the isitpayday folder into your Home Assistant custom_components directory.
3. Restart Home Assistant.
4. Add the integration:
   • Navigate to Settings > Devices & Services > Integrations.
   • Click Add Integration and search for IsItPayday.

2. HACS Installation (Recommended)

1. Add this repository as a custom repository in HACS.
2. Search for Is It Payday? in HACS and install the integration.
3. Restart Home Assistant.

---

⚙️ Configuration

Step 1: Select Country

• Label: Select country
• Description: Choose your country from the dropdown list. The integration will automatically select the country based on your Home Assistant configuration, but you can change it if needed.

Step 2: Select Payout Frequency

• Label: Select the payout frequency
• Options:
  • monthly: Monthly
  • 28_days: Every 28th day
  • 14_days: Every 14th day
  • weekly: Weekly

Step 3: Depending on the Selected Frequency

• Monthly:

  • Label: Select day of month
  • Options:
    • last_bank_day: Last bank day
    • first_bank_day: First bank day
    • specific_day: Specific day

• Every 28th or 14th day:

  • Label: Select last payday
  • Description: Choose the date of your last payday. The integration will calculate future paydays based on this date.

• Weekly:

  • Label: Select weekday
  • Description: Choose the weekday you receive your payment.

Additional Configuration for Monthly Frequency

• If "Last bank day" is selected:

  • Label: Days before last bank day
  • Options: 0 to 10 (default is 0)
  • Description: Specify how many days before the last bank day you receive your payment.

• If "Specific day" is selected:

  • Label: Select specific day
  • Options: 1 to 31 (default is 31)
  • Description: Choose the specific day of the month for your payday. If this day falls on a weekend or public holiday, the integration will adjust to the previous working day.

---

📡 Sensors

Entity ID	Name	Description
binary_sensor.<instance_name>_is_it_payday	Is It Payday?	Indicates if today is a payday (on/off).
sensor.<instance_name>_next_payday	Next Payday	Displays the date of the next payday.

• All entities are grouped under a single device, named after your chosen Instance Name during setup.

---

🔧 Reconfiguration

• After the integration is set up, you can change the settings (country, pay frequency, day, etc.) directly from Settings > Devices & Services > Is It Payday > Configure.
• Once saved, a persistent notification will appear confirming the update.

---

📋 Example Dashboard Card (Lovelace)

You can add a Payday Info Card to your Home Assistant dashboard using the following Lovelace YAML configuration:

type: entities
title: Payday Information
entities:
  - entity: binary_sensor.my_payday_instance_is_it_payday
    name: Is It Payday Today?
  - entity: sensor.my_payday_instance_next_payday
    name: Next Payday Date

---

⁉️ Issues & Support

If you encounter any issues or have feature requests, please open an issue on GitHub:

---

📜 License

This integration is licensed under the MIT License.