Orange (Alpha) NOT WORKING YET!

Orange Home Assistant custom component. This custom component has been built from the ground up to bring your Orange 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 Orange Belgium.

For now only Belgian Mobile subscriptions are supported (the only ones I have). Feel free to extend via pull request.

This integration is in no way affiliated with Orange.

Installation

• HACS: HACS > Integration > add repo 'https://github.com/myTselection/orange' > search for Orange and install
• Restart Home Assistant
• Add 'Orange.be' integration via HA Settings > 'Devices and Services' > 'Integrations'
• Provide Orange.be username and password

Integration

• Sensor sensor.orange__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)
  usage_details_json	Json with full details of usage as received from youfone website
  country	Country (BE or NL)

• Sensor sensor.orange__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

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.

Example usage: (using dual gauge card)

Gauge & Markdown

Click to show Mardown code example

type: vertical-stack
cards:
  - type: markdown
    content: >-
      ## <img
      src="https://raw.githubusercontent.com/myTselection/orange/master/icon.png"
      width="30"/>&nbsp;&nbsp;Youfone
      {{state_attr('sensor.orange_<phonenr>_voice_sms','phone_number')}}


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

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

      #### {{state_attr('sensor.orange_<phonenr>_voice_sms','period_days_left')|int}}
      dagen resterend
      ({{((state_attr('sensor.orange_<phonenr>_voice_sms','total_volume')|replace('
      Min','')) or 0)|int -
      (state_attr('sensor.orange_<phonenr>_voice_sms','includedvolume_usage') or
      0)|int}} Min)
      laatste update: *{{state_attr('sensor.orange_<phonenr>_voice_sms','last update')
      | as_timestamp | timestamp_custom("%d-%m-%Y")}}*
  - type: custom:dual-gauge-card
    title: false
    min: 0
    max: 100
    shadeInner: true
    cardwidth: 350
    outer:
      entity: sensor.orange_<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.orange_<phonenr>_voice_sms
      label: period
      attribute: period_used_percentage
      min: 0
      max: 100
      unit: '%'
  - type: history-graph
    entities:
      - entity: sensor.orange_<phonenr>_voice_sms
    hours_to_show: 500
    refresh_interval: 60