Home Assistant Peplink Local Integration

This custom integration allows you to monitor and track your Peplink router from Home Assistant. It uses the local Peplink API to provide sensors for WAN connections and device tracking capabilities.

Features

• Local Communication: Communicates directly with your Peplink router over your local network
• WAN Status Sensors:
  • Connection Status (connectivity sensor)
  • Download Rate (data rate sensor)
  • Upload Rate (data rate sensor)
  • WAN Type (text sensor)
  • WAN Name (text sensor)
  • WAN IP Address (text sensor)
  • WAN Up Since (timestamp sensor)
• Router Sensors:
  • Fan Speed Sensors (speed sensors, dynamically created for each fan)
  • System Temperature (temperature sensor)
  • System Temperature Threshold (temperature sensor)
  • Serial Number (diagnostic sensor)
  • Device Name (diagnostic sensor)
  • Firmware Version (diagnostic sensor)
• GPS Tracking (for GPS-enabled Peplink routers):
  • Device Tracker Entity (for mapping and zone detection)
  • Speed Sensor (meters per second)
  • Altitude Sensor (meters)
  • Heading Sensor (degrees)
• Device Tracking: Tracks client devices connected to your Peplink router
• Traffic Statistics:
  • WAN Download (data rate sensor)
  • WAN Upload (data rate sensor)
  • Total Download (data rate sensor)
  • Total Upload (data rate sensor)
• Configurable Polling: Adjust how frequently the integration polls your router (default: 5 seconds)

Requirements

• The router must be accessible on your local network
• Valid admin credentials for your Peplink router
• Peplink firmware version 8.1.1 or higher

Installation

HACS Installation (Recommended)

1. Ensure HACS is installed in your Home Assistant instance
2. Add this repository as a custom repository in HACS:
   • Go to HACS > Integrations > ⋮ > Custom repositories
   • Add https://github.com/weirded/ha-peplink-local as a repository
   • Select "Integration" as the category
3. Click "Install" on the Peplink Local integration
4. Restart Home Assistant

Manual Installation

1. Download the latest release from the GitHub repository
2. Extract the custom_components/peplink_local directory into your Home Assistant's custom_components directory
3. Restart Home Assistant

Configuration

1. Go to Settings > Devices & Services > Add Integration
2. Search for "Peplink Local"
3. Enter the following information:
   • IP Address: The IP address of your Peplink router
   • Username: Admin username for your Peplink router
   • Password: Admin password for your Peplink router
   • Verify SSL (optional): Disable this if your router uses a self-signed certificate
   • Polling Frequency (optional): How often to poll the router for updates (in seconds, default: 5)
4. Click "Submit"

GPS Features

The GPS tracking features are automatically enabled when your Peplink router has GPS capabilities. This is particularly useful for mobile routers like MAX Transit or MAX BR1 series with cellular connectivity.

• Device Tracker: The router's GPS location will appear on your Home Assistant map and can be used with zones
• Sensors: Speed, altitude and heading sensors provide additional data about the router's movement and orientation
• Accuracy: GPS accuracy is calculated based on horizontal dilution of precision (HDOP) when available

Contributing

Contributions to improve the integration are welcome! Please feel free to submit a pull request or open an issue on the GitHub repository.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.