Merge pull request #1 from MagicMicky/develop

3.2.0

Author: MagicMicky

CHANGELOG.md

@@ -0,0 +1,70 @@
+# Changelog
+
+All notable changes to the Calendar Heatmap Card will be documented in this file.
+
+## [3.2.0] - 2023-03-01
+
+### Added
+- Advanced theme-aware color handling that automatically adapts to light/dark modes
+- Intelligent color intensity scaling for better visual differentiation between activity durations
+- Stepped intensity approach with specific thresholds for common gaming session durations
+- Theme detection for parent elements to support cards inside dashboards with different themes
+- Data attribute for intensity values to aid in debugging
+- Comprehensive error handling throughout the codebase
+
+### Changed
+- Improved visual differentiation between different activity durations
+- Enhanced contrast for better readability in both light and dark themes
+- Refined color adjustment algorithm to ensure optimal visibility
+- Updated README with new theming information and troubleshooting section
+- Removed manual theme configuration option in favor of automatic detection
+
+### Fixed
+- Fixed "Invalid time value" errors when processing history data
+- Improved handling of invalid dates throughout the application
+- Enhanced error resilience when fetching historical data
+- Better handling of "no data" colors with appropriate opacity
+
+## [3.1.1] - 2023-02-15
+
+### Fixed
+- Fixed an issue with date handling in the history service
+- Improved error handling for WebSocket API calls
+
+## [3.1.0] - 2023-02-01
+
+### Added
+- Support for localized day and month names
+- Configurable week start day (Monday or Sunday)
+- Responsive design improvements for mobile devices
+
+### Changed
+- Improved performance for large datasets
+- Enhanced visual appearance with subtle shadows and hover effects
+
+## [3.0.0] - 2023-01-15
+
+### Added
+- Complete rewrite using a modular architecture
+- Detailed breakdown of activity on hover and click
+- Auto-refresh at configurable intervals
+- Support for Home Assistant themes
+
+### Changed
+- Improved performance and reliability
+- Enhanced visual design
+- Better error handling
+
+## [2.0.0] - 2022-12-01
+
+### Added
+- Support for Home Assistant 2022.12.0
+- Improved color handling
+- Better integration with Home Assistant
+
+## [1.0.0] - 2022-10-15
+
+### Added
+- Initial release
+- Basic calendar heatmap functionality
+- Support for tracking game activity 

README.md

@@ -12,12 +12,14 @@ A custom Lovelace card for Home Assistant that visualizes entity activity data a
 
 - 📅 Displays historical activity data on a calendar grid
 - 🎮 Perfect for tracking game activity, device usage, or any time-based data
-- 🎨 Customizable colors and theming (light/dark mode support)
+- 🎨 Advanced theme-aware colors that automatically adapt to light/dark modes
+- 🌈 Intelligent color intensity scaling for better visual differentiation
 - 🔄 Auto-refreshes data at configurable intervals
 - 📊 Detailed breakdown of activity on hover and click
 - 🌐 Localized day and month names
 - 📱 Responsive design for both desktop and mobile
 - 🗓️ Configurable week start day (Monday or Sunday)
+- 🛡️ Robust error handling for improved reliability
 
 ## Installation
 
@@ -54,7 +56,6 @@ type: custom:calendar-heatmap-card
 entity: sensor.game_activity
 title: My Gaming Activity
 days_to_show: 365
-theme: dark
 ```
 
 ### Configuration Options
@@ -66,8 +67,8 @@ theme: dark
 | `days_to_show` | number | 365 | Number of days of history to display |
 | `ignored_states` | array | ["unknown", "idle", "offline", ""] | States to ignore in calculations |
 | `refresh_interval` | number | 300 | Refresh interval in seconds |
-| `theme` | string | "dark" | Theme to use ("dark" or "light") |
 | `start_day_of_week` | string | "monday" | Day to start the week on ("monday" or "sunday") |
+| `include_unknown` | boolean | false | Whether to include "unknown" state in calculations |
 
 ### Example Configurations
 
@@ -85,15 +86,51 @@ entity: sensor.steam_activity
 title: Steam Gaming Activity
 days_to_show: 180
 ignored_states:
-  - unknown
   - idle
   - offline
   - ""
 refresh_interval: 600
-theme: light
 start_day_of_week: sunday
+include_unknown: true
+```
+
+## Theming
+
+The Calendar Heatmap Card now features advanced theme-aware color handling that automatically adapts to your Home Assistant theme. The card will detect whether you're using a light or dark theme and adjust colors accordingly for optimal visibility.
+
+### Custom Theme Variables
+
+You can customize the appearance of the heatmap by adding these variables to your Home Assistant theme:
+
+```yaml
+calendar-heatmap-no-data-color: "#ebedf0"  # Color for days with no data
+calendar-heatmap-level-1: "#c6e48b"        # Color for lowest activity level
+calendar-heatmap-level-2: "#7bc96f"        # Color for low-medium activity level
+calendar-heatmap-level-3: "#239a3b"        # Color for medium-high activity level
+calendar-heatmap-level-4: "#196127"        # Color for highest activity level
 ```
 
