diff --git a/docs/TinyHdlc_8h.html b/docs/TinyHdlc_8h.html index 59de9276..ef45af52 100644 --- a/docs/TinyHdlc_8h.html +++ b/docs/TinyHdlc_8h.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/TinyHdlc_8h_source.html b/docs/TinyHdlc_8h_source.html index c3746514..00980d4f 100644 --- a/docs/TinyHdlc_8h_source.html +++ b/docs/TinyHdlc_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
@@ -76,13 +76,13 @@
HDLC_CRC_DEFAULT
If default is specified HDLC will auto select CRC option.
Definition: tiny_hdlc.h:30
Tiny::IHdlc::disableCrc
void disableCrc()
Tiny
Definition: TinyHdlc.h:38
-
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:134
+
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:136
Tiny::IHdlc::enableCrc16
bool enableCrc16()
Tiny::IHdlc::end
void end()
Tiny::IHdlc::enableCrc32
bool enableCrc32()
Tiny::IPacket
Definition: TinyPacket.h:46
_hdlc_handle_t
Definition: tiny_hdlc.h:42
-
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:123
+
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:125
Tiny::IHdlc::write
int write(const char *buf, int size)
Tiny::Hdlc
Definition: TinyHdlc.h:171
Tiny::IHdlc::beginToSerial
void beginToSerial()
diff --git a/docs/TinyLightProtocol_8h.html b/docs/TinyLightProtocol_8h.html index 5c88c280..1564ae16 100644 --- a/docs/TinyLightProtocol_8h.html +++ b/docs/TinyLightProtocol_8h.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/TinyLightProtocol_8h_source.html b/docs/TinyLightProtocol_8h_source.html index 564a9205..49194970 100644 --- a/docs/TinyLightProtocol_8h_source.html +++ b/docs/TinyLightProtocol_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
@@ -77,7 +77,7 @@
Tiny::ProtoLight::enableCrc32
bool enableCrc32()
Tiny::ProtoLight::begin
void begin(write_block_cb_t writecb, read_block_cb_t readcb)
Tiny::ProtoLight::beginToSerial
void beginToSerial()
-
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:134
+
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:136
Tiny::ProtoLight::write
int write(char *buf, int size)
STinyLightData
Definition: tiny_light.h:51
Tiny::IPacket
Definition: TinyPacket.h:46
@@ -85,7 +85,7 @@
Tiny::ProtoLight::disableCrc
void disableCrc()
tiny_light.h
Tiny Light protocol API.
Tiny::ProtoLight::end
void end()
-
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:123
+
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:125
Tiny::ProtoLight::enableCheckSum
bool enableCheckSum()
diff --git a/docs/TinyPacket_8h.html b/docs/TinyPacket_8h.html index 75d77f2c..f0f7adf3 100644 --- a/docs/TinyPacket_8h.html +++ b/docs/TinyPacket_8h.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/TinyPacket_8h_source.html b/docs/TinyPacket_8h_source.html index 21d33269..2551996a 100644 --- a/docs/TinyPacket_8h_source.html +++ b/docs/TinyPacket_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/TinyProtocolHd_8h.html b/docs/TinyProtocolHd_8h.html index ef23a7cb..80580b4c 100644 --- a/docs/TinyProtocolHd_8h.html +++ b/docs/TinyProtocolHd_8h.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/TinyProtocolHd_8h_source.html b/docs/TinyProtocolHd_8h_source.html index 1866ee01..fe79274d 100644 --- a/docs/TinyProtocolHd_8h_source.html +++ b/docs/TinyProtocolHd_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
@@ -78,7 +78,7 @@
Tiny::ProtoHd::ProtoHd
ProtoHd(void *buffer, int bufferSize, void(*onReceive)(uint8_t *buf, int len))
Definition: TinyProtocolHd.h:62
Tiny::ProtoHd::beginToSerial1
void beginToSerial1()
Definition: TinyProtocolHd.h:101
Tiny::ProtoHd::write
int write(char *buf, int size)
-
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:134
+
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:136
Tiny::ProtoHd::beginToSerial2
void beginToSerial2()
Definition: TinyProtocolHd.h:114
Tiny::ProtoHd::beginToSerial3
void beginToSerial3()
Definition: TinyProtocolHd.h:127
Tiny::ProtoHd::enableCrc32
bool enableCrc32()
@@ -90,7 +90,7 @@
Tiny::ProtoHd::disableCrc
void disableCrc()
Tiny::ProtoHd::enableCheckSum
bool enableCheckSum()
Tiny::ProtoHd::enableCrc16
bool enableCrc16()
-
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:123
+
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:125
diff --git a/docs/TinyProtocol_8h.html b/docs/TinyProtocol_8h.html index d08c69c5..374707cb 100644 --- a/docs/TinyProtocol_8h.html +++ b/docs/TinyProtocol_8h.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/TinyProtocol_8h_source.html b/docs/TinyProtocol_8h_source.html index 3a44e92a..2a5c3b2c 100644 --- a/docs/TinyProtocol_8h_source.html +++ b/docs/TinyProtocol_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/annotated.html b/docs/annotated.html index 93dd55d6..1d9b3e6f 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/arduino.html b/docs/arduino.html index bfe8ef58..e7cd44e1 100644 --- a/docs/arduino.html +++ b/docs/arduino.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/arduino_2tiny__config_8h_source.html b/docs/arduino_2tiny__config_8h_source.html index 643a58c7..cfb50846 100644 --- a/docs/arduino_2tiny__config_8h_source.html +++ b/docs/arduino_2tiny__config_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/arduino_2tiny__defines_8h_source.html b/docs/arduino_2tiny__defines_8h_source.html index 6c67adb0..01c5c409 100644 --- a/docs/arduino_2tiny__defines_8h_source.html +++ b/docs/arduino_2tiny__defines_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
@@ -68,7 +68,7 @@
tiny_defines.h
-
1 /*
2  Copyright 2016-2019 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #pragma once
21 
22 #include "tiny_config.h"
23 #include <stdint.h>
24 
25 /* For fastest version of protocol assign all defines to zero.
26  * In this case protocol supports no CRC field, and
27  * all api functions become not thread-safe.
28  */
29 
30 
31 typedef uint8_t tiny_mutex_t;
32 
33 typedef uint8_t tiny_events_t;
34 
35 
36 
tiny_events_t
Definition: tiny_defines.h:29
+
1 /*
2  Copyright 2016-2019 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #pragma once
21 
22 #include "tiny_config.h"
23 #include <stdint.h>
24 
25 /* For fastest version of protocol assign all defines to zero.
26  * In this case protocol supports no CRC field, and
27  * all api functions become not thread-safe.
28  */
29 
30 
31 typedef uint8_t tiny_mutex_t;
32 
33 typedef uint8_t tiny_events_t;
34 
35 
36 
tiny_events_t
Definition: tiny_defines.h:30
diff --git a/docs/arduino_8dox.html b/docs/arduino_8dox.html index 9d3eb2c0..68396d17 100644 --- a/docs/arduino_8dox.html +++ b/docs/arduino_8dox.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/avr_2tiny__config_8h_source.html b/docs/avr_2tiny__config_8h_source.html index 927b44ad..af8bf9f7 100644 --- a/docs/avr_2tiny__config_8h_source.html +++ b/docs/avr_2tiny__config_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/avr_2tiny__defines_8h_source.html b/docs/avr_2tiny__defines_8h_source.html index 5df21046..21ea1d36 100644 --- a/docs/avr_2tiny__defines_8h_source.html +++ b/docs/avr_2tiny__defines_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
@@ -68,7 +68,7 @@
tiny_defines.h
-
1 /*
2  Copyright 2016-2019 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #pragma once
21 
22 #include "tiny_config.h"
23 #include <stdint.h>
24 
25 /* For fastest version of protocol assign all defines to zero.
26  * In this case protocol supports no CRC field, and
27  * all api functions become not thread-safe.
28  */
29 
30 typedef uint8_t tiny_mutex_t;
31 
32 typedef uint8_t tiny_events_t;
33 
34 
35 
tiny_events_t
Definition: tiny_defines.h:29
+
1 /*
2  Copyright 2016-2019 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #pragma once
21 
22 #include "tiny_config.h"
23 #include <stdint.h>
24 
25 /* For fastest version of protocol assign all defines to zero.
26  * In this case protocol supports no CRC field, and
27  * all api functions become not thread-safe.
28  */
29 
30 typedef uint8_t tiny_mutex_t;
31 
32 typedef uint8_t tiny_events_t;
33 
34 
35 
tiny_events_t
Definition: tiny_defines.h:30
diff --git a/docs/classTiny_1_1Hdlc-members.html b/docs/classTiny_1_1Hdlc-members.html index c8356299..499ad958 100644 --- a/docs/classTiny_1_1Hdlc-members.html +++ b/docs/classTiny_1_1Hdlc-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classTiny_1_1Hdlc.html b/docs/classTiny_1_1Hdlc.html index 17c2eeaa..d034f78a 100644 --- a/docs/classTiny_1_1Hdlc.html +++ b/docs/classTiny_1_1Hdlc.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classTiny_1_1IHdlc-members.html b/docs/classTiny_1_1IHdlc-members.html index dc8d344e..0a36f2aa 100644 --- a/docs/classTiny_1_1IHdlc-members.html +++ b/docs/classTiny_1_1IHdlc-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classTiny_1_1IHdlc.html b/docs/classTiny_1_1IHdlc.html index e502dd80..63e45a40 100644 --- a/docs/classTiny_1_1IHdlc.html +++ b/docs/classTiny_1_1IHdlc.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classTiny_1_1IPacket-members.html b/docs/classTiny_1_1IPacket-members.html index ef5d77d8..2123ced0 100644 --- a/docs/classTiny_1_1IPacket-members.html +++ b/docs/classTiny_1_1IPacket-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classTiny_1_1IPacket.html b/docs/classTiny_1_1IPacket.html index 238dcbce..5917f5fe 100644 --- a/docs/classTiny_1_1IPacket.html +++ b/docs/classTiny_1_1IPacket.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classTiny_1_1Packet-members.html b/docs/classTiny_1_1Packet-members.html index 2011bb88..6fc74e8b 100644 --- a/docs/classTiny_1_1Packet-members.html +++ b/docs/classTiny_1_1Packet-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classTiny_1_1Packet.html b/docs/classTiny_1_1Packet.html index 3bad1f2b..0f5feed9 100644 --- a/docs/classTiny_1_1Packet.html +++ b/docs/classTiny_1_1Packet.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classTiny_1_1Proto-members.html b/docs/classTiny_1_1Proto-members.html deleted file mode 100644 index dbe4737e..00000000 --- a/docs/classTiny_1_1Proto-members.html +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - -Tiny protocol: Member List - - - - - - - - - -
-
- - - - - - -
-
Tiny protocol -  0.7.0 -
-
Tiny communication protocol for microcontrollers
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
Tiny::Proto Member List
-
-
- -

This is the complete list of members for Tiny::Proto, including all inherited members.

- - - - - - - - - - - - - - - - - - -
begin(write_block_cb_t writecb, read_block_cb_t readcb)Tiny::Proto
beginToSerial()Tiny::Protoinline
beginToSerial1()Tiny::Protoinline
beginToSerial2()Tiny::Protoinline
beginToSerial3()Tiny::Protoinline
disableCrc()Tiny::Proto
disableUid()Tiny::Protoinline
enableCheckSum()Tiny::Proto
enableCrc16()Tiny::Proto
enableCrc32()Tiny::Proto
enableUid()Tiny::Protoinline
end()Tiny::Proto
Proto() (defined in Tiny::Proto)Tiny::Protoinline
read(char *buf, int size, uint8_t flags=TINY_FLAG_WAIT_FOREVER)Tiny::Proto
read(Packet &pkt, uint8_t flags=TINY_FLAG_WAIT_FOREVER)Tiny::Proto
write(char *buf, int size, uint8_t flags=TINY_FLAG_WAIT_FOREVER)Tiny::Proto
write(Packet &pkt, uint8_t flags=TINY_FLAG_WAIT_FOREVER)Tiny::Proto
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/docs/classTiny_1_1Proto.html b/docs/classTiny_1_1Proto.html deleted file mode 100644 index fd514a6b..00000000 --- a/docs/classTiny_1_1Proto.html +++ /dev/null @@ -1,568 +0,0 @@ - - - - - - - -Tiny protocol: Tiny::Proto Class Reference - - - - - - - - - -
-
- - - - - - -
-
Tiny protocol -  0.7.0 -
-
Tiny communication protocol for microcontrollers
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Public Member Functions | -List of all members
-
-
Tiny::Proto Class Reference
-
-
- -

#include <TinyProtocol.h>

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

void begin (write_block_cb_t writecb, read_block_cb_t readcb)
 
void beginToSerial ()
 
void beginToSerial1 ()
 
void beginToSerial2 ()
 
void beginToSerial3 ()
 
void end ()
 
int write (char *buf, int size, uint8_t flags=TINY_FLAG_WAIT_FOREVER)
 
int read (char *buf, int size, uint8_t flags=TINY_FLAG_WAIT_FOREVER)
 
int write (Packet &pkt, uint8_t flags=TINY_FLAG_WAIT_FOREVER)
 
int read (Packet &pkt, uint8_t flags=TINY_FLAG_WAIT_FOREVER)
 
void disableCrc ()
 
bool enableCheckSum ()
 
bool enableCrc16 ()
 
bool enableCrc32 ()
 
void enableUid ()
 
void disableUid ()
 
-

Detailed Description

-

Proto class incapsulates Protocol functionality. Remember that you may use always C-style API functions instead C++. Please refer to documentation.

-

Member Function Documentation

- -

◆ begin()

- -
-
- - - - - - - - - - - - - - - - - - -
void Tiny::Proto::begin (write_block_cb_t writecb,
read_block_cb_t readcb 
)
-
-

Initializes protocol internal variables. If you need to switch communication with other destination point, you can call this method one again after calling end().

Parameters
- - - -
writecb- write function to some physical channel
readcb- read function from some physical channel
-
-
-
Returns
None
- -
-
- -

◆ beginToSerial()

- -
-
- - - - - -
- - - - - - - -
void Tiny::Proto::beginToSerial ()
- 		-inline
-
-

Initializes protocol internal variables and redirects communication through Arduino Serial connection (Serial).

Returns
None
- -
-
- -

◆ beginToSerial1()

- -
-
- - - - - -
- - - - - - - -
void Tiny::Proto::beginToSerial1 ()
- 		-inline
-
-

Initializes protocol internal variables and redirects communication through Arduino Serial1 connection (Serial1).

Returns
None
- -
-
- -

◆ beginToSerial2()

- -
-
- - - - - -
- - - - - - - -
void Tiny::Proto::beginToSerial2 ()
- 		-inline
-
-

Initializes protocol internal variables and redirects communication through Arduino Serial2 connection (Serial2).

Returns
None
- -
-
- -

◆ beginToSerial3()

- -
-
- - - - - -
- - - - - - - -
void Tiny::Proto::beginToSerial3 ()
- 		-inline
-
-

Initializes protocol internal variables and redirects communication through Arduino Serial3 connection (Serial3).

Returns
None
- -
-
- -

◆ disableCrc()

- -
-
- - - - - - - -
void Tiny::Proto::disableCrc ()
-
-

Disable CRC field in the protocol. If CRC field is OFF, then the frame looks like this: 0x7E databytes 0x7E.

- -
-
- -

◆ disableUid()

- -
-
- - - - - -
- - - - - - - -
void Tiny::Proto::disableUid ()
- 		-inline
-
-

Disables Uid field in the protocol. If enabled this 16-bit field with packet identifier is added before each payload data. Frame with uid: 0x7E 16-bituid payload 0x7E Frame without uid: 0x7E payload 0x7E

- -
-
- -

◆ enableCheckSum()

- -
-
- - - - - - - -
bool Tiny::Proto::enableCheckSum ()
-
-

Enables CRC 8-bit field in the protocol. This field contains sum of all data bytes in the packet. 8-bit field is supported by Nano version of Tiny library.

Returns
true if successful false in case of error.
- -
-
- -

◆ enableCrc16()

- -
-
- - - - - - - -
bool Tiny::Proto::enableCrc16 ()
-
-

Enables CRC 16-bit field in the protocol. This field contains FCS 16-bit CCITT like defined in RFC 1662. 16-bit field is not supported by Nano version of Tiny library.

Returns
true if successful false in case of error.
- -
-
- -

◆ enableCrc32()

- -
-
- - - - - - - -
bool Tiny::Proto::enableCrc32 ()
-
-

Enables CRC 32-bit field in the protocol. This field contains FCS 32-bit CCITT like defined in RFC 1662. 32-bit field is not supported by Nano version of Tiny library.

Returns
true if successful false in case of error.
- -
-
- -

◆ enableUid()

- -
-
- - - - - -
- - - - - - - -
void Tiny::Proto::enableUid ()
- 		-inline
-
-

Enables Uid field in the protocol. If enabled this 16-bit field with packet identifier is added before each payload data. Frame with uid: 0x7E 16-bituid payload 0x7E Frame without uid: 0x7E payload 0x7E

- -
-
- -

◆ end()

- -
-
- - - - - - - -
void Tiny::Proto::end ()
-
-

Resets protocol state.

- -
-
- -

◆ read() [1/2]

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
int Tiny::Proto::read (char * buf,
int size,
uint8_t flags = TINY_FLAG_WAIT_FOREVER 
)
-
-

Reads data block from communication channel.

Parameters
- - - - -
buf- buffer to place data read from communication channel
size- maximum size of the buffer in bytes.
flags- Flags for Tiny API functions
-
-
-
Returns
negative value in case of error zero if nothing is read positive - number of bytes read from the channel
- -
-
- -

◆ read() [2/2]

- -
-
- - - - - - - - - - - - - - - - - - -
int Tiny::Proto::read (Packet & pkt,
uint8_t flags = TINY_FLAG_WAIT_FOREVER 
)
-
-

Reads packet from communication channel.

Parameters
- - - -
pktPacket object to put data to
flagsFlags for Tiny API functions
-
-
-
See also
Packet
-
Returns
negative value in case of error zero if nothing is read positive - Packet is successfully received
- -
-
- -

◆ write() [1/2]

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
int Tiny::Proto::write (char * buf,
int size,
uint8_t flags = TINY_FLAG_WAIT_FOREVER 
)
-
-

