Skip to content

Commit

Permalink
docs: update readme with new sensors information
Browse files Browse the repository at this point in the history
  • Loading branch information
geertmeersman committed Dec 14, 2024
1 parent a366040 commit b817a5e
Showing 1 changed file with 53 additions and 9 deletions.
62 changes: 53 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,19 @@

A Home Assistant integration to monitor Mobile Vikings BE services

### Features

- 📱 Mobile data sensors
- 📞 Voice & sms sensors
- 💲 Out of bundle usage
- 💲 Vikings deals balance
- 📈 Invoice sensors
- 👱 User account information
- 🌐 Fixed internet sensors
## Features

- View **Customer Info** such as name and account details.
- Track **Loyalty Points**: Available, blocked, and pending points.
- Monitor **Invoices**: Paid invoices, unpaid invoices, and the next expiration date.
- Access subscription details, including:
- **Data Usage**: Remaining data and percentage used.
- **Voice Balance**: Minutes usage details.
- **SMS Balance**: SMS usage details.
- **Out of Bundle Costs**.
- **Credit Balance**.
- **Subscription Product Information**.
- **SIM Alias**.

---

Expand Down Expand Up @@ -58,6 +62,10 @@ A Home Assistant integration to monitor Mobile Vikings BE services
- [Installation](#installation)
- [Using HACS (recommended)](#using-hacs-recommended)
- [Manual](#manual)
- [Available Sensors](#available-sensors)
- [Account Details](#account-details)
- [Invoices](#invoices)
- [Subscription Details](#subscription-details)
- [Contributions are welcome!](#contributions-are-welcome)
- [Troubleshooting](#troubleshooting)
- [Enable debug logging](#enable-debug-logging)
Expand Down Expand Up @@ -93,6 +101,42 @@ This integration will set up the following platforms.
| ---------------- | ------------------------------------------------------- |
| `mobile_vikings` | Home Assistant component for Mobile Vikings BE services |

## Available Sensors

### Account Details

| Sensor Key | Description | Unit |
| -------------------------- | ------------------------ | -------- |
| `customer_info` | Customer's first name | Text |
| `loyalty_points_available` | Available loyalty points | € (Euro) |
| `loyalty_points_blocked` | Blocked loyalty points | € (Euro) |
| `loyalty_points_pending` | Pending loyalty points | € (Euro) |

### Invoices

| Sensor Key | Description | Unit |
| ------------------------- | ---------------------------- | --------- |
| `paid_invoices` | Total paid invoices | Count |
| `unpaid_invoices` | Unpaid invoices total amount | € (Euro) |
| `next_invoice_expiration` | Next invoice expiration date | Timestamp |

### Subscription Details

| Sensor Key | Description | Unit |
| -------------------- | ------------------------------ | ---------- |
| `data_balance` | Data usage percentage | % |
| `data_remaining` | Data remaining | GB |
| `remaining_days` | Days left in billing cycle | Days |
| `period_percentage` | Billing cycle usage percentage | % |
| `voice_balance` | Voice usage percentage | % |
| `sms_balance` | SMS usage percentage | % |
| `out_of_bundle_cost` | Out-of-bundle cost | € (Euro) |
| `credit` | Available credit balance | € (Euro) |
| `product_info` | Subscription product details | Text/Price |
| `sim_alias` | SIM alias | Text |

---

## Contributions are welcome!

If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)
Expand Down

0 comments on commit b817a5e

Please sign in to comment.