Yoin Youfone Home Assistant integration

Yoin (aka Youfone) Home Assistant custom component. This custom component has been built from the ground up to bring your Youfone mobile phone usage details into Home Assistant to help you towards a better follow up on your usage information. This integration is built against the public website provided by Yoin / Youfone Belgium and Netherlands. Support is provided for multiple sim cards (phone numbers) within one account subscription.

This integration is in no way affiliated with Yoin/Youfone.

As of April 2024, Youfone.be was renamed to Yoin.be. Youfone.nl remained. The integration had been updated to use my.yoin.be or my.youfone.nl site to retrieve account info, yet the sensor names have not been changes as this may impact all dashboards and HA automations or services.

⚠️ Please don't report issues with this integration to Yoin/YouFone, they will not be able to support you.

Some discussion on this topic can be found within the Home Assistant community forum.

Installation

HACS: HACS > Integration > search for 'Yoin.be Youfone.nl' and install
Restart Home Assistant
Add 'Youfone' integration via HA Settings > 'Devices and Services' > 'Integrations'
Provide Youfone.be username and password and country (BE or NL)

Integration

Sensor sensor.youfone_phonenr_voice_sms

Attribute	Description
State	Percentage of used call and sms based on total volume and used amount
`last update`	Timestamp info last retrieved from the youfone website. (There is a throttling of 1h active to limit requests. Restart HA to force update)
`phone_number`	Phone number of the sim card
`used_percentage`	Percentage of used call and sms based on total volume and used amount
`period_used_percentage`	Percentage of period that has passed. Usage will be reset once period has fully passed.
`total_volume`	Total volume of available call & sms within subscription
`includedvolume_usage`	Used amout of call & sms
`unlimited`	Indication if it's an unlimited subscription (not tested)
`period_start`	Start date of the next period
`period_days_left`	Number of days left in current period
`extra_costs`	Amount of extra costs (eg when usage above volume within subscription)
`extra_costs_details`	String with detailed info on the extra cost if available
`usage_details_json`	Json with full details of usage as received from youfone website
`country`	Country (BE or NL)

Sensor sensor.youfone_phonenr_internet

Attribute	Description
State	Percentage of used data based on total volume and used amount
`last update`	Timestamp info last retrieved from the youfone website. (There is a throttling of 1h active to limit requests. Restart HA to force update)
`phone_number`	Phone number of the sim card
`used_percentage`	Percentage of used data based on total volume and used amount
`period_used_percentage`	Percentage of period that has passed. Usage will be reset once period has fully passed.
`total_volume`	Total volume of available data within subscription
`includedvolume_usage`	Used amout of data
`unlimited`	Indication if it's an unlimited subscription (not tested)
`period_start`	Start date of the next period
`period_days_left`	Number of days left in current period
`extra_costs`	Amount of extra costs (eg when usage above volume within subscription)
`extra_costs_details`	String with detailed info on the extra cost if available
`usage_details_json`	Json with full details of usage as received from youfone website
`country`	Country (BE or NL)

Sensor sensor.youfone_phonenr_subscription_info

Attribute	Description
State	Info related to the Youfone subscription
`last update`	Timestamp info last retrieved from the youfone website. (There is a throttling of 1h active to limit requests. Restart HA to force update)
`SubscriptionType`	Info related to the Youfone subscription
`Price`	Subscription monthly rate
`ContractStartDate`	Contract Start Date.
`ContractDuration`	Contract duration
`Msisdn`	SIM unique phone number
`PUK`	PUK code of the sim card
`ICCShort`	SIM card unique id
`MsisdnStatus`	Status of the SIM card
`DataSubscription`	Details (volume indication) of the data subscription
`VoiceSmsSubscription`	Details (volume indication) of the call & sms subscription
`country`	Country (BE or NL)

Status

Still some optimisations are planned, see Issues section in GitHub.

Technical pointers

The main logic and API connection related code can be found within source code youfone.be/custom_components/youfone.be:

sensor.py
utils.py -> mainly ComponentSession class

