2 Commits
Author SHA1 Message Date
MightyPork b29315dce0 removed some confusing entries from the dummy cmakelists.txt file 2018-03-19 00:30:18 +01:00
jdavidbergerandMightyPork 9462a66956 Update README.md (#14)
Added blurb about TF_Accept
2018-03-18 23:29:40 +01:00
2 changed files with 4 additions and 3 deletions
+3 -3
View File
@@ -1,16 +1,16 @@
cmake_minimum_required(VERSION 3.7)
project(tf)
# This is a dummy CMakeLists file for CLion, which still doesn't understand Makefiles.
# Do not try to build the library using this file, it's here only for static analysis.
set(CMAKE_CXX_STANDARD GNU89)
set(SOURCE_FILES
demo/simple/test.c
demo/simple/TF_Config.h
demo/socket_demo/master.c
demo/socket_demo/slave.c
demo/socket_demo/TF_Config.h
demo/multipart_tx/test.c
demo/multipart_tx/TF_Config.h
demo/demo.c
demo/demo.h
TinyFrame.c
+1
View File
@@ -134,6 +134,7 @@ at a higher level and send the data in chunks.
- Implement `TF_WriteImpl()` - declared at the bottom of the header file as `extern`.
This function is used by `TF_Send()` and others to write bytes to your UART (or other physical layer).
A frame can be sent in it's entirety, or in multiple parts, depending on its size.
- Use TF_AcceptChar(tf, byte) to give read data to TF. TF_Accept(tf, bytes, count) will accept mulitple bytes.
- If you wish to use timeouts, periodically call `TF_Tick()`. The calling period determines
the length of 1 tick. This is used to time-out the parser in case it gets stuck
in a bad state (such as receiving a partial frame) and can also time-out ID listeners.