lib/control/scanner_controller.dart


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

// Copyright (C) 2025, uvok cheetah
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

import 'dart:async';

import 'package:uvok_epaper_badge/model/device/device.dart';

/// Represents the scan status.
enum ScanStatus { idle, scanning, finished, error }

enum ScanAvailability { unavailable, available }

/// Represents a scanner controller.
/// It emits devices which may be connected to later.
abstract interface class ScannerController {
  Stream<List<Device>> get scanResultsStream;
  Stream<ScanStatus> get statusStream;
  Stream<ScanAvailability> get availabilityStream;

  Future<void> startScan({Duration timeout});
  Future<void> stopScan();
  void dispose();
}