Skip to content

Latest commit

ย 

History

58 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Ruijie Reyee (Local) for Home Assistant

๐ŸŒ Ruijie Reyee (Local) for Home Assistant

Complete local control for Ruijie Reyee Gateways, managed switches and PoE switches

No cloud โ€ข No subscriptions โ€ข Direct LAN communication.

Version Home Assistant HACS License


โœจ Overview

Ruijie Reyee (Local) is a fully local Home Assistant integration for Reyee EG-series gateways, NBS managed switches and ES-series PoE switches.

Unlike the official cloud integration, this connects directly to your gateway using the built-in eWeb API over your LAN.

โœ” No Cloud Account

โœ” No Internet Required

โœ” Real-time Monitoring

โœ” Full Network Control

โœ” Automatic Discovery

โœ” Switches & PoE Control


๐Ÿš€ Features

๐Ÿ“Š Network Monitoring

  • ๐Ÿ‘ฅ Connected device list with friendly names
  • ๐Ÿ“ Device Trackers for every client
  • ๐ŸŒ VLAN discovery with named networks
  • ๐Ÿ”Œ Live Ethernet port status
  • ๐Ÿ“ถ WAN upload/download throughput
  • ๐ŸŒ Public IP monitoring
  • ๐Ÿ”„ PPPoE reconnect tracking
  • ๐Ÿ“ก Connected APs and switches
  • ๐Ÿ“ถ WiFi SSID monitoring
  • ๐Ÿ” VPN client status
  • ๐Ÿ”€ Active WAN detection
  • ๐ŸŒ Port forwarding list
  • ๐Ÿท Device names from the router's saved device list
  • ๐Ÿ” OpenVPN / L2TP / PPTP server status

๐ŸŽ› Control

Control almost everything directly from Home Assistant.

Feature Supported
๐ŸŒ Primary WAN Switching โœ…
๐Ÿ”„ Forced WAN Failover โœ…
๐Ÿ“ถ WiFi SSID Enable/Disable โœ…
๐Ÿšฆ Flow Control โœ…
โšก WiFi Rate Limiting โœ…
๐Ÿ’ก Gateway LEDs โœ…
๐Ÿ’ก AP LEDs โœ…
๐Ÿšซ Block Internet Access โœ…
๐ŸŒ Port Forward Management โœ…
โšก Hardware NAT โœ…
โ˜Ž SIP ALG โœ…
๐Ÿ“บ IGMP Proxy โœ…
๐Ÿ”— WAN Link Detection โœ…
๐Ÿ“ถ WiFi Load Balancing โœ…

โš™ Buttons

  • ๐Ÿ”„ Refresh Router
  • ๐Ÿ” Deep API Probe

๐Ÿ”€ Switches

Switches live inside your router entry, in their own Switches group:

Settings
โ†’ Devices & Services
โ†’ Ruijie Reyee (Local)
โ†’ + Add switch (on the router entry)
โ†’ pick the switch from the list (or type its IP)