+If these variables are not defined, the card will fall back to using Home Assistant's standard theme colors:
+
+- `--disabled-text-color` for no data
+- `--success-color` for level 1
+- `--primary-color` for level 2
+- `--accent-color` for level 3
+- `--state-active-color` for level 4
+
+### Visual Differentiation
+
+The card now uses an improved intensity scaling algorithm that provides better visual differentiation between different activity durations:
+
+- Very short sessions (< 15 min)
+- Short sessions (15-45 min)
+- Medium sessions (45 min - 2 hours)
+- Longer sessions (2-4 hours)
+- High usage sessions (4-8 hours)
+- Very high usage sessions (8+ hours)
+
+This makes it easier to distinguish between days with different levels of activity at a glance.
+
 ## Entity Requirements
 
 This card works best with entities that:
@@ -131,7 +168,6 @@ ignored_states:
   - dnd
   - online
 refresh_interval: 300
-theme: dark
 start_day_of_week: monday
 ```
 
@@ -150,6 +186,24 @@ This gives you a beautiful visualization of your gaming habits over time, showin
 ![Discord Gaming Activity Example](https://raw.githubusercontent.com/MagicMicky/lovelace-calendar-heatmap-card/main/docs/images/discord-example.png)
 *Example of Discord gaming activity visualization (you may want to replace this with your own screenshot)*
 
+## Troubleshooting
+
+### Common Issues
+
+#### No Data Showing
+- Ensure your entity has historical data in Home Assistant
+- Check that the entity states aren't all in the `ignored_states` list
+- Verify that `days_to_show` isn't set too low
+
+#### Colors Not Matching Theme
+- Make sure you're using a recent version of Home Assistant
+- Try adding the custom theme variables mentioned in the Theming section
+- Check if your theme properly defines the fallback variables
+
+#### Performance Issues
+- Try reducing `days_to_show` to display fewer days
+- Increase `refresh_interval` to reduce update frequency
+
 ## Development
 
 ### Project Structure
@@ -166,7 +220,8 @@ src/
 │   ├── color-utils.js        # Color manipulation helpers
 │   └── dom-utils.js          # DOM manipulation helpers
 ├── services/                 # External services
-│   └── history-service.js    # History data fetching
+│   ├── history-service.js    # History data fetching
+│   └── entity-subscription.js # Entity state subscription
 ├── data/                     # Data processing
 │   └── data-processor.js     # Data transformation logic
 └── ui/                       # UI components

dist/calendar-heatmap-card.js

@@ -1,7 +1,7 @@
 {
   "domain": "lovelace-calendar-heatmap-card",
   "name": "Lovelace Calendar Heatmap Card",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "documentation": "https://github.com/MagicMicky/lovelace-calendar-heatmap-card",
   "description": "A Lovelace custom card for Home Assistant showing a calendar heatmap of game activity.",
   "dependencies": [],

dist/calendar-heatmap-card.js.map

@@ -1,6 +1,6 @@
 {
   "name": "calendar-heatmap-card",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "A Lovelace custom card for Home Assistant showing a calendar heatmap of game activity.",
   "main": "dist/calendar-heatmap-card.js",
   "module": "dist/calendar-heatmap-card.js",

manifest.json

@@ -0,0 +1,60 @@
+#!/bin/bash
+
+# Calendar Heatmap Card Release Preparation Script
+# This script builds the project and prepares files for release
+
+# Exit on error
+set -e
+
+# Get version from constants.js
+CONSTANTS_VERSION=$(grep -o "CARD_VERSION = '[^']*'" src/constants.js | cut -d "'" -f 2)
+PACKAGE_VERSION=$(grep -o '"version": "[^"]*"' package.json | head -1 | cut -d '"' -f 4)
+MANIFEST_VERSION=$(grep -o '"version": "[^"]*"' manifest.json | head -1 | cut -d '"' -f 4)
+
+echo "Checking version consistency..."
+echo "- constants.js: $CONSTANTS_VERSION"
+echo "- package.json: $PACKAGE_VERSION"
+echo "- manifest.json: $MANIFEST_VERSION"
+
+# Check if versions match
+if [ "$CONSTANTS_VERSION" != "$PACKAGE_VERSION" ] || [ "$CONSTANTS_VERSION" != "$MANIFEST_VERSION" ]; then
+  echo "ERROR: Version mismatch detected!"
+  echo "Please ensure all version numbers are consistent before running this script."
+  exit 1
+fi
+
+# Use the version from constants.js
+VERSION=$CONSTANTS_VERSION
+echo "Preparing release for version $VERSION"
+
+# Create release directory if it doesn't exist
+RELEASE_DIR="releases/v$VERSION"
+mkdir -p "$RELEASE_DIR"
+
+# Build the project using build.sh script
+echo "Building project..."
+./build.sh
+
+# Copy files to release directory
+echo "Copying files to release directory..."
+cp dist/calendar-heatmap-card.js "$RELEASE_DIR/"
+cp README.md "$RELEASE_DIR/"
+cp CHANGELOG.md "$RELEASE_DIR/"
+cp LICENSE "$RELEASE_DIR/"
+
+# Create a zip file for HACS
+echo "Creating zip file for HACS..."
+cd "$RELEASE_DIR"
+zip "calendar-heatmap-card-$VERSION.zip" *
+cd -
+
+echo "Release preparation complete!"
+echo "Files are available in: $RELEASE_DIR"
+echo "Next steps:"
+echo "1. Commit and push changes to GitHub"
+echo "2. Create a new release on GitHub with tag v$VERSION"
+echo "3. Upload the zip file to the GitHub release"
+echo "4. Update HACS custom repository"
+echo ""
+echo "Note: The RELEASE_TEMPLATE.md file is for reference only and doesn't need to be committed."
+echo "You can use its contents when creating the GitHub release manually." 

package.json

@@ -0,0 +1,70 @@
+# Changelog
+
+All notable changes to the Calendar Heatmap Card will be documented in this file.
+
+## [3.2.0] - 2023-03-01
+
+### Added
+- Advanced theme-aware color handling that automatically adapts to light/dark modes
+- Intelligent color intensity scaling for better visual differentiation between activity durations
+- Stepped intensity approach with specific thresholds for common gaming session durations
+- Theme detection for parent elements to support cards inside dashboards with different themes
+- Data attribute for intensity values to aid in debugging
+- Comprehensive error handling throughout the codebase
+
+### Changed
+- Improved visual differentiation between different activity durations
+- Enhanced contrast for better readability in both light and dark themes
+- Refined color adjustment algorithm to ensure optimal visibility
+- Updated README with new theming information and troubleshooting section
+- Removed manual theme configuration option in favor of automatic detection
+
+### Fixed
+- Fixed "Invalid time value" errors when processing history data
+- Improved handling of invalid dates throughout the application
+- Enhanced error resilience when fetching historical data
+- Better handling of "no data" colors with appropriate opacity
+
+## [3.1.1] - 2023-02-15
+
+### Fixed
+- Fixed an issue with date handling in the history service
+- Improved error handling for WebSocket API calls
+
+## [3.1.0] - 2023-02-01
+
+### Added
+- Support for localized day and month names
+- Configurable week start day (Monday or Sunday)
+- Responsive design improvements for mobile devices
+
+### Changed
+- Improved performance for large datasets
+- Enhanced visual appearance with subtle shadows and hover effects
+
+## [3.0.0] - 2023-01-15
+
+### Added
+- Complete rewrite using a modular architecture
+- Detailed breakdown of activity on hover and click
+- Auto-refresh at configurable intervals
+- Support for Home Assistant themes
+
+### Changed
+- Improved performance and reliability
+- Enhanced visual design
+- Better error handling
+
+## [2.0.0] - 2022-12-01
+
+### Added
+- Support for Home Assistant 2022.12.0
+- Improved color handling
+- Better integration with Home Assistant
+
+## [1.0.0] - 2022-10-15
+
+### Added
+- Initial release
+- Basic calendar heatmap functionality
+- Support for tracking game activity 

prepare-release.sh

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Mickael Goubin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.