Sends data block over communication channel.

Parameters
- - - - -
buf- data to send
size- length of the data in bytes
flags- flags. Flags for Tiny API functions
-
-
-
Returns
negative value in case of error zero if nothing is sent positive - should be equal to size parameter
- -
-
- -

◆ write() [2/2]

- -
-
- - - - - - - - - - - - - - - - - - -
int Tiny::Proto::write (Packet & pkt,
uint8_t flags = TINY_FLAG_WAIT_FOREVER 
)
-
-

Sends packet over communication channel.

Parameters
- - - -
pkt- Packet to send
flags- Flags for Tiny API functions
-
-
-
See also
Packet
-
Returns
negative value in case of error zero if nothing is sent positive - Packet is successfully sent
- -
-
-
The documentation for this class was generated from the following file: -
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/docs/classTiny_1_1ProtoHd-members.html b/docs/classTiny_1_1ProtoHd-members.html index 978504fe..a00b34e9 100644 --- a/docs/classTiny_1_1ProtoHd-members.html +++ b/docs/classTiny_1_1ProtoHd-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classTiny_1_1ProtoHd.html b/docs/classTiny_1_1ProtoHd.html index 89ae81a1..7b2d1ba2 100644 --- a/docs/classTiny_1_1ProtoHd.html +++ b/docs/classTiny_1_1ProtoHd.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classTiny_1_1ProtoLight-members.html b/docs/classTiny_1_1ProtoLight-members.html index 253e40b1..8d462213 100644 --- a/docs/classTiny_1_1ProtoLight-members.html +++ b/docs/classTiny_1_1ProtoLight-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classTiny_1_1ProtoLight.html b/docs/classTiny_1_1ProtoLight.html index 126e5d05..c3eca21c 100644 --- a/docs/classTiny_1_1ProtoLight.html +++ b/docs/classTiny_1_1ProtoLight.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classes.html b/docs/classes.html index 79b6744c..86fb4e4b 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/crc_8h_source.html b/docs/crc_8h_source.html index 5590c3ba..073f9d73 100644 --- a/docs/crc_8h_source.html +++ b/docs/crc_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_000000_000001.html b/docs/dir_000000_000001.html deleted file mode 100644 index afefc9f2..00000000 --- a/docs/dir_000000_000001.html +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - -Tiny protocol: src -> proto Relation - - - - - - - - - -
-
- - - - - - -
-
Tiny protocol -  0.6.4 -
-
Tiny communication protocol for microcontrollers
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-

src → proto Relation

File in srcIncludes file in src/proto
TinyLightProtocol.htiny_light.h
TinyProtocol.htiny_layer2.h
TinyProtocolHd.htiny_hd.h
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/docs/dir_000002_000004.html b/docs/dir_000002_000004.html index df38541a..5e6933ba 100644 --- a/docs/dir_000002_000004.html +++ b/docs/dir_000002_000004.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_000003_000004.html b/docs/dir_000003_000004.html index de36d8a9..d16d15c7 100644 --- a/docs/dir_000003_000004.html +++ b/docs/dir_000003_000004.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_000008_000004.html b/docs/dir_000008_000004.html deleted file mode 100644 index 627473a2..00000000 --- a/docs/dir_000008_000004.html +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - -Tiny protocol: src/proto/half_duplex -> hal Relation - - - - - - - - - -
-
- - - - - - -
-
Tiny protocol -  0.7.0 -
-
Tiny communication protocol for microcontrollers
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-

half_duplex → hal Relation

File in src/proto/half_duplexIncludes file in src/proto/hal
tiny_hd.htiny_proto_types.h
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/docs/dir_000010_000004.html b/docs/dir_000010_000004.html index b056f73c..6c42d294 100644 --- a/docs/dir_000010_000004.html +++ b/docs/dir_000010_000004.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_000011_000004.html b/docs/dir_000011_000004.html index 2796d539..04f0339b 100644 --- a/docs/dir_000011_000004.html +++ b/docs/dir_000011_000004.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_000012_000004.html b/docs/dir_000012_000004.html index 619c0af8..6a7f40d8 100644 --- a/docs/dir_000012_000004.html +++ b/docs/dir_000012_000004.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_1017fea4f50f4e6c3515d09d5fd58daf.html b/docs/dir_1017fea4f50f4e6c3515d09d5fd58daf.html deleted file mode 100644 index 550b6e0f..00000000 --- a/docs/dir_1017fea4f50f4e6c3515d09d5fd58daf.html +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - -Tiny protocol: src/proto/os/linux Directory Reference - - - - - - - - - -
-
- - - - - - -
-
Tiny protocol -  0.6.4 -
-
Tiny communication protocol for microcontrollers
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
linux Directory Reference
-
-
-
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/docs/dir_16c143ca4ae7a098fe5e5a6e1ed3a83f.html b/docs/dir_16c143ca4ae7a098fe5e5a6e1ed3a83f.html index 4472d25e..5f9b5db0 100644 --- a/docs/dir_16c143ca4ae7a098fe5e5a6e1ed3a83f.html +++ b/docs/dir_16c143ca4ae7a098fe5e5a6e1ed3a83f.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_21a1a85fa70cd1acc7fc424e54ad0840.html b/docs/dir_21a1a85fa70cd1acc7fc424e54ad0840.html index d0ea0f6f..4e696f1c 100644 --- a/docs/dir_21a1a85fa70cd1acc7fc424e54ad0840.html +++ b/docs/dir_21a1a85fa70cd1acc7fc424e54ad0840.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_4662f3ce65d87a541e94818e03dc5213.html b/docs/dir_4662f3ce65d87a541e94818e03dc5213.html deleted file mode 100644 index e548bde3..00000000 --- a/docs/dir_4662f3ce65d87a541e94818e03dc5213.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - -Tiny protocol: src/proto/os Directory Reference - - - - - - - - - -
-
- - - - - - -
-
Tiny protocol -  0.6.4 -
-
Tiny communication protocol for microcontrollers
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
os Directory Reference
-
-
- - -

-Directories

