8. BLE

universal_ble で DualGY521_M5Stamp につなぐ

この章のゴール

1

周辺を検索

どの PC でも試せる

2

実機のセンサ

コマンド送信とデータ解析

3

切り替え

選んだデバイスで測定する

パッケージの選定

パッケージ ライセンス 対応 OS
universal_ble BSD-3(無償) Android / iOS / macOS / Windows / Linux / Web
flutter_blue_plus 2.x 独自(営利は有償) Android / iOS / macOS など

flutter_blue_plus のライセンス

2.0 から、営利団体は開発・評価の段階から有償ライセンスが必要になりました。この講座では universal_ble を使います。

flutter pub add universal_ble

DualGY521_M5Stamp の仕様

項目 内容
デバイス名 DualGY521_M5Stamp
サービス / キャラクタリスティック 1つ。コマンドの書き込みと、データの通知の両方に使う
測定開始 / 停止 0x01, 0x00 / 0x01, 0x01 を書き込む
測定データ 52 byte を 100Hz で通知(次のスライド)
ペアリング PIN 123456(暗号化された通信)

測定データ(52 byte)

byte 内容 型
0-1 識別子 0x01, 0x01 —
2-3 パケット番号 uint16
4-15 センサ1 加速度 x, y, z [g] float32 ×3
16-27 センサ1 角速度 x, y, z [dps] float32 ×3
28-39 センサ2 加速度 float32 ×3
40-51 センサ2 角速度 float32 ×3
  • すべてリトルエンディアン。機器情報などの 文字列の応答も同じ通知で届く ので、形で見分ける

権限の設定

macOS / iOS — Info.plist

<key>NSBluetoothAlwaysUsageDescription</key>
<string>センサと通信するためにBluetoothを使用します。</string>

macOS — *.entitlements(Debug と Release)

<key>com.apple.security.device.bluetooth</key>
<true/>
android/app/src/main/AndroidManifest.xml
<uses-permission android:name="android.permission.BLUETOOTH_SCAN"
                 android:usesPermissionFlags="neverForLocation" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
<uses-permission android:name="android.permission.BLUETOOTH" android:maxSdkVersion="30" />
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" android:maxSdkVersion="30" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" android:maxSdkVersion="30" />

周辺のデバイスを検索する

lib/service/imu/ble_scanner.dart
import 'dart:async';

import 'package:universal_ble/universal_ble.dart';

// 周辺のBLEデバイスを一定時間スキャンして返す(名前のあるものだけ)
class BleScanner {
  Future<List<BleDevice>> scan({Duration duration = const Duration(seconds: 3)}) async {
    final found = <String, BleDevice>{};
    final sub = UniversalBle.scanStream.listen((device) {
      if ((device.name ?? '').isNotEmpty) found[device.deviceId] = device;
    });
    try {
      await UniversalBle.startScan(); // 権限の要求も自動で行われる
      await Future.delayed(duration);
    } finally {
      await UniversalBle.stopScan();
      await sub.cancel();
    }
    return found.values.toList()
      ..sort((a, b) => (b.rssi ?? -999).compareTo(a.rssi ?? -999)); // 電波の強い順
  }
}

データを解析する

lib/service/imu/imu_packet.dart
import 'dart:typed_data';

import 'package:motion_app/service/imu/imu_device.dart';

// DualGY521_M5Stamp が 100Hz で送ってくる測定データ(52byte)の解析
//   0-1  : 識別子 0x01, 0x01
//   2-3  : パケット番号 (uint16)
//   4-15 : センサ1 加速度 x,y,z (float32 ×3, g)
//   16-27: センサ1 角速度 x,y,z (float32 ×3, dps)
//   28-39: センサ2 加速度
//   40-51: センサ2 角速度
// すべてリトルエンディアン
abstract final class ImuPacket {
  static const int length = 52;

  // 測定データでなければ null(機器情報などの文字列の応答も同じ通知で届くため)
  static ImuSample? tryParse(Uint8List bytes) {
    if (bytes.length != length || bytes[0] != 0x01 || bytes[1] != 0x01) {
      return null;
    }
    final data = ByteData.sublistView(bytes);
    Vec3 vec(int offset) => Vec3(
          data.getFloat32(offset, Endian.little),
          data.getFloat32(offset + 4, Endian.little),
          data.getFloat32(offset + 8, Endian.little),
        );
    return ImuSample(
      count: data.getUint16(2, Endian.little),
      acc1: vec(4),
      gyro1: vec(16),
      acc2: vec(28),
      gyro2: vec(40),
    );
  }
}
  • 通信とは切り離した 純粋な関数 にしておくと、実機なしでテストできる(11章)

実機のセンサ

lib/service/imu/dual_gy521_device.dart
import 'dart:async';
import 'dart:io';
import 'dart:typed_data';

import 'package:universal_ble/universal_ble.dart';
import 'package:motion_app/service/imu/imu_device.dart';
import 'package:motion_app/service/imu/imu_packet.dart';

