Flutter插件imc_def的使用方法详解

imc_def

一个用于IMC消息处理的Dart包。

开始使用

这个包既是一个生成器也是一个IMC消息处理包。

IMC定义可以在 这里 找到。

使用包

要使用该包，你需要在你的 pubspec.yaml 文件中添加依赖项：

情况一：使用预生成的包

dependencies:
   imc_def: ^x.x.x

然后运行 flutter pub get。

情况二：使用源码来自动生成代码

在你的项目 pubspec.yaml 文件中添加配置，或者在项目的根目录下创建一个名为 imc_def.yaml 的文件，并添加你的设置。

imc_def:
  imc: <path_to_imc_file_definitions>
  githash: <git repo owner>@<git hash reduced> # 请添加这些信息（例如对于LSTS来说就是 'lsts@f19a343'）
  # package: imc # 可选，将在 `src` 目录下创建包

添加完设置后，运行以下命令：

flutter pub run imc_def:imc_generator

在你的代码中导入包：

import 'package:imc_def/imc_def.dart' as imc;

或者如果你正在生成代码：

import 'package:<project_name>/src/<package>/imc_def.dart' as imc;

示例代码

下面是一个简单的示例代码：

import 'dart:async';
import 'dart:io';
import 'dart:typed_data';

import 'package:imc_def/imc_def.dart' as imc;

void main() async {
  imc.alternativeSyncNumbers = [0x0102];

  await RawDatagramSocket.bind(InternetAddress.anyIPv4, 4444)
      .then((RawDatagramSocket socket) {
    print('Datagram socket ready to receive');
    print('${socket.address.address}:${socket.port}');
    socket.listen((RawSocketEvent e) {
      Datagram? d = socket.receive();
      if (d == null) return;

      try {
        var data = d.data;
        var uData = Uint8List.fromList(data);
        var bData = uData.buffer.asByteData();
        var (msgId, syncNumber) =
            imc.getMessageIdFromHeaderIfSyncNumberOk(bData, 0);
        var bytesSerStr = " [";
        for (var b in uData) {
          bytesSerStr += "0x${b.toRadixString(16)}, ";
        }
        bytesSerStr += "]";
        print(
            "SyncNumber: 0x${syncNumber?.toRadixString(16).padLeft(4, '0').toUpperCase()}  "
            "|  Msg ID: $msgId\nsize=${uData.lengthInBytes} | $bytesSerStr");
        if (msgId == imc.ImcId.nullId) return;

        var serializer = imc
            .messagesSerializers[imc.idsToMessages[msgId] ?? imc.ImcId.nullId]
            ?.call();
        print("Msg Serializer: $serializer");
        if (serializer == null) return;

        var msg = serializer.deserialize(uData);
        print('Datagram from ${d.address.address}:${d.port}: \n$msg');
      } catch (e) {
        print("Error: $e");
      }
    });

    var hbMsgB = imc.HeartbeatBuilder()
      ..src = 0x16
      ..dst = 0x17;
    var dstEnt = 0;
    Timer.periodic(Duration(milliseconds: 300), (Timer t) {
      var msg = (hbMsgB
            ..timestamp = DateTime.now()
            ..dstEnt = dstEnt++ & 0xFF)
          .build();
      var dataB =
          imc.messagesIdsSerializers[msg.msgId]?.call().serialize(msg, 0x0102);
      var bytes =
          dataB?.buffer.asUint8List(dataB.offsetInBytes, dataB.lengthInBytes);
      if (dataB != null && bytes != null) {
        var bs = socket.send(bytes, InternetAddress("0.0.0.0"), 4444);
        print(
            "Bytes sent $bs | ${dataB.offsetInBytes}, ${dataB.lengthInBytes}");
      }
    });
  });
}