-
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4.html b/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4.html index 701bc8ca..80769116 100644 --- a/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4.html +++ b/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_582b623d11d72e7c829f3661a8866227.html b/docs/dir_582b623d11d72e7c829f3661a8866227.html index 77a23975..3c0e6dd6 100644 --- a/docs/dir_582b623d11d72e7c829f3661a8866227.html +++ b/docs/dir_582b623d11d72e7c829f3661a8866227.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_61a763563eb3728beb0014ac26e3418e.html b/docs/dir_61a763563eb3728beb0014ac26e3418e.html index 51aa7435..e88be549 100644 --- a/docs/dir_61a763563eb3728beb0014ac26e3418e.html +++ b/docs/dir_61a763563eb3728beb0014ac26e3418e.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html index 8a36166c..4edb689e 100644 --- a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_75a472a4d9716ba9c1151370abaacaf0.html b/docs/dir_75a472a4d9716ba9c1151370abaacaf0.html index 7bafc7cc..b231ef0a 100644 --- a/docs/dir_75a472a4d9716ba9c1151370abaacaf0.html +++ b/docs/dir_75a472a4d9716ba9c1151370abaacaf0.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_9c7dc50cded8f3aee51a209935ca1b53.html b/docs/dir_9c7dc50cded8f3aee51a209935ca1b53.html index a1cfc676..6bc1c4b7 100644 --- a/docs/dir_9c7dc50cded8f3aee51a209935ca1b53.html +++ b/docs/dir_9c7dc50cded8f3aee51a209935ca1b53.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_9fb74fd6b278eeceae309d1e30cf7c21.html b/docs/dir_9fb74fd6b278eeceae309d1e30cf7c21.html index 613b0bb0..6c5346f8 100644 --- a/docs/dir_9fb74fd6b278eeceae309d1e30cf7c21.html +++ b/docs/dir_9fb74fd6b278eeceae309d1e30cf7c21.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_d7f206fc1f62ce456576c82a236dabe6.html b/docs/dir_d7f206fc1f62ce456576c82a236dabe6.html index 889fd8f7..313e1e1c 100644 --- a/docs/dir_d7f206fc1f62ce456576c82a236dabe6.html +++ b/docs/dir_d7f206fc1f62ce456576c82a236dabe6.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_dad24718f45f781fc76b83eb73abb2a5.html b/docs/dir_dad24718f45f781fc76b83eb73abb2a5.html index ea35d3d9..93c1b099 100644 --- a/docs/dir_dad24718f45f781fc76b83eb73abb2a5.html +++ b/docs/dir_dad24718f45f781fc76b83eb73abb2a5.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_f0e7f7e70e244e0817e4aa8b9982190a.html b/docs/dir_f0e7f7e70e244e0817e4aa8b9982190a.html deleted file mode 100644 index 243a06b4..00000000 --- a/docs/dir_f0e7f7e70e244e0817e4aa8b9982190a.html +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - -Tiny protocol: src/proto/os/arduino Directory Reference - - - - - - - - - -
-
- - - - - - -
-
Tiny protocol -  0.6.4 -
-
Tiny communication protocol for microcontrollers
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
arduino Directory Reference
-
-
-
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/docs/dir_f468ab7bd64995917426f65613b4e1f4.html b/docs/dir_f468ab7bd64995917426f65613b4e1f4.html index f0cce77d..6b2c6aa2 100644 --- a/docs/dir_f468ab7bd64995917426f65613b4e1f4.html +++ b/docs/dir_f468ab7bd64995917426f65613b4e1f4.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_f9eb52bc39deae7ac93b11083dea5441.html b/docs/dir_f9eb52bc39deae7ac93b11083dea5441.html deleted file mode 100644 index dd7c94e7..00000000 --- a/docs/dir_f9eb52bc39deae7ac93b11083dea5441.html +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - -Tiny protocol: src/proto/os/mingw32 Directory Reference - - - - - - - - - -
-
- - - - - - -
-
Tiny protocol -  0.6.4 -
-
Tiny communication protocol for microcontrollers
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
mingw32 Directory Reference
-
-
-
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab.html b/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab.html index 218228aa..e56a03ec 100644 --- a/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab.html +++ b/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/esp32_2tiny__config_8h_source.html b/docs/esp32_2tiny__config_8h_source.html index d7587db8..ca7ef788 100644 --- a/docs/esp32_2tiny__config_8h_source.html +++ b/docs/esp32_2tiny__config_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/esp32_2tiny__defines_8h_source.html b/docs/esp32_2tiny__defines_8h_source.html index 312ce44d..0cbec1a5 100644 --- a/docs/esp32_2tiny__defines_8h_source.html +++ b/docs/esp32_2tiny__defines_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
@@ -68,7 +68,7 @@
tiny_defines.h
-
1 /*
2  Copyright 2019 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #pragma once
21 
22 #include "tiny_config.h"
23 #include "freertos/FreeRTOS.h"
24 #include "freertos/task.h"
25 #include "freertos/semphr.h"
26 #include "freertos/event_groups.h"
27 
28 typedef SemaphoreHandle_t tiny_mutex_t;
29 typedef EventGroupHandle_t tiny_events_t;
30 
31 
tiny_events_t
Definition: tiny_defines.h:29
+
1 /*
2  Copyright 2019 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #pragma once
21 
22 #include "tiny_config.h"
23 #include "freertos/FreeRTOS.h"
24 #include "freertos/task.h"
25 #include "freertos/semphr.h"
26 #include "freertos/event_groups.h"
27 
28 typedef SemaphoreHandle_t tiny_mutex_t;
29 typedef EventGroupHandle_t tiny_events_t;
30 
31 
tiny_events_t
Definition: tiny_defines.h:30
diff --git a/docs/files.html b/docs/files.html index 486e2331..e56e0985 100644 --- a/docs/files.html +++ b/docs/files.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/functions.html b/docs/functions.html index 0141c8c3..21d8b8aa 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/functions_func.html b/docs/functions_func.html index 93d2e944..980c4aa1 100644 --- a/docs/functions_func.html +++ b/docs/functions_func.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/functions_vars.html b/docs/functions_vars.html index ebd78b43..4efb703f 100644 --- a/docs/functions_vars.html +++ b/docs/functions_vars.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/globals.html b/docs/globals.html index 69b698b6..40bfdbfb 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/globals_defs.html b/docs/globals_defs.html index 19d4eb60..5c466e11 100644 --- a/docs/globals_defs.html +++ b/docs/globals_defs.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/globals_func.html b/docs/globals_func.html index adca5cb6..7e0a68bb 100644 --- a/docs/globals_func.html +++ b/docs/globals_func.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/globals_type.html b/docs/globals_type.html index de8823cb..f82ad386 100644 --- a/docs/globals_type.html +++ b/docs/globals_type.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/graph_legend.html b/docs/graph_legend.html index 76cca48b..946c3ef5 100644 --- a/docs/graph_legend.html +++ b/docs/graph_legend.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/group__ADVANCED__API.html b/docs/group__ADVANCED__API.html index 197755e8..6ec14e66 100644 --- a/docs/group__ADVANCED__API.html +++ b/docs/group__ADVANCED__API.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/group__ERROR__FLAGS.html b/docs/group__ERROR__FLAGS.html index 320b56c2..0141d366 100644 --- a/docs/group__ERROR__FLAGS.html +++ b/docs/group__ERROR__FLAGS.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/group__FLAGS__GROUP.html b/docs/group__FLAGS__GROUP.html index 4b2bf25b..fb58f5e9 100644 --- a/docs/group__FLAGS__GROUP.html +++ b/docs/group__FLAGS__GROUP.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/group__HALF__DUPLEX__API.html b/docs/group__HALF__DUPLEX__API.html index 6dcee403..c2ad940a 100644 --- a/docs/group__HALF__DUPLEX__API.html +++ b/docs/group__HALF__DUPLEX__API.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/group__HDLC__API.html b/docs/group__HDLC__API.html index 5c468c48..2b8b7cf0 100644 --- a/docs/group__HDLC__API.html +++ b/docs/group__HDLC__API.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
@@ -106,9 +106,9 @@   int hdlc_run_rx (hdlc_handle_t handle, const void *data, int len, int *error)   - -int hdlc_run_rx_until_read (hdlc_handle_t handle, read_block_cb_t readcb, int *error) -  + +int hdlc_run_rx_until_read (hdlc_handle_t handle, read_block_cb_t readcb, void *user_data, uint16_t timeout) +  int hdlc_run_tx (hdlc_handle_t handle)   int hdlc_send (hdlc_handle_t handle, const void *data, int len, uint32_t timeout) diff --git a/docs/group__LIGHT__API.html b/docs/group__LIGHT__API.html index d914d53c..005c3a90 100644 --- a/docs/group__LIGHT__API.html +++ b/docs/group__LIGHT__API.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/group__SIMPLE__API.html b/docs/group__SIMPLE__API.html index a12bb809..52aae1d4 100644 --- a/docs/group__SIMPLE__API.html +++ b/docs/group__SIMPLE__API.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 5ac20c01..38a086e1 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/index.html b/docs/index.html index 240bad60..b3e879a1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/inherits.html b/docs/inherits.html index e5870be0..d634ef8a 100644 --- a/docs/inherits.html +++ b/docs/inherits.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/latex/TinyHdlc_8h__incl.pdf b/docs/latex/TinyHdlc_8h__incl.pdf index 895fde22..f3df32cb 100644 Binary files a/docs/latex/TinyHdlc_8h__incl.pdf and b/docs/latex/TinyHdlc_8h__incl.pdf differ diff --git a/docs/latex/TinyLightProtocol_8h__dep__incl.pdf b/docs/latex/TinyLightProtocol_8h__dep__incl.pdf index dc6c2680..f166f1c0 100644 Binary files a/docs/latex/TinyLightProtocol_8h__dep__incl.pdf and b/docs/latex/TinyLightProtocol_8h__dep__incl.pdf differ diff --git a/docs/latex/TinyLightProtocol_8h__incl.pdf b/docs/latex/TinyLightProtocol_8h__incl.pdf index 3fc2b356..828832a2 100644 Binary files a/docs/latex/TinyLightProtocol_8h__incl.pdf and b/docs/latex/TinyLightProtocol_8h__incl.pdf differ diff --git a/docs/latex/TinyPacket_8h__dep__incl.pdf b/docs/latex/TinyPacket_8h__dep__incl.pdf index 2af68e28..e7ef97f9 100644 Binary files a/docs/latex/TinyPacket_8h__dep__incl.pdf and b/docs/latex/TinyPacket_8h__dep__incl.pdf differ diff --git a/docs/latex/TinyPacket_8h__incl.pdf b/docs/latex/TinyPacket_8h__incl.pdf index edd89365..149788d1 100644 Binary files a/docs/latex/TinyPacket_8h__incl.pdf and b/docs/latex/TinyPacket_8h__incl.pdf differ diff --git a/docs/latex/TinyProtocolHd_8h__dep__incl.pdf b/docs/latex/TinyProtocolHd_8h__dep__incl.pdf index 9ef7d391..1a943f1c 100644 Binary files a/docs/latex/TinyProtocolHd_8h__dep__incl.pdf and b/docs/latex/TinyProtocolHd_8h__dep__incl.pdf differ diff --git a/docs/latex/TinyProtocolHd_8h__incl.pdf b/docs/latex/TinyProtocolHd_8h__incl.pdf index f82601b3..0a41ca82 100644 Binary files a/docs/latex/TinyProtocolHd_8h__incl.pdf and b/docs/latex/TinyProtocolHd_8h__incl.pdf differ diff --git a/docs/latex/TinyProtocol_8h__incl.pdf b/docs/latex/TinyProtocol_8h__incl.pdf index 67d7d75e..f30c927e 100644 Binary files a/docs/latex/TinyProtocol_8h__incl.pdf and b/docs/latex/TinyProtocol_8h__incl.pdf differ diff --git a/docs/latex/classTiny_1_1Hdlc__coll__graph.pdf b/docs/latex/classTiny_1_1Hdlc__coll__graph.pdf index 3529e220..7a85606b 100644 Binary files a/docs/latex/classTiny_1_1Hdlc__coll__graph.pdf and b/docs/latex/classTiny_1_1Hdlc__coll__graph.pdf differ diff --git a/docs/latex/classTiny_1_1Hdlc__inherit__graph.pdf b/docs/latex/classTiny_1_1Hdlc__inherit__graph.pdf index e61eca6a..3f2a2d1a 100644 Binary files a/docs/latex/classTiny_1_1Hdlc__inherit__graph.pdf and b/docs/latex/classTiny_1_1Hdlc__inherit__graph.pdf differ diff --git a/docs/latex/classTiny_1_1IHdlc__coll__graph.pdf b/docs/latex/classTiny_1_1IHdlc__coll__graph.pdf index f5066f42..5f3cd3e4 100644 Binary files a/docs/latex/classTiny_1_1IHdlc__coll__graph.pdf and b/docs/latex/classTiny_1_1IHdlc__coll__graph.pdf differ diff --git a/docs/latex/classTiny_1_1IHdlc__inherit__graph.pdf b/docs/latex/classTiny_1_1IHdlc__inherit__graph.pdf index 5939ee4a..fefe6429 100644 Binary files a/docs/latex/classTiny_1_1IHdlc__inherit__graph.pdf and b/docs/latex/classTiny_1_1IHdlc__inherit__graph.pdf differ diff --git a/docs/latex/classTiny_1_1IPacket__inherit__graph.pdf b/docs/latex/classTiny_1_1IPacket__inherit__graph.pdf index ac56896f..e940bb97 100644 Binary files a/docs/latex/classTiny_1_1IPacket__inherit__graph.pdf and b/docs/latex/classTiny_1_1IPacket__inherit__graph.pdf differ diff --git a/docs/latex/classTiny_1_1Packet__coll__graph.pdf b/docs/latex/classTiny_1_1Packet__coll__graph.pdf index 3dfdc67a..f9fcfea3 100644 Binary files a/docs/latex/classTiny_1_1Packet__coll__graph.pdf and b/docs/latex/classTiny_1_1Packet__coll__graph.pdf differ diff --git a/docs/latex/classTiny_1_1Packet__inherit__graph.pdf b/docs/latex/classTiny_1_1Packet__inherit__graph.pdf index 3dfdc67a..f9fcfea3 100644 Binary files a/docs/latex/classTiny_1_1Packet__inherit__graph.pdf and b/docs/latex/classTiny_1_1Packet__inherit__graph.pdf differ diff --git a/docs/latex/classTiny_1_1Proto.tex b/docs/latex/classTiny_1_1Proto.tex deleted file mode 100644 index ac8ad036..00000000 --- a/docs/latex/classTiny_1_1Proto.tex +++ /dev/null @@ -1,229 +0,0 @@ -\hypertarget{classTiny_1_1Proto}{}\section{Tiny\+:\+:Proto Class Reference} -\label{classTiny_1_1Proto}\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}} - - -{\ttfamily \#include $<$Tiny\+Protocol.\+h$>$} - -\subsection*{Public Member Functions} -\begin{DoxyCompactItemize} -\item -void \hyperlink{classTiny_1_1Proto_a6f5f4ebec42dc6e679c25e79284d7705}{begin} (\hyperlink{tiny__proto__types_8h_aafd634660bba76cace57a8f9b01e044d}{write\+\_\+block\+\_\+cb\+\_\+t} writecb, \hyperlink{tiny__proto__types_8h_a15bec127d9ee63658563d62e92b5261b}{read\+\_\+block\+\_\+cb\+\_\+t} readcb) -\item -void \hyperlink{classTiny_1_1Proto_a1dcad822337b6155148b1da9222fdd82}{begin\+To\+Serial} () -\item -void \hyperlink{classTiny_1_1Proto_a707f3112e0ca3651d4b0f3df6c19dd8c}{begin\+To\+Serial1} () -\item -void \hyperlink{classTiny_1_1Proto_a6d06cd3b1530e4986ce42a9987c522c4}{begin\+To\+Serial2} () -\item -void \hyperlink{classTiny_1_1Proto_aedbc025e1534105134e4a2499d32207c}{begin\+To\+Serial3} () -\item -void \hyperlink{classTiny_1_1Proto_ae9f52fa1c4f18981672ad7af12633d4e}{end} () -\item -int \hyperlink{classTiny_1_1Proto_a46fbc8b8681431b9b0a9a4b953a8dc33}{write} (char $\ast$buf, int size, uint8\+\_\+t flags=\hyperlink{group__FLAGS__GROUP_ga3a34267804581c5709d03f52d232b307}{T\+I\+N\+Y\+\_\+\+F\+L\+A\+G\+\_\+\+W\+A\+I\+T\+\_\+\+F\+O\+R\+E\+V\+ER}) -\item -int \hyperlink{classTiny_1_1Proto_acc00ac10509eaa11a83b0b88a2278b3e}{read} (char $\ast$buf, int size, uint8\+\_\+t flags=\hyperlink{group__FLAGS__GROUP_ga3a34267804581c5709d03f52d232b307}{T\+I\+N\+Y\+\_\+\+F\+L\+A\+G\+\_\+\+W\+A\+I\+T\+\_\+\+F\+O\+R\+E\+V\+ER}) -\item -int \hyperlink{classTiny_1_1Proto_ade93766700805a81be6a3317d846b276}{write} (\hyperlink{classTiny_1_1Packet}{Packet} \&pkt, uint8\+\_\+t flags=\hyperlink{group__FLAGS__GROUP_ga3a34267804581c5709d03f52d232b307}{T\+I\+N\+Y\+\_\+\+F\+L\+A\+G\+\_\+\+W\+A\+I\+T\+\_\+\+F\+O\+R\+E\+V\+ER}) -\item -int \hyperlink{classTiny_1_1Proto_aedef629f8b8968db7c8693bb45039651}{read} (\hyperlink{classTiny_1_1Packet}{Packet} \&pkt, uint8\+\_\+t flags=\hyperlink{group__FLAGS__GROUP_ga3a34267804581c5709d03f52d232b307}{T\+I\+N\+Y\+\_\+\+F\+L\+A\+G\+\_\+\+W\+A\+I\+T\+\_\+\+F\+O\+R\+E\+V\+ER}) -\item -void \hyperlink{classTiny_1_1Proto_a8992983d7ada115b0aa24db41594947c}{disable\+Crc} () -\item -bool \hyperlink{classTiny_1_1Proto_abb6cbae9a9944dc9ae0d756554f65a52}{enable\+Check\+Sum} () -\item -bool \hyperlink{classTiny_1_1Proto_a794afcac2ca15544247c34b059bc1289}{enable\+Crc16} () -\item -bool \hyperlink{classTiny_1_1Proto_a2ef1c80490d9343b896180ab8b8a6f77}{enable\+Crc32} () -\item -void \hyperlink{classTiny_1_1Proto_a9fdd64b8296e27f3205cd0d3ea685eac}{enable\+Uid} () -\item -void \hyperlink{classTiny_1_1Proto_aff9f3c59f58a8ca527ad0254ab806c5c}{disable\+Uid} () -\end{DoxyCompactItemize} - - -\subsection{Detailed Description} -\hyperlink{classTiny_1_1Proto}{Proto} class incapsulates Protocol functionality. Remember that you may use always C-\/style A\+PI functions instead C++. Please refer to documentation. - -\subsection{Member Function Documentation} -\mbox{\Hypertarget{classTiny_1_1Proto_a6f5f4ebec42dc6e679c25e79284d7705}\label{classTiny_1_1Proto_a6f5f4ebec42dc6e679c25e79284d7705}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!begin@{begin}} -\index{begin@{begin}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{begin()}{begin()}} -{\footnotesize\ttfamily void Tiny\+::\+Proto\+::begin (\begin{DoxyParamCaption}\item[{\hyperlink{tiny__proto__types_8h_aafd634660bba76cace57a8f9b01e044d}{write\+\_\+block\+\_\+cb\+\_\+t}}]{writecb, }\item[{\hyperlink{tiny__proto__types_8h_a15bec127d9ee63658563d62e92b5261b}{read\+\_\+block\+\_\+cb\+\_\+t}}]{readcb }\end{DoxyParamCaption})} - -Initializes protocol internal variables. If you need to switch communication with other destination point, you can call this method one again after calling \hyperlink{classTiny_1_1Proto_ae9f52fa1c4f18981672ad7af12633d4e}{end()}. -\begin{DoxyParams}{Parameters} -{\em writecb} & -\/ write function to some physical channel \\ -\hline -{\em readcb} & -\/ read function from some physical channel \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} -\mbox{\Hypertarget{classTiny_1_1Proto_a1dcad822337b6155148b1da9222fdd82}\label{classTiny_1_1Proto_a1dcad822337b6155148b1da9222fdd82}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!begin\+To\+Serial@{begin\+To\+Serial}} -\index{begin\+To\+Serial@{begin\+To\+Serial}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{begin\+To\+Serial()}{beginToSerial()}} -{\footnotesize\ttfamily void Tiny\+::\+Proto\+::begin\+To\+Serial (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}} - -Initializes protocol internal variables and redirects communication through Arduino Serial connection (Serial). \begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} -\mbox{\Hypertarget{classTiny_1_1Proto_a707f3112e0ca3651d4b0f3df6c19dd8c}\label{classTiny_1_1Proto_a707f3112e0ca3651d4b0f3df6c19dd8c}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!begin\+To\+Serial1@{begin\+To\+Serial1}} -\index{begin\+To\+Serial1@{begin\+To\+Serial1}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{begin\+To\+Serial1()}{beginToSerial1()}} -{\footnotesize\ttfamily void Tiny\+::\+Proto\+::begin\+To\+Serial1 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}} - -Initializes protocol internal variables and redirects communication through Arduino Serial1 connection (Serial1). \begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} -\mbox{\Hypertarget{classTiny_1_1Proto_a6d06cd3b1530e4986ce42a9987c522c4}\label{classTiny_1_1Proto_a6d06cd3b1530e4986ce42a9987c522c4}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!begin\+To\+Serial2@{begin\+To\+Serial2}} -\index{begin\+To\+Serial2@{begin\+To\+Serial2}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{begin\+To\+Serial2()}{beginToSerial2()}} -{\footnotesize\ttfamily void Tiny\+::\+Proto\+::begin\+To\+Serial2 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}} - -Initializes protocol internal variables and redirects communication through Arduino Serial2 connection (Serial2). \begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} -\mbox{\Hypertarget{classTiny_1_1Proto_aedbc025e1534105134e4a2499d32207c}\label{classTiny_1_1Proto_aedbc025e1534105134e4a2499d32207c}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!begin\+To\+Serial3@{begin\+To\+Serial3}} -\index{begin\+To\+Serial3@{begin\+To\+Serial3}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{begin\+To\+Serial3()}{beginToSerial3()}} -{\footnotesize\ttfamily void Tiny\+::\+Proto\+::begin\+To\+Serial3 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}} - -Initializes protocol internal variables and redirects communication through Arduino Serial3 connection (Serial3). \begin{DoxyReturn}{Returns} -None -\end{DoxyReturn} -\mbox{\Hypertarget{classTiny_1_1Proto_a8992983d7ada115b0aa24db41594947c}\label{classTiny_1_1Proto_a8992983d7ada115b0aa24db41594947c}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!disable\+Crc@{disable\+Crc}} -\index{disable\+Crc@{disable\+Crc}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{disable\+Crc()}{disableCrc()}} -{\footnotesize\ttfamily void Tiny\+::\+Proto\+::disable\+Crc (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} - -Disable C\+RC field in the protocol. If C\+RC field is O\+FF, then the frame looks like this\+: 0x7E databytes 0x7E. \mbox{\Hypertarget{classTiny_1_1Proto_aff9f3c59f58a8ca527ad0254ab806c5c}\label{classTiny_1_1Proto_aff9f3c59f58a8ca527ad0254ab806c5c}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!disable\+Uid@{disable\+Uid}} -\index{disable\+Uid@{disable\+Uid}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{disable\+Uid()}{disableUid()}} -{\footnotesize\ttfamily void Tiny\+::\+Proto\+::disable\+Uid (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}} - -Disables Uid field in the protocol. If enabled this 16-\/bit field with packet identifier is added before each payload data. Frame with uid\+: 0x7E 16-\/bituid payload 0x7E Frame without uid\+: 0x7E payload 0x7E \mbox{\Hypertarget{classTiny_1_1Proto_abb6cbae9a9944dc9ae0d756554f65a52}\label{classTiny_1_1Proto_abb6cbae9a9944dc9ae0d756554f65a52}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!enable\+Check\+Sum@{enable\+Check\+Sum}} -\index{enable\+Check\+Sum@{enable\+Check\+Sum}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{enable\+Check\+Sum()}{enableCheckSum()}} -{\footnotesize\ttfamily bool Tiny\+::\+Proto\+::enable\+Check\+Sum (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} - -Enables C\+RC 8-\/bit field in the protocol. This field contains sum of all data bytes in the packet. 8-\/bit field is supported by Nano version of Tiny library. \begin{DoxyReturn}{Returns} -true if successful false in case of error. -\end{DoxyReturn} -\mbox{\Hypertarget{classTiny_1_1Proto_a794afcac2ca15544247c34b059bc1289}\label{classTiny_1_1Proto_a794afcac2ca15544247c34b059bc1289}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!enable\+Crc16@{enable\+Crc16}} -\index{enable\+Crc16@{enable\+Crc16}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{enable\+Crc16()}{enableCrc16()}} -{\footnotesize\ttfamily bool Tiny\+::\+Proto\+::enable\+Crc16 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} - -Enables C\+RC 16-\/bit field in the protocol. This field contains F\+CS 16-\/bit C\+C\+I\+TT like defined in R\+FC 1662. 16-\/bit field is not supported by Nano version of Tiny library. \begin{DoxyReturn}{Returns} -true if successful false in case of error. -\end{DoxyReturn} -\mbox{\Hypertarget{classTiny_1_1Proto_a2ef1c80490d9343b896180ab8b8a6f77}\label{classTiny_1_1Proto_a2ef1c80490d9343b896180ab8b8a6f77}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!enable\+Crc32@{enable\+Crc32}} -\index{enable\+Crc32@{enable\+Crc32}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{enable\+Crc32()}{enableCrc32()}} -{\footnotesize\ttfamily bool Tiny\+::\+Proto\+::enable\+Crc32 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} - -Enables C\+RC 32-\/bit field in the protocol. This field contains F\+CS 32-\/bit C\+C\+I\+TT like defined in R\+FC 1662. 32-\/bit field is not supported by Nano version of Tiny library. \begin{DoxyReturn}{Returns} -true if successful false in case of error. -\end{DoxyReturn} -\mbox{\Hypertarget{classTiny_1_1Proto_a9fdd64b8296e27f3205cd0d3ea685eac}\label{classTiny_1_1Proto_a9fdd64b8296e27f3205cd0d3ea685eac}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!enable\+Uid@{enable\+Uid}} -\index{enable\+Uid@{enable\+Uid}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{enable\+Uid()}{enableUid()}} -{\footnotesize\ttfamily void Tiny\+::\+Proto\+::enable\+Uid (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}} - -Enables Uid field in the protocol. If enabled this 16-\/bit field with packet identifier is added before each payload data. Frame with uid\+: 0x7E 16-\/bituid payload 0x7E Frame without uid\+: 0x7E payload 0x7E \mbox{\Hypertarget{classTiny_1_1Proto_ae9f52fa1c4f18981672ad7af12633d4e}\label{classTiny_1_1Proto_ae9f52fa1c4f18981672ad7af12633d4e}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!end@{end}} -\index{end@{end}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{end()}{end()}} -{\footnotesize\ttfamily void Tiny\+::\+Proto\+::end (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} - -Resets protocol state. \mbox{\Hypertarget{classTiny_1_1Proto_acc00ac10509eaa11a83b0b88a2278b3e}\label{classTiny_1_1Proto_acc00ac10509eaa11a83b0b88a2278b3e}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!read@{read}} -\index{read@{read}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily int Tiny\+::\+Proto\+::read (\begin{DoxyParamCaption}\item[{char $\ast$}]{buf, }\item[{int}]{size, }\item[{uint8\+\_\+t}]{flags = {\ttfamily \hyperlink{group__FLAGS__GROUP_ga3a34267804581c5709d03f52d232b307}{T\+I\+N\+Y\+\_\+\+F\+L\+A\+G\+\_\+\+W\+A\+I\+T\+\_\+\+F\+O\+R\+E\+V\+ER}} }\end{DoxyParamCaption})} - -Reads data block from communication channel. -\begin{DoxyParams}{Parameters} -{\em buf} & -\/ buffer to place data read from communication channel \\ -\hline -{\em size} & -\/ maximum size of the buffer in bytes. \\ -\hline -{\em flags} & -\/ \hyperlink{group__FLAGS__GROUP}{Flags for Tiny A\+PI functions} \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -negative value in case of error zero if nothing is read positive -\/ number of bytes read from the channel -\end{DoxyReturn} -\mbox{\Hypertarget{classTiny_1_1Proto_aedef629f8b8968db7c8693bb45039651}\label{classTiny_1_1Proto_aedef629f8b8968db7c8693bb45039651}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!read@{read}} -\index{read@{read}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{read()}{read()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily int Tiny\+::\+Proto\+::read (\begin{DoxyParamCaption}\item[{\hyperlink{classTiny_1_1Packet}{Packet} \&}]{pkt, }\item[{uint8\+\_\+t}]{flags = {\ttfamily \hyperlink{group__FLAGS__GROUP_ga3a34267804581c5709d03f52d232b307}{T\+I\+N\+Y\+\_\+\+F\+L\+A\+G\+\_\+\+W\+A\+I\+T\+\_\+\+F\+O\+R\+E\+V\+ER}} }\end{DoxyParamCaption})} - -Reads packet from communication channel. -\begin{DoxyParams}{Parameters} -{\em pkt} & \hyperlink{classTiny_1_1Packet}{Packet} object to put data to \\ -\hline -{\em flags} & \hyperlink{group__FLAGS__GROUP}{Flags for Tiny A\+PI functions} \\ -\hline -\end{DoxyParams} -\begin{DoxySeeAlso}{See also} -\hyperlink{classTiny_1_1Packet}{Packet} -\end{DoxySeeAlso} -\begin{DoxyReturn}{Returns} -negative value in case of error zero if nothing is read positive -\/ \hyperlink{classTiny_1_1Packet}{Packet} is successfully received -\end{DoxyReturn} -\mbox{\Hypertarget{classTiny_1_1Proto_a46fbc8b8681431b9b0a9a4b953a8dc33}\label{classTiny_1_1Proto_a46fbc8b8681431b9b0a9a4b953a8dc33}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!write@{write}} -\index{write@{write}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily int Tiny\+::\+Proto\+::write (\begin{DoxyParamCaption}\item[{char $\ast$}]{buf, }\item[{int}]{size, }\item[{uint8\+\_\+t}]{flags = {\ttfamily \hyperlink{group__FLAGS__GROUP_ga3a34267804581c5709d03f52d232b307}{T\+I\+N\+Y\+\_\+\+F\+L\+A\+G\+\_\+\+W\+A\+I\+T\+\_\+\+F\+O\+R\+E\+V\+ER}} }\end{DoxyParamCaption})} - -Sends data block over communication channel. -\begin{DoxyParams}{Parameters} -{\em buf} & -\/ data to send \\ -\hline -{\em size} & -\/ length of the data in bytes \\ -\hline -{\em flags} & -\/ flags. \hyperlink{group__FLAGS__GROUP}{Flags for Tiny A\+PI functions} \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -negative value in case of error zero if nothing is sent positive -\/ should be equal to size parameter -\end{DoxyReturn} -\mbox{\Hypertarget{classTiny_1_1Proto_ade93766700805a81be6a3317d846b276}\label{classTiny_1_1Proto_ade93766700805a81be6a3317d846b276}} -\index{Tiny\+::\+Proto@{Tiny\+::\+Proto}!write@{write}} -\index{write@{write}!Tiny\+::\+Proto@{Tiny\+::\+Proto}} -\subsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily int Tiny\+::\+Proto\+::write (\begin{DoxyParamCaption}\item[{\hyperlink{classTiny_1_1Packet}{Packet} \&}]{pkt, }\item[{uint8\+\_\+t}]{flags = {\ttfamily \hyperlink{group__FLAGS__GROUP_ga3a34267804581c5709d03f52d232b307}{T\+I\+N\+Y\+\_\+\+F\+L\+A\+G\+\_\+\+W\+A\+I\+T\+\_\+\+F\+O\+R\+E\+V\+ER}} }\end{DoxyParamCaption})} - -Sends packet over communication channel. -\begin{DoxyParams}{Parameters} -{\em pkt} & -\/ \hyperlink{classTiny_1_1Packet}{Packet} to send \\ -\hline -{\em flags} & -\/ \hyperlink{group__FLAGS__GROUP}{Flags for Tiny A\+PI functions} \\ -\hline -\end{DoxyParams} -\begin{DoxySeeAlso}{See also} -\hyperlink{classTiny_1_1Packet}{Packet} -\end{DoxySeeAlso} -\begin{DoxyReturn}{Returns} -negative value in case of error zero if nothing is sent positive -\/ \hyperlink{classTiny_1_1Packet}{Packet} is successfully sent -\end{DoxyReturn} - - -The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize} -\item -src/\hyperlink{TinyProtocol_8h}{Tiny\+Protocol.\+h}\end{DoxyCompactItemize} diff --git a/docs/latex/dir_1017fea4f50f4e6c3515d09d5fd58daf.tex b/docs/latex/dir_1017fea4f50f4e6c3515d09d5fd58daf.tex deleted file mode 100644 index 1d8e971d..00000000 --- a/docs/latex/dir_1017fea4f50f4e6c3515d09d5fd58daf.tex +++ /dev/null @@ -1,2 +0,0 @@ -\hypertarget{dir_1017fea4f50f4e6c3515d09d5fd58daf}{}\section{src/proto/os/linux Directory Reference} -\label{dir_1017fea4f50f4e6c3515d09d5fd58daf}\index{src/proto/os/linux Directory Reference@{src/proto/os/linux Directory Reference}} diff --git a/docs/latex/dir_21a1a85fa70cd1acc7fc424e54ad0840.tex b/docs/latex/dir_21a1a85fa70cd1acc7fc424e54ad0840.tex index 5dc9b7f5..07766014 100644 --- a/docs/latex/dir_21a1a85fa70cd1acc7fc424e54ad0840.tex +++ b/docs/latex/dir_21a1a85fa70cd1acc7fc424e54ad0840.tex @@ -1,6 +1,7 @@ \hypertarget{dir_21a1a85fa70cd1acc7fc424e54ad0840}{}\section{src/proto/\+\_\+old Directory Reference} \label{dir_21a1a85fa70cd1acc7fc424e54ad0840}\index{src/proto/\+\_\+old Directory Reference@{src/proto/\+\_\+old Directory Reference}} -Directory dependency graph for \+\_\+old\+:\nopagebreak +Directory dependency graph for \+\_\+old\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode diff --git a/docs/latex/dir_21a1a85fa70cd1acc7fc424e54ad0840_dep.pdf b/docs/latex/dir_21a1a85fa70cd1acc7fc424e54ad0840_dep.pdf index dd4ff0cb..c9352f37 100644 Binary files a/docs/latex/dir_21a1a85fa70cd1acc7fc424e54ad0840_dep.pdf and b/docs/latex/dir_21a1a85fa70cd1acc7fc424e54ad0840_dep.pdf differ diff --git a/docs/latex/dir_4662f3ce65d87a541e94818e03dc5213.tex b/docs/latex/dir_4662f3ce65d87a541e94818e03dc5213.tex deleted file mode 100644 index c1565c6c..00000000 --- a/docs/latex/dir_4662f3ce65d87a541e94818e03dc5213.tex +++ /dev/null @@ -1,5 +0,0 @@ -\hypertarget{dir_4662f3ce65d87a541e94818e03dc5213}{}\section{src/proto/os Directory Reference} -\label{dir_4662f3ce65d87a541e94818e03dc5213}\index{src/proto/os Directory Reference@{src/proto/os Directory Reference}} -\subsection*{Directories} -\begin{DoxyCompactItemize} -\end{DoxyCompactItemize} diff --git a/docs/latex/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.pdf b/docs/latex/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.pdf index c28a56d0..5ffdcf91 100644 Binary files a/docs/latex/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.pdf and b/docs/latex/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.pdf differ diff --git a/docs/latex/dir_61a763563eb3728beb0014ac26e3418e_dep.pdf b/docs/latex/dir_61a763563eb3728beb0014ac26e3418e_dep.pdf index 0f85bdbb..cf13c524 100644 Binary files a/docs/latex/dir_61a763563eb3728beb0014ac26e3418e_dep.pdf and b/docs/latex/dir_61a763563eb3728beb0014ac26e3418e_dep.pdf differ diff --git a/docs/latex/dir_68267d1309a1af8e8297ef4c3efbcdba.tex b/docs/latex/dir_68267d1309a1af8e8297ef4c3efbcdba.tex index 2290a77b..1cb71e77 100644 --- a/docs/latex/dir_68267d1309a1af8e8297ef4c3efbcdba.tex +++ b/docs/latex/dir_68267d1309a1af8e8297ef4c3efbcdba.tex @@ -1,6 +1,7 @@ \hypertarget{dir_68267d1309a1af8e8297ef4c3efbcdba}{}\section{src Directory Reference} \label{dir_68267d1309a1af8e8297ef4c3efbcdba}\index{src Directory Reference@{src Directory Reference}} -Directory dependency graph for src\+:\nopagebreak +Directory dependency graph for src\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode diff --git a/docs/latex/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.pdf b/docs/latex/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.pdf index 3b45a438..1faed01a 100644 Binary files a/docs/latex/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.pdf and b/docs/latex/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.pdf differ diff --git a/docs/latex/dir_75a472a4d9716ba9c1151370abaacaf0_dep.pdf b/docs/latex/dir_75a472a4d9716ba9c1151370abaacaf0_dep.pdf index e670ca44..099b3f87 100644 Binary files a/docs/latex/dir_75a472a4d9716ba9c1151370abaacaf0_dep.pdf and b/docs/latex/dir_75a472a4d9716ba9c1151370abaacaf0_dep.pdf differ diff --git a/docs/latex/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.pdf b/docs/latex/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.pdf index bb13f28e..8e2097dd 100644 Binary files a/docs/latex/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.pdf and b/docs/latex/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.pdf differ diff --git a/docs/latex/dir_9fb74fd6b278eeceae309d1e30cf7c21_dep.pdf b/docs/latex/dir_9fb74fd6b278eeceae309d1e30cf7c21_dep.pdf index ee8cc51a..34f41b4e 100644 Binary files a/docs/latex/dir_9fb74fd6b278eeceae309d1e30cf7c21_dep.pdf and b/docs/latex/dir_9fb74fd6b278eeceae309d1e30cf7c21_dep.pdf differ diff --git a/docs/latex/dir_f0e7f7e70e244e0817e4aa8b9982190a.tex b/docs/latex/dir_f0e7f7e70e244e0817e4aa8b9982190a.tex deleted file mode 100644 index cee17f86..00000000 --- a/docs/latex/dir_f0e7f7e70e244e0817e4aa8b9982190a.tex +++ /dev/null @@ -1,2 +0,0 @@ -\hypertarget{dir_f0e7f7e70e244e0817e4aa8b9982190a}{}\section{src/proto/os/arduino Directory Reference} -\label{dir_f0e7f7e70e244e0817e4aa8b9982190a}\index{src/proto/os/arduino Directory Reference@{src/proto/os/arduino Directory Reference}} diff --git a/docs/latex/dir_f468ab7bd64995917426f65613b4e1f4_dep.pdf b/docs/latex/dir_f468ab7bd64995917426f65613b4e1f4_dep.pdf index e738599f..2b33bba6 100644 Binary files a/docs/latex/dir_f468ab7bd64995917426f65613b4e1f4_dep.pdf and b/docs/latex/dir_f468ab7bd64995917426f65613b4e1f4_dep.pdf differ diff --git a/docs/latex/dir_f9eb52bc39deae7ac93b11083dea5441.tex b/docs/latex/dir_f9eb52bc39deae7ac93b11083dea5441.tex deleted file mode 100644 index b9bc51b0..00000000 --- a/docs/latex/dir_f9eb52bc39deae7ac93b11083dea5441.tex +++ /dev/null @@ -1,2 +0,0 @@ -\hypertarget{dir_f9eb52bc39deae7ac93b11083dea5441}{}\section{src/proto/os/mingw32 Directory Reference} -\label{dir_f9eb52bc39deae7ac93b11083dea5441}\index{src/proto/os/mingw32 Directory Reference@{src/proto/os/mingw32 Directory Reference}} diff --git a/docs/latex/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.pdf b/docs/latex/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.pdf index 00d1333b..5fb07e45 100644 Binary files a/docs/latex/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.pdf and b/docs/latex/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.pdf differ diff --git a/docs/latex/group__HDLC__API.tex b/docs/latex/group__HDLC__API.tex index a5ed7a84..7bb1209d 100644 --- a/docs/latex/group__HDLC__API.tex +++ b/docs/latex/group__HDLC__API.tex @@ -36,8 +36,8 @@ \subsection*{Functions} \item int \hyperlink{group__HDLC__API_ga911a3f1cb32dd6cadd00223e0097642c}{hdlc\+\_\+run\+\_\+rx} (\hyperlink{struct__hdlc__handle__t}{hdlc\+\_\+handle\+\_\+t} handle, const void $\ast$data, int len, int $\ast$error) \item -\mbox{\Hypertarget{group__HDLC__API_ga196e57dcf71cd8910f756181f1f86871}\label{group__HDLC__API_ga196e57dcf71cd8910f756181f1f86871}} -int {\bfseries hdlc\+\_\+run\+\_\+rx\+\_\+until\+\_\+read} (\hyperlink{struct__hdlc__handle__t}{hdlc\+\_\+handle\+\_\+t} handle, \hyperlink{tiny__types_8h_a15bec127d9ee63658563d62e92b5261b}{read\+\_\+block\+\_\+cb\+\_\+t} readcb, int $\ast$error) +\mbox{\Hypertarget{group__HDLC__API_gaf20d86bb10361096f507838394c624c7}\label{group__HDLC__API_gaf20d86bb10361096f507838394c624c7}} +int {\bfseries hdlc\+\_\+run\+\_\+rx\+\_\+until\+\_\+read} (\hyperlink{struct__hdlc__handle__t}{hdlc\+\_\+handle\+\_\+t} handle, \hyperlink{tiny__types_8h_a15bec127d9ee63658563d62e92b5261b}{read\+\_\+block\+\_\+cb\+\_\+t} readcb, void $\ast$user\+\_\+data, uint16\+\_\+t timeout) \item int \hyperlink{group__HDLC__API_gae31d921043b4f175603114c206b6b829}{hdlc\+\_\+run\+\_\+tx} (\hyperlink{struct__hdlc__handle__t}{hdlc\+\_\+handle\+\_\+t} handle) \item diff --git a/docs/latex/refman.tex b/docs/latex/refman.tex index fe1bf93a..50bc554a 100644 --- a/docs/latex/refman.tex +++ b/docs/latex/refman.tex @@ -125,7 +125,7 @@ \begin{titlepage} \vspace*{7cm} \begin{center}% -{\Large Tiny protocol \\[1ex]\large 0.\+7.\+2 }\\ +{\Large Tiny protocol \\[1ex]\large 0.\+8.\+0 }\\ \vspace*{1cm} {\large Generated by Doxygen 1.8.13}\\ \end{center} diff --git a/docs/latex/structSTinyData.tex b/docs/latex/structSTinyData.tex index 23f90a09..edd0015b 100644 --- a/docs/latex/structSTinyData.tex +++ b/docs/latex/structSTinyData.tex @@ -6,7 +6,8 @@ -Collaboration diagram for S\+Tiny\+Data\+:\nopagebreak +Collaboration diagram for S\+Tiny\+Data\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode diff --git a/docs/latex/structSTinyData__coll__graph.pdf b/docs/latex/structSTinyData__coll__graph.pdf index c8ece878..af47425b 100644 Binary files a/docs/latex/structSTinyData__coll__graph.pdf and b/docs/latex/structSTinyData__coll__graph.pdf differ diff --git a/docs/latex/structSTinyHdData____coll__graph.md5 b/docs/latex/structSTinyHdData____coll__graph.md5 deleted file mode 100644 index 257120cb..00000000 --- a/docs/latex/structSTinyHdData____coll__graph.md5 +++ /dev/null @@ -1 +0,0 @@ -8af38d4f35eebf45d78d519bf80173d9 \ No newline at end of file diff --git a/docs/latex/structSTinyHdData____coll__graph.pdf b/docs/latex/structSTinyHdData____coll__graph.pdf deleted file mode 100644 index 583062b7..00000000 Binary files a/docs/latex/structSTinyHdData____coll__graph.pdf and /dev/null differ diff --git a/docs/latex/structSTinyLightData.tex b/docs/latex/structSTinyLightData.tex index b1985a1f..3611ff21 100644 --- a/docs/latex/structSTinyLightData.tex +++ b/docs/latex/structSTinyLightData.tex @@ -6,7 +6,8 @@ -Collaboration diagram for S\+Tiny\+Light\+Data\+:\nopagebreak +Collaboration diagram for S\+Tiny\+Light\+Data\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode diff --git a/docs/latex/structSTinyLightData__coll__graph.pdf b/docs/latex/structSTinyLightData__coll__graph.pdf index 8a1734ac..e17b0feb 100644 Binary files a/docs/latex/structSTinyLightData__coll__graph.pdf and b/docs/latex/structSTinyLightData__coll__graph.pdf differ diff --git a/docs/latex/structlist__element__.tex b/docs/latex/structlist__element__.tex index e7543b9d..794205d7 100644 --- a/docs/latex/structlist__element__.tex +++ b/docs/latex/structlist__element__.tex @@ -11,7 +11,8 @@ -Collaboration diagram for list\+\_\+element\+\_\+\+:\nopagebreak +Collaboration diagram for list\+\_\+element\+\_\+\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode diff --git a/docs/latex/structlist__element____coll__graph.pdf b/docs/latex/structlist__element____coll__graph.pdf index 855491c5..abf3041e 100644 Binary files a/docs/latex/structlist__element____coll__graph.pdf and b/docs/latex/structlist__element____coll__graph.pdf differ diff --git a/docs/latex/structtiny__request__.tex b/docs/latex/structtiny__request__.tex index 9eb09d18..8943c95c 100644 --- a/docs/latex/structtiny__request__.tex +++ b/docs/latex/structtiny__request__.tex @@ -11,7 +11,8 @@ -Collaboration diagram for tiny\+\_\+request\+\_\+\+:\nopagebreak +Collaboration diagram for tiny\+\_\+request\+\_\+\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode diff --git a/docs/latex/structtiny__request____coll__graph.pdf b/docs/latex/structtiny__request____coll__graph.pdf index f9472864..f89b0c18 100644 Binary files a/docs/latex/structtiny__request____coll__graph.pdf and b/docs/latex/structtiny__request____coll__graph.pdf differ diff --git a/docs/latex/tiny__hd_8h__dep__incl.pdf b/docs/latex/tiny__hd_8h__dep__incl.pdf index 5a525181..129b00ac 100644 Binary files a/docs/latex/tiny__hd_8h__dep__incl.pdf and b/docs/latex/tiny__hd_8h__dep__incl.pdf differ diff --git a/docs/latex/tiny__hd_8h__incl.pdf b/docs/latex/tiny__hd_8h__incl.pdf index 25173403..5d735ee1 100644 Binary files a/docs/latex/tiny__hd_8h__incl.pdf and b/docs/latex/tiny__hd_8h__incl.pdf differ diff --git a/docs/latex/tiny__layer2_8h__dep__incl.md5 b/docs/latex/tiny__layer2_8h__dep__incl.md5 deleted file mode 100644 index c1cb2db0..00000000 --- a/docs/latex/tiny__layer2_8h__dep__incl.md5 +++ /dev/null @@ -1 +0,0 @@ -15891e038d69b781db447306b6571987 \ No newline at end of file diff --git a/docs/latex/tiny__layer2_8h__dep__incl.pdf b/docs/latex/tiny__layer2_8h__dep__incl.pdf deleted file mode 100644 index aa3201f4..00000000 Binary files a/docs/latex/tiny__layer2_8h__dep__incl.pdf and /dev/null differ diff --git a/docs/latex/tiny__layer2_8h__incl.pdf b/docs/latex/tiny__layer2_8h__incl.pdf index 790f7b75..b6101850 100644 Binary files a/docs/latex/tiny__layer2_8h__incl.pdf and b/docs/latex/tiny__layer2_8h__incl.pdf differ diff --git a/docs/latex/tiny__light_8h__dep__incl.pdf b/docs/latex/tiny__light_8h__dep__incl.pdf index 0dc21a89..9ed5b9ba 100644 Binary files a/docs/latex/tiny__light_8h__dep__incl.pdf and b/docs/latex/tiny__light_8h__dep__incl.pdf differ diff --git a/docs/latex/tiny__light_8h__incl.pdf b/docs/latex/tiny__light_8h__incl.pdf index 82362d86..5c763de7 100644 Binary files a/docs/latex/tiny__light_8h__incl.pdf and b/docs/latex/tiny__light_8h__incl.pdf differ diff --git a/docs/latex/tiny__proto__types_8h.tex b/docs/latex/tiny__proto__types_8h.tex deleted file mode 100644 index eaa76244..00000000 --- a/docs/latex/tiny__proto__types_8h.tex +++ /dev/null @@ -1,139 +0,0 @@ -\hypertarget{tiny__proto__types_8h}{}\section{src/proto/hal/tiny\+\_\+proto\+\_\+types.h File Reference} -\label{tiny__proto__types_8h}\index{src/proto/hal/tiny\+\_\+proto\+\_\+types.\+h@{src/proto/hal/tiny\+\_\+proto\+\_\+types.\+h}} - - -Tiny protocol Types. - - -{\ttfamily \#include $<$stdint.\+h$>$}\newline -{\ttfamily \#include \char`\"{}tiny\+\_\+defines.\+h\char`\"{}}\newline -Include dependency graph for tiny\+\_\+proto\+\_\+types.\+h\+:\nopagebreak -\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[width=242pt]{tiny__proto__types_8h__incl} -\end{center} -\end{figure} -This graph shows which files directly or indirectly include this file\+:\nopagebreak -\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[width=350pt]{tiny__proto__types_8h__dep__incl} -\end{center} -\end{figure} -\subsection*{Classes} -\begin{DoxyCompactItemize} -\item -struct \hyperlink{structSTinyStats}{S\+Tiny\+Stats} -\end{DoxyCompactItemize} -\subsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \hyperlink{group__ERROR__FLAGS_ga16cd043c890ed1fa381b3a20f75a626c}{T\+I\+N\+Y\+\_\+\+S\+U\+C\+C\+E\+SS}~(1) -\begin{DoxyCompactList}\small\item\em Tiny operation successful. Only tiny\+\_\+send\+\_\+start and tiny\+\_\+read\+\_\+start functions return this code. \end{DoxyCompactList}\item -\#define \hyperlink{group__ERROR__FLAGS_ga69c869a686b67bf0b7b8115599515d61}{T\+I\+N\+Y\+\_\+\+N\+O\+\_\+\+E\+R\+R\+OR}~(0) -\begin{DoxyCompactList}\small\item\em No error. For tiny\+\_\+send and tiny\+\_\+read functions, this means, no data sent or received. \end{DoxyCompactList}\item -\#define \hyperlink{group__ERROR__FLAGS_ga84e6ca143550038e1a71cf36078d1926}{T\+I\+N\+Y\+\_\+\+E\+R\+R\+\_\+\+F\+A\+I\+L\+ED}~(-\/1) -\begin{DoxyCompactList}\small\item\em Timeout. \end{DoxyCompactList}\item -\#define \hyperlink{group__ERROR__FLAGS_gac9ba8076a1eb8613e8d1f07629ff0cd1}{T\+I\+N\+Y\+\_\+\+E\+R\+R\+\_\+\+T\+I\+M\+E\+O\+UT}~(-\/2) -\begin{DoxyCompactList}\small\item\em Timeout happened. The function must be called once again. \end{DoxyCompactList}\item -\#define \hyperlink{group__ERROR__FLAGS_ga7bbe7440d11ad304b0af68e011f4eab7}{T\+I\+N\+Y\+\_\+\+E\+R\+R\+\_\+\+D\+A\+T\+A\+\_\+\+T\+O\+O\+\_\+\+L\+A\+R\+GE}~(-\/3) -\begin{DoxyCompactList}\small\item\em Data too large to fit the user buffer, valid for tiny\+\_\+read function. \end{DoxyCompactList}\item -\#define \hyperlink{group__ERROR__FLAGS_ga541a9e67a84e39595ad647d641c4df2e}{T\+I\+N\+Y\+\_\+\+E\+R\+R\+\_\+\+I\+N\+V\+A\+L\+I\+D\+\_\+\+D\+A\+TA}~(-\/4) -\begin{DoxyCompactList}\small\item\em Some invalid data passed to Tiny A\+PI function. \end{DoxyCompactList}\item -\#define \hyperlink{group__ERROR__FLAGS_ga9b3e170e1c6ce269f216ef4a1ac61995}{T\+I\+N\+Y\+\_\+\+E\+R\+R\+\_\+\+B\+U\+SY}~(-\/5) -\begin{DoxyCompactList}\small\item\em A\+PI function detected that operation cannot be performed right now. \end{DoxyCompactList}\item -\#define \hyperlink{group__ERROR__FLAGS_gae1949de45d9c478830dad9c9b996193a}{T\+I\+N\+Y\+\_\+\+E\+R\+R\+\_\+\+O\+U\+T\+\_\+\+O\+F\+\_\+\+S\+Y\+NC}~(-\/6) -\begin{DoxyCompactList}\small\item\em Out of sync -\/ received some data, which are not part of the frame (tiny\+\_\+read) \end{DoxyCompactList}\item -\#define \hyperlink{group__ERROR__FLAGS_gab15347e8e9f90d709d94d9c151d505b7}{T\+I\+N\+Y\+\_\+\+E\+R\+R\+\_\+\+A\+G\+A\+IN}~(-\/7) -\begin{DoxyCompactList}\small\item\em No data for now, need to retry reading once again. \end{DoxyCompactList}\item -\#define \hyperlink{group__FLAGS__GROUP_gadadd60eb21d7949e6d097ad36aab9b2e}{T\+I\+N\+Y\+\_\+\+F\+L\+A\+G\+\_\+\+N\+O\+\_\+\+W\+A\+IT}~(0) -\begin{DoxyCompactList}\small\item\em This flag makes tiny A\+PI functions perform as non-\/blocking. \end{DoxyCompactList}\item -\#define \hyperlink{group__FLAGS__GROUP_gae41123cfeed375e618a4152c9bbd0d6d}{T\+I\+N\+Y\+\_\+\+F\+L\+A\+G\+\_\+\+R\+E\+A\+D\+\_\+\+A\+LL}~(1) -\begin{DoxyCompactList}\small\item\em This flag makes tiny\+\_\+read function to read whole frame event if it doesn\textquotesingle{}t fit the buffer. \end{DoxyCompactList}\item -\#define \hyperlink{group__FLAGS__GROUP_ga593e3353339a36dcd0746057e2864958}{T\+I\+N\+Y\+\_\+\+F\+L\+A\+G\+\_\+\+L\+O\+C\+K\+\_\+\+S\+E\+ND}~(2) -\begin{DoxyCompactList}\small\item\em Informs advanced A\+PI that caller wants to start transmit new frame to the channel. \end{DoxyCompactList}\item -\#define \hyperlink{group__FLAGS__GROUP_ga3a34267804581c5709d03f52d232b307}{T\+I\+N\+Y\+\_\+\+F\+L\+A\+G\+\_\+\+W\+A\+I\+T\+\_\+\+F\+O\+R\+E\+V\+ER}~(0x80) -\begin{DoxyCompactList}\small\item\em This flag makes tiny A\+PI functions perform in blocking mode. \end{DoxyCompactList}\end{DoxyCompactItemize} -\subsection*{Typedefs} -\begin{DoxyCompactItemize} -\item -typedef int($\ast$ \hyperlink{tiny__proto__types_8h_aafd634660bba76cace57a8f9b01e044d}{write\+\_\+block\+\_\+cb\+\_\+t}) (void $\ast$pdata, const void $\ast$buffer, int size) -\item -typedef int($\ast$ \hyperlink{tiny__proto__types_8h_a15bec127d9ee63658563d62e92b5261b}{read\+\_\+block\+\_\+cb\+\_\+t}) (void $\ast$pdata, void $\ast$buffer, int size) -\item -typedef void($\ast$ \hyperlink{tiny__proto__types_8h_ad6bf709565b8aecb9e6ecf196f219d54}{on\+\_\+frame\+\_\+cb\+\_\+t}) (void $\ast$handle, uint16\+\_\+t uid, uint8\+\_\+t $\ast$pdata, int size) -\end{DoxyCompactItemize} - - -\subsection{Detailed Description} -Tiny protocol Types. - -This is Tiny protocol implementation for microcontrollers - -\subsection{Typedef Documentation} -\mbox{\Hypertarget{tiny__proto__types_8h_ad6bf709565b8aecb9e6ecf196f219d54}\label{tiny__proto__types_8h_ad6bf709565b8aecb9e6ecf196f219d54}} -\index{tiny\+\_\+proto\+\_\+types.\+h@{tiny\+\_\+proto\+\_\+types.\+h}!on\+\_\+frame\+\_\+cb\+\_\+t@{on\+\_\+frame\+\_\+cb\+\_\+t}} -\index{on\+\_\+frame\+\_\+cb\+\_\+t@{on\+\_\+frame\+\_\+cb\+\_\+t}!tiny\+\_\+proto\+\_\+types.\+h@{tiny\+\_\+proto\+\_\+types.\+h}} -\subsubsection{\texorpdfstring{on\+\_\+frame\+\_\+cb\+\_\+t}{on\_frame\_cb\_t}} -{\footnotesize\ttfamily typedef void($\ast$ on\+\_\+frame\+\_\+cb\+\_\+t) (void $\ast$handle, uint16\+\_\+t uid, uint8\+\_\+t $\ast$pdata, int size)} - -on\+\_\+frame\+\_\+cb\+\_\+t is a callback function, which is called every time new frame is received, or sent. refer to tiny\+\_\+set\+\_\+callbacks -\begin{DoxyParams}{Parameters} -{\em handle} & -\/ handle of Tiny. \\ -\hline -{\em uid} & -\/ U\+ID of the received frame or sent frame (if uids are enabled). \\ -\hline -{\em pdata} & -\/ data received over Tiny Protocol. \\ -\hline -{\em size} & -\/ size of data received. \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -None. -\end{DoxyReturn} -\begin{DoxySeeAlso}{See also} -\hyperlink{group__ADVANCED__API_gac562103dd1699b82fddf29dccdc0ec7c}{tiny\+\_\+set\+\_\+callbacks} -\end{DoxySeeAlso} -\mbox{\Hypertarget{tiny__proto__types_8h_a15bec127d9ee63658563d62e92b5261b}\label{tiny__proto__types_8h_a15bec127d9ee63658563d62e92b5261b}} -\index{tiny\+\_\+proto\+\_\+types.\+h@{tiny\+\_\+proto\+\_\+types.\+h}!read\+\_\+block\+\_\+cb\+\_\+t@{read\+\_\+block\+\_\+cb\+\_\+t}} -\index{read\+\_\+block\+\_\+cb\+\_\+t@{read\+\_\+block\+\_\+cb\+\_\+t}!tiny\+\_\+proto\+\_\+types.\+h@{tiny\+\_\+proto\+\_\+types.\+h}} -\subsubsection{\texorpdfstring{read\+\_\+block\+\_\+cb\+\_\+t}{read\_block\_cb\_t}} -{\footnotesize\ttfamily typedef int($\ast$ read\+\_\+block\+\_\+cb\+\_\+t) (void $\ast$pdata, void $\ast$buffer, int size)} - -The function reads data from communication channel. -\begin{DoxyParams}{Parameters} -{\em pdata} & -\/ pointer to user private data. -\/ absent in Arduino version \\ -\hline -{\em buffer} & -\/ pointer to a buffer to read data to from the channel. \\ -\hline -{\em size} & -\/ maximum size of the buffer. \\ -\hline -\end{DoxyParams} -\begin{DoxySeeAlso}{See also} -\hyperlink{tiny__proto__types_8h_aafd634660bba76cace57a8f9b01e044d}{write\+\_\+block\+\_\+cb\+\_\+t} -\end{DoxySeeAlso} -\begin{DoxyReturn}{Returns} -the function must return negative value in case of error or number of bytes actually read or zero. -\end{DoxyReturn} -\mbox{\Hypertarget{tiny__proto__types_8h_aafd634660bba76cace57a8f9b01e044d}\label{tiny__proto__types_8h_aafd634660bba76cace57a8f9b01e044d}} -\index{tiny\+\_\+proto\+\_\+types.\+h@{tiny\+\_\+proto\+\_\+types.\+h}!write\+\_\+block\+\_\+cb\+\_\+t@{write\+\_\+block\+\_\+cb\+\_\+t}} -\index{write\+\_\+block\+\_\+cb\+\_\+t@{write\+\_\+block\+\_\+cb\+\_\+t}!tiny\+\_\+proto\+\_\+types.\+h@{tiny\+\_\+proto\+\_\+types.\+h}} -\subsubsection{\texorpdfstring{write\+\_\+block\+\_\+cb\+\_\+t}{write\_block\_cb\_t}} -{\footnotesize\ttfamily typedef int($\ast$ write\+\_\+block\+\_\+cb\+\_\+t) (void $\ast$pdata, const void $\ast$buffer, int size)} - -The function writes data to communication channel port. -\begin{DoxyParams}{Parameters} -{\em pdata} & -\/ pointer to user private data -\/ absent in Arduino version \\ -\hline -{\em buffer} & -\/ pointer to the data to send to channel. \\ -\hline -{\em size} & -\/ size of data to write. \\ -\hline -\end{DoxyParams} -\begin{DoxySeeAlso}{See also} -\hyperlink{tiny__proto__types_8h_a15bec127d9ee63658563d62e92b5261b}{read\+\_\+block\+\_\+cb\+\_\+t} -\end{DoxySeeAlso} -\begin{DoxyReturn}{Returns} -the function must return negative value in case of error or number of bytes written or zero. -\end{DoxyReturn} diff --git a/docs/latex/tiny__proto__types_8h__dep__incl.md5 b/docs/latex/tiny__proto__types_8h__dep__incl.md5 deleted file mode 100644 index 82ef3720..00000000 --- a/docs/latex/tiny__proto__types_8h__dep__incl.md5 +++ /dev/null @@ -1 +0,0 @@ -3aad964a61a7ef3cb6ea6c19ff2406d0 \ No newline at end of file diff --git a/docs/latex/tiny__proto__types_8h__dep__incl.pdf b/docs/latex/tiny__proto__types_8h__dep__incl.pdf deleted file mode 100644 index 948fae0c..00000000 Binary files a/docs/latex/tiny__proto__types_8h__dep__incl.pdf and /dev/null differ diff --git a/docs/latex/tiny__proto__types_8h__incl.md5 b/docs/latex/tiny__proto__types_8h__incl.md5 deleted file mode 100644 index 29ed5a86..00000000 --- a/docs/latex/tiny__proto__types_8h__incl.md5 +++ /dev/null @@ -1 +0,0 @@ -8846d3f01ac135def96c15002964ea49 \ No newline at end of file diff --git a/docs/latex/tiny__proto__types_8h__incl.pdf b/docs/latex/tiny__proto__types_8h__incl.pdf deleted file mode 100644 index 8687df2b..00000000 Binary files a/docs/latex/tiny__proto__types_8h__incl.pdf and /dev/null differ diff --git a/docs/latex/tiny__types_8h__dep__incl.pdf b/docs/latex/tiny__types_8h__dep__incl.pdf index 411b101f..3a360e45 100644 Binary files a/docs/latex/tiny__types_8h__dep__incl.pdf and b/docs/latex/tiny__types_8h__dep__incl.pdf differ diff --git a/docs/latex/tiny__types_8h__incl.pdf b/docs/latex/tiny__types_8h__incl.pdf index 6bf88ad0..7e3427cb 100644 Binary files a/docs/latex/tiny__types_8h__incl.pdf and b/docs/latex/tiny__types_8h__incl.pdf differ diff --git a/docs/linux_2tiny__config_8h_source.html b/docs/linux_2tiny__config_8h_source.html index 76bd062c..f0cd3a73 100644 --- a/docs/linux_2tiny__config_8h_source.html +++ b/docs/linux_2tiny__config_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/linux_2tiny__defines_8h_source.html b/docs/linux_2tiny__defines_8h_source.html index 69bfaaa1..6d71d2c2 100644 --- a/docs/linux_2tiny__defines_8h_source.html +++ b/docs/linux_2tiny__defines_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
@@ -68,7 +68,7 @@
tiny_defines.h
-
1 /*
2  Copyright 2016 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
20 #pragma once
21 
22 #include <pthread.h>
23 #include <unistd.h>
24 #include <stdint.h>
25 #include <time.h>
26 
27 typedef pthread_mutex_t tiny_mutex_t;
28 
29 typedef struct
30 {
31  uint8_t bits;
32  uint16_t waiters;
33  pthread_mutex_t mutex;
34  pthread_cond_t cond;
35 } tiny_events_t;
36 
37 
tiny_events_t
Definition: tiny_defines.h:29
+
1 /*
2  Copyright 2016 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
20 #pragma once
21 
22 #include "tiny_config.h"
23 #include <pthread.h>
24 #include <unistd.h>
25 #include <stdint.h>
26 #include <time.h>
27 
28 typedef pthread_mutex_t tiny_mutex_t;
29 
30 typedef struct
31 {
32  uint8_t bits;
33  uint16_t waiters;
34  pthread_mutex_t mutex;
35  pthread_cond_t cond;
36 } tiny_events_t;
37 
38 
tiny_events_t
Definition: tiny_defines.h:30
diff --git a/docs/mainpage_8dox.html b/docs/mainpage_8dox.html index 712112a3..7e8c73b6 100644 --- a/docs/mainpage_8dox.html +++ b/docs/mainpage_8dox.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/mingw32_2tiny__config_8h_source.html b/docs/mingw32_2tiny__config_8h_source.html index a570a513..1522535d 100644 --- a/docs/mingw32_2tiny__config_8h_source.html +++ b/docs/mingw32_2tiny__config_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/mingw32_2tiny__defines_8h_source.html b/docs/mingw32_2tiny__defines_8h_source.html index 412bf841..1ffe674f 100644 --- a/docs/mingw32_2tiny__defines_8h_source.html +++ b/docs/mingw32_2tiny__defines_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
@@ -68,7 +68,8 @@
tiny_defines.h
-
1 /*
2  Copyright 2016,2019 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
20 #pragma once
21 
22 #include <pthread.h>
23 #include <unistd.h>
24 #include <stdint.h>
25 #include <time.h>
26 #include <Windows.h>
27 
28 
29 //#define TASK_YIELD() Sleep(0)
30 
31 
32 /*static inline uint16_t PLATFORM_TICKS()
33 {
34  return GetTickCount();
35 }
36 */
37 
38 
+
1 /*
2  Copyright 2016,2019 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
20 #pragma once
21 
22 #include "tiny_config.h"
23 #include <pthread.h>
24 #include <unistd.h>
25 #include <stdint.h>
26 #include <time.h>
27 #include <windows.h>
28 
29 typedef pthread_mutex_t tiny_mutex_t;
30 
31 typedef struct
32 {
33  uint8_t bits;
34  uint16_t waiters;
35  pthread_mutex_t mutex;
36  pthread_cond_t cond;
37 } tiny_events_t;
38 
39 //#define TASK_YIELD() Sleep(0)
40 
41 
42 /*static inline uint16_t PLATFORM_TICKS()
43 {
44  return GetTickCount();
45 }
46 */
47 
48 #if 0
49 
50 #include <pthread.h>
51 #include <unistd.h>
52 #include <stdint.h>
53 #include <time.h>
54 #include <Windows.h>
55 
56 #define PLATFORM_MUTEX pthread_mutex_t
57 
58 #define MUTEX_INIT(x) pthread_mutex_init(&x, NULL)
59 
60 #define MUTEX_LOCK(x) pthread_mutex_lock(&x)
61 
62 #define MUTEX_TRY_LOCK(x) pthread_mutex_trylock(&x)
63 
64 #define MUTEX_UNLOCK(x) pthread_mutex_unlock(&x)
65 
66 #define MUTEX_DESTROY(x) pthread_mutex_destroy(&x)
67 
68 #define PLATFORM_COND pthread_cond_t
69 
70 #define COND_INIT(x) pthread_cond_init(&x, NULL)
71 
72 #define COND_DESTROY(x) pthread_cond_destroy(&x)
73 
74 #define COND_WAIT(cond, mutex) pthread_cond_wait(&cond, &mutex)
75 
76 #define COND_SIGNAL(x) pthread_cond_signal(&x)
77 
78 #define TASK_YIELD() sleep(0)
79 
80 
81 static inline uint16_t PLATFORM_TICKS()
82 {
83  return GetTickCount();
84 }
85 
86 #endif
tiny_events_t
Definition: tiny_defines.h:30
+
Generated by   diff --git a/docs/modules.html b/docs/modules.html index 8f3308af..871909f8 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/pages.html b/docs/pages.html index 3a21abb7..41ae28ad 100644 --- a/docs/pages.html +++ b/docs/pages.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structSTinyData-members.html b/docs/structSTinyData-members.html index 7c4a18d1..b4d40ce7 100644 --- a/docs/structSTinyData-members.html +++ b/docs/structSTinyData-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structSTinyData.html b/docs/structSTinyData.html index 5bb402cd..99183cf4 100644 --- a/docs/structSTinyData.html +++ b/docs/structSTinyData.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structSTinyHdData__-members.html b/docs/structSTinyHdData__-members.html index 82ce2c2a..6e6377f5 100644 --- a/docs/structSTinyHdData__-members.html +++ b/docs/structSTinyHdData__-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structSTinyHdData__.html b/docs/structSTinyHdData__.html index 3badc5fb..3e6a9d33 100644 --- a/docs/structSTinyHdData__.html +++ b/docs/structSTinyHdData__.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structSTinyHdData____coll__graph.map b/docs/structSTinyHdData____coll__graph.map deleted file mode 100644 index aa979df8..00000000 --- a/docs/structSTinyHdData____coll__graph.map +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/docs/structSTinyHdData____coll__graph.md5 b/docs/structSTinyHdData____coll__graph.md5 deleted file mode 100644 index 6c710fb9..00000000 --- a/docs/structSTinyHdData____coll__graph.md5 +++ /dev/null @@ -1 +0,0 @@ -e14c23d12ce6b5cad6534dafa1cee45c \ No newline at end of file diff --git a/docs/structSTinyHdData____coll__graph.png b/docs/structSTinyHdData____coll__graph.png deleted file mode 100644 index e8d19c55..00000000 Binary files a/docs/structSTinyHdData____coll__graph.png and /dev/null differ diff --git a/docs/structSTinyHdInit__-members.html b/docs/structSTinyHdInit__-members.html index 10eba66f..4f5fb073 100644 --- a/docs/structSTinyHdInit__-members.html +++ b/docs/structSTinyHdInit__-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structSTinyHdInit__.html b/docs/structSTinyHdInit__.html index 84acba9f..51285279 100644 --- a/docs/structSTinyHdInit__.html +++ b/docs/structSTinyHdInit__.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structSTinyLightData-members.html b/docs/structSTinyLightData-members.html index d23545d2..86b57d61 100644 --- a/docs/structSTinyLightData-members.html +++ b/docs/structSTinyLightData-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structSTinyLightData.html b/docs/structSTinyLightData.html index 2db49c28..2f31df73 100644 --- a/docs/structSTinyLightData.html +++ b/docs/structSTinyLightData.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structSTinyRxStatus-members.html b/docs/structSTinyRxStatus-members.html index 2cc02de7..a522f559 100644 --- a/docs/structSTinyRxStatus-members.html +++ b/docs/structSTinyRxStatus-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structSTinyRxStatus.html b/docs/structSTinyRxStatus.html index 4f1db12a..d6b13a21 100644 --- a/docs/structSTinyRxStatus.html +++ b/docs/structSTinyRxStatus.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structSTinyStats-members.html b/docs/structSTinyStats-members.html index 5e62a8bd..f2159253 100644 --- a/docs/structSTinyStats-members.html +++ b/docs/structSTinyStats-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structSTinyStats.html b/docs/structSTinyStats.html index ab740dcc..857dbee0 100644 --- a/docs/structSTinyStats.html +++ b/docs/structSTinyStats.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structSTinyTxStatus-members.html b/docs/structSTinyTxStatus-members.html index 46e7c91d..278b4afe 100644 --- a/docs/structSTinyTxStatus-members.html +++ b/docs/structSTinyTxStatus-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structSTinyTxStatus.html b/docs/structSTinyTxStatus.html index ac1a77c1..6f169a66 100644 --- a/docs/structSTinyTxStatus.html +++ b/docs/structSTinyTxStatus.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/struct__hdlc__handle__t-members.html b/docs/struct__hdlc__handle__t-members.html index 1a18a3d4..12ef897f 100644 --- a/docs/struct__hdlc__handle__t-members.html +++ b/docs/struct__hdlc__handle__t-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/struct__hdlc__handle__t.html b/docs/struct__hdlc__handle__t.html index ebed4d91..2c280df0 100644 --- a/docs/struct__hdlc__handle__t.html +++ b/docs/struct__hdlc__handle__t.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structlist__element__-members.html b/docs/structlist__element__-members.html index 85d9b012..5d65c29b 100644 --- a/docs/structlist__element__-members.html +++ b/docs/structlist__element__-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/structlist__element__.html b/docs/structlist__element__.html index 269f63a9..239726c1 100644 --- a/docs/structlist__element__.html +++ b/docs/structlist__element__.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
@@ -76,6 +76,8 @@ Collaboration diagram for list_element_:
Collaboration graph
+ +
[legend]
diff --git a/docs/structtiny__events__t.html b/docs/structtiny__events__t.html index 93f9530c..b33742f4 100644 --- a/docs/structtiny__events__t.html +++ b/docs/structtiny__events__t.html @@ -22,7 +22,7 @@ diff --git a/docs/structtiny__request__-members.html b/docs/structtiny__request__-members.html index 896b713c..d98f72c0 100644 --- a/docs/structtiny__request__-members.html +++ b/docs/structtiny__request__-members.html @@ -22,7 +22,7 @@ diff --git a/docs/structtiny__request__.html b/docs/structtiny__request__.html index b03c8ff9..9bb29ba9 100644 --- a/docs/structtiny__request__.html +++ b/docs/structtiny__request__.html @@ -22,7 +22,7 @@ diff --git a/docs/tiny__config_8h_source.html b/docs/tiny__config_8h_source.html deleted file mode 100644 index 2573a327..00000000 --- a/docs/tiny__config_8h_source.html +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - -Tiny protocol: src/proto/hal/arduino/tiny_config.h Source File - - - - - - - - - -
-
-

