srec 1.1.0

A Dart library that can read and write Motorola S-Record files. The Motorola S-Record is a file format that contains binary information as ASCII text.

example/README.md

Example files

The full source code for the examples can be found in the examples directory in github.

Motorola S-record file linter

The file "srec_lint.dart" contains all the code you need to validate that a Motorola S-record contains no errors. The program reads a file, and parses all records until the end of the file. If there is any type of error (checksum not valid, wrong record block, wrong characters...) an exception is thrown.

The example condensed into a few lines:

import 'package:srec/srec.dart';

try {
  var file = File(path).readAsStringSync();
  var srec = SRecordFile.fromString(file);
} catch (e) {
  // handle error
}

Motorola S-record file converter

The file "convert_to_srec.dart" contains all the code you need to convert binary data to a Motorola S-record file.

The example condensed into a few lines:

import 'package:srec/srec.dart';

List<int> data = /* fill data */;
var srec = SRecordFile.fromData(data);
var hexString = srec.toFileContents();

Convert a Motorola S-record file to a binary file

The file "convert_to_binary.dart" contains all the code you need to convert a Motorola S-record file to binary data.

The example condensed into a few lines of code:

import 'package:srec/srec.dart';

var file = File(path).readAsStringSync();
var srec = SRecordFile.fromString(file);
var data = Uint8List(srec.maxAddress);
for (final seg in srec.segments) {
  for (int i = seg.address; i < seg.endAddress; ++i) {
    data[i] = seg.byte(i);
  }
}
File(outfile).writeAsBytesSync(data);

This code snippet will fill any gaps between the segments with 0 bytes.

Try the executables

You can try the example executables with a few simple commands in the project root directory:

# Runs the linter on an invalid file - will display an error and return a nonzero value
dart ./example/srec_lint.dart ./example/srec_lint.dart
# Converts a file to Motorola s-record
dart ./example/convert_to_srec.dart ./example/convert_to_srec.dart
# Runs the linter on a valid file
dart ./example/srec_lint.dart ./example/convert_to_srec.dart.srec
# converts the srec to a binary file
dart ./example/convert_to_binary.dart ./example/convert_to_srec.dart.srec