Skip to content

Commit 43e72a6

Browse files
authored
Update readme.md
1 parent 5235751 commit 43e72a6

1 file changed

Lines changed: 44 additions & 42 deletions

File tree

‎readme.md‎

Lines changed: 44 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,50 @@
1-
# Librelink Extended Gauge
1+
# Librelink Extended Card
22

33
[![HACS](https://img.shields.io/badge/HACS-Custom-orange.svg)](https://github.com/hacs/default)
4-
[![GitHub Release](https://img.shields.io/github/release/yourusername/librelink-extended-gauge.svg)](https://github.com/yourusername/librelink-extended-gauge/releases)
4+
[![GitHub Release](https://img.shields.io/github/release/dodog/librelink-extended-card.svg)](https://github.com/dodo/librelink-extended-card/releases)
55

66
## 📊 About
77

8-
A custom Home Assistant card that combines the default gauge with trend arrow, delta values, and sensor expiration information. Designed specifically for LibreLink CGM data.
8+
A custom Home Assistant card with trend arrow, delta values, and sensor expiration information. Designed specifically for [LibreLink integration](https://github.com/dodog/librelink) data.
99

1010
**Features:**
11-
- ⚡ Automatic detection of all LibreLink sensors
12-
- 🌍 Multi-language support (English,Slovak)
11+
- ⚡ Automatic detection of LibreLink sensors
12+
- 🌍 Multi-language support (English, Slovak)
1313
- 🎯 Configurable delta display (1min, 5min, 15min)
1414
- ⏰ Sensor expiration countdown
1515
- 🎨 Clean, minimal design
1616

1717
## 📦 Installation
1818

1919
### HACS (Recommended)
20-
1. Add as a custom repository in HACS:
21-
- HACS → ⋮ → Custom repositories
22-
- URL: `https://github.com/dodog/librelink-extended-gauge`
23-
- Category: Lovelace
20+
1. Add as a custom repository in ![HACS](https://hacs.xyz/):
21+
- HACS → Click on 3 dots top right ⋮ → Custom repositories
22+
- URL: `https://github.com/dodog/librelink-extended-card`
23+
- Type: Dashboard
2424
2. Click Install
2525

2626
### Manual Installation
27-
1. Download `librelink-extended-gauge.js`
27+
1. Download `librelink-extended-card.js`
2828
2. Copy to `/config/www/`
2929
3. Add as resource:
3030
- Settings → Dashboards → Resources
31-
- URL: `/local/librelink-extended-gauge.js`
31+
- URL: `/local/librelink-extended-card.js`
3232
- Type: JavaScript Module
3333

3434
## 🚀 Usage
3535

3636
### Basic Configuration
3737

3838
```
39-
type: custom:librelink-extended-gauge
40-
entity: sensor.john_doe_glucose_measurement
41-
language: sk
39+
type: custom:librelink-extended-card
40+
entity: sensor.john_doe_measurement
41+
language: en
4242
```
4343
### Full Configuration
4444
```
45-
type: custom:librelink-extended-gauge
46-
entity: sensor.john_doe_glucose_measurement
47-
language: en # sk or en (default: sk)
45+
type: custom:librelink-extended-card
46+
entity: sensor.john_doe_measurement
47+
language: en # en or sk (default: en
4848
show_trend_arrow: true # Show trend arrow (↑, ↓, →)
4949
show_trend_text: true # Show trend text (STABLE, Falling, Rising)
5050
show_delta: true # Show main delta
@@ -56,56 +56,59 @@ show_delta_5min: false # Show 5min delta as secondary
5656
show_delta_15min: false # Show 15min delta as secondary
5757
```
5858
### ⚙️ Configuration Options
59-
```
60-
Option |Type |Default |Description
61-
entity string Required Main glucose sensor
62-
language string sk sk or en
63-
show_trend_arrow boolean true Show/hide trend arrow
64-
show_trend_text boolean true Show/hide trend text
65-
show_delta boolean true Show/hide main delta
66-
show_timestamp boolean true Show/hide last measurement time
67-
show_expiration boolean true Show/hide sensor expiration
68-
delta_type number 5 Main delta: 1, 5, or 15
69-
show_delta_1min boolean false Show 1min delta as secondary
70-
show_delta_5min boolean false Show 5min delta as secondary
71-
show_delta_15min boolean false Show 15min delta as secondary
72-
```
59+
60+
| Option | Type | Default | Description |
61+
|--------|------|---------|-------------|
62+
| entity | string | Required | Main glucose sensor |
63+
| language | string | en | en or sk |
64+
| show_measurement | boolean | true | Show/hide measurement |
65+
| show_trend_arrow | boolean | true | Show/hide trend arrow |
66+
| show_trend_text | boolean | true | Show/hide trend text |
67+
| show_delta | boolean | true | Show/hide main delta |
68+
| show_timestamp | boolean | true | Show/hide last measurement time |
69+
| show_expiration | boolean | true | Show/hide sensor expiration |
70+
| delta_type | number | 5 | Main delta: 1, 5, or 15 |
71+
| show_delta_1min | boolean | false | Show 1min delta as secondary |
72+
| show_delta_5min | boolean | false | Show 5min delta as secondary |
73+
| show_delta_15min | boolean | false | Show 15min delta as secondary |
74+
75+
7376
### 🎯 Examples
7477
Show 15min as main, 5min as secondary
7578
```
76-
type: custom:librelink-extended-gauge
77-
entity: sensor.john_doe_glucose_measurement
79+
type: custom:librelink-extended-card
80+
entity: sensor.john_doe_measurement
7881
delta_type: 15
7982
show_delta_5min: true
8083
```
8184
Show only delta and timestamp (minimal)
8285
```
83-
type: custom:librelink-extended-gauge
84-
entity: sensor.john_doe_glucose_measurement
86+
type: custom:librelink-extended-card
87+
entity: sensor.john_doe_measurement
8588
show_trend_arrow: false
8689
show_trend_text: false
8790
show_expiration: false
8891
```
8992
English language with all features
9093
```
91-
type: custom:librelink-extended-gauge
92-
entity: sensor.john_doe_glucose_measurement
94+
type: custom:librelink-extended-card
95+
entity: sensor.john_doe_measurement
9396
language: en
9497
show_trend_arrow: true
9598
show_trend_text: true
9699
show_delta_1min: true
97100
show_delta_15min: true
98101
```
99102
## 📸 Screenshots
100-
<img width="528" height="362" alt="librelink-extended-gauge-screenshot" src="https://github.com/user-attachments/assets/c0592ba8-4706-4e42-bd6e-d5a92eb29575" />
103+
<img width="528" height="362" alt="librelink-extended-card-screenshot" src="https://raw.githubusercontent.com/dodog/librelink-extended-card/refs/heads/main/screenshot.png" />
101104

102105

103106
## 🔧 Requirements
104107
Home Assistant 2024.6.0 or higher
105108

106-
card_mod installed
109+
[card_mod](https://github.com/thomasloven/lovelace-card-mod) installed
107110

108-
[LibreLink integration](https://github.com/dodog/librelink)
111+
[LibreLink integration](https://github.com/dodog/librelink) installed
109112

110113
## 🤝 Contributing
111114
Contributions are welcome! Please open an issue or submit a PR.
@@ -114,6 +117,5 @@ Contributions are welcome! Please open an issue or submit a PR.
114117
This project is licensed under the GNU General Public License v3.0.
115118

116119
## 🙏 Credits
117-
Inspired by the default Home Assistant gauge card
118120

119-
Built for the LibreLink Home Assistant integration
121+
Built for the [LibreLink Home Assistant integration](https://github.com/dodog/librelink)

0 commit comments

Comments
 (0)