diff --git a/docs/structtiny__events__t-members.html b/docs/structtiny__events__t-members.html index 288f1fda..b1dac5ad 100644 --- a/docs/structtiny__events__t-members.html +++ b/docs/structtiny__events__t-members.html @@ -22,7 +22,7 @@

Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
- - - - - -
-
Tiny protocol -  0.7.0 -
-
Tiny communication protocol for microcontrollers
-
- - - - - - - - - -
-
- - -
- -
- - - -
-
-
tiny_config.h
-
-
-
1 #ifndef __TINY_CONFIG_H__
2 #define __TINY_CONFIG_H__
3 
4 #ifdef ARDUINO_AVR_NANO
5 // Tiny protocol configuration for Nano boards
8 
9 # define CONFIG_ENABLE_CHECKSUM
10 
11 #else
12 // Tiny protocol configuration for All other boards
15 
16 #ifndef CONFIG_ENABLE_CHECKSUM
17 # define CONFIG_ENABLE_CHECKSUM
18 #endif
19 
20 #ifndef CONFIG_ENABLE_FCS16
21 # define CONFIG_ENABLE_FCS16
22 #endif
23 
24 #ifndef CONFIG_ENABLE_FCS32
25 # define CONFIG_ENABLE_FCS32
26 #endif
27 
28 #endif
29 
30 
31 #endif /* __TINY_CONFIG_H__ */
32 
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/docs/tiny__defines_8h_source.html b/docs/tiny__defines_8h_source.html deleted file mode 100644 index e7bc2b9f..00000000 --- a/docs/tiny__defines_8h_source.html +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - -Tiny protocol: src/proto/hal/tiny_defines.h Source File - - - - - - - - - -
-
- - - - - - -
-
Tiny protocol -  0.7.0 -
-
Tiny communication protocol for microcontrollers
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
tiny_defines.h
-
-
-
1 /*
2  Copyright 2018 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef __OS_TINY_CONFIG_H__
21 #define __OS_TINY_CONFIG_H__
22 
23 #ifdef ARDUINO
24 #include "arduino/tiny_defines.h"
25 
26 #elif __linux__
27 #include "linux/tiny_defines.h"
28 
29 #else
30 #include "mingw32/tiny_defines.h"
31 
32 #endif
33 
34 #endif /* __OS_TINY_CONFIG_H__ */
35 
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/docs/tiny__hd_8h.html b/docs/tiny__hd_8h.html index 96d71304..232eea1b 100644 --- a/docs/tiny__hd_8h.html +++ b/docs/tiny__hd_8h.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/tiny__hd_8h_source.html b/docs/tiny__hd_8h_source.html index 61b1178e..64ee2f22 100644 --- a/docs/tiny__hd_8h_source.html +++ b/docs/tiny__hd_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
@@ -69,19 +69,19 @@
Go to the documentation of this file.
1 /*
2  Copyright 2017-2019 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
27 #ifndef _TINY_HALF_DUPLEX_H_
28 #define _TINY_HALF_DUPLEX_H_
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 #include <stdint.h>
35 #include "proto/hdlc/tiny_hdlc.h"
36 #include "proto/hal/tiny_types.h"
37 
38 
43 typedef struct STinyHdData_
44 {
45 #ifndef DOXYGEN_SHOULD_SKIP_THIS
46  hdlc_struct_t _hdlc;
47  uint8_t _sent;
48 #endif
49  write_block_cb_t write_func;
52  read_block_cb_t read_func;
54  on_frame_cb_t on_frame_cb;
56  on_frame_cb_t on_sent_cb;
58  uint16_t timeout;
60  uint16_t uid;
66  uint8_t multithread_mode;
68  void * user_data;
69 } STinyHdData;
70 
71 
75 typedef struct STinyHdInit_
76 {
78  write_block_cb_t write_func;
80  read_block_cb_t read_func;
82  void * pdata;
84  on_frame_cb_t on_frame_cb;
86  on_frame_cb_t on_sent_cb;
92  void * inbuf;
94  uint16_t inbuf_size;
96  uint16_t timeout;
98  uint8_t multithread_mode;
104  hdlc_crc_t crc_type;
105 } STinyHdInit;
106 
123 extern int tiny_hd_init(STinyHdData * handle,
124  STinyHdInit * init);
125 
133 extern void tiny_hd_close(STinyHdData * handle);
134 
158 extern int tiny_hd_run(STinyHdData * handle);
159 
179 extern int tiny_send_wait_ack(STinyHdData *handle, void *buf, uint16_t len);
180 
181 #if 0
182 static inline STinyData * hd_to_tiny(STinyHdData * handle)
183 {
184  return &handle->handle;
185 }
186 
187 static inline STinyHdData * tiny_to_hd(STinyData * handle)
188 {
189  return (STinyHdData *)handle;
190 }
191 #endif
192 
197 #ifdef __cplusplus
198 }
199 #endif
200 
201 #endif /* _TINY_HALFDUPLEX_PROTOCOL_H_ */
hdlc_crc_t
hdlc_crc_t
Definition: tiny_hdlc.h:28
-
tiny_hd_init
int tiny_hd_init(STinyHdData *handle, STinyHdInit *init)
Initialized communication for Tiny Half Duplex protocol.
Definition: tiny_hd.c:159
+
tiny_hd_init
int tiny_hd_init(STinyHdData *handle, STinyHdInit *init)
Initialized communication for Tiny Half Duplex protocol.
Definition: tiny_hd.c:179
STinyHdData_::multithread_mode
uint8_t multithread_mode
Multithread mode. Should be zero.
Definition: tiny_hd.h:66
STinyHdData_::on_sent_cb
on_frame_cb_t on_sent_cb
Callback to get notification of sent frames.
Definition: tiny_hd.h:56
STinyHdInit_::read_func
read_block_cb_t read_func
callback function to read bytes from the physical channel
Definition: tiny_hd.h:80
STinyHdInit_::timeout
uint16_t timeout
timeout. Can be set to 0 during initialization. In this case timeout will be set to default ...
Definition: tiny_hd.h:96
STinyHdInit_::on_sent_cb
on_frame_cb_t on_sent_cb
Callback to get notification of sent frames.
Definition: tiny_hd.h:86
-
tiny_hd_close
void tiny_hd_close(STinyHdData *handle)
stops Tiny Half Duplex state machine
Definition: tiny_hd.c:190
+
tiny_hd_close
void tiny_hd_close(STinyHdData *handle)
stops Tiny Half Duplex state machine
Definition: tiny_hd.c:211
STinyData
Definition: tiny_layer2.h:110
STinyHdData_::on_frame_cb
on_frame_cb_t on_frame_cb
Callback to process received frames.
Definition: tiny_hd.h:54
STinyHdData_::read_func
read_block_cb_t read_func
callback function to read bytes from the physical channel
Definition: tiny_hd.h:52
-
tiny_send_wait_ack
int tiny_send_wait_ack(STinyHdData *handle, void *buf, uint16_t len)
Sends userdata and waits for acknowledgement from remote side.
Definition: tiny_hd.c:70
-
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:134
-
on_frame_cb_t
void(* on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size)
Definition: tiny_types.h:147
+
tiny_send_wait_ack
int tiny_send_wait_ack(STinyHdData *handle, void *buf, uint16_t len)
Sends userdata and waits for acknowledgement from remote side.
Definition: tiny_hd.c:80
+
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:136
+
on_frame_cb_t
void(* on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size)
Definition: tiny_types.h:149
STinyHdInit_::on_frame_cb
on_frame_cb_t on_frame_cb
callback function to process incoming frames
Definition: tiny_hd.h:84
STinyHdInit_::write_func
write_block_cb_t write_func
callback function to write bytes to the physical channel
Definition: tiny_hd.h:78
STinyHdInit_::crc_type
hdlc_crc_t crc_type
Definition: tiny_hd.h:104
@@ -95,8 +95,8 @@
STinyHdInit_::multithread_mode
uint8_t multithread_mode
multithread mode. At present should be 0
Definition: tiny_hd.h:98
_hdlc_handle_t
Definition: tiny_hdlc.h:42
STinyHdData_::timeout
uint16_t timeout
Timeout for operations with acknowledge.
Definition: tiny_hd.h:58
-
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:123
-
tiny_hd_run
int tiny_hd_run(STinyHdData *handle)
runs receive functions of Tiny Half Duplex protocol.
Definition: tiny_hd.c:204
+
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:125
+
tiny_hd_run
int tiny_hd_run(STinyHdData *handle)
runs receive functions of Tiny Half Duplex protocol.
Definition: tiny_hd.c:225
STinyHdData_::uid
uint16_t uid
field used to store temporary uid
Definition: tiny_hd.h:60
STinyHdData_::user_data
void * user_data
user specific data
Definition: tiny_hd.h:68
STinyHdData_::write_func
write_block_cb_t write_func
callback function to write bytes to the physical channel
Definition: tiny_hd.h:50
diff --git a/docs/tiny__hdlc_8h_source.html b/docs/tiny__hdlc_8h_source.html index dba6ca7c..62fe4939 100644 --- a/docs/tiny__hdlc_8h_source.html +++ b/docs/tiny__hdlc_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
@@ -68,33 +68,33 @@
tiny_hdlc.h
-
1 #pragma once
2 
3 #include "proto/hal/tiny_types.h"
4 #include <stdint.h>
5 #include <stdbool.h>
6 
7 #ifdef __cplusplus
8 extern "C"
9 {
10 #endif
11 
17 #ifdef CONFIG_ENABLE_FCS32
19  typedef uint32_t crc_t;
20 #else
21  typedef uint16_t crc_t;
22 #endif
23 
28 typedef enum
29 {
30  HDLC_CRC_DEFAULT = 0,
31  HDLC_CRC_8 = 8,
32  HDLC_CRC_16 = 16,
33  HDLC_CRC_32 = 32,
34  HDLC_CRC_OFF = 0xFF,
35 } hdlc_crc_t;
36 
42 typedef struct _hdlc_handle_t
43 {
54  write_block_cb_t send_tx;
55 
67  int (*on_frame_read)(void *user_data, void *data, int len);
68 
79  int (*on_frame_sent)(void *user_data, const void *data, int len);
80 
84  void *rx_buf;
85 
89  int rx_buf_size;
90 
96  hdlc_crc_t crc_type;
97 
102  bool multithread_mode;
103 
105  void *user_data;
106 
107 #ifndef DOXYGEN_SHOULD_SKIP_THIS
108 
109  tiny_mutex_t send_mutex;
110  tiny_events_t events;
111  struct
112  {
113  uint8_t *data;
114  int len;
115  int (*state)( struct _hdlc_handle_t *handle, const uint8_t *data, int len );
116  uint8_t escape;
117  } rx;
118  struct
119  {
120  const uint8_t *origin_data;
121  const uint8_t *data;
122  int len;
123  crc_t crc;
124  uint8_t escape;
125  int (*state)( struct _hdlc_handle_t *handle );
126  } tx;
127 #endif
128 } hdlc_struct_t, *hdlc_handle_t;
129 
137 hdlc_handle_t hdlc_init( hdlc_struct_t *hdlc_info );
138 
144 int hdlc_close( hdlc_handle_t handle );
145 
152 void hdlc_reset( hdlc_handle_t handle );
153 
167 int hdlc_run_rx( hdlc_handle_t handle, const void *data, int len, int *error );
168 
169 int hdlc_run_rx_until_read( hdlc_handle_t handle, read_block_cb_t readcb, int *error );
170 
183 int hdlc_run_tx( hdlc_handle_t handle );
184 
215 int hdlc_send( hdlc_handle_t handle, const void *data, int len, uint32_t timeout );
216 
224 void hdlc_set_rx_buffer( hdlc_handle_t handle, void *data, int size);
225 
230 #ifdef __cplusplus
231 }
232 #endif
233 
hdlc_crc_t
hdlc_crc_t
Definition: tiny_hdlc.h:28
+
1 #pragma once
2 
3 #include "proto/hal/tiny_types.h"
4 #include <stdint.h>
5 #include <stdbool.h>
6 
7 #ifdef __cplusplus
8 extern "C"
9 {
10 #endif
11 
17 #ifdef CONFIG_ENABLE_FCS32
19  typedef uint32_t crc_t;
20 #else
21  typedef uint16_t crc_t;
22 #endif
23 
28 typedef enum
29 {
30  HDLC_CRC_DEFAULT = 0,
31  HDLC_CRC_8 = 8,
32  HDLC_CRC_16 = 16,
33  HDLC_CRC_32 = 32,
34  HDLC_CRC_OFF = 0xFF,
35 } hdlc_crc_t;
36 
42 typedef struct _hdlc_handle_t
43 {
54  write_block_cb_t send_tx;
55 
67  int (*on_frame_read)(void *user_data, void *data, int len);
68 
79  int (*on_frame_sent)(void *user_data, const void *data, int len);
80 
84  void *rx_buf;
85 
89  int rx_buf_size;
90 
96  hdlc_crc_t crc_type;
97 
102  bool multithread_mode;
103 
105  void *user_data;
106 
107 #ifndef DOXYGEN_SHOULD_SKIP_THIS
108 
109  tiny_mutex_t send_mutex;
110  tiny_events_t events;
111  struct
112  {
113  uint8_t *data;
114  int len;
115  int (*state)( struct _hdlc_handle_t *handle, const uint8_t *data, int len );
116  uint8_t escape;
117  } rx;
118  struct
119  {
120  const uint8_t *origin_data;
121  const uint8_t *data;
122  int len;
123  crc_t crc;
124  uint8_t escape;
125  int (*state)( struct _hdlc_handle_t *handle );
126  } tx;
127 #endif
128 } hdlc_struct_t, *hdlc_handle_t;
129 
137 hdlc_handle_t hdlc_init( hdlc_struct_t *hdlc_info );
138 
144 int hdlc_close( hdlc_handle_t handle );
145 
152 void hdlc_reset( hdlc_handle_t handle );
153 
167 int hdlc_run_rx( hdlc_handle_t handle, const void *data, int len, int *error );
168 
169 int hdlc_run_rx_until_read( hdlc_handle_t handle, read_block_cb_t readcb, void *user_data, uint16_t timeout );
170 
183 int hdlc_run_tx( hdlc_handle_t handle );
184 
215 int hdlc_send( hdlc_handle_t handle, const void *data, int len, uint32_t timeout );
216 
224 void hdlc_set_rx_buffer( hdlc_handle_t handle, void *data, int size);
225 
230 #ifdef __cplusplus
231 }
232 #endif
233 
hdlc_crc_t
hdlc_crc_t
Definition: tiny_hdlc.h:28
_hdlc_handle_t::rx_buf_size
int rx_buf_size
Definition: tiny_hdlc.h:89
HDLC_CRC_DEFAULT
If default is specified HDLC will auto select CRC option.
Definition: tiny_hdlc.h:30
_hdlc_handle_t::send_tx
write_block_cb_t send_tx
Definition: tiny_hdlc.h:54
_hdlc_handle_t::on_frame_read
int(* on_frame_read)(void *user_data, void *data, int len)
Definition: tiny_hdlc.h:67
_hdlc_handle_t::multithread_mode
bool multithread_mode
Definition: tiny_hdlc.h:102
-
hdlc_run_tx
int hdlc_run_tx(hdlc_handle_t handle)
Definition: tiny_hdlc.c:208
+
hdlc_run_tx
int hdlc_run_tx(hdlc_handle_t handle)
Definition: tiny_hdlc.c:219
_hdlc_handle_t::crc_type
hdlc_crc_t crc_type
Definition: tiny_hdlc.h:96
-
hdlc_init
hdlc_handle_t hdlc_init(hdlc_struct_t *hdlc_info)
Definition: tiny_hdlc.c:27
-
hdlc_reset
void hdlc_reset(hdlc_handle_t handle)
Definition: tiny_hdlc.c:66
-
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:134
+
hdlc_init
hdlc_handle_t hdlc_init(hdlc_struct_t *hdlc_info)
Definition: tiny_hdlc.c:38
+
hdlc_reset
void hdlc_reset(hdlc_handle_t handle)
Definition: tiny_hdlc.c:77
+
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:136
HDLC_CRC_32
CCITT-32.
Definition: tiny_hdlc.h:33
_hdlc_handle_t::rx_buf
void * rx_buf
Definition: tiny_hdlc.h:84
HDLC_CRC_8
Simple sum of all bytes in user payload.
Definition: tiny_hdlc.h:31
hdlc_struct_t
struct _hdlc_handle_t hdlc_struct_t
tiny_types.h
Tiny protocol Types.
-
hdlc_send
int hdlc_send(hdlc_handle_t handle, const void *data, int len, uint32_t timeout)
Definition: tiny_hdlc.c:261
+
hdlc_send
int hdlc_send(hdlc_handle_t handle, const void *data, int len, uint32_t timeout)
Definition: tiny_hdlc.c:272
_hdlc_handle_t::on_frame_sent
int(* on_frame_sent)(void *user_data, const void *data, int len)
Definition: tiny_hdlc.h:79
_hdlc_handle_t
Definition: tiny_hdlc.h:42
-
hdlc_close
int hdlc_close(hdlc_handle_t handle)
Definition: tiny_hdlc.c:51
+
hdlc_close
int hdlc_close(hdlc_handle_t handle)
Definition: tiny_hdlc.c:62
HDLC_CRC_OFF
Disable CRC field.
Definition: tiny_hdlc.h:34
-
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:123
+
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:125
_hdlc_handle_t::user_data
void * user_data
Definition: tiny_hdlc.h:105
HDLC_CRC_16
CCITT-16.
Definition: tiny_hdlc.h:32
-
hdlc_set_rx_buffer
void hdlc_set_rx_buffer(hdlc_handle_t handle, void *data, int size)
Definition: tiny_hdlc.c:419
-
hdlc_run_rx
int hdlc_run_rx(hdlc_handle_t handle, const void *data, int len, int *error)
Definition: tiny_hdlc.c:396
-
tiny_events_t
Definition: tiny_defines.h:29
+
hdlc_set_rx_buffer
void hdlc_set_rx_buffer(hdlc_handle_t handle, void *data, int size)
Definition: tiny_hdlc.c:439
+
hdlc_run_rx
int hdlc_run_rx(hdlc_handle_t handle, const void *data, int len, int *error)
Definition: tiny_hdlc.c:416
+
tiny_events_t
Definition: tiny_defines.h:30
diff --git a/docs/tiny__layer2_8h.html b/docs/tiny__layer2_8h.html index ce61d320..7803e2a6 100644 --- a/docs/tiny__layer2_8h.html +++ b/docs/tiny__layer2_8h.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/tiny__layer2_8h__dep__incl.map b/docs/tiny__layer2_8h__dep__incl.map deleted file mode 100644 index 81093799..00000000 --- a/docs/tiny__layer2_8h__dep__incl.map +++ /dev/null @@ -1,3 +0,0 @@ - - - diff --git a/docs/tiny__layer2_8h__dep__incl.md5 b/docs/tiny__layer2_8h__dep__incl.md5 deleted file mode 100644 index 23c5d4f9..00000000 --- a/docs/tiny__layer2_8h__dep__incl.md5 +++ /dev/null @@ -1 +0,0 @@ -a75dce2e1ec87e6ab7fbd6ef754bec8c \ No newline at end of file diff --git a/docs/tiny__layer2_8h__dep__incl.png b/docs/tiny__layer2_8h__dep__incl.png deleted file mode 100644 index 8ccccdd3..00000000 Binary files a/docs/tiny__layer2_8h__dep__incl.png and /dev/null differ diff --git a/docs/tiny__layer2_8h_source.html b/docs/tiny__layer2_8h_source.html index 5c382ba1..cce00598 100644 --- a/docs/tiny__layer2_8h_source.html +++ b/docs/tiny__layer2_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
@@ -75,7 +75,7 @@
STinyTxStatus::fcs
fcs_t fcs
The field contains calculated checksum and not available in TINY_MINIMAL configuration.
Definition: tiny_layer2.h:91
STinyRxStatus
Definition: tiny_layer2.h:59
STinyRxStatus::inprogress
uint8_t inprogress
The state of Receive State machine.
Definition: tiny_layer2.h:65
-
STinyStats
Definition: tiny_types.h:98
+
STinyStats
Definition: tiny_types.h:100
tiny_unlock
void tiny_unlock(STinyData *handle)
unlock Tiny state machine for send operations
Definition: tiny_layer2.c:1092
tiny_send_buffer
int tiny_send_buffer(STinyData *handle, uint8_t *pbuf, int len, uint8_t flags)
sends user provided data in the body of the frame
Definition: tiny_layer2.c:422
STinyData::fcs_bits
uint8_t fcs_bits
The field contains number of bits to use for FCS and not available in TINY_MINIMAL configuration...
Definition: tiny_layer2.h:128
@@ -88,11 +88,11 @@
tiny_simple_read
int tiny_simple_read(STinyData *handle, uint8_t *pbuf, int len)
reads frame from the channel in blocking mode.
Definition: tiny_layer2.c:987
tiny_enable_uid
void tiny_enable_uid(STinyData *handle, uint8_t on)
The function enables uid support. Enables uid support. The function affects on tiny_on_rx_byte and on...
Definition: tiny_layer2.c:224
tiny_init
int tiny_init(STinyData *handle, write_block_cb_t write_func, read_block_cb_t read_func, void *pdata)
Definition: tiny_layer2.c:145
-
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:134
+
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:136
tiny_send
int tiny_send(STinyData *handle, uint16_t *uid, uint8_t *pbuf, int len, uint8_t flags)
sends frame with user payload to communication channel
Definition: tiny_layer2.c:554
STinyTxStatus::sentbytes
int sentbytes
Number of payload bytes, sent from the frame being sent.
Definition: tiny_layer2.h:83
STinyRxStatus::framelen
int framelen
Number of bytes in the frame being received.
Definition: tiny_layer2.h:63
-
on_frame_cb_t
void(* on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size)
Definition: tiny_types.h:147
+
on_frame_cb_t
void(* on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size)
Definition: tiny_types.h:149
STinyData::pdata
void * pdata
pointer to application defined data, passed during protocol initialization - absent in Arduino versio...
Definition: tiny_layer2.h:113
STinyData::rx
STinyRxStatus rx
Definition: tiny_layer2.h:123
STinyData::uid_support
uint8_t uid_support
flag indicates if uid support is enabled. It is important for tiny_on_rx_byte()
Definition: tiny_layer2.h:139
@@ -103,7 +103,7 @@
tiny_read_terminate
void tiny_read_terminate(STinyData *handle)
terminates read operation
Definition: tiny_layer2.c:907
tiny_simple_send
int tiny_simple_send(STinyData *handle, uint8_t *pbuf, int len)
sends frame with user payload to communication channel in blocking mode
Definition: tiny_layer2.c:608
tiny_get_callbacks
int tiny_get_callbacks(STinyData *handle, on_frame_cb_t *read_cb, on_frame_cb_t *send_cb)
returns callbacks assigned for frame processing The function returns set callbacks.
Definition: tiny_layer2.c:1051
-
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:123
+
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:125
STinyTxStatus::framelen
int framelen
Length of the frame passed by a user.
Definition: tiny_layer2.h:87
STinyTxStatus::inprogress
uint8_t inprogress
Definition: tiny_layer2.h:89
STinyData::write_cb
on_frame_cb_t write_cb
pointer to callback function to get data being sent
Definition: tiny_layer2.h:137
diff --git a/docs/tiny__light_8h.html b/docs/tiny__light_8h.html index fadd1857..dcb1a748 100644 --- a/docs/tiny__light_8h.html +++ b/docs/tiny__light_8h.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/tiny__light_8h_source.html b/docs/tiny__light_8h_source.html index 61427194..ac616830 100644 --- a/docs/tiny__light_8h_source.html +++ b/docs/tiny__light_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
@@ -71,15 +71,15 @@ Go to the documentation of this file.
1 /*
2  Copyright 2017-2019 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
26 #ifndef _TINY_LIGHT_H_
27 #define _TINY_LIGHT_H_
28 
29 #include "proto/hdlc/tiny_hdlc.h"
30 #include "proto/hal/tiny_types.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
41 /*************************************************************
42  *
43  * Tiny defines
44  *
45  *************************************************************/
46 
51 typedef struct
52 {
53 #ifdef CONFIG_ENABLE_STATS
54  STinyStats stat;
56 #endif
57  write_block_cb_t write_func;
60  read_block_cb_t read_func;
62  void *user_data;
63 #ifndef DOXYGEN_SHOULD_SKIP_THIS
64  hdlc_struct_t _hdlc;
65  uint8_t _received;
66  uint8_t _sent;
67 #endif
68 } STinyLightData;
69 
70 
71 
85 extern int tiny_light_init(void *handle,
86  write_block_cb_t write_func,
87  read_block_cb_t read_func,
88  void *pdata);
89 
90 
98 extern int tiny_light_close(void *handle);
99 
114 extern int tiny_light_send(void *handle, const uint8_t *pbuf, int len);
115 
134 extern int tiny_light_read(void *handle, uint8_t *pbuf, int len);
135 
146 extern hdlc_handle_t tiny_light_get_hdlc(void *handle);
147 
152 #ifdef __cplusplus
153 }
154 #endif
155 
156 #endif /* _TINY_PROTOCOL_H_ */
tiny_light_get_hdlc
hdlc_handle_t tiny_light_get_hdlc(void *handle)
returns lower level hdlc handle.
Definition: tiny_light.c:185
tiny_light_close
int tiny_light_close(void *handle)
Definition: tiny_light.c:105
tiny_light_send
int tiny_light_send(void *handle, const uint8_t *pbuf, int len)
sends frame with user payload to communication channel in blocking mode
Definition: tiny_light.c:136
-
STinyStats
Definition: tiny_types.h:98
+
STinyStats
Definition: tiny_types.h:100
tiny_light_read
int tiny_light_read(void *handle, uint8_t *pbuf, int len)
reads frame from the channel in blocking mode.
Definition: tiny_light.c:158
-
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:134
+
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:136
STinyLightData::read_func
read_block_cb_t read_func
pointer to platform related read function
Definition: tiny_light.h:60
STinyLightData
Definition: tiny_light.h:51
tiny_types.h
Tiny protocol Types.
STinyLightData::user_data
void * user_data
user-specific data
Definition: tiny_light.h:62
_hdlc_handle_t
Definition: tiny_hdlc.h:42
-
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:123
+
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:125
tiny_light_init
int tiny_light_init(void *handle, write_block_cb_t write_func, read_block_cb_t read_func, void *pdata)
Definition: tiny_light.c:72
diff --git a/docs/tiny__list_8h_source.html b/docs/tiny__list_8h_source.html index e5fb2dc1..57dab31a 100644 --- a/docs/tiny__list_8h_source.html +++ b/docs/tiny__list_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/tiny__proto__types_8h.html b/docs/tiny__proto__types_8h.html deleted file mode 100644 index 1f517965..00000000 --- a/docs/tiny__proto__types_8h.html +++ /dev/null @@ -1,260 +0,0 @@ - - - - - - - -Tiny protocol: src/proto/hal/tiny_proto_types.h File Reference - - - - - - - - - -
-
- - - - - - -
-
Tiny protocol -  0.7.0 -
-
Tiny communication protocol for microcontrollers
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Classes | -Macros | -Typedefs
-
-
tiny_proto_types.h File Reference
-
-
- -

