🌘 Lunar Phase Integration for Home Assistant

VietNgoc · July 19, 2024, 9:59pm

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

Moon Phase Sensor: 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.
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 New and Full Moon: Provides the dates for the next new moon and full moon.

Installation

HACS Installation

Go to the HACS settings and add this repository as a custom repository.
Search for “Lunar Phase” in HACS and install it.
Restart Home Assistant.

Manual Installation

Download the lunar_phase folder from this repository.
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.
Restart Home Assistant.

Configuration

Using the Home Assistant UI

To configure the Lunar Phase integration, follow these steps:

Go to the Home Assistant dashboard.
Navigate to Configuration > Devices & Services > Add Integration.
Search for Lunar Phase and select it.
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

Moon Phase Sensor

Name: Moon Phase
Attributes:
- age: The age of the moon in days.
- distance_km: The distance to the moon in kilometers.
- illumination_fraction: The fraction of the moon that is illuminated.
- moon_rise: The moon rise time.
- moon_set: The moon set time.
- next_full: The next full moon date.
- next_new: The next new moon date.

Moon Age Sensor

Name: Moon Age
Unit: days

Moon Distance Sensors

Name: Moon Distance
Unit: km

Moon Illumination Fraction Sensor

Name: Moon Illumination Fraction
Unit: %

Moon Rise and Set Sensors

Name: Moon Rise
Device Class: timestamp
Name: Moon Set
Device Class: timestamp

Next Full and New Moon Sensors

Name: Next Full Moon
Device Class: timestamp
Name: Next New Moon
Device Class: timestamp

Contribution

Contributions are welcome! If you have any suggestions, issues, or feature requests, please open an issue or submit a pull request.

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 monthly phase 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.

Enjoy tracking the lunar phases with the Lunar Phase integration for Home Assistant!

nickrout · July 19, 2024, 10:27pm

Nice, but shouldn’t it take my latitude and longitude from my existing setup?

nickrout · July 19, 2024, 10:40pm

Also I don’t understand what moon age means? Currently 321:52:09 days. I am sure the moon is older than that

Couldn’t resist,

VietNgoc · July 19, 2024, 10:52pm

To be honest, this is my first custom component, which I drew from various tutorials and code studies from other developers. As a first attempt I tried to use data from configs, but the results for time attributes like next full moon etc were strange. So I finally chose the option for prime time zone setting, lat lon, then it gave better results.

This is the time in hours, as default for duration. Try selecting a different display for the sensor

nickrout · July 19, 2024, 10:58pm

The screenshot shows the unit of measurement is d or days. But what is it actually measuring?

VietNgoc · July 19, 2024, 11:04pm

That sensor shows the current age of the moon in days. It calculates the number of days since the last new moon…

nickrout · July 19, 2024, 11:17pm

Well mine says 320 days. I think this line should be HOURS rather than DAYS.

github.com

ngocjohn/lunar-phase/blob/8b2a9e1a78d3d799f0d8d7dc6430ae6b36cf255f/custom_components/lunar_phase/sensor.py#L243


      
          
              _attr_device_class = SensorDeviceClass.DISTANCE
              _attr_native_unit_of_measurement = UnitOfLength.KILOMETERS
              _attr_state_class = SensorStateClass.MEASUREMENT
          
          
          class MoonAgeSensor(MoonAttributeSensor):
              """Representation of a Moon Age sensor."""
          
              _attr_device_class = SensorDeviceClass.DURATION
              _attr_native_unit_of_measurement = UnitOfTime.DAYS
          
          
          class MoonIlluminationFractionSensor(MoonAttributeSensor):
              """Representation of a Moon Illumination Fraction sensor."""
          
              _attr_native_unit_of_measurement = PERCENTAGE
              _attr_state_class = SensorStateClass.MEASUREMENT

RickFurtado · July 20, 2024, 3:41pm

The history tracking actually shows moon_age correctly as days but the UI for the integration shows hours despite the settings, sounds like a display bug to me.

nickrout · July 20, 2024, 9:37pm