The list shows the switches your router has already found. ES PoE switches need no password (they're managed through the router); for NBS switches leave the password empty to use the router's.

The integration page is split into folding groups:

Group What's in it
๐ŸŒ Router the gateway and all its controls
๐Ÿ”€ Switches every switch, each one clickable to its own ports / PoE / VLAN page
๐Ÿ“ถ Access Points the APs the router sees
๐Ÿ“ฑ Connected Devices every tracked client

To remove a switch, open the Switches group's โ‹ฎ menu โ†’ Reconfigure and tick it. Typing a switch IP into Add Integration also works: it's put into the router's Switches group instead of becoming a separate hub.

Upgrading from v1.24 or older? Switches you added as their own hub are moved into the router's Switches group automatically on the first restart, keeping the same entity IDs. Nothing to delete or re-add.

Switches are read directly when they answer, otherwise through the router (the same way the Reyee web interface manages them).

๐Ÿ–ง NBS Managed Switches

Per port
๐Ÿ”Œ Link up/down (speed, VLANs, traffic, errors, connected devices) โœ…
โป Port enable / disable โœ…
๐Ÿท VLAN (access VLAN / trunk native VLAN) โœ…
๐Ÿ“ Description โœ…
๐Ÿ›ก Port isolation โœ…
๐Ÿ“ˆ RX / TX rate, link speed, CRC errors โœ…
Switch-wide
๐Ÿ” Loop Detection โœ…
๐ŸŒณ Spanning Tree โœ…
๐Ÿ”— LLDP โœ…
๐Ÿ›ก DHCP Snooping โœ…
๐Ÿ“บ IGMP Snooping โœ…
โ˜Ž Voice VLAN โœ…
๐Ÿ—‚ VLAN list, create / delete VLANs โœ…
โš  Loop detected, CRC errors, ports up, uplink port โœ…
๐Ÿ”„ Reboot โœ…

โšก ES-Series PoE Switches

ES switches have no web login of their own. They are managed through the router, so they can be added even though a direct login to them fails.

Per port
๐Ÿ”Œ Link up/down (speed, VLAN, traffic, errors, loop, connected devices) โœ…
โšก PoE on / off โœ…
๐Ÿ” PoE power-cycle (reboot a camera or AP) โœ…
๐Ÿ”‹ PoE power (W), voltage, current, fault โœ…
๐Ÿท VLAN and VLAN mode (access / trunk) โœ…
๐Ÿ“ˆ RX / TX rate โœ…
Switch-wide
๐Ÿ”‹ PoE Power Used / Budget / Remaining (W) โœ…
โฌ† Uplink port detection โœ…
๐Ÿ—‚ VLAN list (creates a VLAN on the switch when needed) โœ…
โš  Loop detected โœ…
๐Ÿ”„ Reboot โœ…

๐Ÿ›ก Safety

  • The uplink port of a switch can't be disabled and its VLAN can't be changed โ€” doing so would cut the switch off from the router.
  • Every change uses the exact request the Reyee web interface sends. If a device rejects a change you get an error and nothing changes.

๐Ÿ“ถ Access Points

Add APs the same way, with + Add AP on the router entry. Tick the APs from the list the router has found; no password is needed (they're read through the router). Each AP's device page in the Access Points group then gets:

Sensor
๐Ÿ‘ฅ Clients (total, plus per 2.4G / 5G), with the client list as an attribute โœ…
๐Ÿ“ก Channel per radio (frequency and bandwidth as attributes) โœ…
๐Ÿ“Š Channel Busy % per radio โœ…
๐Ÿ“ถ Weakest Client Signal (dBm, and which client) โœ…
โฌ†โฌ‡ Data Sent / Data Received โœ…
๐Ÿ”Œ Uplink Speed, TX Power, Noise Floor, Firmware (diagnostic) โœ…

To remove an AP, open the Access Points group's โ‹ฎ menu โ†’ Reconfigure. Tested on RAP2200(E).

๐Ÿ–ฅ Supported Hardware

Tested Hardware

  • โœ… EG105G-V3 (ReyeeOS 2.360.x)
  • โœ… RG-EW3000GX
  • โœ… NBS3100-24GT4SFP-V2 (ReyeeOS 2.380)
  • โœ… RG-ES220GS-P / RG-ES205GC-P (ESW_1.0)
  • โœ… RG-ES210GS-P / RG-ES208GC / RG-ES206GS-P
Model Type Status
EG105G-V3 Gateway โœ… Tested
RG-EW3000GX Gateway โœ… Tested
NBS3100-24GT4SFP-V2 Managed switch โœ… Tested
RG-ES220GS-P PoE switch (16+4) โœ… Tested
RG-ES205GC-P PoE switch (4+1) โœ… Tested
RG-ES210GS-P PoE switch (8+2 SFP) โœ… Supported
RG-ES208GC Switch (8, no PoE) โœ… Supported
RG-ES206GS-P PoE switch (4+2) โœ… Supported
RAP2200(E) Access point โœ… Tested
Other ReyeeOS devices โš ๏ธ Expected to work

Compatible with most EG-series gateways running ReyeeOS 2.x

The integration automatically discovers:

  • VLANs
  • WAN Interfaces
  • Ethernet Ports
  • Access Points
  • Switches
  • Clients

No model-specific configuration required.


๐Ÿ“ฆ Installation

HACS (Recommended)

  1. Open HACS
  2. Integrations
  3. โ‹ฎ โ†’ Custom Repositories
  4. Add
https://github.com/marsh4200/ruijie_reyee

Category:

Integration

Restart Home Assistant.

Then:

Settings
โ†’ Devices & Services
โ†’ Add Integration
โ†’ Ruijie Reyee (Local)

Enter:

  • Gateway IP
  • Username
  • Password

Then add your switches with + Add switch on the router entry (see Switches).


Manual Installation

Copy

custom_components/reyee_local/

into

config/custom_components/

Restart Home Assistant.


๐Ÿ›  Services

Service Purpose
set_primary_wan Switch Primary WAN
set_forced_switch Enable/Disable Failover
set_ssid Enable or Disable SSIDs
set_rate_limit Wireless Speed Limits
block_device Block Internet Access
unblock_device Remove Internet Block
add_port_forward Create Port Forward
remove_port_forward Delete Port Forward
deep_probe Advanced API Diagnostics
set_port_description Switch โ€” set port description
set_port_vlan Switch โ€” set port VLAN (access / trunk / hybrid)
set_port_isolation Switch โ€” port isolation on/off
set_port_rate_limit Switch โ€” port bandwidth limit (kbps)
create_vlan Switch โ€” create a VLAN
delete_vlan Switch โ€” delete a VLAN

โšก Polling

Polling interval is configurable between

10โ€“300 seconds

from the Integration Configure menu.


๐Ÿ”’ How It Works

The integration communicates directly with the gateway's built-in eWeb API.

/cgi-bin/luci/api/
  • Router and NBS switches: /api/cmd (managed switches are reached through the router with remoteIp)
  • ES PoE switches: /api/switch โ†’ doSwitchApi, relayed by the router

Authentication uses the same encrypted login process as the official web interface.

Configuration changes are written locally and automatically verified after the gateway applies them.

No telemetry.

No cloud.

No external services.


โš  Notes

  • EG105G-V3 has no built-in WiFi. Wireless information is collected from the integrated AP Controller.
  • Some APs may display their serial number if topology information is incomplete.
  • Device status depends on the gateway's topology refresh interval.
  • The gateway device is prefixed with its IP address so it stays at the top of Home Assistant's device list.
  • Switch entries need the router entry loaded, because switches are reached through it.
  • RX/TX rate units on switches are reported as kbit/s.

โค๏ธ Why This Integration?

Unlike cloud-based solutions, this integration provides:

  • ๐Ÿ  100% Local
  • โšก Faster Updates
  • ๐Ÿ”’ Better Privacy
  • ๐ŸŒ Works Without Internet
  • ๐Ÿš€ Native Home Assistant Entities
  • ๐Ÿ”ง Nearly Every Router Feature Exposed

๐Ÿ“„ License

Released under the MIT License.

This project is not affiliated with or endorsed by Ruijie Networks.

"Ruijie" and "Reyee" are trademarks of Ruijie Networks Co., Ltd.

Releases

Packages

Contributors

Languages