Initial Release

Author: globi

.gitignore

@@ -0,0 +1,7 @@
+# https://dart.dev/guides/libraries/private-files
+# Created by `dart pub`
+.dart_tool/
+
+# Avoid committing pubspec.lock for library packages; see
+# https://dart.dev/guides/libraries/private-files#pubspeclock.
+pubspec.lock

CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0
+
+- Initial version.

README.md

@@ -0,0 +1,52 @@
+Port of the TinyFrame C library from https://github.com/MightyPork/TinyFrame
+
+Used an automated code conversion tool from to port https://github.com/MightyPork/PonyFrame from python to dart with some minor modifications
+
+## Features
+
+TinyFrame is a simple library for building and parsing data frames to be sent over a serial interface (e.g. UART, telnet, socket). 
+
+## Usage
+
+### Master
+```dart
+import 'dart:typed_data';
+import 'package:tiny_frame/tiny_frame.dart';
+
+void write(Uint8List data) => print('write: $data');
+void main() {
+  const mainID = 1;
+  // create a TinyFrame instance as master (peer id set)
+  // the write method has to be implemented, tinyframe will call it
+  // to send the data after building the frame
+  final tf = TinyFrame(write);
+  // some optional settings
+  tf.cksumType = 'xor';
+  // generate a listener for the id 1
+  tf.addIdListener(mainID, (Uint8List frame) => print('main: $frame'));
+  // if no listener is found for the id, this listener will be called
+  tf.addFallbackListener((Uint8List frame) => print('fallback: $frame'));
+  // send to slave on id 1
+  tf.send(mainID, Uint8List.fromList('abcde'.codeUnits));
+}
+```
+
+### Slave
+
+## TinyFrame
+```sh
+,-----+-----+-----+------+------------+- - - -+-------------,
+| SOF | ID  | LEN | TYPE | HEAD_CKSUM | DATA  | DATA_CKSUM  |
+| 0-1 | 1-4 | 1-4 | 1-4  | 0-4        | ...   | 0-4         | <- size (bytes)
+'-----+-----+-----+------+------------+- - - -+-------------'
+
+SOF ......... start of frame, usually 0x01 (optional, configurable)
+ID  ......... the frame ID (MSb is the peer bit)
+LEN ......... number of data bytes in the frame
+TYPE ........ message type (used to run Type Listeners, pick any values you like)
+HEAD_CKSUM .. header checksum
+
+DATA ........ LEN bytes of data
+DATA_CKSUM .. data checksum (left out if LEN is 0)
+```
+

analysis_options.yaml

@@ -0,0 +1,17 @@
+include: package:dart_flutter_team_lints/analysis_options.yaml
+
+linter:
+  rules:
+    - avoid_private_typedef_functions
+    - avoid_unused_constructor_parameters
+    - avoid_void_async
+    - cancel_subscriptions
+    - join_return_with_assignment
+    - missing_whitespace_between_adjacent_strings
+    - no_runtimeType_toString
+    - package_api_docs
+    - prefer_const_declarations
+    - prefer_expression_function_bodies
+    - prefer_final_locals
+    - unnecessary_breaks
+    - use_string_buffers

example/example.dart

@@ -0,0 +1,21 @@
+import 'dart:typed_data';
+
+import 'package:tiny_frame/tiny_frame.dart';
+
+void write(Uint8List data) => print('write: $data');
+void main() {
+  const mainID = 1;
+  // create a TinyFrame instance as master (peer id set)
+  // the write method has to be implemented, tinyframe will call it
+  // to send the data after building the frame
+  final tf = TinyFrame(write);
+  // some optional settings
+  tf.cksumType = 'xor';
+  // generate a listener for the id 1
+  tf.addIdListener(mainID, (Uint8List frame) => print('main: $frame'));
+  // if no listener is found for the id, this listener will be called
+  tf.addFallbackListener((Uint8List frame) => print('fallback: $frame'));
+
+  // send to slave on id 1
+  tf.send(mainID, Uint8List.fromList('abcde'.codeUnits));
+}