Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ngocjohn/lunar-phase
🌘 Lunar Phase Integration for Home Assistant
https://github.com/ngocjohn/lunar-phase
custom-component custom-integration home-assistant homeassistant lunar lunar-phase moon moon-phase
Last synced: 3 days ago
JSON representation
🌘 Lunar Phase Integration for Home Assistant
- Host: GitHub
- URL: https://github.com/ngocjohn/lunar-phase
- Owner: ngocjohn
- License: mit
- Created: 2024-07-19T17:01:05.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-08-20T14:17:47.000Z (about 1 month ago)
- Last Synced: 2024-09-20T12:56:17.658Z (7 days ago)
- Topics: custom-component, custom-integration, home-assistant, homeassistant, lunar, lunar-phase, moon, moon-phase
- Language: Python
- Homepage: https://ngocjohn.is-a.dev/lunar-phase/
- Size: 2.84 MB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/ngocjohn/lunar-phase/actions/workflows/hassfest.yaml)  
# 🌘 Lunar Phase Integration for Home Assistant
##
The Lunar Phase integration is a custom component for Home Assistant that provides detailed information about the current phase of the moon. This integration leverages precise astronomical calculations to deliver accurate lunar data, making it a valuable addition for those interested in astronomy, astrology, or just tracking the moon's phases.
## Features
- **Current Moon Phase**: Displays the current phase of the moon.
- **Moon Age**: Shows the age of the moon in days.
- **Distance to Moon**: Provides the distance to the moon in kilometers.
- **Illumination Fraction**: Indicates the fraction of the moon that is illuminated.
- **Moon Rise and Set Times**: Displays the moon rise and set times.
- **Next Key Phases**: Provides dates for the next new moon, full moon, first quarter, and third quarter.
- **Moon Position**: Provides altitude, azimuth, and parallactic angle of the moon.
- **Next Moon High**: Indicates the time of the next moon high position.
## Enhance Your Dashboard with a Beautiful Lunar Display
> [!TIP]
> If you're looking to add a visually appealing and informative lunar phase tracker to your Home Assistant dashboard, check out my custom Lunar Phase Card. This card provides detailed Moon phases information and integrates seamlessly with your existing setup. It's a great addition for anyone interested in astronomy or simply wanting to keep track of the moon's phases in a stylish way. You can find and install the Lunar Phase Card [here](https://github.com/ngocjohn/lunar-phase-card/).
## Table of contents
Table of contents
- [Overview](#overview)
- [Features](#features)
- [Installation](#installation)
- [HACS Installation](#hacs-installation)
- [Manual Installation](#manual-installation)
- [Configuration](#configuration)
- [Using the Home Assistant UI](#using-the-home-assistant-ui)
- [Sensor Details](#sensor-details)
- [Contribution](#contribution)
## Installation
### HACS Installation
1. Go to the HACS settings and add this repository as a custom repository.
2. Search for "Lunar Phase" in HACS and install it.
3. Restart Home Assistant.
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=ngocjohn&repository=lunar-phase&category=Integration)
### Manual Installation
1. Download the `lunar_phase` folder from this repository.
2. Copy the `lunar_phase` folder to your Home Assistant `custom_components` directory. The `custom_components` directory resides in the same directory as your `configuration.yaml` file.
3. Restart Home Assistant.
## Configuration
### Using the Home Assistant UI
To configure the Lunar Phase integration, follow these steps:
1. Go to the Home Assistant dashboard.
2. Navigate to `Configuration` > `Devices & Services` > `Add Integration`.
3. Search for `Lunar Phase` and select it.
4. You will be prompted to enter the city for your location.
- **City**: Enter the name of your city. If the city is not found in the database, you will be prompted to provide additional information:
- **Region**: The region or state where the city is located.
- **Timezone**: The timezone of the city.
- **Latitude**: The latitude coordinate of the city.
- **Longitude**: The longitude coordinate of the city.
Once configured, the integration will add the Moon Phase sensor along with other diagnostic sensors that provide detailed lunar information.
## Sensor Details
| **Name** | **Description** |
| -------------------------------- | ---------------------------------------------------------------------------------------------- |
| `Moon Phase` | Displays the current phase of the moon (e.g., New Moon, Waxing Crescent, First Quarter, etc.). |
| `Moon Age` | Shows the age of the moon in days. |
| `Moon Distance` | Provides the distance to the moon in kilometers. |
| `Moon Illumination Fraction` | Indicates the fraction of the moon that is illuminated. |
| `Moon Rise, Moon Set, Moon High` | Displays the moon rise, set and highest times. |
| `Next Full Moon` | Provides the date for the next full moon. |
| `Next New Moon` | Provides the date for the next new moon. |
| `Next Third Quarter` | Provides the date for the next third quarter moon phase. |
| `Next First Quarter` | Provides the date for the next first quarter moon phase. |
| `Moon High` | Provides the time of the next moon high position. |
| `Moon Altitude` | Provides the altitude of the moon in degrees. |
| `Moon Azimuth` | Provides the azimuth of the moon in degrees. |
| `Moon Parallactic Angle` | Provides the parallactic angle of the moon in degrees. |
| `Next Moon Phase` | Provides the next moon phase and its date. |
## Contribution
Contributions are welcome! If you have any suggestions, issues, or feature requests, please open an issue or submit a pull request.
##
Enjoy tracking the lunar phases with the Lunar Phase integration for Home Assistant!
© 2024 Viet Ngoc
[https://github.com/ngocjohn/](https://github.com/ngocjohn/)