Tiny protocol Types. -More...

-
#include <stdint.h>
-#include "tiny_defines.h"
-
-Include dependency graph for tiny_proto_types.h:
-
-
- - - - - -
-
-This graph shows which files directly or indirectly include this file:
-
-
- - - - - - - - -
-
-

Go to the source code of this file.

- - - - -

-Classes

struct  STinyStats
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Macros

-#define TINY_SUCCESS   (1)
 Tiny operation successful. Only tiny_send_start and tiny_read_start functions return this code.
 
-#define TINY_NO_ERROR   (0)
 No error. For tiny_send and tiny_read functions, this means, no data sent or received.
 
-#define TINY_ERR_FAILED   (-1)
 Timeout.
 
-#define TINY_ERR_TIMEOUT   (-2)
 Timeout happened. The function must be called once again.
 
-#define TINY_ERR_DATA_TOO_LARGE   (-3)
 Data too large to fit the user buffer, valid for tiny_read function.
 
-#define TINY_ERR_INVALID_DATA   (-4)
 Some invalid data passed to Tiny API function.
 
-#define TINY_ERR_BUSY   (-5)
 API function detected that operation cannot be performed right now.
 
-#define TINY_ERR_OUT_OF_SYNC   (-6)
 Out of sync - received some data, which are not part of the frame (tiny_read)
 