All other files just contain boilerplat code for the integration to work wtihin HA or to have some constants/strings/translations.

If you would encounter some issues with this custom component, you can enable extra debug logging by adding below into your configuration.yaml:

logger:
  default: info
  logs:
     custom_components.youfone_be: debug

Example usage: (using dual gauge card)

Gauge & Markdown

Click to show Mardown code example

type: conditional
conditions:
  - entity: input_boolean.lana_details
    state: 'on'
card:
  type: vertical-stack
  cards:
    - type: markdown
      content: >-
        ## <img
        src="https://raw.githubusercontent.com/myTselection/youfone_be/master/icon.png"
        width="30"/>&nbsp;&nbsp;Yoin Youfone <Name>
        ({{state_attr('sensor.youfone_<phonenr>_voice_sms','phone_number') |
        replace('32','0')}})


        ### Totaal bel/sms verbruikt:
        {{states('sensor.youfone_<phonenr>_voice_sms')}}%
        ({{state_attr('sensor.youfone_<phonenr>_voice_sms','includedvolume_usage')}}
        van
        {{state_attr('sensor.youfone_<phonenr>_voice_sms','total_volume')}})

        ### Totaal data verbruikt:
        {{states('sensor.youfone_<phonenr>_internet')}}%
        ({{state_attr('sensor.youfone_<phonenr>_internet','includedvolume_usage')}}
        van
        {{state_attr('sensor.youfone_<phonenr>_internet','total_volume')}})

        ### Totaal extra kosten:
        {{state_attr('sensor.youfone_<phonenr>_voice_sms','extra_costs')}}€

        {{state_attr('sensor.youfone_<phonenr>_voice_sms','extra_costs_details')}}

        ####
        {{state_attr('sensor.youfone_<phonenr>_voice_sms','period_days_left')|int}}
        dagen resterend
        ({{((state_attr('sensor.youfone_<phonenr>_voice_sms','total_volume')|replace('
        Min','')) or 0)|int -
        (state_attr('sensor.youfone_<phonenr>_voice_sms','includedvolume_usage')
        or 0)|int}} Min,
        {{((state_attr('sensor.youfone_<phonenr>_internet','total_volume')|replace('
        MB','')) or 0)|int -
        (state_attr('sensor.youfone_<phonenr>_internet','includedvolume_usage')
        or 0)|int}} MB)



        laatste update:
        *{{state_attr('sensor.youfone_<phonenr>_voice_sms','last update') |
        as_timestamp | timestamp_custom("%d-%m-%Y %H:%M")}}*
         
    - type: custom:dual-gauge-card
      title: 📞
      min: 0
      max: 100
      shadeInner: true
      cardwidth: 350
      outer:
        entity: sensor.youfone_<phonenr>_voice_sms
        attribute: used_percentage
        label: used
        min: 0
        max: 100
        unit: '%'
        colors:
          - color: var(--label-badge-green)
            value: 0
          - color: var(--label-badge-yellow)
            value: 60
          - color: var(--label-badge-red)
            value: 80
      inner:
        entity: sensor.youfone_<phonenr>_voice_sms
        label: period
        attribute: period_used_percentage
        min: 0
        max: 100
        unit: '%'
    - type: custom:dual-gauge-card
      title: 🌐
      min: 0
      max: 100
      shadeInner: true
      cardwidth: 350
      outer:
        entity: sensor.youfone_<phonenr>_internet
        attribute: used_percentage
        label: used
        min: 0
        max: 100
        unit: '%'
        colors:
          - color: var(--label-badge-green)
            value: 0
          - color: var(--label-badge-yellow)
            value: 60
          - color: var(--label-badge-red)
            value: 80
      inner:
        entity: sensor.youfone_<phonenr>_internet
        label: period
        attribute: period_used_percentage
        min: 0
        max: 100
        unit: '%'
    - type: history-graph
      entities:
        - entity: sensor.youfone_<phonenr>_voice_sms
        - entity: sensor.youfone_<phonenr>_internet
      hours_to_show: 500
      refresh_interval: 60

myTselection / youfone_be