Skip to content

Repository files navigation

GitHub hacs_badge

GitHub commit activity GitHub Release Date GitHub release (latest by date)

Coverflex Benefits Integration

Coverflex Benefits - Custom Component for Home Assistant

Current major version: v2

The data source for this integration is the Coverflex Benefits.

The author of this project categorically rejects any and all responsibility for the card balance and other data that were presented by the integration.

Installation

HACS (Recommended)

This integration can be added to HACS as a custom (non-default) repository.

Assuming you have already installed and configured HACS, follow these steps:

  1. Navigate to the HACS integrations page
  2. Choose Integrations under HACS
  3. Click the '+' button on the bottom of the page
  4. Search for "Coverflex", choose it, and click install in HACS
  5. Ready! Now continue with the configuration.

Configuration Through the interface

  1. Navigate to Settings > Devices & Services and then click Add Integration
  2. Search for coverflex
  3. Enter your credentials (email + password)
  4. If requested, enter the OTP verification code (2FA)
  5. Repeat the procedure as many times as desired to include other cards/accounts you may have

Notes for v2

  • Config flow supports OTP (2FA) when required by Coverflex.
  • The integration can request re-authentication when tokens expire.
  • Data is updated every 30 minutes.

Presentation

Each Coverflex pocket is exposed as a dedicated monetary sensor entity.

To present your data (card balance), use any entity card with one of your pocket sensors.

Entity IDs are generated by Home Assistant from your account and pocket names. Example:

type: entities
entities:
  - sensor.coverflex_username_example_com_meal

Transactions

While showing the card's balance on a card is commonplace (any entity card will do), displaying transactions can be more complicated to achieve.

We recommend using custom:list-card which has the advantage of being able to indicate the number of rows to display:

type: custom:list-card
entity: sensor.coverflex_username_example_com_meal
feed_attribute: transactions
title: My Coverflex Transactions
row_limit: 10
columns:
  - title: Data
    field: date
  - title: Movimento
    field: description
  - title: Valor
    field: amount
    postfix: ""
    style:
      - text-align: right
      - white-space: nowrap

Each transaction includes these fields:

  • date
  • description
  • amount
  • currency

By default, the integration keeps up to 20 transactions per pocket.

Supported Languages

The integration UI is available in the following languages:

Language Code
English en
Português pt
Español es
Italiano it

Legal notice

This is a personal project and isn't in any way affiliated with, sponsored or endorsed by Coverflex Benefits.

All product names, trademarks and registered trademarks in (the images in) this repository, are property of their respective owners. All images in this repository are used by the project for identification purposes only.


Please, support my other integrations: Preços dos Combustivels | MyEdenred | Sodexo

About

Coverflex - Custom Component for Home Assistant

Topics

Resources

Stars

3 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages