ESPHome SNMP Component

This is description of the external ESPHome component that enables support for SNMP protocol. The protocol is widely used in network management and network monitoring.

This component requires Wi-Fi enabled. It supports version 2c of the protocol. All items are read only.

# Example configuration entry
snmp:
  contact: Joe
  location: Basement

Configuration variables

• contact (Optional, string): Value for sysContact (1.3.6.1.2.1.1.4) OID. Defaults to an empty string.
• location (Optional, string): Value for sysLocation (1.3.6.1.2.1.1.6) OID. Defaults to an empty string.

WARNING

SNMP is not supported for Ethernet.

Installation

Add the following section to your ESPHome YAML configuration file:

external_components:
    # SNMP component
    - source: github://aquaticus/esphome-snmp

OID List

OID (Object Identifier) is an address used to uniquely identify statuses.

System

General system information.

• 1.3.6.1.2.1.1.1 (sysDescr): System description including firmware version and board type
• 1.3.6.1.2.1.1.2 (sysObjectId): Object id, different for ESP32 and ESP8266
• 1.3.6.1.2.1.1.3 (sysUptime): The time (in hundredths of a second) since Wi-Fi established connection. If the standard WiFi component is used always 0.
• 1.3.6.1.2.1.1.4 (sysContact): Identification of the contact person. Set by contact configuration entry
• 1.3.6.1.2.1.1.5 (sysName): Name of the node
• 1.3.6.1.2.1.1.6 (sysLocation): Physical location of the node. Set by location configuration entry
• 1.3.6.1.2.1.1.7 (sysServices): Set of services. Always 64.
• 1.3.6.1.2.1.25.1.1 (hrSystemUptime): The amount of time since the bootup

To make sysUptime work you must use extended WiFi. See more here: Network uptime.

Storage

Information about FLASH and RAM.

• 1.3.6.1.2.1.25.2.2 (hrMemorySize): The amount of standard RAM memory in kb

FLASH

• 1.3.6.1.2.1.25.2.3.1.1.1: (hrStorageIndex): Always 1
• 1.3.6.1.2.1.25.2.3.1.3.1: (hrStorageDesc): Description of the storage: FLASH
• 1.3.6.1.2.1.25.2.3.1.4.1: (hrAllocationUnit): Always 1
• 1.3.6.1.2.1.25.2.3.1.5.1: (hrStorageSize): FLASH memory size
• 1.3.6.1.2.1.25.2.3.1.6.1: (hrStorageUsed): FLASH memory usage

SPI RAM

For ESP8266 it shows 0 as size and usage.

• 1.3.6.1.2.1.25.2.3.1.1.2: (hrStorageIndex): Always 2
• 1.3.6.1.2.1.25.2.3.1.3.2: (hrStorageDesc): Description of the storage: PSI RAM
• 1.3.6.1.2.1.25.2.3.1.4.2: (hrAllocationUnit): Always 1
• 1.3.6.1.2.1.25.2.3.1.5.2: (hrStorageSize): SPI RAM memory size
• 1.3.6.1.2.1.25.2.3.1.6.2: (hrStorageUsed): SPI RAM memory usage

Wi-Fi

Wi-Fi signal details.

• 1.3.9999.4.1.0: RSSI
• 1.3.9999.4.2.0: BSSI
• 1.3.9999.4.3.0: SSID
• 1.3.9999.4.4.0: IP address

ESP32 heap

Available only on ESP32 based chips.

• 1.3.9999.32.1.0: Heap size
• 1.3.9999.32.2.0: Free heap
• 1.3.9999.32.3.0: Minimum free heap
• 1.3.9999.32.4.0: Maximum allocated heap

ESP8266 heap

Available only for ESP8266 chips.

• 1.3.9999.8266.1.0: Free heap
• 1.3.9999.8266.2.0: Heap fragmentation in percents
• 1.3.9999.8266.3.0: Maximum size of the free heap block

Chip

CPU details.

• 1.3.9999.2.1.0: chip type, 32 for EPS32, 8266 for ESP8266
• 1.3.9999.2.2.0: CPU Clock
• 1.3.9999.2.3.0: Chip model fo ESP32 or core version for ESP8266
• 1.3.9999.2.4.0: Number of CPU cores
• 1.3.9999.2.5.0: ESP32 chip revision or 0 for ESP8266

Testing

Integration tests are available for ths component: https://github.com/aquaticus/esphome_snmp_tests

Network monitoring

For a practical guide on how to monitor ESPHome devices see ESPHome network monitoring.