Skip to content

Commit 96c7541

Browse files
committed
Textual improvements
1 parent 46d82c0 commit 96c7541

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Frame-based streaming protocol for embedded applications.
44
## Introduction
55
This is a Python module to provide a bi-directional frame-based streaming protocol for low-speed embedded applications, such as serial connected devices. It allowes the receiver to 'jump into' a stream of data frames. Every frame starts with a preamble, so the receiver can synchronize. Any mismatch in checksum will the receiver.
66

7-
A payload is optional. A reserved `RESET` flag can be used to indicate that the link should be reset, for instance when the receiver is ready and the sender restart.
7+
A payload is optional. The reserved `RESET` flag can be used to indicate that the link should reset, for instance when the receiver just started and the sender should restart.
88

9-
The format of the frame is as follows:
9+
The format of a frame is as follows:
1010

1111
```
1212
| 0xAA 0x55 0xAA 0x55 | AA AA BB BB CC | XX XX .. .. .. .. XX XX YY YY YY YY |
@@ -20,10 +20,10 @@ X = Body payload (max. 65536 bytes)
2020
Y = CRC32 checksum over header + body
2121
```
2222

23-
Error correction is not implemented by this protocol and the bytes are not aligned. The endianness is customizable.
23+
Error correction is not implemented and the bytes are not aligned. The endianness is customizable.
2424

2525
## Statechart diagram
26-
Below is a simplified statechart diagram of the protocol.
26+
Below is a simplified statechart diagram of the receiver.
2727
![Alt text](docs/statechart.png)
2828

2929
## Installation

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
setup(
55
name="python-tinylink",
66
version="1.0",
7-
description="Streaming frame protocol library for embedded applications.",
7+
description="Frame-based streaming protocol for embedded applications.",
88
author="Bas Stottelaar",
99
author_email="basstottelaar@gmail.com",
1010
py_modules=["tinylink"],

0 commit comments

Comments
 (0)