nicole/ha-map-badge-card
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated readme

Browse source
This commit is contained in:
Nicole 2025-11-16 14:35:49 +01:00
parent 1da473d52a
commit d0a71327cd
1 changed files with 19 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -41,16 +41,30 @@ _Coming soon_
### Manual Installation ### Manual Installation
1. Download `map-badge-card.js` and `map-badge-v2.html` 1. Download all required files from the `src/` directory:
- `map-badge-card.js` (main entry point)
- `constants.js`
- `config-manager.js`
- `entity-data-fetcher.js`
- `iframe-messenger.js`
- `editor-ui.js`
- `editor-handlers.js`
- `map-badge-v2.html`
2. Create a folder `/config/www/map-badge-card/` 2. Create a folder `/config/www/map-badge-card/`
3. Copy both files into that folder
3. Copy **all 8 files** into that folder
4. Add the card resource: 4. Add the card resource:
- Go to Settings → Dashboards → Resources - Go to Settings → Dashboards → Resources
- Click "Add Resource" - Click "Add Resource"
- URL: `/local/map-badge-card/map-badge-card.js` - URL: `/local/map-badge-card/map-badge-card.js`
- Resource type: `JavaScript Module` - Resource type: **`JavaScript Module`** (important!)
5. Refresh your browser 5. Refresh your browser
**Note:** The card uses ES6 modules, so all files must be in the same directory and the resource type must be set to "JavaScript Module".
## Configuration ## Configuration
### Basic Configuration ### Basic Configuration
@ -122,7 +136,7 @@ activities:
### Supported Activities ### Supported Activities
Based on [Google](https://developers.google.com/android/reference/com/google/android/gms/location/DetectedActivity) and iOS activity detection APIs. Icons are fixed, you can only change colors. Based on [Google](https://developers.google.com/android/reference/com/google/android/gms/location/DetectedActivity) and iOS activity detection APIs. Icon colors are customizable.
- Still, On Foot, Walking, Running, Cycling - Still, On Foot, Walking, Running, Cycling
- In Vehicle (covers car, automotive, etc.) - In Vehicle (covers car, automotive, etc.)
@ -133,6 +147,6 @@ All default to black background with white icons.
## Requirements ## Requirements
Your person entities need GPS coordinates (latitude/longitude) and profile pictures. Activity sensors come from the [Home Assistant Companion App](https://companion.home-assistant.io/) or similar integrations. Your person entities need GPS coordinates (latitude/longitude). Activity sensors come from the [Home Assistant Companion App](https://companion.home-assistant.io/) or similar integrations.
For Google Maps, you'll need an API key from [Google Cloud Console](https://console.cloud.google.com/) with billing enabled. OpenStreetMap works out of the box. For Google Maps, you'll need an API key from [Google Cloud Console](https://console.cloud.google.com/) with billing enabled. OpenStreetMap works out of the box.