-#define TINY_ERR_AGAIN   (-7)
 No data for now, need to retry reading once again.
 
-#define TINY_FLAG_NO_WAIT   (0)
 This flag makes tiny API functions perform as non-blocking.
 
-#define TINY_FLAG_READ_ALL   (1)
 This flag makes tiny_read function to read whole frame event if it doesn't fit the buffer.
 
-#define TINY_FLAG_LOCK_SEND   (2)
 Informs advanced API that caller wants to start transmit new frame to the channel.
 
-#define TINY_FLAG_WAIT_FOREVER   (0x80)
 This flag makes tiny API functions perform in blocking mode.
 
- - - - - - - -

-Typedefs

typedef int(* write_block_cb_t) (void *pdata, const void *buffer, int size)
 
typedef int(* read_block_cb_t) (void *pdata, void *buffer, int size)
 
typedef void(* on_frame_cb_t) (void *handle, uint16_t uid, uint8_t *pdata, int size)
 
-

Detailed Description

-

Tiny protocol Types.

-

This is Tiny protocol implementation for microcontrollers

-

Typedef Documentation

- -

◆ on_frame_cb_t

- -
-
- - - - -
typedef void(* on_frame_cb_t) (void *handle, uint16_t uid, uint8_t *pdata, int size)
-
-