Mine has been stuck on 321:52:09 since I installed 24 hours hours ago.

VietNgoc · July 21, 2024, 4:39pm

I made a fix for the correct display, the problem was the device class duration, I set the unit directly as days.

RickFurtado · July 21, 2024, 5:13pm

That seems to work, thanks

VietNgoc · July 24, 2024, 1:19am

A custom card is available for this integration, offering a visually appealing and informative lunar phase tracker. Find and install the Lunar Phase Card here.

https://github-production-user-asset-6210df.s3.amazonaws.com/96962827/351527846-e35c96f9-8b41-42ee-ad9c-8372fdd8b932.gif?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20240724%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240724T011904Z&X-Amz-Expires=300&X-Amz-Signature=3253a326c676f59344ef0a61a5aa9f27886cec5792d2814642f2e71df1077e0e&X-Amz-SignedHeaders=host&actor_id=0&key_id=0&repo_id=831102533(image larger than 3 MB)

l3enjamin · July 26, 2024, 10:56pm

Wonderfull ! Exactly what i’m looking for
I would like to translate into french ? Could you tell me if it is possible and how ?

Thanks for the job

nickrout · July 26, 2024, 11:12pm

Nice. Thanks.

VietNgoc · July 27, 2024, 3:17pm

Hi, you can add another fr.json file to the translations folder. And when you have it, can I ask you to make it as PR, then I will add the update component? Thanks

RickFurtado · August 9, 2024, 1:23pm

I like the latest update, thanks. However I’m left with this, should I be deleting these ‘Unavailable’ entities?

VietNgoc · August 9, 2024, 1:39pm

Hi, these entities are relegated to the diagnostic category. You can delete them. Or delete the integration and recreate with the same inputs.

RickFurtado · August 9, 2024, 1:42pm

That’s what I though, just wanted to confirm. Thanks

alexandrechoske · August 18, 2024, 9:02pm

{
"name": "Português BR",
"nativeName": "Português",
"card": {
"phase": {
"firstQuarterMoon": "Primeiro quarto",
"fullMoon": "Lua cheia",
"thirdQuarterMoon": "Último quarto",
"newMoon": "Lua nova",
"waxingCrescentMoon": "Lua crescente crescente",
"waxingGibbousMoon": "Lua crescente convexa",
"waningCrescentMoon": "Lua minguante crescente",
"waningGibbousMoon": "Lua minguante convexa"
},
"illumination": "Iluminação",
"illuminated": "Iluminada",
"moonRise": "Nascer da lua",
"moonSet": "Pôr da lua",
"moonHigh": "Lua mais alta",
"moonAge": "Idade da lua",
"distance": "Distância",
"azimuth": "Azimute",
"altitude": "Altitude",
"fullMoon": "Lua cheia",
"newMoon": "Lua nova",
"relativeTime": {
"days": "dias",
"justNow": "agora mesmo",
"minutesAgo": "há {0} minutos",
"hoursAgo": "há {0} horas",
"inMinutes": "em {0} minutos",
"inHours": "em {0} horas"
}
},
"editor": {
"viewConfig": {
"title": "Idioma e modo de visualização",
"description": "Definir uma configuração para idioma e plano de fundo"
},
"baseConfig": {
"title": "Latitude e Longitude",
"description": "Definir uma configuração para latitude e longitude"
},
"optionsConfig": {
"useDefault": "Usar sistema",
"useEntity": "Usar entidade",
"useCustom": "Usar personalizado"
},
"compactView": "Visualização compacta",
"showBackground": "Mostrar plano de fundo",
"timeFormat": "Formato de 12 horas",
"placeHolder": {
"latitude": "Inserir latitude",
"longitude": "Inserir longitude",
"customBackground": "URL ou caminho para a imagem",
"language": "Selecionar idioma"
}
}
}

i dont know how to add the pt-br.json file in git, here it is, if you can upload hahaha

VietNgoc · August 19, 2024, 7:02am

Hi @nickrout , I’ve seen the PR on the repo. New translations are added to main branch. I’ll add them to the new release in a week, thanks.