SFR Box

The SFR Box integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] connects your SFR broadband router to Home Assistant over your local network. It shows the state of your internet connection, details about your DSL or fiber line, and the status of your phone line. You can restart the box from Home Assistant.

For example, you can get notified when your internet connection comes back after an outage, keep track of DSL line quality over time, or restart the box automatically when the connection stays down.

Supported devices

The integration uses the local API of the box. This API is known to be available on the following models:

• NB4
• NB5
• NB6
• NB6V
• NB6VAC

Unsupported devices

The following devices are not supported:

• NCC models: these models do not appear to provide the local API that the integration uses.

Prerequisites

• Your SFR Box and Home Assistant must be on the same local network.
• To use the phone line entities and the restart button, you need the username and password of the box’s web interface. The default username is admin. The default password is the Wi-Fi security key printed on the label of the box.

Configuration

To add the SFR Box device to your Home Assistant instance, use this My button:

After you enter the host, Home Assistant asks whether you want to set credentials. Credentials are optional, but they enable the phone line entities and the restart button. Select Set credentials (recommended) to enter them, or Skip authentication to continue without them.

Supported functionality

The SFR Box integration provides the following entities.

Some entities depend on the type of internet line, which the integration detects when it starts:

• DSL entities are only available when the box uses a DSL line.
• The FTTH status entity is only available when the box uses a fiber line.
• Phone line (VoIP) entities and the Restart button are only available when you set credentials.

Binary sensors

• DSL status
  • Description: Whether the DSL line is connected
  • Remarks: Only available on DSL lines
• FTTH status
  • Description: Whether the fiber line is connected
  • Remarks: Only available on fiber lines
• VoIP call history active
  • Description: Whether the call history is turned on in the box
  • Remarks: Requires credentials
• VoIP phone hook status
  • Description: Whether the phone connected to the box is On-hook or Off-hook
  • Remarks: Requires credentials
• VoIP status
  • Description: Whether the phone line is connected
  • Remarks: Requires credentials
• WAN status
  • Description: Whether the box is connected to the internet

Buttons

• Restart
  • Description: Restarts the SFR Box
  • Remarks: Requires credentials

Sensors

• DSL attenuation down and DSL attenuation up
  • Description: Signal attenuation of the DSL line, in dB, for download and upload
  • Remarks: Only available on DSL lines. These entities are disabled by default
• DSL connect count
  • Description: Number of DSL connection attempts
  • Remarks: Only available on DSL lines. This entity is disabled by default
• DSL CRC error count
  • Description: Number of transmission errors on the DSL line
  • Remarks: Only available on DSL lines. This entity is disabled by default
• DSL line mode
  • Description: The DSL standard used by the line
  • Remarks: Only available on DSL lines. This entity is disabled by default
• DSL line status
  • Description: Current state of the DSL line: No defect, Loss of frame, Loss of signal, Loss of power, or Loss of signal quality
  • Remarks: Only available on DSL lines. This entity is disabled by default
• DSL noise down and DSL noise up
  • Description: Noise margin of the DSL line, in dB, for download and upload
  • Remarks: Only available on DSL lines. These entities are disabled by default
• DSL rate down and DSL rate up
  • Description: Synchronization speed of the DSL line, in kbit/s, for download and upload
  • Remarks: Only available on DSL lines
• DSL training
  • Description: Current step of the DSL line synchronization, such as Idle or Showtime when the line is synchronized
  • Remarks: Only available on DSL lines. This entity is disabled by default
• Network infrastructure
  • Description: Type of internet line used by the box: ADSL, FTTH, or GPRS
  • Remarks: This entity is disabled by default
• Temperature
  • Description: Internal temperature of the box
  • Remarks: This entity is disabled by default
• Voltage
  • Description: Power supply voltage of the box, in mV
  • Remarks: This entity is disabled by default
• VoIP infrastructure
  • Description: Type of line used for the phone service: ADSL, FTTH, or GPRS
  • Remarks: Requires credentials. This entity is disabled by default
• WAN mode
  • Description: How the box connects to the internet, such as ADSL (PPP) or FTTH (Routed)
  • Remarks: This entity is disabled by default

SFR Box automation examples

The WAN status binary sensor and the Restart button let you react when your internet connection drops. Here are some ideas to get you started.

Automation: Get notified when the internet connection comes back

While your internet connection is down, notifications to your phone cannot be delivered. This automation sends a notification as soon as the connection is back, so you know there was an outage. Replace the entity IDs in the example with the entity IDs of your box and your phone.

• Trigger: State changed
  • Target: Your box’s WAN status binary sensor
  • From: Off
  • To: On
• Action: Send a notification message
  • Target: My Device (notify.my_device)

alias: "Notify when the internet connection comes back"
triggers:
  - trigger: state
    entity_id: binary_sensor.sfr_box_wan_status
    from: "off"
    to: "on"
actions:
  - action: notify.send_message
    target:
      entity_id: notify.my_device
    data:
      message: "The internet connection is back after an outage."

Automation: Restart the box when the internet connection stays down

Restarting the box often fixes a connection that does not recover on its own. This automation presses the Restart button when the connection has been down for 15 minutes. The Restart button is only available when you set credentials. If the outage is on SFR’s side, the box restarts every 15 minutes until the connection is back. Replace the entity IDs in the example with the entity IDs of your box.

• Trigger: State changed
  • Target: Your box’s WAN status binary sensor
  • To: Off
  • For at least: 00:15:00
• Action: Press button
  • Target: Your box’s Restart button

alias: "Restart the SFR Box when the internet connection stays down"
triggers:
  - trigger: state
    entity_id: binary_sensor.sfr_box_wan_status
    to: "off"
    for:
      minutes: 15
actions:
  - action: button.press
    target:
      entity_id: button.sfr_box_restart

Data updates

The SFR Box integration pollsData polling is the process of querying a device or service at regular intervals to check for updates or retrieve data. By defining a custom polling interval, you can control how frequently your system checks for new data, which can help optimize performance and reduce unnecessary network traffic. [Learn more] data from the box every minute.

Known limitations

• The integration only works on your local network. It cannot connect to the box through SFR’s online services.
• Home Assistant does not discover the box automatically. You need to enter its host during setup.
• The integration detects the type of internet line when it starts. If your line changes, for example from DSL to fiber, reload the integration to get the matching entities.
• Boxes that report another type of line, such as FTTB, do not get DSL or fiber entities.
• The integration does not provide Wi-Fi settings or the list of connected devices.

Troubleshooting

Removing the integration

This integration follows standard integration removal. No extra steps are required.

To remove an integration instance from Home Assistant

1. Go to Settings > Devices & services and select the integration card.
2. Next to the entry you want to remove, select the three dots menu. Then, select Delete.
   • Depending on the integration, the entries are listed under one of the following headings:
     • Devices
     • Hubs
     • Services
     • Integration entries
3. To confirm, select Delete.
   • Home Assistant also deletes the devices and entities of the entry.
4. If Home Assistant asks you to restart, restart Home Assistant.
5. If Home Assistant asks whether to also delete the application credentials, select Remove or Keep.
   • If you keep them, Home Assistant uses them automatically when you add the integration again.
   • To delete them later, refer to Deleting application credentials.