// DualGY521_M5Stamp(6軸センサ×2、BLE)
// 1つのキャラクタリスティックで、コマンドの書き込みと測定データの通知を行う
class DualGy521Device implements ImuDevice {
  DualGy521Device(this.deviceId);

  final String deviceId;
  static final _service =
      BleUuidParser.string('4fafc201-1fb5-459e-8fcc-c5c9c331914b');
  static final _chara =
      BleUuidParser.string('beb5483e-36e1-4688-b7f5-ea07361b26a8');
  static final _startCommand = Uint8List.fromList([0x01, 0x00]); // 連続測定開始
  static final _stopCommand = Uint8List.fromList([0x01, 0x01]); // 連続測定停止

  final _controller = StreamController<ImuSample>.broadcast();
  StreamSubscription<Uint8List>? _valueSub;
  bool _connected = false;

  @override
  Stream<ImuSample> get samples => _controller.stream;

  @override
  Future<void> start() async {
    if (!_connected) {
      await UniversalBle.connect(deviceId);
      await UniversalBle.discoverServices(deviceId); // 通知の有効化の前に必要
      if (Platform.isAndroid) {
        // 52byte のデータが1回で届くよう、通信サイズ(MTU)を広げる(iOS/macOS は自動)
        await UniversalBle.requestMtu(deviceId, 128);
      }
      _valueSub = UniversalBle.characteristicValueStream(deviceId, _chara)
          .listen(_onValue);
      // 暗号化された通信のため、初回は OS のペアリング画面で PIN(123456)を入力する
      await UniversalBle.subscribeNotifications(deviceId, _service, _chara);
      _connected = true;
    }
    await UniversalBle.write(deviceId, _service, _chara, _startCommand);
  }

  void _onValue(Uint8List value) {
    final sample = ImuPacket.tryParse(value);
    if (sample != null) _controller.add(sample);
  }

  @override
  Future<void> stop() async {
    if (!_connected) return;
    await UniversalBle.write(deviceId, _service, _chara, _stopCommand);
  }

  @override
  Future<void> dispose() async {
    await _valueSub?.cancel();
    if (_connected) await UniversalBle.disconnect(deviceId);
    await _controller.close();
  }
}

universal_ble のポイント

  • 命令(接続・探索・通知の有効化・書き込み)は 自動で順番に実行 される
  • すべての命令に既定 10 秒のタイムアウトがある
  • 通知を受けるには、先に discoverServices が必要
  • 52 byte を1回で受け取るため、Android は requestMtu で通信サイズを広げる(iOS/macOS は自動)
  • 初回は OS のペアリング画面が出るので、PIN 123456 を入力する

偽物と実機を切り替える

lib/provider/providers.dart
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:motion_app/domain/save_session_usecase.dart';
import 'package:motion_app/infrastructure/database/app_database.dart';
import 'package:motion_app/repository/session/session_repository.dart';
import 'package:motion_app/repository/user/user_repository.dart';
import 'package:motion_app/service/imu/ble_scanner.dart';
import 'package:motion_app/service/imu/dual_gy521_device.dart';
import 'package:motion_app/service/imu/fake_imu_device.dart';
import 'package:motion_app/service/imu/imu_device.dart';

part 'providers.g.dart';

@Riverpod(keepAlive: true)
AppDatabase appDatabase(Ref ref) {
  final db = AppDatabase();
  ref.onDispose(db.close);
  return db;
}

@Riverpod(keepAlive: true)
UserRepository userRepository(Ref ref) =>
    UserRepository(ref.watch(appDatabaseProvider));

@Riverpod(keepAlive: true)
SessionRepository sessionRepository(Ref ref) =>
    SessionRepository(ref.watch(appDatabaseProvider));

// 使うセンサのBLEデバイスID。null なら偽物のセンサを使う
@Riverpod(keepAlive: true)
class SelectedBleDevice extends _$SelectedBleDevice {
  @override
  String? build() => null;

  void select(String? deviceId) => state = deviceId;
}

// 6軸センサ。デバイスが選ばれていればBLE、なければ偽物
@Riverpod(keepAlive: true)
ImuDevice imuDevice(Ref ref) {
  final deviceId = ref.watch(selectedBleDeviceProvider);
  final ImuDevice device =
      deviceId == null ? FakeImuDevice() : DualGy521Device(deviceId);
  ref.onDispose(device.dispose);
  return device;
}

@Riverpod(keepAlive: true)
BleScanner bleScanner(Ref ref) => BleScanner();

// センサのデータを Riverpod で購読できるようにする
@riverpod
Stream<ImuSample> imuSample(Ref ref) => ref.watch(imuDeviceProvider).samples;

@Riverpod(keepAlive: true)
SaveSessionUseCase saveSessionUseCase(Ref ref) => SaveSessionUseCase(
      sessionRepository: ref.watch(sessionRepositoryProvider),
    );
  • ref.watch(selectedBleDeviceProvider) → 選択が変わるとセンサも作り直される

デバイス画面

