Home Assistant

NETGEAR LTE

The NETGEAR LTE integration for Home Assistant allows you to observe and control NETGEAR LTE modems.

There is currently support for the following device types within Home Assistant:

  • Notifications
  • Sensors
  • Binary Sensors

The integration supports sending notifications with SMS, reporting incoming SMS with events and reporting the modem and connection state in a number of sensors and binary sensors.

Splitting of long SMS messages is not supported so notifications can contain a maximum of 70 characters. Simple messages using the reduced GSM-7 alphabet can contain up to 160 characters. Most emojis are not supported.

Configuration

To enable the integration, add the following lines to your configuration.yaml file:

# Example configuration.yaml entry
netgear_lte:
  - host: IP_ADDRESS
    password: SECRET
    notify:
      - name: sms
        recipient: "+15105550123"
    sensor:
      monitored_conditions:
        - usage
        - sms
    binary_sensor:
      monitored_conditions:
        - wire_connected
        - mobile_connected

Configuration Variables

Looking for your configuration file?
host string Required

The IP address of the modem web interface.

password string Required

The password used for the modem web interface.

notify list (Optional)

A list of notification services connected to this specific host.

recipient string | list (Optional)

The phone number of a default recipient or a list with multiple recipients.

name string (Optional)

The name of the notification service.

Default:

netgear_lte

sensor map (Optional)

Configuration options for sensors.

monitored_conditions list (Optional, default: usage)

Sensor types to create.

cell_id

The Cell ID, a number identifying the base station.

connection_text

A connection text, e.g., “4G”.

connection_type

The connection type, e.g., “IPv4Only”.

current_band

The radio band used, e.g., “LTE B3”.

current_ps_service_type

The service type, e.g., “LTE”.

radio_quality

A number with the radio quality in percent, e.g., “55”

register_network_display

The name of the service provider.

rx_level

The RSRP value, a measurement of the received power level, e.g., “-95”.

sms

Number of unread SMS messages in the modem inbox.

sms_total

Number of SMS messages in the modem inbox.

tx_level

Transmit power, e.g., “23”.

upstream

Current upstream connection, “WAN” or “LTE”.

usage

Amount of data transferred.

binary_sensor map (Optional)

Configuration options for binary sensors.

monitored_conditions list (Optional, default: mobile_connected)

Binary sensor types to create.

mobile_connected

The LTE connection state.

wire_connected

The wired uplink connection state.

roaming

The current roaming state.

Events

Event netgear_lte_sms

Messages arriving in the modem inbox are sent as events of type netgear_lte_sms with the following content.

Event data attribute Description
host The modem that received the message.
sms_id The inbox ID of the received message.
from The sender of the message.
message The SMS message content.

Services

Service netgear_lte.connect_lte

This service asks the modem to establish its LTE connection, useful if the modem does not autoconnect.

Service data attribute Optional Description
host yes The modem that should connect (optional when just one modem is configured).

Service netgear_lte.disconnect_lte

This service asks the modem to close its LTE connection.

Service data attribute Optional Description
host yes The modem that should disconnect (optional when just one modem is configured).

Service netgear_lte.delete_sms

The integration makes a service available to delete messages from the modem inbox. This can be used to clean up after incoming SMS events.

Service data attribute Optional Description
host yes The modem that should have a message deleted (optional when just one modem is configured).
sms_id no Integer or list of integers with inbox IDs of messages to delete.

Service netgear_lte.set_option

This service can set modem configuration options (otherwise available in the modem web UI).

Service data attribute Optional Description
host yes The modem to set options on (optional when just one modem is configured).
autoconnect yes Autoconnect value: never/home/always, with home meaning “not roaming”.
failover yes Failover mode: wire (wired connection only), mobile (mobile connection only), auto (wired connection with failover to mobile connection).

Examples

The following automation example processes incoming SMS messages with the Conversation integration and then deletes the message from the inbox.

automation:
  - alias: "SMS conversation"
    trigger:
      - platform: event
        event_type: netgear_lte_sms
    action:
      - service: conversation.process
        data:
          text: "{{ trigger.event.data.message }}"
      - service: netgear_lte.delete_sms
        data:
          host: "{{ trigger.event.data.host }}"
          sms_id: "{{ trigger.event.data.sms_id }}"