mirror of
https://github.com/ruvnet/RuView
synced 2026-08-03 19:21:42 +00:00
chore(repo): move v1/ → archive/v1/ + add archive/README.md (#430)
The Rust port at v2/ has been the primary codebase since the rename in #427. The Python implementation at v1/ is no longer the active target; the only load-bearing path is the deterministic proof bundle at v1/data/proof/ (per ADR-011 / ADR-028 witness verification). Move the whole Python tree into archive/v1/ and document the policy in archive/README.md: no new features, bug fixes only when they affect a still-load-bearing path (currently just the proof), CI continues to verify the proof on every push and PR. Path references updated in 26 files via path-pattern sed (only matches v1/<known-child> patterns, never bare v1 or API URLs like /api/v1/). Two double-prefix typos (archive/archive/v1/) caught and hand-fixed in verify-pipeline.yml and ADR-011. Validated: - Python proof verify.py imports cleanly at archive/v1/data/proof/ (numpy/scipy still required; CI installs requirements-lock.txt from archive/v1/ now) - cargo test --workspace --no-default-features → 1,539 passed, 0 failed, 8 ignored (unaffected by Python tree relocation) - ESP32-S3 on COM7 untouched (no firmware paths changed) After-merge: contributors should re-run any local `python v1/...` commands as `python archive/v1/...` (CLAUDE.md and CHANGELOG already updated).
This commit is contained in:
rUv
@@ -0,0 +1,241 @@
|
||||
"""Router interface for WiFi-DensePose system using TDD approach."""
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
from typing import Dict, Any, Optional
|
||||
import asyncssh
|
||||
from datetime import datetime, timezone
|
||||
import numpy as np
|
||||
|
||||
try:
|
||||
from .csi_extractor import CSIData
|
||||
except ImportError:
|
||||
# Handle import for testing
|
||||
from src.hardware.csi_extractor import CSIData
|
||||
|
||||
|
||||
class RouterConnectionError(Exception):
|
||||
"""Exception raised for router connection errors."""
|
||||
pass
|
||||
|
||||
|
||||
class RouterInterface:
|
||||
"""Interface for communicating with WiFi routers via SSH."""
|
||||
|
||||
def __init__(self, config: Dict[str, Any], logger: Optional[logging.Logger] = None):
|
||||
"""Initialize router interface.
|
||||
|
||||
Args:
|
||||
config: Configuration dictionary with connection parameters
|
||||
logger: Optional logger instance
|
||||
|
||||
Raises:
|
||||
ValueError: If configuration is invalid
|
||||
"""
|
||||
self._validate_config(config)
|
||||
|
||||
self.config = config
|
||||
self.logger = logger or logging.getLogger(__name__)
|
||||
|
||||
# Connection parameters
|
||||
self.host = config['host']
|
||||
self.port = config['port']
|
||||
self.username = config['username']
|
||||
self.password = config['password']
|
||||
self.command_timeout = config.get('command_timeout', 30)
|
||||
self.connection_timeout = config.get('connection_timeout', 10)
|
||||
self.max_retries = config.get('max_retries', 3)
|
||||
self.retry_delay = config.get('retry_delay', 1.0)
|
||||
|
||||
# Connection state
|
||||
self.is_connected = False
|
||||
self.ssh_client = None
|
||||
|
||||
def _validate_config(self, config: Dict[str, Any]) -> None:
|
||||
"""Validate configuration parameters.
|
||||
|
||||
Args:
|
||||
config: Configuration to validate
|
||||
|
||||
Raises:
|
||||
ValueError: If configuration is invalid
|
||||
"""
|
||||
required_fields = ['host', 'port', 'username', 'password']
|
||||
missing_fields = [field for field in required_fields if field not in config]
|
||||
|
||||
if missing_fields:
|
||||
raise ValueError(f"Missing required configuration: {missing_fields}")
|
||||
|
||||
if not isinstance(config['port'], int) or config['port'] <= 0:
|
||||
raise ValueError("Port must be a positive integer")
|
||||
|
||||
async def connect(self) -> bool:
|
||||
"""Establish SSH connection to router.
|
||||
|
||||
Returns:
|
||||
True if connection successful, False otherwise
|
||||
"""
|
||||
try:
|
||||
self.ssh_client = await asyncssh.connect(
|
||||
self.host,
|
||||
port=self.port,
|
||||
username=self.username,
|
||||
password=self.password,
|
||||
connect_timeout=self.connection_timeout
|
||||
)
|
||||
self.is_connected = True
|
||||
self.logger.info(f"Connected to router at {self.host}:{self.port}")
|
||||
return True
|
||||
except Exception as e:
|
||||
self.logger.error(f"Failed to connect to router: {e}")
|
||||
self.is_connected = False
|
||||
self.ssh_client = None
|
||||
return False
|
||||
|
||||
async def disconnect(self) -> None:
|
||||
"""Disconnect from router."""
|
||||
if self.is_connected and self.ssh_client:
|
||||
self.ssh_client.close()
|
||||
self.is_connected = False
|
||||
self.ssh_client = None
|
||||
self.logger.info("Disconnected from router")
|
||||
|
||||
async def execute_command(self, command: str) -> str:
|
||||
"""Execute command on router via SSH.
|
||||
|
||||
Args:
|
||||
command: Command to execute
|
||||
|
||||
Returns:
|
||||
Command output
|
||||
|
||||
Raises:
|
||||
RouterConnectionError: If not connected or command fails
|
||||
"""
|
||||
if not self.is_connected:
|
||||
raise RouterConnectionError("Not connected to router")
|
||||
|
||||
# Retry mechanism for temporary failures
|
||||
for attempt in range(self.max_retries):
|
||||
try:
|
||||
result = await self.ssh_client.run(command, timeout=self.command_timeout)
|
||||
|
||||
if result.returncode != 0:
|
||||
raise RouterConnectionError(f"Command failed: {result.stderr}")
|
||||
|
||||
return result.stdout
|
||||
|
||||
except ConnectionError as e:
|
||||
if attempt < self.max_retries - 1:
|
||||
self.logger.warning(f"Command attempt {attempt + 1} failed, retrying: {e}")
|
||||
await asyncio.sleep(self.retry_delay)
|
||||
else:
|
||||
raise RouterConnectionError(f"Command execution failed after {self.max_retries} retries: {e}")
|
||||
except Exception as e:
|
||||
raise RouterConnectionError(f"Command execution error: {e}")
|
||||
|
||||
async def get_csi_data(self) -> CSIData:
|
||||
"""Retrieve CSI data from router.
|
||||
|
||||
Returns:
|
||||
CSI data structure
|
||||
|
||||
Raises:
|
||||
RouterConnectionError: If data retrieval fails
|
||||
"""
|
||||
try:
|
||||
response = await self.execute_command("iwlist scan | grep CSI")
|
||||
return self._parse_csi_response(response)
|
||||
except Exception as e:
|
||||
raise RouterConnectionError(f"Failed to retrieve CSI data: {e}")
|
||||
|
||||
async def get_router_status(self) -> Dict[str, Any]:
|
||||
"""Get router system status.
|
||||
|
||||
Returns:
|
||||
Dictionary containing router status information
|
||||
|
||||
Raises:
|
||||
RouterConnectionError: If status retrieval fails
|
||||
"""
|
||||
try:
|
||||
response = await self.execute_command("cat /proc/stat && free && iwconfig")
|
||||
return self._parse_status_response(response)
|
||||
except Exception as e:
|
||||
raise RouterConnectionError(f"Failed to retrieve router status: {e}")
|
||||
|
||||
async def configure_csi_monitoring(self, config: Dict[str, Any]) -> bool:
|
||||
"""Configure CSI monitoring on router.
|
||||
|
||||
Args:
|
||||
config: CSI monitoring configuration
|
||||
|
||||
Returns:
|
||||
True if configuration successful, False otherwise
|
||||
"""
|
||||
try:
|
||||
channel = config.get('channel', 6)
|
||||
# Validate channel is an integer in a safe range to prevent command injection
|
||||
if not isinstance(channel, int) or not (1 <= channel <= 196):
|
||||
raise ValueError(f"Invalid WiFi channel: {channel}. Must be an integer between 1 and 196.")
|
||||
command = f"iwconfig wlan0 channel {channel} && echo 'CSI monitoring configured'"
|
||||
await self.execute_command(command)
|
||||
return True
|
||||
except Exception as e:
|
||||
self.logger.error(f"Failed to configure CSI monitoring: {e}")
|
||||
return False
|
||||
|
||||
async def health_check(self) -> bool:
|
||||
"""Perform health check on router.
|
||||
|
||||
Returns:
|
||||
True if router is healthy, False otherwise
|
||||
"""
|
||||
try:
|
||||
response = await self.execute_command("echo 'ping' && echo 'pong'")
|
||||
return "pong" in response
|
||||
except Exception as e:
|
||||
self.logger.error(f"Health check failed: {e}")
|
||||
return False
|
||||
|
||||
def _parse_csi_response(self, response: str) -> CSIData:
|
||||
"""Parse CSI response data.
|
||||
|
||||
Args:
|
||||
response: Raw response from router
|
||||
|
||||
Returns:
|
||||
Parsed CSI data
|
||||
|
||||
Raises:
|
||||
RouterConnectionError: Always in current state, because real CSI
|
||||
parsing from router command output requires hardware-specific
|
||||
format knowledge that must be implemented per router model.
|
||||
"""
|
||||
raise RouterConnectionError(
|
||||
"Real CSI data parsing from router responses is not yet implemented. "
|
||||
"Collecting CSI data from a router requires: "
|
||||
"(1) a router with CSI-capable firmware (e.g., Atheros CSI Tool, Nexmon), "
|
||||
"(2) proper hardware setup and configuration, and "
|
||||
"(3) a parser for the specific binary/text format produced by the firmware. "
|
||||
"See docs/hardware-setup.md for instructions on configuring your router for CSI collection."
|
||||
)
|
||||
|
||||
def _parse_status_response(self, response: str) -> Dict[str, Any]:
|
||||
"""Parse router status response.
|
||||
|
||||
Args:
|
||||
response: Raw response from router
|
||||
|
||||
Returns:
|
||||
Parsed status information
|
||||
"""
|
||||
# Mock implementation for testing
|
||||
# In real implementation, this would parse actual system status
|
||||
return {
|
||||
'cpu_usage': 25.5,
|
||||
'memory_usage': 60.2,
|
||||
'wifi_status': 'active',
|
||||
'uptime': '5 days, 3 hours',
|
||||
'raw_response': response
|
||||
}
|
||||
Reference in New Issue
Block a user