imc_def 5.0.1 copy "imc_def: ^5.0.1" to clipboard
imc_def: ^5.0.1 copied to clipboard

This package is a Dart package for IMC messages manipulation. IMC is an open source message protocol specification from UPorto-FEUP-LSTS (https://github.com/LSTS/imc).

imc_def #

pub package

A dart package for IMC messages manipulation.

Getting Started #

This package is both a generator and an IMC messages manipulation package.

The IMC definition is found here.

Using the package #

To use you need to import into your pubspec.yaml such as:

  • In case to use the package with the bundle generated IMC
dependencies:
   imc_def: ^x.x.x

Don't forget to flutter pub get.

  • In case you want to use the source to generate your own code add your settings to your project's pubspec.yaml file or create a file in your root project folder named imc_def.yaml with your settings.
imc_def:
  imc: <path_to_imc_file_definitions>
  githash: <git repo owner>@<git hash reduced> # please add this info (example for LSTS would be 'lsts@f19a343')
  # package: imc # optional, will create in src inside the folder(s)

After adding your settings, run the package with

flutter pub run imc_def:imc_generator

In your code just import:

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

or if generating:

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

An example of use is the following:

...
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);
  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}");
  }
});
...

To use alternative sync numbers also do:

...
imc.alternativeSyncNumbers = [0x0102];
...
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}");
  }
});
...
0
likes
140
pub points
3%
popularity

Publisher

unverified uploader

This package is a Dart package for IMC messages manipulation. IMC is an open source message protocol specification from UPorto-FEUP-LSTS (https://github.com/LSTS/imc).

Repository (GitHub)
View/report issues

Documentation

API reference

License

BSD-3-Clause (license)

Dependencies

collection, crypto, xml, yaml

More

Packages that depend on imc_def