on_frame_cb_t is a callback function, which is called every time new frame is received, or sent. refer to tiny_set_callbacks

Parameters
- - - - - -
handle- handle of Tiny.
uid- UID of the received frame or sent frame (if uids are enabled).
pdata- data received over Tiny Protocol.
size- size of data received.
-
-
-
Returns
None.
-
See also
tiny_set_callbacks
- -
-
- -

◆ read_block_cb_t

- -
-
- - - - -
typedef int(* read_block_cb_t) (void *pdata, void *buffer, int size)
-
-

The function reads data from communication channel.

Parameters
- - - - -
pdata- pointer to user private data. - absent in Arduino version
buffer- pointer to a buffer to read data to from the channel.
size- maximum size of the buffer.
-
-
-
See also
write_block_cb_t
-
Returns
the function must return negative value in case of error or number of bytes actually read or zero.
- -
-
- -

◆ write_block_cb_t

- -
-
- - - - -
typedef int(* write_block_cb_t) (void *pdata, const void *buffer, int size)
-
-

The function writes data to communication channel port.

Parameters
- - - - -
pdata- pointer to user private data - absent in Arduino version
buffer- pointer to the data to send to channel.
size- size of data to write.
-
-
-
See also
read_block_cb_t
-
Returns
the function must return negative value in case of error or number of bytes written or zero.
- -
-
-
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/docs/tiny__proto__types_8h__dep__incl.map b/docs/tiny__proto__types_8h__dep__incl.map deleted file mode 100644 index fd4710be..00000000 --- a/docs/tiny__proto__types_8h__dep__incl.map +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/docs/tiny__proto__types_8h__dep__incl.md5 b/docs/tiny__proto__types_8h__dep__incl.md5 deleted file mode 100644 index 59918aba..00000000 --- a/docs/tiny__proto__types_8h__dep__incl.md5 +++ /dev/null @@ -1 +0,0 @@ -c92f7f9225e05167e21112eb8ba9a32b \ No newline at end of file diff --git a/docs/tiny__proto__types_8h__dep__incl.png b/docs/tiny__proto__types_8h__dep__incl.png deleted file mode 100644 index 7411e030..00000000 Binary files a/docs/tiny__proto__types_8h__dep__incl.png and /dev/null differ diff --git a/docs/tiny__proto__types_8h__incl.map b/docs/tiny__proto__types_8h__incl.map deleted file mode 100644 index 366667f3..00000000 --- a/docs/tiny__proto__types_8h__incl.map +++ /dev/null @@ -1,5 +0,0 @@ - - - - - diff --git a/docs/tiny__proto__types_8h__incl.md5 b/docs/tiny__proto__types_8h__incl.md5 deleted file mode 100644 index 2652a30f..00000000 --- a/docs/tiny__proto__types_8h__incl.md5 +++ /dev/null @@ -1 +0,0 @@ -336f4c52f6d28704d80992f421814130 \ No newline at end of file diff --git a/docs/tiny__proto__types_8h__incl.png b/docs/tiny__proto__types_8h__incl.png deleted file mode 100644 index bc1a0890..00000000 Binary files a/docs/tiny__proto__types_8h__incl.png and /dev/null differ diff --git a/docs/tiny__proto__types_8h_source.html b/docs/tiny__proto__types_8h_source.html deleted file mode 100644 index b3c5cb5a..00000000 --- a/docs/tiny__proto__types_8h_source.html +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - -Tiny protocol: src/proto/hal/tiny_proto_types.h Source File - - - - - - - - - -
-
- - - - - - -
-
Tiny protocol -  0.7.0 -
-
Tiny communication protocol for microcontrollers
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
tiny_proto_types.h
-
-
-Go to the documentation of this file.
1 /*
2  Copyright 2016-2018 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
26 #ifndef _TINY_PROTO_TYPES_H_
27 #define _TINY_PROTO_TYPES_H_
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 #include <stdint.h>
34 #include "tiny_defines.h"
35 
37 #ifdef CONFIG_ENABLE_FCS32
38  typedef uint32_t fcs_t;
39 #else
40  typedef uint16_t fcs_t;
41 #endif
42 
48 #define TINY_SUCCESS (1)
50 #define TINY_NO_ERROR (0)
52 #define TINY_ERR_FAILED (-1)
54 #define TINY_ERR_TIMEOUT (-2)
56 #define TINY_ERR_DATA_TOO_LARGE (-3)
58 #define TINY_ERR_INVALID_DATA (-4)
60 #define TINY_ERR_BUSY (-5)
62 #define TINY_ERR_OUT_OF_SYNC (-6)
64 #define TINY_ERR_AGAIN (-7)
66 
74 #define TINY_FLAG_NO_WAIT (0)
76 #define TINY_FLAG_READ_ALL (1)
78 #define TINY_FLAG_LOCK_SEND (2)
80 #define TINY_FLAG_WAIT_FOREVER (0x80)
82 
89 typedef struct
90 {
92  uint32_t oosyncBytes;
94  uint32_t bytesSent;
96  uint32_t bytesReceived;
98  uint32_t framesSent;
100  uint32_t framesReceived;
102  uint32_t framesBroken;
103 } STinyStats;
104 
114 typedef int (*write_block_cb_t)(void *pdata, const void *buffer, int size);
115 
125 typedef int (*read_block_cb_t)(void *pdata, void *buffer, int size);
126 
127 
138 typedef void (*on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size);
139 
140 #ifdef __cplusplus
141 }
142 #endif
143 
144 #endif
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_proto_types.h:114
-
STinyStats::framesBroken
uint32_t framesBroken
Number of broken frames received.
Definition: tiny_proto_types.h:102
-
STinyStats::bytesReceived
uint32_t bytesReceived
Number of payload bytes totally received through the channel.
Definition: tiny_proto_types.h:96
-
STinyStats::framesSent
uint32_t framesSent
Number of frames, successfully sent through the channel.
Definition: tiny_proto_types.h:98
-
STinyStats
Definition: tiny_proto_types.h:89
-
STinyStats::framesReceived
uint32_t framesReceived
Number of frames, successfully received through the communication channel.
Definition: tiny_proto_types.h:100
-
STinyStats::oosyncBytes
uint32_t oosyncBytes
Number of bytes received out of frame bytes.
Definition: tiny_proto_types.h:92
-
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_proto_types.h:125
-
STinyStats::bytesSent
uint32_t bytesSent
Number of payload bytes totally sent through the channel.
Definition: tiny_proto_types.h:94
-
on_frame_cb_t
void(* on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size)
Definition: tiny_proto_types.h:138
-
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/docs/tiny__rq__pool_8h_source.html b/docs/tiny__rq__pool_8h_source.html index 19630201..383f4514 100644 --- a/docs/tiny__rq__pool_8h_source.html +++ b/docs/tiny__rq__pool_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/tiny__types_8h.html b/docs/tiny__types_8h.html index 668c4ef3..cf9133ab 100644 --- a/docs/tiny__types_8h.html +++ b/docs/tiny__types_8h.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
diff --git a/docs/tiny__types_8h_source.html b/docs/tiny__types_8h_source.html index cc7f14fc..e5e6a709 100644 --- a/docs/tiny__types_8h_source.html +++ b/docs/tiny__types_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.7.2 +  0.8.0
Tiny communication protocol for microcontrollers
@@ -68,17 +68,17 @@
tiny_types.h
-Go to the documentation of this file.
1 /*
2  Copyright 2016-2019 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
27 #pragma once
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 #if defined(__AVR__)
34 #include "avr/tiny_defines.h"
35 #elif defined(__XTENSA__)
36 #include "esp32/tiny_defines.h"
37 #elif defined(ARDUINO)
38 #include "arduino/tiny_defines.h"
39 #elif defined(__linux__)
40 #include "linux/tiny_defines.h"
41 #else
42 #include "mingw32/tiny_defines.h"
43 #endif
44 
45 #include <stdint.h>
46 
48 #ifdef CONFIG_ENABLE_FCS32
49  typedef uint32_t fcs_t;
50 #else
51  typedef uint16_t fcs_t;
52 #endif
53 
59 #define TINY_SUCCESS (0)
61 #define TINY_ERR_FAILED (-1)
63 #define TINY_ERR_TIMEOUT (-2)
65 #define TINY_ERR_DATA_TOO_LARGE (-3)
67 #define TINY_ERR_INVALID_DATA (-4)
69 #define TINY_ERR_BUSY (-5)
71 #define TINY_ERR_OUT_OF_SYNC (-6)
73 #define TINY_ERR_AGAIN (-7)
75 
83 #define TINY_FLAG_NO_WAIT (0)
85 #define TINY_FLAG_READ_ALL (1)
87 #define TINY_FLAG_LOCK_SEND (2)
89 #define TINY_FLAG_WAIT_FOREVER (0x80)
91 
98 typedef struct
99 {
101  uint32_t oosyncBytes;
103  uint32_t bytesSent;
105  uint32_t bytesReceived;
107  uint32_t framesSent;
109  uint32_t framesReceived;
111  uint32_t framesBroken;
112 } STinyStats;
113 
123 typedef int (*write_block_cb_t)(void *pdata, const void *buffer, int size);
124 
134 typedef int (*read_block_cb_t)(void *pdata, void *buffer, int size);
135 
136 
147 typedef void (*on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size);
148 
149 #define EVENT_BIS_ALL 0xFF
150 
151 void tiny_mutex_create(tiny_mutex_t *mutex);
152 
153 void tiny_mutex_destroy(tiny_mutex_t *mutex);
154 
155 void tiny_mutex_lock(tiny_mutex_t *mutex);
156 
157 uint8_t tiny_mutex_try_lock(tiny_mutex_t *mutex);
158 
159 void tiny_mutex_unlock(tiny_mutex_t *mutex);
160 
161 void tiny_events_create(tiny_events_t *events);
162 
163 void tiny_events_destroy(tiny_events_t *events);
164 
165 uint8_t tiny_events_wait(tiny_events_t *event, uint8_t bits,
166  uint8_t clear, uint32_t timeout);
167 
168 void tiny_events_set(tiny_events_t *event, uint8_t bits);
169 
170 void tiny_events_clear(tiny_events_t *event, uint8_t bits);
171 
172 void tiny_sleep(uint32_t ms);
173 
174 uint32_t tiny_millis();
175 
176 
177 #ifdef __cplusplus
178 }
179 #endif
180 
STinyStats::framesBroken
uint32_t framesBroken
Number of broken frames received.
Definition: tiny_types.h:111
-
STinyStats::bytesReceived
uint32_t bytesReceived
Number of payload bytes totally received through the channel.
Definition: tiny_types.h:105
-
STinyStats::framesSent
uint32_t framesSent
Number of frames, successfully sent through the channel.
Definition: tiny_types.h:107
-
STinyStats
Definition: tiny_types.h:98
-
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:134
-
on_frame_cb_t
void(* on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size)
Definition: tiny_types.h:147
-
STinyStats::framesReceived
uint32_t framesReceived
Number of frames, successfully received through the communication channel.
Definition: tiny_types.h:109
-
STinyStats::oosyncBytes
uint32_t oosyncBytes
Number of bytes received out of frame bytes.
Definition: tiny_types.h:101
-
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:123
-
tiny_events_t
Definition: tiny_defines.h:29
-
STinyStats::bytesSent
uint32_t bytesSent
Number of payload bytes totally sent through the channel.
Definition: tiny_types.h:103
+Go to the documentation of this file.
1 /*
2  Copyright 2016-2019 (C) Alexey Dynda
3 
4  This file is part of Tiny Protocol Library.
5 
6  Protocol Library is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Protocol Library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with Protocol Library. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
27 #pragma once
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 #if defined(__AVR__)
34 #include "avr/tiny_defines.h"
35 #elif defined(__XTENSA__)
36 #include "esp32/tiny_defines.h"
37 #elif defined(ARDUINO)
38 #include "arduino/tiny_defines.h"
39 #elif defined(__linux__)
40 #include "linux/tiny_defines.h"
41 #elif defined(__MINGW32__)
42 #include "mingw32/tiny_defines.h"
43 #else
44 #error "Platform not supported"
45 #endif
46 
47 #include <stdint.h>
48 
50 #ifdef CONFIG_ENABLE_FCS32
51  typedef uint32_t fcs_t;
52 #else
53  typedef uint16_t fcs_t;
54 #endif
55 
61 #define TINY_SUCCESS (0)
63 #define TINY_ERR_FAILED (-1)
65 #define TINY_ERR_TIMEOUT (-2)
67 #define TINY_ERR_DATA_TOO_LARGE (-3)
69 #define TINY_ERR_INVALID_DATA (-4)
71 #define TINY_ERR_BUSY (-5)
73 #define TINY_ERR_OUT_OF_SYNC (-6)
75 #define TINY_ERR_AGAIN (-7)
77 
85 #define TINY_FLAG_NO_WAIT (0)
87 #define TINY_FLAG_READ_ALL (1)
89 #define TINY_FLAG_LOCK_SEND (2)
91 #define TINY_FLAG_WAIT_FOREVER (0x80)
93 
100 typedef struct
101 {
103  uint32_t oosyncBytes;
105  uint32_t bytesSent;
107  uint32_t bytesReceived;
109  uint32_t framesSent;
111  uint32_t framesReceived;
113  uint32_t framesBroken;
114 } STinyStats;
115 
125 typedef int (*write_block_cb_t)(void *pdata, const void *buffer, int size);
126 
136 typedef int (*read_block_cb_t)(void *pdata, void *buffer, int size);
137 
138 
149 typedef void (*on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size);
150 
151 #define EVENT_BIS_ALL 0xFF
152 
153 void tiny_mutex_create(tiny_mutex_t *mutex);
154 
155 void tiny_mutex_destroy(tiny_mutex_t *mutex);
156 
157 void tiny_mutex_lock(tiny_mutex_t *mutex);
158 
159 uint8_t tiny_mutex_try_lock(tiny_mutex_t *mutex);
160 
161 void tiny_mutex_unlock(tiny_mutex_t *mutex);
162 
163 void tiny_events_create(tiny_events_t *events);
164 
165 void tiny_events_destroy(tiny_events_t *events);
166 
167 uint8_t tiny_events_wait(tiny_events_t *event, uint8_t bits,
168  uint8_t clear, uint32_t timeout);
169 
170 void tiny_events_set(tiny_events_t *event, uint8_t bits);
171 
172 void tiny_events_clear(tiny_events_t *event, uint8_t bits);
173 
174 void tiny_sleep(uint32_t ms);
175 
176 uint32_t tiny_millis();
177 
178 
179 #ifdef __cplusplus
180 }
181 #endif
182 
STinyStats::framesBroken
uint32_t framesBroken
Number of broken frames received.
Definition: tiny_types.h:113
+
STinyStats::bytesReceived
uint32_t bytesReceived
Number of payload bytes totally received through the channel.
Definition: tiny_types.h:107
+
STinyStats::framesSent
uint32_t framesSent
Number of frames, successfully sent through the channel.
Definition: tiny_types.h:109
+
STinyStats
Definition: tiny_types.h:100
+
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:136
+
on_frame_cb_t
void(* on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size)
Definition: tiny_types.h:149
+
STinyStats::framesReceived
uint32_t framesReceived
Number of frames, successfully received through the communication channel.
Definition: tiny_types.h:111
+
STinyStats::oosyncBytes
uint32_t oosyncBytes
Number of bytes received out of frame bytes.
Definition: tiny_types.h:103
+
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:125
+
tiny_events_t
Definition: tiny_defines.h:30
+
STinyStats::bytesSent
uint32_t bytesSent
Number of payload bytes totally sent through the channel.
Definition: tiny_types.h:105
diff --git a/doxygen.cfg b/doxygen.cfg index 1bb789e5..537d245e 100644 --- a/doxygen.cfg +++ b/doxygen.cfg @@ -5,7 +5,7 @@ #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = "Tiny protocol" -PROJECT_NUMBER = 0.7.2 +PROJECT_NUMBER = 0.8.0 PROJECT_BRIEF = "Tiny communication protocol for microcontrollers" PROJECT_LOGO = OUTPUT_DIRECTORY = ./docs diff --git a/library.properties b/library.properties index 74af7cb8..21bf54fd 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=tinyproto -version=0.7.2 +version=0.8.0 author=Alexey Dynda maintainer=Alexey Dynda sentence=Allows to communicate other boards/PC via physical connection.