lib/ui/device/view/device_page.dart
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:motion_app/provider/providers.dart';
import 'package:motion_app/ui/device/view_model/device_view_model.dart';

class DevicePage extends ConsumerWidget {
  const DevicePage({super.key});

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    final state = ref.watch(deviceViewModelProvider);
    final notifier = ref.read(deviceViewModelProvider.notifier);
    final selectedId = ref.watch(selectedBleDeviceProvider);

    return Scaffold(
      appBar: AppBar(title: const Text('デバイス')),
      floatingActionButton: FloatingActionButton.extended(
        icon: const Icon(Icons.bluetooth_searching),
        label: Text(state.isScanning ? '検索中...' : '検索'),
        onPressed: state.isScanning ? null : notifier.scan,
      ),
      body: RadioGroup<String?>(
        groupValue: selectedId,
        onChanged: notifier.select,
        child: ListView(
          children: [
            const RadioListTile<String?>(
              value: null,
              title: Text('偽物のセンサ(実機なし)'),
            ),
            if (state.errorMessage != null)
              ListTile(title: Text(state.errorMessage!)),
            for (final device in state.devices)
              RadioListTile<String?>(
                value: device.deviceId,
                title: Text(device.name ?? ''),
                subtitle: Text('${device.deviceId}  RSSI ${device.rssi ?? '-'}'),
              ),
          ],
        ),
      ),
    );
  }
}

デバイス画面の ViewModel

lib/ui/device/view_model/device_view_model.dart
import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:motion_app/provider/providers.dart';
import 'package:universal_ble/universal_ble.dart';

part 'device_view_model.g.dart';
part 'device_view_model.freezed.dart';

@freezed
abstract class DeviceState with _$DeviceState {
  const factory DeviceState({
    @Default([]) List<BleDevice> devices,
    @Default(false) bool isScanning,
    String? errorMessage,
  }) = _DeviceState;
}

@riverpod
class DeviceViewModel extends _$DeviceViewModel {
  @override
  DeviceState build() => const DeviceState();

  Future<void> scan() async {
    state = state.copyWith(isScanning: true, errorMessage: null);
    try {
      final devices = await ref.read(bleScannerProvider).scan();
      state = state.copyWith(devices: devices, isScanning: false);
    } catch (e) {
      state = state.copyWith(isScanning: false, errorMessage: '$e');
    }
  }

  void select(String? deviceId) =>
      ref.read(selectedBleDeviceProvider.notifier).select(deviceId);
}

ルーターに追加

lib/router/router.dart
import 'package:go_router/go_router.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:motion_app/ui/device/view/device_page.dart';
import 'package:motion_app/ui/home/view/home_page.dart';
import 'package:motion_app/ui/measurement/view/measurement_page.dart';
import 'package:motion_app/ui/user_detail/view/user_detail_page.dart';
import 'package:motion_app/ui/user_list/view/user_list_page.dart';

part 'router.g.dart';

// パスは定数にまとめ、文字列の打ち間違いを防ぐ
abstract final class Routes {
  static const home = '/';
  static const users = '/users';
  static const device = '/device';
  static String userDetail(String userId) => '/users/$userId';
  static String measurement(String userId) => '/users/$userId/measure';
}

@Riverpod(keepAlive: true)
GoRouter router(Ref ref) {
  return GoRouter(
    initialLocation: Routes.home,
    routes: [
      GoRoute(
        path: Routes.home,
        builder: (context, state) => const HomePage(),
        routes: [
          GoRoute(
            path: 'device',
            builder: (context, state) => const DevicePage(),
          ),
          GoRoute(
            path: 'users', // 子ルートは先頭に / を付けない
            builder: (context, state) => const UserListPage(),
            routes: [
              GoRoute(
                path: ':userId',
                builder: (context, state) => UserDetailPage(
                  userId: state.pathParameters['userId']!,
                ),
                routes: [
                  GoRoute(
                    path: 'measure',
                    builder: (context, state) => MeasurementPage(
                      userId: state.pathParameters['userId']!,
                    ),
                  ),
                ],
              ),
            ],
          ),
        ],
      ),
    ],
  );
}

ホームに「デバイス」を追加

lib/ui/home/view/home_page.dart
import 'package:flutter/material.dart';
import 'package:go_router/go_router.dart';
import 'package:motion_app/router/router.dart';

class HomePage extends StatelessWidget {
  const HomePage({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Motion Note')),
      body: ListView(
        padding: const EdgeInsets.all(16),
        children: [
          Card(
            child: ListTile(
              leading: const Icon(Icons.people),
              title: const Text('ユーザー'),
              trailing: const Icon(Icons.chevron_right),
              onTap: () => context.push(Routes.users),
            ),
          ),
          Card(
            child: ListTile(
              leading: const Icon(Icons.bluetooth),
              title: const Text('デバイス'),
              trailing: const Icon(Icons.chevron_right),
              onTap: () => context.push(Routes.device),
            ),
          ),
        ],
      ),
    );
  }
}

チェックポイント

CHECK 0 / 4