mirror of
https://github.com/zjs81/meshcore-open.git
synced 2026-06-17 16:06:28 +10:00
38d40ca0a4
- Updated the _friendlyErrorMessage method in UsbScreen to provide more user-friendly error messages based on specific PlatformException codes. - Added localized error messages for various USB-related errors, improving clarity for users. - Modified the UsbSerialService to rethrow exceptions instead of throwing StateError, allowing for better error propagation. - Updated the usb_flow_test to reflect changes in the USB display label behavior, ensuring the test accurately describes the functionality.
582 lines
20 KiB
Dart
582 lines
20 KiB
Dart
import 'dart:async';
|
|
import 'dart:math' as math;
|
|
|
|
import 'package:flutter/material.dart';
|
|
import 'package:flutter/services.dart';
|
|
import 'package:provider/provider.dart';
|
|
|
|
import '../connector/meshcore_connector.dart';
|
|
import '../connector/meshcore_connector_usb.dart';
|
|
import '../l10n/l10n.dart';
|
|
import '../utils/platform_info.dart';
|
|
import '../utils/usb_port_labels.dart';
|
|
import 'contacts_screen.dart';
|
|
import 'scanner_screen.dart';
|
|
|
|
class UsbScreen extends StatefulWidget {
|
|
const UsbScreen({super.key});
|
|
|
|
@override
|
|
State<UsbScreen> createState() => _UsbScreenState();
|
|
}
|
|
|
|
class _UsbScreenState extends State<UsbScreen> {
|
|
final List<String> _ports = <String>[];
|
|
bool _isLoadingPorts = true;
|
|
bool _isConnecting = false;
|
|
bool _navigatedToContacts = false;
|
|
bool _didScheduleInitialLoad = false;
|
|
String? _selectedPort;
|
|
String? _connectedPortDisplayLabel;
|
|
String? _errorText;
|
|
Timer? _hotPlugTimer;
|
|
late final MeshCoreConnector _connector;
|
|
late final MeshCoreConnectorUsb _usbConnector;
|
|
late final VoidCallback _connectionListener;
|
|
|
|
/// Whether the current platform supports dynamic hot-plug polling.
|
|
/// On desktop (macOS, Windows, Linux) we poll continuously so the user
|
|
/// never needs to hit Refresh manually.
|
|
bool get _supportsHotPlug =>
|
|
PlatformInfo.isWindows || PlatformInfo.isLinux || PlatformInfo.isMacOS;
|
|
|
|
@override
|
|
void initState() {
|
|
super.initState();
|
|
_connector = context.read<MeshCoreConnector>();
|
|
_usbConnector = MeshCoreConnectorUsb(_connector);
|
|
_connectionListener = () {
|
|
if (!mounted) return;
|
|
final activeUsbPortDisplayLabel = _usbConnector.activeUsbPortDisplayLabel;
|
|
final shouldUpdateDisplayLabel =
|
|
activeUsbPortDisplayLabel != _connectedPortDisplayLabel;
|
|
if (_usbConnector.state == MeshCoreConnectionState.disconnected) {
|
|
_navigatedToContacts = false;
|
|
setState(() {
|
|
_isConnecting = false;
|
|
_connectedPortDisplayLabel = activeUsbPortDisplayLabel;
|
|
});
|
|
} else if (shouldUpdateDisplayLabel) {
|
|
setState(() {
|
|
_connectedPortDisplayLabel = activeUsbPortDisplayLabel;
|
|
});
|
|
}
|
|
if (_usbConnector.state == MeshCoreConnectionState.connected &&
|
|
_usbConnector.isUsbTransportConnected &&
|
|
!_navigatedToContacts) {
|
|
_navigatedToContacts = true;
|
|
Navigator.of(context).pushReplacement(
|
|
MaterialPageRoute(builder: (_) => const ContactsScreen()),
|
|
);
|
|
}
|
|
};
|
|
_usbConnector.addListener(_connectionListener);
|
|
_startHotPlugTimer();
|
|
}
|
|
|
|
@override
|
|
void didChangeDependencies() {
|
|
super.didChangeDependencies();
|
|
_usbConnector.setRequestPortLabel(context.l10n.usbScreenStatus);
|
|
if (!_didScheduleInitialLoad) {
|
|
_didScheduleInitialLoad = true;
|
|
unawaited(_loadPorts());
|
|
}
|
|
}
|
|
|
|
@override
|
|
void dispose() {
|
|
_hotPlugTimer?.cancel();
|
|
_hotPlugTimer = null;
|
|
_usbConnector.removeListener(_connectionListener);
|
|
if (!_navigatedToContacts &&
|
|
_usbConnector.activeTransport == MeshCoreTransportType.usb &&
|
|
_usbConnector.state != MeshCoreConnectionState.disconnected) {
|
|
WidgetsBinding.instance.addPostFrameCallback((_) {
|
|
unawaited(_usbConnector.disconnect(manual: true));
|
|
});
|
|
}
|
|
super.dispose();
|
|
}
|
|
|
|
@override
|
|
Widget build(BuildContext context) {
|
|
final theme = Theme.of(context);
|
|
final l10n = context.l10n;
|
|
|
|
return Scaffold(
|
|
appBar: AppBar(
|
|
leading: IconButton(
|
|
icon: const Icon(Icons.arrow_back),
|
|
onPressed: () {
|
|
debugPrint('UsbScreen: back button pressed');
|
|
Navigator.of(context).maybePop();
|
|
},
|
|
),
|
|
title: Text(
|
|
l10n.connectionChoiceUsbLabel,
|
|
style: theme.textTheme.titleLarge,
|
|
),
|
|
centerTitle: true,
|
|
actions: [
|
|
if (PlatformInfo.isWeb ||
|
|
PlatformInfo.isAndroid ||
|
|
PlatformInfo.isIOS)
|
|
TextButton.icon(
|
|
onPressed: () {
|
|
debugPrint(
|
|
'UsbScreen: Bluetooth selected, opening ScannerScreen',
|
|
);
|
|
Navigator.of(context).pushReplacement(
|
|
MaterialPageRoute(builder: (_) => const ScannerScreen()),
|
|
);
|
|
},
|
|
icon: const Icon(Icons.bluetooth),
|
|
label: Text(l10n.connectionChoiceBluetoothLabel),
|
|
),
|
|
],
|
|
),
|
|
body: SafeArea(
|
|
child: LayoutBuilder(
|
|
builder: (context, constraints) {
|
|
final availableHeight = constraints.maxHeight.isFinite
|
|
? constraints.maxHeight
|
|
: 600.0;
|
|
final availableWidth = constraints.maxWidth.isFinite
|
|
? constraints.maxWidth
|
|
: 800.0;
|
|
final gap = math.max(8.0, math.min(16.0, availableHeight * 0.025));
|
|
final iconSize = math.max(
|
|
28.0,
|
|
math.min(72.0, availableHeight * 0.12),
|
|
);
|
|
final isNarrow = availableWidth < 460.0;
|
|
|
|
return Padding(
|
|
padding: const EdgeInsets.symmetric(horizontal: 24, vertical: 20),
|
|
child: Column(
|
|
crossAxisAlignment: CrossAxisAlignment.stretch,
|
|
children: [
|
|
// ── Compact header ──────────────────────────────────────
|
|
Row(
|
|
children: [
|
|
Icon(
|
|
Icons.usb,
|
|
size: iconSize.clamp(24.0, 40.0),
|
|
color: theme.colorScheme.primary,
|
|
),
|
|
SizedBox(width: gap),
|
|
Expanded(
|
|
child: Column(
|
|
crossAxisAlignment: CrossAxisAlignment.start,
|
|
mainAxisSize: MainAxisSize.min,
|
|
children: [
|
|
Text(
|
|
l10n.usbScreenTitle,
|
|
maxLines: 1,
|
|
overflow: TextOverflow.ellipsis,
|
|
style: theme.textTheme.titleLarge?.copyWith(
|
|
fontWeight: FontWeight.w600,
|
|
),
|
|
),
|
|
Text(
|
|
l10n.usbScreenSubtitle,
|
|
maxLines: 2,
|
|
overflow: TextOverflow.ellipsis,
|
|
style: theme.textTheme.bodySmall?.copyWith(
|
|
color: theme.colorScheme.onSurfaceVariant,
|
|
),
|
|
),
|
|
],
|
|
),
|
|
),
|
|
],
|
|
),
|
|
SizedBox(height: gap),
|
|
// ── Port list takes all remaining space ─────────────────
|
|
Expanded(child: _buildPortList(context)),
|
|
if (_errorText != null) ...[
|
|
SizedBox(height: gap * 0.5),
|
|
Text(
|
|
_errorText!,
|
|
textAlign: TextAlign.center,
|
|
maxLines: 3,
|
|
overflow: TextOverflow.ellipsis,
|
|
style: theme.textTheme.bodySmall?.copyWith(
|
|
color: theme.colorScheme.error,
|
|
),
|
|
),
|
|
],
|
|
SizedBox(height: gap),
|
|
// ── Action buttons ──────────────────────────────────────
|
|
if (isNarrow)
|
|
Column(
|
|
crossAxisAlignment: CrossAxisAlignment.stretch,
|
|
children: [
|
|
if (!_supportsHotPlug) ...[
|
|
OutlinedButton.icon(
|
|
onPressed: _isLoadingPorts || _isConnecting
|
|
? null
|
|
: () {
|
|
debugPrint(
|
|
'UsbScreen: refresh ports pressed',
|
|
);
|
|
_loadPorts();
|
|
},
|
|
icon: const Icon(Icons.refresh),
|
|
label: Text(l10n.repeater_refresh),
|
|
),
|
|
SizedBox(height: gap),
|
|
],
|
|
FilledButton.icon(
|
|
onPressed: _canConnect
|
|
? () {
|
|
final rawPortName = normalizeUsbPortName(
|
|
_selectedPort!,
|
|
);
|
|
debugPrint(
|
|
'UsbScreen: connect pressed for $_selectedPort (raw: $rawPortName)',
|
|
);
|
|
_connectSelectedPort();
|
|
}
|
|
: null,
|
|
icon: _isConnecting
|
|
? const SizedBox(
|
|
width: 18,
|
|
height: 18,
|
|
child: CircularProgressIndicator(
|
|
strokeWidth: 2,
|
|
),
|
|
)
|
|
: const Icon(Icons.usb),
|
|
label: Text(l10n.common_connect),
|
|
),
|
|
],
|
|
)
|
|
else
|
|
Row(
|
|
children: [
|
|
if (!_supportsHotPlug) ...[
|
|
Expanded(
|
|
child: OutlinedButton.icon(
|
|
onPressed: _isLoadingPorts || _isConnecting
|
|
? null
|
|
: () {
|
|
debugPrint(
|
|
'UsbScreen: refresh ports pressed',
|
|
);
|
|
_loadPorts();
|
|
},
|
|
icon: const Icon(Icons.refresh),
|
|
label: Text(l10n.repeater_refresh),
|
|
),
|
|
),
|
|
SizedBox(width: gap),
|
|
],
|
|
Expanded(
|
|
child: FilledButton.icon(
|
|
onPressed: _canConnect
|
|
? () {
|
|
final rawPortName = normalizeUsbPortName(
|
|
_selectedPort!,
|
|
);
|
|
debugPrint(
|
|
'UsbScreen: connect pressed for $_selectedPort (raw: $rawPortName)',
|
|
);
|
|
_connectSelectedPort();
|
|
}
|
|
: null,
|
|
icon: _isConnecting
|
|
? const SizedBox(
|
|
width: 18,
|
|
height: 18,
|
|
child: CircularProgressIndicator(
|
|
strokeWidth: 2,
|
|
),
|
|
)
|
|
: const Icon(Icons.usb),
|
|
label: Text(l10n.common_connect),
|
|
),
|
|
),
|
|
],
|
|
),
|
|
SizedBox(height: math.max(4.0, gap * 0.5)),
|
|
Text(
|
|
l10n.usbScreenNote,
|
|
textAlign: TextAlign.center,
|
|
maxLines: 2,
|
|
overflow: TextOverflow.ellipsis,
|
|
style: theme.textTheme.bodySmall?.copyWith(
|
|
color: theme.colorScheme.onSurfaceVariant,
|
|
),
|
|
),
|
|
],
|
|
),
|
|
);
|
|
},
|
|
),
|
|
),
|
|
);
|
|
}
|
|
|
|
bool get _canConnect =>
|
|
!_isLoadingPorts &&
|
|
!_isConnecting &&
|
|
_selectedPort != null &&
|
|
_selectedPort!.isNotEmpty;
|
|
|
|
void _startHotPlugTimer() {
|
|
if (!_supportsHotPlug) return;
|
|
_hotPlugTimer?.cancel();
|
|
_hotPlugTimer = Timer.periodic(const Duration(seconds: 2), (_) {
|
|
_pollHotPlug();
|
|
});
|
|
}
|
|
|
|
Future<void> _pollHotPlug() async {
|
|
// Don't interfere with an active connection attempt or initial load.
|
|
if (_isConnecting || _isLoadingPorts) return;
|
|
if (!mounted) return;
|
|
try {
|
|
final ports = await _connector.listUsbPorts();
|
|
if (!mounted) return;
|
|
final added = ports.where((p) => !_ports.contains(p)).toList();
|
|
final removed = _ports.where((p) => !ports.contains(p)).toList();
|
|
if (added.isEmpty && removed.isEmpty) return;
|
|
setState(() {
|
|
_ports
|
|
..clear()
|
|
..addAll(ports);
|
|
if (_ports.isEmpty) {
|
|
_selectedPort = null;
|
|
} else if (added.isNotEmpty) {
|
|
// Auto-select the newly-connected device.
|
|
_selectedPort = added.first;
|
|
} else if (_selectedPort != null && !_ports.contains(_selectedPort)) {
|
|
// Previously-selected device was unplugged.
|
|
_selectedPort = _ports.isNotEmpty ? _ports.first : null;
|
|
}
|
|
});
|
|
} catch (_) {
|
|
// Silent — hot-plug failures are non-critical.
|
|
}
|
|
}
|
|
|
|
Widget _buildPortList(BuildContext context) {
|
|
final theme = Theme.of(context);
|
|
final l10n = context.l10n;
|
|
|
|
if (_isLoadingPorts) {
|
|
return Center(
|
|
child: Column(
|
|
mainAxisSize: MainAxisSize.min,
|
|
children: [
|
|
const CircularProgressIndicator(),
|
|
const SizedBox(height: 12),
|
|
Text(l10n.common_loading),
|
|
],
|
|
),
|
|
);
|
|
}
|
|
|
|
if (_ports.isEmpty) {
|
|
return Center(
|
|
child: Text(
|
|
l10n.usbScreenEmptyState,
|
|
textAlign: TextAlign.center,
|
|
style: theme.textTheme.bodyMedium?.copyWith(
|
|
color: theme.colorScheme.onSurfaceVariant,
|
|
),
|
|
),
|
|
);
|
|
}
|
|
|
|
return ListView.separated(
|
|
itemCount: _ports.length,
|
|
itemBuilder: (context, index) {
|
|
final port = _ports[index];
|
|
final isSelected = port == _selectedPort;
|
|
final displayName = _friendlyPortName(port);
|
|
final rawName = normalizeUsbPortName(port);
|
|
final showRawName =
|
|
rawName != displayName && !rawName.startsWith('web:');
|
|
return Material(
|
|
color: isSelected
|
|
? theme.colorScheme.primaryContainer
|
|
: theme.colorScheme.surfaceContainerLow,
|
|
borderRadius: BorderRadius.circular(16),
|
|
child: ListTile(
|
|
onTap: _isConnecting
|
|
? null
|
|
: () {
|
|
setState(() {
|
|
_selectedPort = port;
|
|
_errorText = null;
|
|
});
|
|
debugPrint('UsbScreen: selected port $port');
|
|
},
|
|
leading: Icon(
|
|
Icons.usb,
|
|
color: isSelected
|
|
? theme.colorScheme.onPrimaryContainer
|
|
: theme.colorScheme.onSurfaceVariant,
|
|
),
|
|
title: Text(
|
|
displayName,
|
|
maxLines: 1,
|
|
overflow: TextOverflow.ellipsis,
|
|
style: theme.textTheme.titleMedium?.copyWith(
|
|
color: isSelected ? theme.colorScheme.onPrimaryContainer : null,
|
|
),
|
|
),
|
|
subtitle: showRawName
|
|
? Text(
|
|
rawName,
|
|
maxLines: 1,
|
|
overflow: TextOverflow.ellipsis,
|
|
style: theme.textTheme.bodySmall?.copyWith(
|
|
color: isSelected
|
|
? theme.colorScheme.onPrimaryContainer
|
|
: theme.colorScheme.onSurfaceVariant,
|
|
),
|
|
)
|
|
: null,
|
|
trailing: isSelected
|
|
? Icon(
|
|
Icons.check_circle,
|
|
color: theme.colorScheme.onPrimaryContainer,
|
|
)
|
|
: null,
|
|
),
|
|
);
|
|
},
|
|
separatorBuilder: (context, index) => const SizedBox(height: 10),
|
|
);
|
|
}
|
|
|
|
Future<void> _loadPorts() async {
|
|
if (!mounted) return;
|
|
_usbConnector.setRequestPortLabel(context.l10n.usbScreenStatus);
|
|
|
|
setState(() {
|
|
_isLoadingPorts = true;
|
|
_errorText = null;
|
|
});
|
|
|
|
try {
|
|
final ports = await _usbConnector.listPorts();
|
|
if (!mounted) return;
|
|
setState(() {
|
|
_ports
|
|
..clear()
|
|
..addAll(ports);
|
|
if (_ports.isEmpty) {
|
|
_selectedPort = null;
|
|
} else if (!_ports.contains(_selectedPort)) {
|
|
_selectedPort = _ports.first;
|
|
}
|
|
_isLoadingPorts = false;
|
|
});
|
|
} catch (error) {
|
|
if (!mounted) return;
|
|
setState(() {
|
|
_ports.clear();
|
|
_selectedPort = null;
|
|
_errorText = _friendlyErrorMessage(error);
|
|
_isLoadingPorts = false;
|
|
});
|
|
}
|
|
}
|
|
|
|
Future<void> _connectSelectedPort() async {
|
|
final selectedPort = _selectedPort;
|
|
if (selectedPort == null || selectedPort.isEmpty) {
|
|
return;
|
|
}
|
|
_usbConnector.setRequestPortLabel(context.l10n.usbScreenStatus);
|
|
if (_usbConnector.state != MeshCoreConnectionState.disconnected) {
|
|
setState(() {
|
|
_isConnecting = false;
|
|
_errorText = null;
|
|
});
|
|
return;
|
|
}
|
|
final rawPortName = normalizeUsbPortName(selectedPort);
|
|
|
|
setState(() {
|
|
_isConnecting = true;
|
|
_errorText = null;
|
|
});
|
|
|
|
try {
|
|
await _usbConnector.connect(portName: rawPortName);
|
|
} catch (error, stackTrace) {
|
|
debugPrint(
|
|
'UsbScreen: connect failed for $rawPortName: $error\n$stackTrace',
|
|
);
|
|
if (!mounted) return;
|
|
setState(() {
|
|
_isConnecting = false;
|
|
_errorText = _friendlyErrorMessage(error);
|
|
});
|
|
// Re-scan so stale or renamed port entries are cleared from the list.
|
|
unawaited(_loadPorts());
|
|
}
|
|
}
|
|
|
|
String _friendlyErrorMessage(Object error) {
|
|
final l10n = context.l10n;
|
|
if (error is PlatformException) {
|
|
switch (error.code) {
|
|
case 'usb_permission_denied':
|
|
return l10n.usbErrorPermissionDenied;
|
|
case 'usb_device_missing':
|
|
case 'usb_device_detached':
|
|
return l10n.usbErrorDeviceMissing;
|
|
case 'usb_invalid_port':
|
|
return l10n.usbErrorInvalidPort;
|
|
case 'usb_busy':
|
|
return l10n.usbErrorBusy;
|
|
case 'usb_not_connected':
|
|
return l10n.usbErrorNotConnected;
|
|
case 'usb_driver_missing':
|
|
case 'usb_open_failed':
|
|
return l10n.usbErrorOpenFailed;
|
|
case 'usb_connect_failed':
|
|
case 'usb_write_failed':
|
|
case 'usb_io_error':
|
|
return l10n.usbErrorConnectFailed;
|
|
}
|
|
}
|
|
|
|
var msg = error.toString();
|
|
if (msg.startsWith('Bad state: ')) {
|
|
msg = msg.substring('Bad state: '.length);
|
|
} else if (msg.startsWith('Exception: ')) {
|
|
msg = msg.substring('Exception: '.length);
|
|
}
|
|
|
|
switch (msg) {
|
|
case 'USB serial transport is already active':
|
|
return l10n.usbErrorAlreadyActive;
|
|
case 'No USB serial device selected':
|
|
return l10n.usbErrorNoDeviceSelected;
|
|
case 'USB serial port is not open':
|
|
return l10n.usbErrorPortClosed;
|
|
case 'USB serial is not supported on this platform.':
|
|
case 'Web Serial is not supported by this browser.':
|
|
return l10n.usbErrorUnsupported;
|
|
case 'Timed out waiting for SELF_INFO during connect':
|
|
return l10n.usbErrorConnectTimedOut;
|
|
}
|
|
|
|
if (msg.startsWith('Failed to open USB port ')) {
|
|
return l10n.usbErrorOpenFailed;
|
|
}
|
|
|
|
return msg;
|
|
}
|
|
|
|
String _friendlyPortName(String portLabel) => friendlyUsbPortName(portLabel);
|
|
}
|