Skip to content
Snippets Groups Projects
Commit 189218cc authored by Charles Javerliat's avatar Charles Javerliat
Browse files

Update readme

parent b3411be3
No related branches found
No related tags found
No related merge requests found
...@@ -7,12 +7,14 @@ This library provides a way to frame and send data safely over serial, this incl ...@@ -7,12 +7,14 @@ This library provides a way to frame and send data safely over serial, this incl
### Framing data ### Framing data
```python ```python
from sfp.sfp import frame_data
import binascii
# The data to be framed # The data to be framed
data = bytearray([0x12, 0x34, 0x56]) data = bytearray([0x12, 0x34, 0x56])
# Frame and store the result in framed_data # Frame and store the result in framed_data
framed_data = bytearray() framed_data = frame_data(data)
frame_data(data, framed_data)
# Print the hexadecimal representation of the result # Print the hexadecimal representation of the result
# This will return b'7e0003123456bf127f' # This will return b'7e0003123456bf127f'
...@@ -30,12 +32,14 @@ In those bytes: ...@@ -30,12 +32,14 @@ In those bytes:
### Unframing data ### Unframing data
```python ```python
from sfp.sfp import unframe_data
import binascii
# The frame to unframe the data from # The frame to unframe the data from
framed_data = bytearray([0x7e, 0x0, 0x3, 0x12, 0x34, 0x56, 0xbf, 0x12, 0x7f]) framed_data = bytearray([0x7e, 0x0, 0x3, 0x12, 0x34, 0x56, 0xbf, 0x12, 0x7f])
# Unframe and store the result in unframed_data # Unframe and store the result in unframed_data
unframed_data = bytearray() unframed_data = unframe_data(framed_data)
unframe_data(framed_data, unframed_data)
# Print the hexadecimal representation of the result # Print the hexadecimal representation of the result
# This will return b'123456' # This will return b'123456'
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment