diff --git a/docs/TinyLightProtocol_8h.html b/docs/TinyLightProtocol_8h.html index 9cf268d7..4219ec5c 100644 --- a/docs/TinyLightProtocol_8h.html +++ b/docs/TinyLightProtocol_8h.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -81,11 +81,11 @@
- - - - - + + + + +
@@ -93,7 +93,7 @@
- +
diff --git a/docs/TinyLightProtocol_8h__dep__incl.map b/docs/TinyLightProtocol_8h__dep__incl.map index 64eca21e..07df79a7 100644 --- a/docs/TinyLightProtocol_8h__dep__incl.map +++ b/docs/TinyLightProtocol_8h__dep__incl.map @@ -1,3 +1,3 @@ - + diff --git a/docs/TinyLightProtocol_8h__dep__incl.png b/docs/TinyLightProtocol_8h__dep__incl.png index 09386936..5ab6484e 100644 Binary files a/docs/TinyLightProtocol_8h__dep__incl.png and b/docs/TinyLightProtocol_8h__dep__incl.png differ diff --git a/docs/TinyLightProtocol_8h__incl.map b/docs/TinyLightProtocol_8h__incl.map index a7eb2616..500fc4e0 100644 --- a/docs/TinyLightProtocol_8h__incl.map +++ b/docs/TinyLightProtocol_8h__incl.map @@ -1,7 +1,7 @@ - - - - - + + + + + diff --git a/docs/TinyLightProtocol_8h__incl.png b/docs/TinyLightProtocol_8h__incl.png index a4274765..163ec100 100644 Binary files a/docs/TinyLightProtocol_8h__incl.png and b/docs/TinyLightProtocol_8h__incl.png differ diff --git a/docs/TinyLightProtocol_8h_source.html b/docs/TinyLightProtocol_8h_source.html index 1bbcf182..49c0c0ce 100644 --- a/docs/TinyLightProtocol_8h_source.html +++ b/docs/TinyLightProtocol_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -69,9 +69,9 @@
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_LIGHT_PROTOCOL_H_
28 #define _TINY_LIGHT_PROTOCOL_H_
29 
30 #include "TinyPacket.h"
31 #include "proto/light/tiny_light.h"
32 
33 #ifdef ARDUINO
34 # include <HardwareSerial.h>
35 #else
36 # include <string.h>
37 #endif
38 
39 namespace Tiny {
40 
51 class ProtoLight
52 {
53 public:
54  inline ProtoLight(): m_data{} { }
55 
64  void begin (write_block_cb_t writecb,
65  read_block_cb_t readcb);
66 
67 #ifdef ARDUINO
68 
73  void beginToSerial();
74 
75 #ifdef HAVE_HWSERIAL1
76 
81  inline void beginToSerial1()
82  {
83  begin([](void *p, const void *b, int s)->int { return Serial1.write((const uint8_t *)b, s); },
84  [](void *p, void *b, int s)->int { return Serial1.readBytes((uint8_t *)b, s); });
85  }
86 #endif
87 
88 #ifdef HAVE_HWSERIAL2
89 
94  inline void beginToSerial2()
95  {
96  begin([](void *p, const void *b, int s)->int { return Serial2.write((const uint8_t *)b, s); },
97  [](void *p, void *b, int s)->int { return Serial2.readBytes((uint8_t *)b, s); });
98  }
99 #endif
100 
101 #ifdef HAVE_SERIALUSB
102 
107  inline void beginToSerialUSB()
108  {
109  begin([](void *p, const void *b, int s)->int { return SerialUSB.write((const char *)b, s); },
110  [](void *p, void *b, int s)->int { return SerialUSB.readBytes((char *)b, s); });
111  }
112 #endif
113 
114 #endif
115 
119  void end ();
120 
129  int write (char* buf, int size);
130 
139  int read (char* buf, int size);
140 
149  int write (IPacket &pkt);
150 
159  int read (IPacket &pkt);
160 
166  void disableCrc ();
167 
173  void enableCrc(hdlc_crc_t crc);
174 
182  bool enableCheckSum ();
183 
191  bool enableCrc16 ();
192 
201  bool enableCrc32 ();
202 
203 private:
204  STinyLightData m_data{};
205 
206  hdlc_crc_t m_crc = HDLC_CRC_DEFAULT;
207 };
208 
213 } // Tiny namespace
214 
215 #endif
Tiny::ProtoLight::enableCrc
void enableCrc(hdlc_crc_t crc)
-
hdlc_crc_t
hdlc_crc_t
Definition: tiny_hdlc.h:51
+
hdlc_crc_t
hdlc_crc_t
Definition: tiny_hdlc.h:54
TinyPacket.h
Tiny protocol Arduino API.
-
HDLC_CRC_DEFAULT
If default is specified HDLC will auto select CRC option.
Definition: tiny_hdlc.h:53
+
HDLC_CRC_DEFAULT
If default is specified HDLC will auto select CRC option.
Definition: tiny_hdlc.h:56
Tiny
Definition: TinyLightProtocol.h:39
Tiny::ProtoLight::read
int read(char *buf, int size)
@@ -79,7 +79,7 @@
Tiny::ProtoLight::beginToSerial2
void beginToSerial2()
Definition: TinyLightProtocol.h:94
Tiny::ProtoLight::begin
void begin(write_block_cb_t writecb, read_block_cb_t readcb)
-
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:139
+
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:141
Tiny::ProtoLight::write
int write(char *buf, int size)
STinyLightData
Definition: tiny_light.h:51
Tiny::IPacket
Definition: TinyPacket.h:46
@@ -87,7 +87,7 @@
tiny_light.h
Tiny Light protocol API.
-
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:128
+
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:130
Tiny::ProtoLight::beginToSerial1
void beginToSerial1()
Definition: TinyLightProtocol.h:81
diff --git a/docs/TinyPacket_8h.html b/docs/TinyPacket_8h.html index b3dbaf5a..1e6fdace 100644 --- a/docs/TinyPacket_8h.html +++ b/docs/TinyPacket_8h.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -79,16 +79,19 @@ Include dependency graph for TinyPacket.h:
+ +
This graph shows which files directly or indirectly include this file:
- - - - + + + + +
diff --git a/docs/TinyPacket_8h__dep__incl.map b/docs/TinyPacket_8h__dep__incl.map index f941ff2b..8b470239 100644 --- a/docs/TinyPacket_8h__dep__incl.map +++ b/docs/TinyPacket_8h__dep__incl.map @@ -1,6 +1,7 @@ - - - - + + + + + diff --git a/docs/TinyPacket_8h__dep__incl.md5 b/docs/TinyPacket_8h__dep__incl.md5 index de4de3e9..4a76e9a5 100644 --- a/docs/TinyPacket_8h__dep__incl.md5 +++ b/docs/TinyPacket_8h__dep__incl.md5 @@ -1 +1 @@ -802a9114d87be2bfeb5466362d6fa9f4 \ No newline at end of file +6ae3379a23559936852ce4b8722a1a74 \ No newline at end of file diff --git a/docs/TinyPacket_8h__dep__incl.png b/docs/TinyPacket_8h__dep__incl.png index 5725f2fb..9da20d01 100644 Binary files a/docs/TinyPacket_8h__dep__incl.png and b/docs/TinyPacket_8h__dep__incl.png differ diff --git a/docs/TinyPacket_8h__incl.png b/docs/TinyPacket_8h__incl.png index 5d9b59ee..35961cae 100644 Binary files a/docs/TinyPacket_8h__incl.png and b/docs/TinyPacket_8h__incl.png differ diff --git a/docs/TinyPacket_8h_source.html b/docs/TinyPacket_8h_source.html index 639947f2..5b0d6346 100644 --- a/docs/TinyPacket_8h_source.html +++ b/docs/TinyPacket_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -68,10 +68,11 @@
TinyPacket.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 
28 #ifndef _TINY_PACKET_H_
29 #define _TINY_PACKET_H_
30 
31 #ifdef ARDUINO
32 # include <HardwareSerial.h>
33 #else
34 # include <stdint.h>
35 # include <string.h>
36 #endif
37 
38 #include <stdio.h>
39 
40 namespace Tiny {
41 
46 class IPacket
47 {
48 public:
55  IPacket(char *buf, size_t size) { m_len = 0; m_size = size; m_buf = (uint8_t*)buf; m_p=0; }
56 
60  virtual ~IPacket() = default;
61 
65  void clear () { m_len = 0; m_p = 0; }
66 
72  void put (uint8_t byte) { m_buf[m_len++] = byte; }
73 
79  void put (char chr) { put((uint8_t)chr); }
80 
85  inline void put (uint16_t data) { m_buf[m_len++] = data & 0x00FF;
86  m_buf[m_len++] = data >> 8; }
87 
92  inline void put (uint32_t data) { put((uint16_t)(data & 0x0000FFFF));
93  put((uint16_t)(data >> 16)); }
94 
99  inline void put (int16_t data) { put((uint16_t)data); }
100 
105  inline void put (const char *str){ strncpy((char *)&m_buf[m_len], str, m_size - m_len);
106  m_len += strlen(str);
107  m_buf[m_len++] = 0; }
108 
113  inline void put (const IPacket &pkt){ memcpy(&m_buf[m_len], pkt.m_buf, pkt.m_len); m_len += pkt.m_len; }
114 
119  inline uint8_t getByte () { return m_buf[m_p++]; }
120 
125  inline char getChar () { return (char)IPacket::getByte(); }
126 
131  inline uint16_t getUint16() { uint16_t t = m_buf[m_p++]; return t | ((uint16_t)m_buf[m_p++] << 8); }
132 
137  inline int16_t getInt16 () { return (int16_t)(getUint16()); }
138 
143  inline uint32_t getUint32() { return getUint16() | ((uint32_t)getUint16())<<16; }
144 
149  inline char* getString () { char *p = (char *)&m_buf[m_p]; m_p += strlen(p) + 1; return p; }
150 
155  inline size_t size () const { return m_len; }
156 
161  inline size_t maxSize () const { return m_size; }
162 
167  inline char *data () { return (char*)m_buf; }
168 
172  uint8_t &operator[] (size_t idx) { return m_buf[idx]; }
173 
174 private:
175  friend class ProtoHd;
176  friend class IProtoFd;
177  friend class ProtoLight;
178 
179  uint8_t* m_buf;
180  int m_size;
181  int m_len;
182  int m_p;
183 };
184 
189 template <size_t S>
190 class Packet: public IPacket
191 {
192 public:
196  Packet(): IPacket(m_data, S) {}
197 
198 private:
199  char m_data[S];
200 };
201 
206 class PacketD: public IPacket
207 {
208 public:
213  PacketD(int size): IPacket((char *)(new uint8_t[size]), size) {}
214 
215  ~PacketD() { delete[] (uint8_t *)data(); }
216 
217 private:
218 };
219 
220 
221 } // Tiny namespace
222 
223 #endif
224 
Tiny::IPacket::size
size_t size() const
Definition: TinyPacket.h:155
-
Tiny::Packet::Packet
Packet()
Definition: TinyPacket.h:196
+Go to the documentation of this file.
1 /*
2  Copyright 2016-2020 (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 
28 #ifndef _TINY_PACKET_H_
29 #define _TINY_PACKET_H_
30 
31 #ifdef ARDUINO
32 # include <HardwareSerial.h>
33 #else
34 # include <stdint.h>
35 # include <string.h>
36 #endif
37 
38 #include <stdio.h>
39 
40 namespace Tiny {
41 
46 class IPacket
47 {
48 public:
55  IPacket(char *buf, size_t size) { m_len = 0; m_size = static_cast<int>(size); m_buf = (uint8_t*)buf; m_p=0; }
56 
60  virtual ~IPacket() = default;
61 
65  void clear () { m_len = 0; m_p = 0; }
66 
72  void put (uint8_t byte) { m_buf[m_len++] = byte; }
73 
79  void put (char chr) { put((uint8_t)chr); }
80 
85  inline void put (uint16_t data) { m_buf[m_len++] = data & 0x00FF;
86  m_buf[m_len++] = data >> 8; }
87 
92  inline void put (uint32_t data) { put((uint16_t)(data & 0x0000FFFF));
93  put((uint16_t)(data >> 16)); }
94 
99  inline void put (int16_t data) { put((uint16_t)data); }
100 
105  inline void put (const char *str){ strncpy((char *)&m_buf[m_len], str, m_size - m_len);
106  m_len += static_cast<int>(strlen(str));
107  m_buf[m_len++] = 0; }
108 
113  inline void put (const IPacket &pkt){ memcpy(&m_buf[m_len], pkt.m_buf, pkt.m_len); m_len += pkt.m_len; }
114 
119  inline uint8_t getByte () { return m_buf[m_p++]; }
120 
125  inline char getChar () { return (char)IPacket::getByte(); }
126 
131  inline uint16_t getUint16() { uint16_t t = m_buf[m_p++]; return t | ((uint16_t)m_buf[m_p++] << 8); }
132 
137  inline int16_t getInt16 () { return (int16_t)(getUint16()); }
138 
143  inline uint32_t getUint32() { return getUint16() | ((uint32_t)getUint16())<<16; }
144 
149  inline char* getString () { char *p = (char *)&m_buf[m_p]; m_p += static_cast<int>(strlen(p)) + 1; return p; }
150 
155  inline size_t size () const { return m_len; }
156 
161  inline size_t maxSize () const { return m_size; }
162 
167  inline char *data () { return (char*)m_buf; }
168 
172  uint8_t &operator[] (size_t idx) { return m_buf[idx]; }
173 
174 private:
175  friend class ProtoHdlc;
176  friend class ProtoHd;
177  friend class IProtoFd;
178  friend class ProtoLight;
179 
180  uint8_t* m_buf;
181  int m_size;
182  int m_len;
183  int m_p;
184 };
185 
190 template <size_t S>
191 class Packet: public IPacket
192 {
193 public:
197  Packet(): IPacket(m_data, S) {}
198 
199 private:
200  char m_data[S];
201 };
202 
207 class PacketD: public IPacket
208 {
209 public:
214  PacketD(int size): IPacket((char *)(new uint8_t[size]), size) {}
215 
216  ~PacketD() { delete[] (uint8_t *)data(); }
217 
218 private:
219 };
220 
221 
222 } // Tiny namespace
223 
224 #endif
225 
Tiny::IPacket::size
size_t size() const
Definition: TinyPacket.h:155
+
Tiny::Packet::Packet
Packet()
Definition: TinyPacket.h:197
Tiny
Definition: TinyLightProtocol.h:39
Tiny::IPacket::getString
char * getString()
Definition: TinyPacket.h:149
+
Tiny::ProtoHdlc
Definition: TinyProtocolHdlc.h:53
Tiny::ProtoHd
Definition: TinyProtocolHd.h:54
Tiny::IPacket::clear
void clear()
Definition: TinyPacket.h:65
Tiny::IPacket::put
void put(uint8_t byte)
Definition: TinyPacket.h:72
@@ -81,14 +82,14 @@
Tiny::IPacket::data
char * data()
Definition: TinyPacket.h:167
Tiny::IPacket::getByte
uint8_t getByte()
Definition: TinyPacket.h:119
Tiny::IPacket::IPacket
IPacket(char *buf, size_t size)
Definition: TinyPacket.h:55
-
Tiny::Packet
Definition: TinyPacket.h:190
+
Tiny::Packet
Definition: TinyPacket.h:191
Tiny::IPacket::getChar
char getChar()
Definition: TinyPacket.h:125
Tiny::IPacket
Definition: TinyPacket.h:46
Tiny::ProtoLight
Definition: TinyLightProtocol.h:51
Tiny::IPacket::operator[]
uint8_t & operator[](size_t idx)
Definition: TinyPacket.h:172
-
Tiny::PacketD
Definition: TinyPacket.h:206
+
Tiny::PacketD
Definition: TinyPacket.h:207
Tiny::IProtoFd
Definition: TinyProtocolFd.h:53
-
Tiny::PacketD::PacketD
PacketD(int size)
Definition: TinyPacket.h:213
+
Tiny::PacketD::PacketD
PacketD(int size)
Definition: TinyPacket.h:214
Tiny::IPacket::put
void put(uint32_t data)
Definition: TinyPacket.h:92
Tiny::IPacket::put
void put(char chr)
Definition: TinyPacket.h:79
Tiny::IPacket::getUint16
uint16_t getUint16()
Definition: TinyPacket.h:131
diff --git a/docs/TinyProtocolFd_8h.html b/docs/TinyProtocolFd_8h.html index 3d5c4f6f..7309dd8b 100644 --- a/docs/TinyProtocolFd_8h.html +++ b/docs/TinyProtocolFd_8h.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -81,11 +81,11 @@
- - - - - + + + + +
@@ -93,7 +93,7 @@
- +
diff --git a/docs/TinyProtocolFd_8h__dep__incl.map b/docs/TinyProtocolFd_8h__dep__incl.map index cbe71a87..aab7ddc4 100644 --- a/docs/TinyProtocolFd_8h__dep__incl.map +++ b/docs/TinyProtocolFd_8h__dep__incl.map @@ -1,3 +1,3 @@ - + diff --git a/docs/TinyProtocolFd_8h__dep__incl.png b/docs/TinyProtocolFd_8h__dep__incl.png index b4f6b9a6..0768631d 100644 Binary files a/docs/TinyProtocolFd_8h__dep__incl.png and b/docs/TinyProtocolFd_8h__dep__incl.png differ diff --git a/docs/TinyProtocolFd_8h__incl.map b/docs/TinyProtocolFd_8h__incl.map index f77273ec..b3f026be 100644 --- a/docs/TinyProtocolFd_8h__incl.map +++ b/docs/TinyProtocolFd_8h__incl.map @@ -1,7 +1,7 @@ - - - - - + + + + + diff --git a/docs/TinyProtocolFd_8h__incl.png b/docs/TinyProtocolFd_8h__incl.png index b52bfb3d..abe6a136 100644 Binary files a/docs/TinyProtocolFd_8h__incl.png and b/docs/TinyProtocolFd_8h__incl.png differ diff --git a/docs/TinyProtocolFd_8h_source.html b/docs/TinyProtocolFd_8h_source.html index 64677495..3d9c837f 100644 --- a/docs/TinyProtocolFd_8h_source.html +++ b/docs/TinyProtocolFd_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -68,39 +68,39 @@
TinyProtocolFd.h
-Go to the documentation of this file.
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 
27 #pragma once
28 
29 #include "TinyPacket.h"
30 #include "proto/fd/tiny_fd.h"
31 
32 #ifdef ARDUINO
33 # include <HardwareSerial.h>
34 #else
35 # include <string.h>
36 #endif
37 
38 namespace Tiny {
39 
53 class IProtoFd
54 {
55 public:
56  friend class ProtoFdD;
62  IProtoFd(void * buffer,
63  int bufferSize)
64  : m_buffer( (uint8_t *)buffer )
65  , m_bufferSize( bufferSize )
66  {
67  }
68 
69  virtual ~IProtoFd() = default;
70 
79  void begin (write_block_cb_t writecb,
80  read_block_cb_t readcb);
81 
82 #ifdef ARDUINO
83 
88  inline void beginToSerial()
89  {
90  begin([](void *p, const void *b, int s)->int { return Serial.write((const uint8_t *)b, s); },
91  [](void *p, void *b, int s)->int { return Serial.readBytes((uint8_t *)b, s); });
92  }
93 
94 #ifdef HAVE_HWSERIAL1
95 
100  inline void beginToSerial1()
101  {
102  begin([](void *p, const void *b, int s)->int { return Serial1.write((const uint8_t *)b, s); },
103  [](void *p, void *b, int s)->int { return Serial1.readBytes((uint8_t *)b, s); });
104  }
105 #endif
106 
107 #ifdef HAVE_HWSERIAL2
108 
113  inline void beginToSerial2()
114  {
115  begin([](void *p, const void *b, int s)->int { return Serial2.write((const uint8_t *)b, s); },
116  [](void *p, void *b, int s)->int { return Serial2.readBytes((uint8_t *)b, s); });
117  }
118 #endif
119 
120 #ifdef HAVE_HWSERIAL3
121 
126  inline void beginToSerial3()
127  {
128  begin([](void *p, const void *b, int s)->int { return Serial3.write((const uint8_t *)b, s); },
129  [](void *p, void *b, int s)->int { return Serial3.readBytes((uint8_t *)b, s); });
130  }
131 #endif
132 
133 
134 #ifdef HAVE_SERIALUSB
135 
140  inline void beginToSerialUSB()
141  {
142  begin([](void *p, const void *b, int s)->int { return SerialUSB.write((const char *)b, s); },
143  [](void *p, void *b, int s)->int { return SerialUSB.readBytes((char *)b, s); });
144  }
145 #endif
146 
147 #endif
148 
152  void end();
153 
162  int write(char* buf, int size);
163 
172  int write(IPacket &pkt);
173 
182  int run_rx(uint16_t timeout = 0);
183 
188  int run_tx(uint16_t timeout = 0);
189 
195  void disableCrc();
196 
202  void enableCrc(hdlc_crc_t crc);
203 
211  bool enableCheckSum();
212 
220  bool enableCrc16();
221 
230  bool enableCrc32();
231 
236  void setReceiveCallback(void (*on_receive)(IPacket &pkt) = nullptr) { m_onReceive = on_receive; };
237 
242  void setSendCallback(void (*on_send)(IPacket &pkt) = nullptr) { m_onSend = on_send; };
243 
250  void setWindowSize(uint8_t window) { m_window = window; }
251 
256  void setSendTimeout(uint16_t timeout) { m_sendTimeout = timeout; }
257 
258 protected:
265  virtual void onReceive(uint8_t *pdata, int size)
266  {
267  IPacket pkt((char *)pdata, size);
268  pkt.m_len = size;
269  if ( m_onReceive ) m_onReceive( pkt );
270  }
271 
278  virtual void onSend(uint8_t *pdata, int size)
279  {
280  IPacket pkt((char *)pdata, size);
281  pkt.m_len = size;
282  if ( m_onSend ) m_onSend( pkt );
283  }
284 
285 private:
287  tiny_fd_handle_t m_handle = nullptr;
288 
290  uint8_t *m_buffer = nullptr;
291 
292  hdlc_crc_t m_crc = HDLC_CRC_DEFAULT;
293 
295  int m_bufferSize = 0;
296 
298  uint16_t m_sendTimeout = 0;
299 
301  uint8_t m_window = 3;
302 
304  void (*m_onReceive)(IPacket &pkt) = nullptr;
305 
307  void (*m_onSend)(IPacket &pkt) = nullptr;
308 
310  static void onReceiveInternal(void *handle, uint16_t uid, uint8_t *pdata, int size);
311 
313  static void onSendInternal(void *handle, uint16_t uid, uint8_t *pdata, int size);
314 };
315 
319 template <int S>
320 class ProtoFd: public IProtoFd
321 {
322 public:
323  ProtoFd(): IProtoFd( m_data, S ) {}
324 private:
325  uint8_t m_data[S];
326 };
327 
333 class ProtoFdD: public IProtoFd
334 {
335 public:
340  ProtoFdD( int size ): IProtoFd( new uint8_t[size], size ) { }
341  ~ProtoFdD() { delete[] m_buffer; }
342 private:
343 };
344 
349 } // Tiny namespace
350 
Tiny::IProtoFd::run_tx
int run_tx(uint16_t timeout=0)
-
hdlc_crc_t
hdlc_crc_t
Definition: tiny_hdlc.h:51
+Go to the documentation of this file.
1 /*
2  Copyright 2019-2020 (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 #include "TinyPacket.h"
30 #include "proto/fd/tiny_fd.h"
31 
32 #ifdef ARDUINO
33 # include <HardwareSerial.h>
34 #else
35 # include <string.h>
36 #endif
37 
38 namespace Tiny {
39 
53 class IProtoFd
54 {
55 public:
56  friend class ProtoFdD;
62  IProtoFd(void * buffer,
63  int bufferSize)
64  : m_buffer( (uint8_t *)buffer )
65  , m_bufferSize( bufferSize )
66  {
67  }
68 
69  virtual ~IProtoFd() = default;
70 
79  void begin (write_block_cb_t writecb,
80  read_block_cb_t readcb);
81 
82 
90  void begin();
91 
92 #ifdef ARDUINO
93 
98  inline void beginToSerial()
99  {
100  begin([](void *p, const void *b, int s)->int { return Serial.write((const uint8_t *)b, s); },
101  [](void *p, void *b, int s)->int { return Serial.readBytes((uint8_t *)b, s); });
102  }
103 
104 #ifdef HAVE_HWSERIAL1
105 
110  inline void beginToSerial1()
111  {
112  begin([](void *p, const void *b, int s)->int { return Serial1.write((const uint8_t *)b, s); },
113  [](void *p, void *b, int s)->int { return Serial1.readBytes((uint8_t *)b, s); });
114  }
115 #endif
116 
117 #ifdef HAVE_HWSERIAL2
118 
123  inline void beginToSerial2()
124  {
125  begin([](void *p, const void *b, int s)->int { return Serial2.write((const uint8_t *)b, s); },
126  [](void *p, void *b, int s)->int { return Serial2.readBytes((uint8_t *)b, s); });
127  }
128 #endif
129 
130 #ifdef HAVE_HWSERIAL3
131 
136  inline void beginToSerial3()
137  {
138  begin([](void *p, const void *b, int s)->int { return Serial3.write((const uint8_t *)b, s); },
139  [](void *p, void *b, int s)->int { return Serial3.readBytes((uint8_t *)b, s); });
140  }
141 #endif
142 
143 
144 #ifdef HAVE_SERIALUSB
145 
150  inline void beginToSerialUSB()
151  {
152  begin([](void *p, const void *b, int s)->int { return SerialUSB.write((const char *)b, s); },
153  [](void *p, void *b, int s)->int { return SerialUSB.readBytes((char *)b, s); });
154  }
155 #endif
156 
157 #endif
158 
162  void end();
163 
172  int write(char* buf, int size);
173 
182  int write(IPacket &pkt);
183 
192  int run_rx(uint16_t timeout = 0);
193 
200  int run_rx(const void *data, int len);
201 
206  int run_tx(uint16_t timeout = 0);
207 
215  int run_tx(void *data, int max_size);
216 
222  void disableCrc();
223 
229  void enableCrc(hdlc_crc_t crc);
230 
238  bool enableCheckSum();
239 
247  bool enableCrc16();
248 
257  bool enableCrc32();
258 
263  void setReceiveCallback(void (*on_receive)(IPacket &pkt) = nullptr) { m_onReceive = on_receive; };
264 
269  void setSendCallback(void (*on_send)(IPacket &pkt) = nullptr) { m_onSend = on_send; };
270 
277  void setWindowSize(uint8_t window) { m_window = window; }
278 
283  void setSendTimeout(uint16_t timeout) { m_sendTimeout = timeout; }
284 
285 protected:
292  virtual void onReceive(uint8_t *pdata, int size)
293  {
294  IPacket pkt((char *)pdata, size);
295  pkt.m_len = size;
296  if ( m_onReceive ) m_onReceive( pkt );
297  }
298 
305  virtual void onSend(uint8_t *pdata, int size)
306  {
307  IPacket pkt((char *)pdata, size);
308  pkt.m_len = size;
309  if ( m_onSend ) m_onSend( pkt );
310  }
311 
312 private:
314  tiny_fd_handle_t m_handle = nullptr;
315 
317  uint8_t *m_buffer = nullptr;
318 
319  hdlc_crc_t m_crc = HDLC_CRC_DEFAULT;
320 
322  int m_bufferSize = 0;
323 
325  uint16_t m_sendTimeout = 0;
326 
328  uint8_t m_window = 3;
329 
331  void (*m_onReceive)(IPacket &pkt) = nullptr;
332 
334  void (*m_onSend)(IPacket &pkt) = nullptr;
335 
337  static void onReceiveInternal(void *handle, uint16_t uid, uint8_t *pdata, int size);
338 
340  static void onSendInternal(void *handle, uint16_t uid, uint8_t *pdata, int size);
341 };
342 
346 template <int S>
347 class ProtoFd: public IProtoFd
348 {
349 public:
350  ProtoFd(): IProtoFd( m_data, S ) {}
351 private:
352  uint8_t m_data[S];
353 };
354 
360 class ProtoFdD: public IProtoFd
361 {
362 public:
367  ProtoFdD( int size ): IProtoFd( new uint8_t[size], size ) { }
368  ~ProtoFdD() { delete[] m_buffer; }
369 private:
370 };
371 
376 } // Tiny namespace
377 
Tiny::IProtoFd::run_tx
int run_tx(uint16_t timeout=0)
+
hdlc_crc_t
hdlc_crc_t
Definition: tiny_hdlc.h:54
TinyPacket.h
Tiny protocol Arduino API.
-
HDLC_CRC_DEFAULT
If default is specified HDLC will auto select CRC option.
Definition: tiny_hdlc.h:53
-
Tiny::IProtoFd::onSend
virtual void onSend(uint8_t *pdata, int size)
Definition: TinyProtocolFd.h:278
-
Tiny::ProtoFd
Definition: TinyProtocolFd.h:320
+
HDLC_CRC_DEFAULT
If default is specified HDLC will auto select CRC option.
Definition: tiny_hdlc.h:56
+
Tiny::IProtoFd::onSend
virtual void onSend(uint8_t *pdata, int size)
Definition: TinyProtocolFd.h:305
+
Tiny::ProtoFd
Definition: TinyProtocolFd.h:347
Tiny
Definition: TinyLightProtocol.h:39
Tiny::IProtoFd::enableCheckSum
bool enableCheckSum()
Tiny::IProtoFd::enableCrc
void enableCrc(hdlc_crc_t crc)
tiny_fd_handle_t
struct tiny_fd_data_t * tiny_fd_handle_t
Definition: tiny_fd.h:50
-
Tiny::IProtoFd::setReceiveCallback
void setReceiveCallback(void(*on_receive)(IPacket &pkt)=nullptr)
Definition: TinyProtocolFd.h:236
-
Tiny::IProtoFd::onReceive
virtual void onReceive(uint8_t *pdata, int size)
Definition: TinyProtocolFd.h:265
+
Tiny::IProtoFd::setReceiveCallback
void setReceiveCallback(void(*on_receive)(IPacket &pkt)=nullptr)
Definition: TinyProtocolFd.h:263
+
Tiny::IProtoFd::onReceive
virtual void onReceive(uint8_t *pdata, int size)
Definition: TinyProtocolFd.h:292
Tiny::IProtoFd::enableCrc32
bool enableCrc32()
-
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:139
+
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:141
Tiny::IProtoFd::IProtoFd
IProtoFd(void *buffer, int bufferSize)
Definition: TinyProtocolFd.h:62
-
Tiny::IProtoFd::beginToSerial3
void beginToSerial3()
Definition: TinyProtocolFd.h:126
-
Tiny::IProtoFd::setWindowSize
void setWindowSize(uint8_t window)
Definition: TinyProtocolFd.h:250
+
Tiny::IProtoFd::beginToSerial3
void beginToSerial3()
Definition: TinyProtocolFd.h:136
+
Tiny::IProtoFd::setWindowSize
void setWindowSize(uint8_t window)
Definition: TinyProtocolFd.h:277
Tiny::IProtoFd::enableCrc16
bool enableCrc16()
Tiny::IPacket
Definition: TinyPacket.h:46
-
Tiny::IProtoFd::beginToSerial2
void beginToSerial2()
Definition: TinyProtocolFd.h:113
+
Tiny::IProtoFd::beginToSerial2
void beginToSerial2()
Definition: TinyProtocolFd.h:123
Tiny::IProtoFd
Definition: TinyProtocolFd.h:53
Tiny::IProtoFd::run_rx
int run_rx(uint16_t timeout=0)
-
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:128
-
Tiny::IProtoFd::beginToSerial
void beginToSerial()
Definition: TinyProtocolFd.h:88
-
Tiny::ProtoFdD
Definition: TinyProtocolFd.h:333
+
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:130
+
Tiny::IProtoFd::beginToSerial
void beginToSerial()
Definition: TinyProtocolFd.h:98
+
Tiny::ProtoFdD
Definition: TinyProtocolFd.h:360
tiny_fd.h
Tiny Protocol Full Duplex API.
-
Tiny::IProtoFd::beginToSerial1
void beginToSerial1()
Definition: TinyProtocolFd.h:100
-
Tiny::ProtoFdD::ProtoFdD
ProtoFdD(int size)
Definition: TinyProtocolFd.h:340
-
Tiny::IProtoFd::setSendCallback
void setSendCallback(void(*on_send)(IPacket &pkt)=nullptr)
Definition: TinyProtocolFd.h:242
-
Tiny::IProtoFd::setSendTimeout
void setSendTimeout(uint16_t timeout)
Definition: TinyProtocolFd.h:256
-
Tiny::IProtoFd::begin
void begin(write_block_cb_t writecb, read_block_cb_t readcb)
+
Tiny::IProtoFd::beginToSerial1
void beginToSerial1()
Definition: TinyProtocolFd.h:110
+
Tiny::ProtoFdD::ProtoFdD
ProtoFdD(int size)
Definition: TinyProtocolFd.h:367
+
Tiny::IProtoFd::setSendCallback
void setSendCallback(void(*on_send)(IPacket &pkt)=nullptr)
Definition: TinyProtocolFd.h:269
+ +
Tiny::IProtoFd::setSendTimeout
void setSendTimeout(uint16_t timeout)
Definition: TinyProtocolFd.h:283
Tiny::IProtoFd::write
int write(char *buf, int size)
diff --git a/docs/TinyProtocolHd_8h.html b/docs/TinyProtocolHd_8h.html index 9fce57d4..a4de1528 100644 --- a/docs/TinyProtocolHd_8h.html +++ b/docs/TinyProtocolHd_8h.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -81,11 +81,11 @@
- - - - - + + + + +
@@ -93,7 +93,7 @@
- +
diff --git a/docs/TinyProtocolHd_8h__dep__incl.map b/docs/TinyProtocolHd_8h__dep__incl.map index d5380356..affee479 100644 --- a/docs/TinyProtocolHd_8h__dep__incl.map +++ b/docs/TinyProtocolHd_8h__dep__incl.map @@ -1,3 +1,3 @@ - + diff --git a/docs/TinyProtocolHd_8h__dep__incl.png b/docs/TinyProtocolHd_8h__dep__incl.png index d77b6848..afde790c 100644 Binary files a/docs/TinyProtocolHd_8h__dep__incl.png and b/docs/TinyProtocolHd_8h__dep__incl.png differ diff --git a/docs/TinyProtocolHd_8h__incl.map b/docs/TinyProtocolHd_8h__incl.map index 06af3ebe..f508acbe 100644 --- a/docs/TinyProtocolHd_8h__incl.map +++ b/docs/TinyProtocolHd_8h__incl.map @@ -1,7 +1,7 @@ - - - - - + + + + + diff --git a/docs/TinyProtocolHd_8h__incl.png b/docs/TinyProtocolHd_8h__incl.png index 2dfc127f..82fd8230 100644 Binary files a/docs/TinyProtocolHd_8h__incl.png and b/docs/TinyProtocolHd_8h__incl.png differ diff --git a/docs/TinyProtocolHd_8h_source.html b/docs/TinyProtocolHd_8h_source.html index 92e3cd20..facd5f33 100644 --- a/docs/TinyProtocolHd_8h_source.html +++ b/docs/TinyProtocolHd_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -68,9 +68,9 @@
TinyProtocolHd.h
-Go to the documentation of this file.
1 /*
2  Copyright 2017 (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 
28 #ifndef _TINY_PROTOCOL_H_
29 #define _TINY_PROTOCOL_H_
30 
31 #include "TinyPacket.h"
32 #include "proto/half_duplex/tiny_hd.h"
33 
34 #ifdef ARDUINO
35 # include <HardwareSerial.h>
36 #else
37 # include <string.h>
38 #endif
39 
40 namespace Tiny {
41 
54 class ProtoHd
55 {
56 private:
58  STinyHdData m_data;
59 
60 public:
67  inline ProtoHd(void * buffer,
68  int bufferSize,
69  void (*onReceive)(uint8_t *buf, int len))
70  :m_data{}
71  {
72  m_buffer = buffer;
73  m_bufferSize = bufferSize;
74  m_onReceive = onReceive;
75  }
76 
85  void begin (write_block_cb_t writecb,
86  read_block_cb_t readcb);
87 
88 #ifdef ARDUINO
89 
94  inline void beginToSerial()
95  {
96  begin([](void *p, const void *b, int s)->int { return Serial.write((const uint8_t *)b, s); },
97  [](void *p, void *b, int s)->int { return Serial.readBytes((uint8_t *)b, s); });
98  }
99 
100 #ifdef HAVE_HWSERIAL1
101 
106  inline void beginToSerial1()
107  {
108  begin([](void *p, const void *b, int s)->int { return Serial1.write((const uint8_t *)b, s); },
109  [](void *p, void *b, int s)->int { return Serial1.readBytes((uint8_t *)b, s); });
110  }
111 #endif
112 
113 #ifdef HAVE_HWSERIAL2
114 
119  inline void beginToSerial2()
120  {
121  begin([](void *p, const void *b, int s)->int { return Serial2.write((const uint8_t *)b, s); },
122  [](void *p, void *b, int s)->int { return Serial2.readBytes((uint8_t *)b, s); });
123  }
124 #endif
125 
126 #ifdef HAVE_HWSERIAL3
127 
132  inline void beginToSerial3()
133  {
134  begin([](void *p, const void *b, int s)->int { return Serial3.write((const uint8_t *)b, s); },
135  [](void *p, void *b, int s)->int { return Serial3.readBytes((uint8_t *)b, s); });
136  }
137 #endif
138 
139 
140 #ifdef HAVE_SERIALUSB
141 
146  inline void beginToSerialUSB()
147  {
148  begin([](void *p, const void *b, int s)->int { return SerialUSB.write((const char *)b, s); },
149  [](void *p, void *b, int s)->int { return SerialUSB.readBytes((char *)b, s); });
150  }
151 #endif
152 
153 #endif
154 
158  void end ();
159 
168  int write (char* buf, int size);
169 
178  int write (IPacket &pkt);
179 
188  int run ();
189 
195  void disableCrc ();
196 
204  bool enableCheckSum ();
205 
213  bool enableCrc16 ();
214 
223  bool enableCrc32 ();
224 
225 private:
227  void *m_buffer;
228  hdlc_crc_t m_crc = HDLC_CRC_DEFAULT;
230  int m_bufferSize;
232  void (*m_onReceive)(uint8_t *buf, int len);
234  static void onReceiveInternal(void *handle, uint16_t uid, uint8_t *pdata, int size);
235 
236 };
237 
242 } // Tiny namespace
243 
244 #endif
245 
hdlc_crc_t
hdlc_crc_t
Definition: tiny_hdlc.h:51
+Go to the documentation of this file.
1 /*
2  Copyright 2017 (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 
28 #ifndef _TINY_PROTOCOL_H_
29 #define _TINY_PROTOCOL_H_
30 
31 #include "TinyPacket.h"
32 #include "proto/half_duplex/tiny_hd.h"
33 
34 #ifdef ARDUINO
35 # include <HardwareSerial.h>
36 #else
37 # include <string.h>
38 #endif
39 
40 namespace Tiny {
41 
54 class ProtoHd
55 {
56 private:
58  STinyHdData m_data;
59 
60 public:
67  inline ProtoHd(void * buffer,
68  int bufferSize,
69  void (*onReceive)(uint8_t *buf, int len))
70  :m_data{}
71  {
72  m_buffer = buffer;
73  m_bufferSize = bufferSize;
74  m_onReceive = onReceive;
75  }
76 
85  void begin (write_block_cb_t writecb,
86  read_block_cb_t readcb);
87 
88 #ifdef ARDUINO
89 
94  inline void beginToSerial()
95  {
96  begin([](void *p, const void *b, int s)->int { return Serial.write((const uint8_t *)b, s); },
97  [](void *p, void *b, int s)->int { return Serial.readBytes((uint8_t *)b, s); });
98  }
99 
100 #ifdef HAVE_HWSERIAL1
101 
106  inline void beginToSerial1()
107  {
108  begin([](void *p, const void *b, int s)->int { return Serial1.write((const uint8_t *)b, s); },
109  [](void *p, void *b, int s)->int { return Serial1.readBytes((uint8_t *)b, s); });
110  }
111 #endif
112 
113 #ifdef HAVE_HWSERIAL2
114 
119  inline void beginToSerial2()
120  {
121  begin([](void *p, const void *b, int s)->int { return Serial2.write((const uint8_t *)b, s); },
122  [](void *p, void *b, int s)->int { return Serial2.readBytes((uint8_t *)b, s); });
123  }
124 #endif
125 
126 #ifdef HAVE_HWSERIAL3
127 
132  inline void beginToSerial3()
133  {
134  begin([](void *p, const void *b, int s)->int { return Serial3.write((const uint8_t *)b, s); },
135  [](void *p, void *b, int s)->int { return Serial3.readBytes((uint8_t *)b, s); });
136  }
137 #endif
138 
139 
140 #ifdef HAVE_SERIALUSB
141 
146  inline void beginToSerialUSB()
147  {
148  begin([](void *p, const void *b, int s)->int { return SerialUSB.write((const char *)b, s); },
149  [](void *p, void *b, int s)->int { return SerialUSB.readBytes((char *)b, s); });
150  }
151 #endif
152 
153 #endif
154 
158  void end ();
159 
168  int write (char* buf, int size);
169 
178  int write (IPacket &pkt);
179 
188  int run ();
189 
195  void disableCrc ();
196 
204  bool enableCheckSum ();
205 
213  bool enableCrc16 ();
214 
223  bool enableCrc32 ();
224 
225 private:
227  void *m_buffer;
228  hdlc_crc_t m_crc = HDLC_CRC_DEFAULT;
230  int m_bufferSize;
232  void (*m_onReceive)(uint8_t *buf, int len);
234  static void onReceiveInternal(void *handle, uint16_t uid, uint8_t *pdata, int size);
235 
236 };
237 
242 } // Tiny namespace
243 
244 #endif
245 
hdlc_crc_t
hdlc_crc_t
Definition: tiny_hdlc.h:54
TinyPacket.h
Tiny protocol Arduino API.
-
HDLC_CRC_DEFAULT
If default is specified HDLC will auto select CRC option.
Definition: tiny_hdlc.h:53
+
HDLC_CRC_DEFAULT
If default is specified HDLC will auto select CRC option.
Definition: tiny_hdlc.h:56
Tiny
Definition: TinyLightProtocol.h:39
Tiny::ProtoHd::begin
void begin(write_block_cb_t writecb, read_block_cb_t readcb)
Tiny::ProtoHd::beginToSerial
void beginToSerial()
Definition: TinyProtocolHd.h:94
@@ -78,7 +78,7 @@
Tiny::ProtoHd::ProtoHd
ProtoHd(void *buffer, int bufferSize, void(*onReceive)(uint8_t *buf, int len))
Definition: TinyProtocolHd.h:67
Tiny::ProtoHd::beginToSerial1
void beginToSerial1()
Definition: TinyProtocolHd.h:106
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:139
+
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:141
Tiny::ProtoHd::beginToSerial2
void beginToSerial2()
Definition: TinyProtocolHd.h:119
Tiny::ProtoHd::beginToSerial3
void beginToSerial3()
Definition: TinyProtocolHd.h:132
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:128
+
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:130
diff --git a/docs/TinyProtocolHdlc_8h.html b/docs/TinyProtocolHdlc_8h.html new file mode 100644 index 00000000..575ba967 --- /dev/null +++ b/docs/TinyProtocolHdlc_8h.html @@ -0,0 +1,117 @@ + + + + + + + +Tiny protocol: src/TinyProtocolHdlc.h File Reference + + + + + + + + + +
+
+ + + + + + +
+
Tiny protocol +  0.11.0 +
+
Tiny communication protocol for microcontrollers
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes
+
+
TinyProtocolHdlc.h File Reference
+
+
+ +

Tiny protocol Arduino API. +More...

+
#include "TinyPacket.h"
+#include "proto/hdlc/tiny_hdlc.h"
+#include <HardwareSerial.h>
+
+Include dependency graph for TinyProtocolHdlc.h:
+
+
+ + + + + + +
+
+This graph shows which files directly or indirectly include this file:
+
+
+ + + +
+
+

Go to the source code of this file.

+ + + + +

+Classes

class  Tiny::ProtoHdlc
 
+

Detailed Description

+

Tiny protocol Arduino API.

+

This is Tiny protocol implementation for microcontrollers

+
+ +
+Generated by   +doxygen + 1.8.13 +
+ + diff --git a/docs/TinyProtocolHdlc_8h__dep__incl.map b/docs/TinyProtocolHdlc_8h__dep__incl.map new file mode 100644 index 00000000..f3d4c419 --- /dev/null +++ b/docs/TinyProtocolHdlc_8h__dep__incl.map @@ -0,0 +1,3 @@ + + + diff --git a/docs/TinyProtocolHdlc_8h__dep__incl.md5 b/docs/TinyProtocolHdlc_8h__dep__incl.md5 new file mode 100644 index 00000000..93ef5e5f --- /dev/null +++ b/docs/TinyProtocolHdlc_8h__dep__incl.md5 @@ -0,0 +1 @@ +39d739a0f12a8d0bea866cb13640103e \ No newline at end of file diff --git a/docs/TinyProtocolHdlc_8h__dep__incl.png b/docs/TinyProtocolHdlc_8h__dep__incl.png new file mode 100644 index 00000000..18a4b5e6 Binary files /dev/null and b/docs/TinyProtocolHdlc_8h__dep__incl.png differ diff --git a/docs/TinyProtocolHdlc_8h__incl.map b/docs/TinyProtocolHdlc_8h__incl.map new file mode 100644 index 00000000..880de7e8 --- /dev/null +++ b/docs/TinyProtocolHdlc_8h__incl.map @@ -0,0 +1,6 @@ + + + + + + diff --git a/docs/TinyProtocolHdlc_8h__incl.md5 b/docs/TinyProtocolHdlc_8h__incl.md5 new file mode 100644 index 00000000..83570c67 --- /dev/null +++ b/docs/TinyProtocolHdlc_8h__incl.md5 @@ -0,0 +1 @@ +ae366b3c3266562e319a2ca24ffec449 \ No newline at end of file diff --git a/docs/TinyProtocolHdlc_8h__incl.png b/docs/TinyProtocolHdlc_8h__incl.png new file mode 100644 index 00000000..196f9548 Binary files /dev/null and b/docs/TinyProtocolHdlc_8h__incl.png differ diff --git a/docs/TinyProtocolHdlc_8h_source.html b/docs/TinyProtocolHdlc_8h_source.html new file mode 100644 index 00000000..b15871cd --- /dev/null +++ b/docs/TinyProtocolHdlc_8h_source.html @@ -0,0 +1,107 @@ + + + + + + + +Tiny protocol: src/TinyProtocolHdlc.h Source File + + + + + + + + + +
+
+ + + + + + +
+
Tiny protocol +  0.11.0 +
+
Tiny communication protocol for microcontrollers
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
TinyProtocolHdlc.h
+
+
+Go to the documentation of this file.
1 /*
2  Copyright 2020 (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 #include "TinyPacket.h"
30 #include "proto/hdlc/tiny_hdlc.h"
31 
32 #ifdef ARDUINO
33 # include <HardwareSerial.h>
34 #else
35 # include <string.h>
36 #endif
37 
38 namespace Tiny {
39 
53 class ProtoHdlc
54 {
55 public:
61  ProtoHdlc(void *buffer, int bufferSize)
62  : m_buffer( buffer )
63  , m_bufferSize( bufferSize )
64  {
65  }
66 
67  virtual ~ProtoHdlc() = default;
68 
77  void begin (write_block_cb_t writecb,
78  read_block_cb_t readcb);
79 
86  void begin();
87 
88 #ifdef ARDUINO
89 
94  inline void beginToSerial()
95  {
96  begin([](void *p, const void *b, int s)->int { return Serial.write((const uint8_t *)b, s); },
97  [](void *p, void *b, int s)->int { return Serial.readBytes((uint8_t *)b, s); });
98  }
99 
100 #ifdef HAVE_HWSERIAL1
101 
106  inline void beginToSerial1()
107  {
108  begin([](void *p, const void *b, int s)->int { return Serial1.write((const uint8_t *)b, s); },
109  [](void *p, void *b, int s)->int { return Serial1.readBytes((uint8_t *)b, s); });
110  }
111 #endif
112 
113 #ifdef HAVE_HWSERIAL2
114 
119  inline void beginToSerial2()
120  {
121  begin([](void *p, const void *b, int s)->int { return Serial2.write((const uint8_t *)b, s); },
122  [](void *p, void *b, int s)->int { return Serial2.readBytes((uint8_t *)b, s); });
123  }
124 #endif
125 
126 #ifdef HAVE_HWSERIAL3
127 
132  inline void beginToSerial3()
133  {
134  begin([](void *p, const void *b, int s)->int { return Serial3.write((const uint8_t *)b, s); },
135  [](void *p, void *b, int s)->int { return Serial3.readBytes((uint8_t *)b, s); });
136  }
137 #endif
138 
139 
140 #ifdef HAVE_SERIALUSB
141 
146  inline void beginToSerialUSB()
147  {
148  begin([](void *p, const void *b, int s)->int { return SerialUSB.write((const char *)b, s); },
149  [](void *p, void *b, int s)->int { return SerialUSB.readBytes((char *)b, s); });
150  }
151 #endif
152 
153 #endif
154 
158  void end();
159 
168  int write(char* buf, int size);
169 
178  int write(IPacket &pkt);
179 
186  int run_rx(const void *data, int len);
187 
194  int run_tx(void *data, int max_len);
195 
201  void disableCrc();
202 
208  void enableCrc(hdlc_crc_t crc);
209 
217  bool enableCheckSum();
218 
226  bool enableCrc16();
227 
236  bool enableCrc32();
237 
242  void setReceiveCallback(void (*on_receive)(IPacket &pkt) = nullptr) { m_onReceive = on_receive; };
243 
248  void setSendCallback(void (*on_send)(IPacket &pkt) = nullptr) { m_onSend = on_send; };
249 
250 protected:
257  virtual void onReceive(uint8_t *pdata, int size)
258  {
259  IPacket pkt((char *)pdata, size);
260  pkt.m_len = size;
261  if ( m_onReceive ) m_onReceive( pkt );
262  }
263 
270  virtual void onSend(const uint8_t *pdata, int size)
271  {
272  IPacket pkt((char *)pdata, size);
273  pkt.m_len = size;
274  if ( m_onSend ) m_onSend( pkt );
275  }
276 
277 private:
279  hdlc_handle_t m_handle = nullptr;
280 
281  hdlc_struct_t m_data{};
282 
283  void *m_buffer = nullptr;
284 
285  int m_bufferSize = 0;
286 
287  hdlc_crc_t m_crc = HDLC_CRC_DEFAULT;
288 
290  void (*m_onReceive)(IPacket &pkt) = nullptr;
291 
293  void (*m_onSend)(IPacket &pkt) = nullptr;
294 
296  static int onReceiveInternal(void *handle, void *pdata, int size);
297 
299  static int onSendInternal(void *handle, const void *pdata, int size);
300 };
301 
306 } // Tiny namespace
307 
+ +
hdlc_crc_t
hdlc_crc_t
Definition: tiny_hdlc.h:54
+
TinyPacket.h
Tiny protocol Arduino API.
+
Tiny::ProtoHdlc::run_rx
int run_rx(const void *data, int len)
+
HDLC_CRC_DEFAULT
If default is specified HDLC will auto select CRC option.
Definition: tiny_hdlc.h:56
+
Tiny::ProtoHdlc::beginToSerial2
void beginToSerial2()
Definition: TinyProtocolHdlc.h:119
+
Tiny::ProtoHdlc::beginToSerial
void beginToSerial()
Definition: TinyProtocolHdlc.h:94
+
Tiny
Definition: TinyLightProtocol.h:39
+
Tiny::ProtoHdlc
Definition: TinyProtocolHdlc.h:53
+
Tiny::ProtoHdlc::onSend
virtual void onSend(const uint8_t *pdata, int size)
Definition: TinyProtocolHdlc.h:270
+
Tiny::ProtoHdlc::onReceive
virtual void onReceive(uint8_t *pdata, int size)
Definition: TinyProtocolHdlc.h:257
+
read_block_cb_t
int(* read_block_cb_t)(void *pdata, void *buffer, int size)
Definition: tiny_types.h:141
+
Tiny::ProtoHdlc::enableCrc
void enableCrc(hdlc_crc_t crc)
+ +
Tiny::ProtoHdlc::write
int write(char *buf, int size)
+
Tiny::ProtoHdlc::beginToSerial3
void beginToSerial3()
Definition: TinyProtocolHdlc.h:132
+
Tiny::ProtoHdlc::ProtoHdlc
ProtoHdlc(void *buffer, int bufferSize)
Definition: TinyProtocolHdlc.h:61
+
Tiny::ProtoHdlc::enableCheckSum
bool enableCheckSum()
+
Tiny::IPacket
Definition: TinyPacket.h:46
+
_hdlc_handle_t
Definition: tiny_hdlc.h:68
+
Tiny::ProtoHdlc::setReceiveCallback
void setReceiveCallback(void(*on_receive)(IPacket &pkt)=nullptr)
Definition: TinyProtocolHdlc.h:242
+
write_block_cb_t
int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
Definition: tiny_types.h:130
+ +
Tiny::ProtoHdlc::run_tx
int run_tx(void *data, int max_len)
+ +
Tiny::ProtoHdlc::beginToSerial1
void beginToSerial1()
Definition: TinyProtocolHdlc.h:106
+
Tiny::ProtoHdlc::setSendCallback
void setSendCallback(void(*on_send)(IPacket &pkt)=nullptr)
Definition: TinyProtocolHdlc.h:248
+
+ +
+Generated by   +doxygen + 1.8.13 +
+ + diff --git a/docs/TinyProtocol_8h.html b/docs/TinyProtocol_8h.html index 8615395e..18ebd48b 100644 --- a/docs/TinyProtocol_8h.html +++ b/docs/TinyProtocol_8h.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -73,6 +73,7 @@ More...

#include "TinyPacket.h"
#include "TinyLightProtocol.h"
+#include "TinyProtocolHdlc.h"
#include "TinyProtocolHd.h"
#include "TinyProtocolFd.h"
@@ -80,16 +81,17 @@
- - - - - - - - - - + + + + + + + + + + +
diff --git a/docs/TinyProtocol_8h__incl.map b/docs/TinyProtocol_8h__incl.map index 3a93fd16..fe0fde43 100644 --- a/docs/TinyProtocol_8h__incl.map +++ b/docs/TinyProtocol_8h__incl.map @@ -1,12 +1,13 @@ - - - - - - - - - - + + + + + + + + + + + diff --git a/docs/TinyProtocol_8h__incl.md5 b/docs/TinyProtocol_8h__incl.md5 index cbbd7bfb..63a3af19 100644 --- a/docs/TinyProtocol_8h__incl.md5 +++ b/docs/TinyProtocol_8h__incl.md5 @@ -1 +1 @@ -2522b34629d74fe9de8703bb3bfbdbf9 \ No newline at end of file +8bb3d1e818fc19d89354a31cea9e929d \ No newline at end of file diff --git a/docs/TinyProtocol_8h__incl.png b/docs/TinyProtocol_8h__incl.png index 218f0d07..d25a6c38 100644 Binary files a/docs/TinyProtocol_8h__incl.png and b/docs/TinyProtocol_8h__incl.png differ diff --git a/docs/TinyProtocol_8h_source.html b/docs/TinyProtocol_8h_source.html index f3d9a47d..f44a1894 100644 --- a/docs/TinyProtocol_8h_source.html +++ b/docs/TinyProtocol_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -68,8 +68,9 @@
TinyProtocol.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 
28 #pragma once
29 
30 #include "TinyPacket.h"
31 #include "TinyLightProtocol.h"
32 #include "TinyProtocolHd.h"
33 #include "TinyProtocolFd.h"
34 
TinyProtocolFd.h
Tiny protocol Arduino API.
+Go to the documentation of this file.
1 /*
2  Copyright 2016-2020 (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 
28 #pragma once
29 
30 #include "TinyPacket.h"
31 #include "TinyLightProtocol.h"
32 #include "TinyProtocolHdlc.h"
33 #include "TinyProtocolHd.h"
34 #include "TinyProtocolFd.h"
35 
TinyProtocolFd.h
Tiny protocol Arduino API.
TinyPacket.h
Tiny protocol Arduino API.
+
TinyProtocolHdlc.h
Tiny protocol Arduino API.
TinyProtocolHd.h
Tiny protocol Arduino API.
TinyLightProtocol.h
Tiny light protocol Arduino API.
diff --git a/docs/annotated.html b/docs/annotated.html index f032712f..ffe3fc3d 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -74,15 +74,16 @@  CProtoFd  CProtoFdD  CProtoHd - CProtoLight - C_hdlc_handle_t - Clist_element_Structure defines base type for the lists - CSTinyHdData_ - CSTinyHdInit_ - CSTinyLightData - CSTinyStats - Ctiny_fd_init_t_ - Ctiny_request_Defines type for tiny request list item + CProtoHdlc + CProtoLight + C_hdlc_handle_t + Clist_element_Structure defines base type for the lists + CSTinyHdData_ + CSTinyHdInit_ + CSTinyLightData + CSTinyStats + Ctiny_fd_init_t_ + Ctiny_request_Defines type for tiny request list item
diff --git a/docs/arduino.html b/docs/arduino.html index e9b72c46..8d2c3c3d 100644 --- a/docs/arduino.html +++ b/docs/arduino.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
diff --git a/docs/arduino_8dox.html b/docs/arduino_8dox.html index f4fcb979..522c80db 100644 --- a/docs/arduino_8dox.html +++ b/docs/arduino_8dox.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
diff --git a/docs/arduino__hal_8h_source.html b/docs/arduino__hal_8h_source.html index d1cfeac0..39df560c 100644 --- a/docs/arduino__hal_8h_source.html +++ b/docs/arduino__hal_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
diff --git a/docs/avr__hal_8h_source.html b/docs/avr__hal_8h_source.html index 341339ce..14f4a5a6 100644 --- a/docs/avr__hal_8h_source.html +++ b/docs/avr__hal_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classTiny_1_1IPacket-members.html b/docs/classTiny_1_1IPacket-members.html index ce3172ce..18adcedb 100644 --- a/docs/classTiny_1_1IPacket-members.html +++ b/docs/classTiny_1_1IPacket-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -84,16 +84,17 @@ maxSize() constTiny::IPacketinline operator[](size_t idx)Tiny::IPacketinline ProtoHd (defined in Tiny::IPacket)Tiny::IPacketfriend - ProtoLight (defined in Tiny::IPacket)Tiny::IPacketfriend - put(uint8_t byte)Tiny::IPacketinline - put(char chr)Tiny::IPacketinline - put(uint16_t data)Tiny::IPacketinline - put(uint32_t data)Tiny::IPacketinline - put(int16_t data)Tiny::IPacketinline - put(const char *str)Tiny::IPacketinline - put(const IPacket &pkt)Tiny::IPacketinline - size() constTiny::IPacketinline - ~IPacket()=defaultTiny::IPacketvirtual + ProtoHdlc (defined in Tiny::IPacket)Tiny::IPacketfriend + ProtoLight (defined in Tiny::IPacket)Tiny::IPacketfriend + put(uint8_t byte)Tiny::IPacketinline + put(char chr)Tiny::IPacketinline + put(uint16_t data)Tiny::IPacketinline + put(uint32_t data)Tiny::IPacketinline + put(int16_t data)Tiny::IPacketinline + put(const char *str)Tiny::IPacketinline + put(const IPacket &pkt)Tiny::IPacketinline + size() constTiny::IPacketinline + ~IPacket()=defaultTiny::IPacketvirtual
diff --git a/docs/classTiny_1_1IPacket.html b/docs/classTiny_1_1IPacket.html index 266336fe..bbd66fe8 100644 --- a/docs/classTiny_1_1IPacket.html +++ b/docs/classTiny_1_1IPacket.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -79,8 +79,8 @@
Inheritance graph
- - + +
[legend]
@@ -129,6 +129,9 @@
+ + diff --git a/docs/classTiny_1_1IPacket__inherit__graph.map b/docs/classTiny_1_1IPacket__inherit__graph.map index 0b49626e..59672ae8 100644 --- a/docs/classTiny_1_1IPacket__inherit__graph.map +++ b/docs/classTiny_1_1IPacket__inherit__graph.map @@ -1,4 +1,4 @@ - - + + diff --git a/docs/classTiny_1_1IPacket__inherit__graph.png b/docs/classTiny_1_1IPacket__inherit__graph.png index 31d5e051..37fa3ba7 100644 Binary files a/docs/classTiny_1_1IPacket__inherit__graph.png and b/docs/classTiny_1_1IPacket__inherit__graph.png differ diff --git a/docs/classTiny_1_1IProtoFd-members.html b/docs/classTiny_1_1IProtoFd-members.html index d8b14865..add159c7 100644 --- a/docs/classTiny_1_1IProtoFd-members.html +++ b/docs/classTiny_1_1IProtoFd-members.html @@ -22,7 +22,7 @@ @@ -72,29 +72,32 @@

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

Friends

+class ProtoHdlc
 
class ProtoHd
 
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
- - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - - - - - - + + + + + + + +
begin(write_block_cb_t writecb, read_block_cb_t readcb)Tiny::IProtoFd
beginToSerial()Tiny::IProtoFdinline
beginToSerial1()Tiny::IProtoFdinline
beginToSerial2()Tiny::IProtoFdinline
beginToSerial3()Tiny::IProtoFdinline
disableCrc()Tiny::IProtoFd
enableCheckSum()Tiny::IProtoFd
enableCrc(hdlc_crc_t crc)Tiny::IProtoFd
enableCrc16()Tiny::IProtoFd
enableCrc32()Tiny::IProtoFd
end()Tiny::IProtoFd
IProtoFd(void *buffer, int bufferSize)Tiny::IProtoFdinline
onReceive(uint8_t *pdata, int size)Tiny::IProtoFdinlineprotectedvirtual
onSend(uint8_t *pdata, int size)Tiny::IProtoFdinlineprotectedvirtual
ProtoFdD (defined in Tiny::IProtoFd)Tiny::IProtoFdfriend
run_rx(uint16_t timeout=0)Tiny::IProtoFd
begin()Tiny::IProtoFd
beginToSerial()Tiny::IProtoFdinline
beginToSerial1()Tiny::IProtoFdinline
beginToSerial2()Tiny::IProtoFdinline
beginToSerial3()Tiny::IProtoFdinline
disableCrc()Tiny::IProtoFd
enableCheckSum()Tiny::IProtoFd
enableCrc(hdlc_crc_t crc)Tiny::IProtoFd
enableCrc16()Tiny::IProtoFd
enableCrc32()Tiny::IProtoFd
end()Tiny::IProtoFd
IProtoFd(void *buffer, int bufferSize)Tiny::IProtoFdinline
onReceive(uint8_t *pdata, int size)Tiny::IProtoFdinlineprotectedvirtual
onSend(uint8_t *pdata, int size)Tiny::IProtoFdinlineprotectedvirtual
ProtoFdD (defined in Tiny::IProtoFd)Tiny::IProtoFdfriend
run_rx(uint16_t timeout=0)Tiny::IProtoFd
run_rx(const void *data, int len)Tiny::IProtoFd
run_tx(uint16_t timeout=0)Tiny::IProtoFd
setReceiveCallback(void(*on_receive)(IPacket &pkt)=nullptr)Tiny::IProtoFdinline
setSendCallback(void(*on_send)(IPacket &pkt)=nullptr)Tiny::IProtoFdinline
setSendTimeout(uint16_t timeout)Tiny::IProtoFdinline
setWindowSize(uint8_t window)Tiny::IProtoFdinline
write(char *buf, int size)Tiny::IProtoFd
write(IPacket &pkt)Tiny::IProtoFd
~IProtoFd()=default (defined in Tiny::IProtoFd)Tiny::IProtoFdvirtual
run_tx(void *data, int max_size)Tiny::IProtoFd
setReceiveCallback(void(*on_receive)(IPacket &pkt)=nullptr)Tiny::IProtoFdinline
setSendCallback(void(*on_send)(IPacket &pkt)=nullptr)Tiny::IProtoFdinline
setSendTimeout(uint16_t timeout)Tiny::IProtoFdinline
setWindowSize(uint8_t window)Tiny::IProtoFdinline
write(char *buf, int size)Tiny::IProtoFd
write(IPacket &pkt)Tiny::IProtoFd
~IProtoFd()=default (defined in Tiny::IProtoFd)Tiny::IProtoFdvirtual
diff --git a/docs/classTiny_1_1IProtoFd.html b/docs/classTiny_1_1IProtoFd.html index eb81a65d..b6275cd4 100644 --- a/docs/classTiny_1_1IProtoFd.html +++ b/docs/classTiny_1_1IProtoFd.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -80,8 +80,8 @@
Inheritance graph
- - + +
[legend]
@@ -91,6 +91,8 @@ + + @@ -107,8 +109,12 @@ + + + + @@ -189,7 +195,7 @@

Member Function Documentation

-

◆ begin()

+

◆ begin() [1/2]

@@ -222,6 +228,24 @@

Returns
None
+

+
+ +

◆ begin() [2/2]

+ +
+
+
 
void begin (write_block_cb_t writecb, read_block_cb_t readcb)
 
void begin ()
 
void beginToSerial ()
 
void beginToSerial1 ()
 
int run_rx (uint16_t timeout=0)
 
int run_rx (const void *data, int len)
 
int run_tx (uint16_t timeout=0)
 
int run_tx (void *data, int max_size)
 
void disableCrc ()
 
void enableCrc (hdlc_crc_t crc)
+ + + + + + +
void Tiny::IProtoFd::begin ()
+
+

Initializes protocol internal variables. If you need to switch communication with other destination point, you can call this method one again after calling end(). Use this method if you want to control write and read data by yourself

Returns
None
+
@@ -529,7 +553,7 @@

-

◆ run_rx()

+

◆ run_rx() [1/2]

@@ -546,10 +570,40 @@

Returns
negative value in case of error zero if nothing is read positive - Packet is successfully received
Remarks
if Packet is receive during run execution callback is called.
+

+
+ +

◆ run_rx() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
int Tiny::IProtoFd::run_rx (const void * data,
int len 
)
+
+

Processes incoming rx data, specified by a user.

Returns
TINY_SUCCESS
+
Remarks
if Packet is receive during run execution callback is called.
+
-

◆ run_tx()

+

◆ run_tx() [1/2]

@@ -565,6 +619,42 @@

Sends data to communcation channel.

Returns
negative value in case of error
+

+
+ +

◆ run_tx() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
int Tiny::IProtoFd::run_tx (void * data,
int max_size 
)
+
+

Force protocol to generate tx data for you. In this case you will need to send data to remote side by yourself.

Parameters
+ + + +
databuffer to fill with tx data
max_sizemaximum size of the buffer
+
+
+
Returns
number of bytes written to buffer
+
@@ -686,7 +776,7 @@

-

Sets desired window size. Use this function only before begin() call. window size is number of frames, which confirmation may be deferred for.

Parameters
+

Sets desired window size. Use this function only before begin() call. window size is number of frames, which confirmation may be deferred for.

Parameters
windowwindow size, valid between 1 - 7 inclusively
diff --git a/docs/classTiny_1_1IProtoFd__inherit__graph.map b/docs/classTiny_1_1IProtoFd__inherit__graph.map index c062e4eb..c0d02887 100644 --- a/docs/classTiny_1_1IProtoFd__inherit__graph.map +++ b/docs/classTiny_1_1IProtoFd__inherit__graph.map @@ -1,4 +1,4 @@ - - + + diff --git a/docs/classTiny_1_1IProtoFd__inherit__graph.png b/docs/classTiny_1_1IProtoFd__inherit__graph.png index fa5b3468..a3c3a0bd 100644 Binary files a/docs/classTiny_1_1IProtoFd__inherit__graph.png and b/docs/classTiny_1_1IProtoFd__inherit__graph.png differ diff --git a/docs/classTiny_1_1Packet-members.html b/docs/classTiny_1_1Packet-members.html index c82d8644..3d83ccc0 100644 --- a/docs/classTiny_1_1Packet-members.html +++ b/docs/classTiny_1_1Packet-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classTiny_1_1Packet.html b/docs/classTiny_1_1Packet.html index 49594b1b..ce2e452f 100644 --- a/docs/classTiny_1_1Packet.html +++ b/docs/classTiny_1_1Packet.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -78,7 +78,7 @@
Inheritance graph
- +
[legend]
@@ -86,7 +86,7 @@
Collaboration graph
- +
[legend]
diff --git a/docs/classTiny_1_1PacketD-members.html b/docs/classTiny_1_1PacketD-members.html index 06f09aaa..e208def0 100644 --- a/docs/classTiny_1_1PacketD-members.html +++ b/docs/classTiny_1_1PacketD-members.html @@ -22,7 +22,7 @@ diff --git a/docs/classTiny_1_1PacketD.html b/docs/classTiny_1_1PacketD.html index 466659b0..00235d06 100644 --- a/docs/classTiny_1_1PacketD.html +++ b/docs/classTiny_1_1PacketD.html @@ -22,7 +22,7 @@ @@ -78,7 +78,7 @@
Inheritance graph
- +
[legend]
@@ -86,7 +86,7 @@
Collaboration graph
- +
[legend]
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classTiny_1_1PacketD__coll__graph.map b/docs/classTiny_1_1PacketD__coll__graph.map index 27616004..8d2f979b 100644 --- a/docs/classTiny_1_1PacketD__coll__graph.map +++ b/docs/classTiny_1_1PacketD__coll__graph.map @@ -1,3 +1,3 @@ - + diff --git a/docs/classTiny_1_1PacketD__coll__graph.png b/docs/classTiny_1_1PacketD__coll__graph.png index dd92261c..ea6b4323 100644 Binary files a/docs/classTiny_1_1PacketD__coll__graph.png and b/docs/classTiny_1_1PacketD__coll__graph.png differ diff --git a/docs/classTiny_1_1PacketD__inherit__graph.map b/docs/classTiny_1_1PacketD__inherit__graph.map index 27616004..8d2f979b 100644 --- a/docs/classTiny_1_1PacketD__inherit__graph.map +++ b/docs/classTiny_1_1PacketD__inherit__graph.map @@ -1,3 +1,3 @@ - + diff --git a/docs/classTiny_1_1PacketD__inherit__graph.png b/docs/classTiny_1_1PacketD__inherit__graph.png index dd92261c..ea6b4323 100644 Binary files a/docs/classTiny_1_1PacketD__inherit__graph.png and b/docs/classTiny_1_1PacketD__inherit__graph.png differ diff --git a/docs/classTiny_1_1Packet__coll__graph.map b/docs/classTiny_1_1Packet__coll__graph.map index d86837d6..fc4cb3fb 100644 --- a/docs/classTiny_1_1Packet__coll__graph.map +++ b/docs/classTiny_1_1Packet__coll__graph.map @@ -1,3 +1,3 @@ - + diff --git a/docs/classTiny_1_1Packet__coll__graph.png b/docs/classTiny_1_1Packet__coll__graph.png index 66fd88a7..094ce86a 100644 Binary files a/docs/classTiny_1_1Packet__coll__graph.png and b/docs/classTiny_1_1Packet__coll__graph.png differ diff --git a/docs/classTiny_1_1Packet__inherit__graph.map b/docs/classTiny_1_1Packet__inherit__graph.map index d86837d6..fc4cb3fb 100644 --- a/docs/classTiny_1_1Packet__inherit__graph.map +++ b/docs/classTiny_1_1Packet__inherit__graph.map @@ -1,3 +1,3 @@ - + diff --git a/docs/classTiny_1_1Packet__inherit__graph.png b/docs/classTiny_1_1Packet__inherit__graph.png index 66fd88a7..094ce86a 100644 Binary files a/docs/classTiny_1_1Packet__inherit__graph.png and b/docs/classTiny_1_1Packet__inherit__graph.png differ diff --git a/docs/classTiny_1_1ProtoFd-members.html b/docs/classTiny_1_1ProtoFd-members.html index 3d01cd2f..e07cf856 100644 --- a/docs/classTiny_1_1ProtoFd-members.html +++ b/docs/classTiny_1_1ProtoFd-members.html @@ -22,7 +22,7 @@ @@ -72,29 +72,32 @@

This is the complete list of members for Tiny::ProtoFd< S >, including all inherited members.

Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
- - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - - - - - - + + + + + + + +
begin(write_block_cb_t writecb, read_block_cb_t readcb)Tiny::IProtoFd
beginToSerial()Tiny::IProtoFdinline
beginToSerial1()Tiny::IProtoFdinline
beginToSerial2()Tiny::IProtoFdinline
beginToSerial3()Tiny::IProtoFdinline
disableCrc()Tiny::IProtoFd
enableCheckSum()Tiny::IProtoFd
enableCrc(hdlc_crc_t crc)Tiny::IProtoFd
enableCrc16()Tiny::IProtoFd
enableCrc32()Tiny::IProtoFd
end()Tiny::IProtoFd
IProtoFd(void *buffer, int bufferSize)Tiny::IProtoFdinline
onReceive(uint8_t *pdata, int size)Tiny::IProtoFdinlineprotectedvirtual
onSend(uint8_t *pdata, int size)Tiny::IProtoFdinlineprotectedvirtual
ProtoFd() (defined in Tiny::ProtoFd< S >)Tiny::ProtoFd< S >inline
run_rx(uint16_t timeout=0)Tiny::IProtoFd
begin()Tiny::IProtoFd
beginToSerial()Tiny::IProtoFdinline
beginToSerial1()Tiny::IProtoFdinline
beginToSerial2()Tiny::IProtoFdinline
beginToSerial3()Tiny::IProtoFdinline
disableCrc()Tiny::IProtoFd
enableCheckSum()Tiny::IProtoFd
enableCrc(hdlc_crc_t crc)Tiny::IProtoFd
enableCrc16()Tiny::IProtoFd
enableCrc32()Tiny::IProtoFd
end()Tiny::IProtoFd
IProtoFd(void *buffer, int bufferSize)Tiny::IProtoFdinline
onReceive(uint8_t *pdata, int size)Tiny::IProtoFdinlineprotectedvirtual
onSend(uint8_t *pdata, int size)Tiny::IProtoFdinlineprotectedvirtual
ProtoFd() (defined in Tiny::ProtoFd< S >)Tiny::ProtoFd< S >inline
run_rx(uint16_t timeout=0)Tiny::IProtoFd
run_rx(const void *data, int len)Tiny::IProtoFd
run_tx(uint16_t timeout=0)Tiny::IProtoFd
setReceiveCallback(void(*on_receive)(IPacket &pkt)=nullptr)Tiny::IProtoFdinline
setSendCallback(void(*on_send)(IPacket &pkt)=nullptr)Tiny::IProtoFdinline
setSendTimeout(uint16_t timeout)Tiny::IProtoFdinline
setWindowSize(uint8_t window)Tiny::IProtoFdinline
write(char *buf, int size)Tiny::IProtoFd
write(IPacket &pkt)Tiny::IProtoFd
~IProtoFd()=default (defined in Tiny::IProtoFd)Tiny::IProtoFdvirtual
run_tx(void *data, int max_size)Tiny::IProtoFd
setReceiveCallback(void(*on_receive)(IPacket &pkt)=nullptr)Tiny::IProtoFdinline
setSendCallback(void(*on_send)(IPacket &pkt)=nullptr)Tiny::IProtoFdinline
setSendTimeout(uint16_t timeout)Tiny::IProtoFdinline
setWindowSize(uint8_t window)Tiny::IProtoFdinline
write(char *buf, int size)Tiny::IProtoFd
write(IPacket &pkt)Tiny::IProtoFd
~IProtoFd()=default (defined in Tiny::IProtoFd)Tiny::IProtoFdvirtual
diff --git a/docs/classTiny_1_1ProtoFd.html b/docs/classTiny_1_1ProtoFd.html index cbde1ce2..caa2ea7f 100644 --- a/docs/classTiny_1_1ProtoFd.html +++ b/docs/classTiny_1_1ProtoFd.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -77,7 +77,7 @@
Inheritance graph
- +
[legend]
@@ -85,7 +85,7 @@
Collaboration graph
- +
[legend]
@@ -96,6 +96,8 @@ + + @@ -112,8 +114,12 @@ + + + + diff --git a/docs/classTiny_1_1ProtoFdD-members.html b/docs/classTiny_1_1ProtoFdD-members.html index f809f6d3..9451201a 100644 --- a/docs/classTiny_1_1ProtoFdD-members.html +++ b/docs/classTiny_1_1ProtoFdD-members.html @@ -22,7 +22,7 @@ @@ -72,30 +72,33 @@

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

 
void begin (write_block_cb_t writecb, read_block_cb_t readcb)
 
void begin ()
 
void beginToSerial ()
 
void beginToSerial1 ()
 
int run_rx (uint16_t timeout=0)
 
int run_rx (const void *data, int len)
 
int run_tx (uint16_t timeout=0)
 
int run_tx (void *data, int max_size)
 
void disableCrc ()
 
void enableCrc (hdlc_crc_t crc)
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
- - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - - - - - - - + + + + + + + + +
begin(write_block_cb_t writecb, read_block_cb_t readcb)Tiny::IProtoFd
beginToSerial()Tiny::IProtoFdinline
beginToSerial1()Tiny::IProtoFdinline
beginToSerial2()Tiny::IProtoFdinline
beginToSerial3()Tiny::IProtoFdinline
disableCrc()Tiny::IProtoFd
enableCheckSum()Tiny::IProtoFd
enableCrc(hdlc_crc_t crc)Tiny::IProtoFd
enableCrc16()Tiny::IProtoFd
enableCrc32()Tiny::IProtoFd
end()Tiny::IProtoFd
IProtoFd(void *buffer, int bufferSize)Tiny::IProtoFdinline
onReceive(uint8_t *pdata, int size)Tiny::IProtoFdinlineprotectedvirtual
onSend(uint8_t *pdata, int size)Tiny::IProtoFdinlineprotectedvirtual
ProtoFdD(int size)Tiny::ProtoFdDinline
run_rx(uint16_t timeout=0)Tiny::IProtoFd
begin()Tiny::IProtoFd
beginToSerial()Tiny::IProtoFdinline
beginToSerial1()Tiny::IProtoFdinline
beginToSerial2()Tiny::IProtoFdinline
beginToSerial3()Tiny::IProtoFdinline
disableCrc()Tiny::IProtoFd
enableCheckSum()Tiny::IProtoFd
enableCrc(hdlc_crc_t crc)Tiny::IProtoFd
enableCrc16()Tiny::IProtoFd
enableCrc32()Tiny::IProtoFd
end()Tiny::IProtoFd
IProtoFd(void *buffer, int bufferSize)Tiny::IProtoFdinline
onReceive(uint8_t *pdata, int size)Tiny::IProtoFdinlineprotectedvirtual
onSend(uint8_t *pdata, int size)Tiny::IProtoFdinlineprotectedvirtual
ProtoFdD(int size)Tiny::ProtoFdDinline
run_rx(uint16_t timeout=0)Tiny::IProtoFd
run_rx(const void *data, int len)Tiny::IProtoFd
run_tx(uint16_t timeout=0)Tiny::IProtoFd
setReceiveCallback(void(*on_receive)(IPacket &pkt)=nullptr)Tiny::IProtoFdinline
setSendCallback(void(*on_send)(IPacket &pkt)=nullptr)Tiny::IProtoFdinline
setSendTimeout(uint16_t timeout)Tiny::IProtoFdinline
setWindowSize(uint8_t window)Tiny::IProtoFdinline
write(char *buf, int size)Tiny::IProtoFd
write(IPacket &pkt)Tiny::IProtoFd
~IProtoFd()=default (defined in Tiny::IProtoFd)Tiny::IProtoFdvirtual
~ProtoFdD() (defined in Tiny::ProtoFdD)Tiny::ProtoFdDinline
run_tx(void *data, int max_size)Tiny::IProtoFd
setReceiveCallback(void(*on_receive)(IPacket &pkt)=nullptr)Tiny::IProtoFdinline
setSendCallback(void(*on_send)(IPacket &pkt)=nullptr)Tiny::IProtoFdinline
setSendTimeout(uint16_t timeout)Tiny::IProtoFdinline
setWindowSize(uint8_t window)Tiny::IProtoFdinline
write(char *buf, int size)Tiny::IProtoFd
write(IPacket &pkt)Tiny::IProtoFd
~IProtoFd()=default (defined in Tiny::IProtoFd)Tiny::IProtoFdvirtual
~ProtoFdD() (defined in Tiny::ProtoFdD)Tiny::ProtoFdDinline
diff --git a/docs/classTiny_1_1ProtoFdD.html b/docs/classTiny_1_1ProtoFdD.html index 3fb4dda2..7c6357c7 100644 --- a/docs/classTiny_1_1ProtoFdD.html +++ b/docs/classTiny_1_1ProtoFdD.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -78,7 +78,7 @@
Inheritance graph
- +
[legend]
@@ -86,7 +86,7 @@
Collaboration graph
- +
[legend]
@@ -99,6 +99,8 @@ + + @@ -115,8 +117,12 @@ + + + + diff --git a/docs/classTiny_1_1ProtoFdD__coll__graph.map b/docs/classTiny_1_1ProtoFdD__coll__graph.map index 6aca7b6c..c545039a 100644 --- a/docs/classTiny_1_1ProtoFdD__coll__graph.map +++ b/docs/classTiny_1_1ProtoFdD__coll__graph.map @@ -1,3 +1,3 @@ - + diff --git a/docs/classTiny_1_1ProtoFdD__coll__graph.png b/docs/classTiny_1_1ProtoFdD__coll__graph.png index 431304d4..c23950ed 100644 Binary files a/docs/classTiny_1_1ProtoFdD__coll__graph.png and b/docs/classTiny_1_1ProtoFdD__coll__graph.png differ diff --git a/docs/classTiny_1_1ProtoFdD__inherit__graph.map b/docs/classTiny_1_1ProtoFdD__inherit__graph.map index 6aca7b6c..c545039a 100644 --- a/docs/classTiny_1_1ProtoFdD__inherit__graph.map +++ b/docs/classTiny_1_1ProtoFdD__inherit__graph.map @@ -1,3 +1,3 @@ - + diff --git a/docs/classTiny_1_1ProtoFdD__inherit__graph.png b/docs/classTiny_1_1ProtoFdD__inherit__graph.png index 431304d4..c23950ed 100644 Binary files a/docs/classTiny_1_1ProtoFdD__inherit__graph.png and b/docs/classTiny_1_1ProtoFdD__inherit__graph.png differ diff --git a/docs/classTiny_1_1ProtoFd__coll__graph.map b/docs/classTiny_1_1ProtoFd__coll__graph.map index 6f10cc5c..665594a4 100644 --- a/docs/classTiny_1_1ProtoFd__coll__graph.map +++ b/docs/classTiny_1_1ProtoFd__coll__graph.map @@ -1,3 +1,3 @@ - + diff --git a/docs/classTiny_1_1ProtoFd__coll__graph.png b/docs/classTiny_1_1ProtoFd__coll__graph.png index 3152420f..1f730e4d 100644 Binary files a/docs/classTiny_1_1ProtoFd__coll__graph.png and b/docs/classTiny_1_1ProtoFd__coll__graph.png differ diff --git a/docs/classTiny_1_1ProtoFd__inherit__graph.map b/docs/classTiny_1_1ProtoFd__inherit__graph.map index 6f10cc5c..665594a4 100644 --- a/docs/classTiny_1_1ProtoFd__inherit__graph.map +++ b/docs/classTiny_1_1ProtoFd__inherit__graph.map @@ -1,3 +1,3 @@ - + diff --git a/docs/classTiny_1_1ProtoFd__inherit__graph.png b/docs/classTiny_1_1ProtoFd__inherit__graph.png index 3152420f..1f730e4d 100644 Binary files a/docs/classTiny_1_1ProtoFd__inherit__graph.png and b/docs/classTiny_1_1ProtoFd__inherit__graph.png differ diff --git a/docs/classTiny_1_1ProtoHd-members.html b/docs/classTiny_1_1ProtoHd-members.html index 1aa28c03..0ae9e4fa 100644 --- a/docs/classTiny_1_1ProtoHd-members.html +++ b/docs/classTiny_1_1ProtoHd-members.html @@ -22,7 +22,7 @@ diff --git a/docs/classTiny_1_1ProtoHd.html b/docs/classTiny_1_1ProtoHd.html index ed974dc6..8ab3ba57 100644 --- a/docs/classTiny_1_1ProtoHd.html +++ b/docs/classTiny_1_1ProtoHd.html @@ -22,7 +22,7 @@ diff --git a/docs/classTiny_1_1ProtoHdlc-members.html b/docs/classTiny_1_1ProtoHdlc-members.html new file mode 100644 index 00000000..fa70ad6c --- /dev/null +++ b/docs/classTiny_1_1ProtoHdlc-members.html @@ -0,0 +1,104 @@ + + + + + + + +Tiny protocol: Member List + + + + + + + + + +
+
+
 
void begin (write_block_cb_t writecb, read_block_cb_t readcb)
 
void begin ()
 
void beginToSerial ()
 
void beginToSerial1 ()
 
int run_rx (uint16_t timeout=0)
 
int run_rx (const void *data, int len)
 
int run_tx (uint16_t timeout=0)
 
int run_tx (void *data, int max_size)
 
void disableCrc ()
 
void enableCrc (hdlc_crc_t crc)
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
+ + + + + +
+
Tiny protocol +  0.11.0 +
+
Tiny communication protocol for microcontrollers
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + + +
+
+
Tiny::ProtoHdlc Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + + + + +
begin(write_block_cb_t writecb, read_block_cb_t readcb)Tiny::ProtoHdlc
begin()Tiny::ProtoHdlc
beginToSerial()Tiny::ProtoHdlcinline
beginToSerial1()Tiny::ProtoHdlcinline
beginToSerial2()Tiny::ProtoHdlcinline
beginToSerial3()Tiny::ProtoHdlcinline
disableCrc()Tiny::ProtoHdlc
enableCheckSum()Tiny::ProtoHdlc
enableCrc(hdlc_crc_t crc)Tiny::ProtoHdlc
enableCrc16()Tiny::ProtoHdlc
enableCrc32()Tiny::ProtoHdlc
end()Tiny::ProtoHdlc
onReceive(uint8_t *pdata, int size)Tiny::ProtoHdlcinlineprotectedvirtual
onSend(const uint8_t *pdata, int size)Tiny::ProtoHdlcinlineprotectedvirtual
ProtoHdlc(void *buffer, int bufferSize)Tiny::ProtoHdlcinline
run_rx(const void *data, int len)Tiny::ProtoHdlc
run_tx(void *data, int max_len)Tiny::ProtoHdlc
setReceiveCallback(void(*on_receive)(IPacket &pkt)=nullptr)Tiny::ProtoHdlcinline
setSendCallback(void(*on_send)(IPacket &pkt)=nullptr)Tiny::ProtoHdlcinline
write(char *buf, int size)Tiny::ProtoHdlc
write(IPacket &pkt)Tiny::ProtoHdlc
~ProtoHdlc()=default (defined in Tiny::ProtoHdlc)Tiny::ProtoHdlcvirtual
+ +
+Generated by   +doxygen + 1.8.13 +
+ + diff --git a/docs/classTiny_1_1ProtoHdlc.html b/docs/classTiny_1_1ProtoHdlc.html new file mode 100644 index 00000000..c5e4b48f --- /dev/null +++ b/docs/classTiny_1_1ProtoHdlc.html @@ -0,0 +1,734 @@ + + + + + + + +Tiny protocol: Tiny::ProtoHdlc Class Reference + + + + + + + + + +
+
+ + + + + + +
+
Tiny protocol +  0.11.0 +
+
Tiny communication protocol for microcontrollers
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Member Functions | +List of all members
+
+
Tiny::ProtoHdlc Class Reference
Tiny HDLC protocol API functions
+
+
+ +

#include <TinyProtocolHdlc.h>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 ProtoHdlc (void *buffer, int bufferSize)
 
void begin (write_block_cb_t writecb, read_block_cb_t readcb)
 
void begin ()
 
void beginToSerial ()
 
void beginToSerial1 ()
 
void beginToSerial2 ()
 
void beginToSerial3 ()
 
void end ()
 
int write (char *buf, int size)
 
int write (IPacket &pkt)
 
int run_rx (const void *data, int len)
 
int run_tx (void *data, int max_len)
 
void disableCrc ()
 
void enableCrc (hdlc_crc_t crc)
 
bool enableCheckSum ()
 
bool enableCrc16 ()
 
bool enableCrc32 ()
 
void setReceiveCallback (void(*on_receive)(IPacket &pkt)=nullptr)
 
void setSendCallback (void(*on_send)(IPacket &pkt)=nullptr)
 
+ + + + + +

+Protected Member Functions

virtual void onReceive (uint8_t *pdata, int size)
 
virtual void onSend (const uint8_t *pdata, int size)
 
+

Detailed Description

+

ProtoHdlc class incapsulates hdlc Protocol functionality. hdlc version of the Protocol allows to send messages with confirmation. Remember that you may use always C-style API functions instead C++. Please refer to documentation.

+

Constructor & Destructor Documentation

+ +

◆ ProtoHdlc()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
Tiny::ProtoHdlc::ProtoHdlc (void * buffer,
int bufferSize 
)
+ 		+inline
+
+

Initializes ProtoHdlc object

Parameters
+ + + +
buffer- buffer to store the frames being received.
bufferSize- size of the buffer
+
+
+ +
+
+

Member Function Documentation

+ +

◆ begin() [1/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
void Tiny::ProtoHdlc::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
+ +
+
+ +

◆ begin() [2/2]

+ +
+
+ + + + + + + +
void Tiny::ProtoHdlc::begin ()
+
+

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

Returns
None
+ +
+
+ +

◆ beginToSerial()

+ +
+
+ + + + + +
+ + + + + + + +
void Tiny::ProtoHdlc::beginToSerial ()
+ 		+inline
+
+

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

Returns
None
+ +
+
+ +

◆ beginToSerial1()

+ +
+
+ + + + + +
+ + + + + + + +
void Tiny::ProtoHdlc::beginToSerial1 ()
+ 		+inline
+
+

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

Returns
None
+ +
+
+ +

◆ beginToSerial2()

+ +
+
+ + + + + +
+ + + + + + + +
void Tiny::ProtoHdlc::beginToSerial2 ()
+ 		+inline
+
+

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

Returns
None
+ +
+
+ +

◆ beginToSerial3()

+ +
+
+ + + + + +
+ + + + + + + +
void Tiny::ProtoHdlc::beginToSerial3 ()
+ 		+inline
+
+

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

Returns
None
+ +
+
+ +

◆ disableCrc()

+ +
+
+ + + + + + + +
void Tiny::ProtoHdlc::disableCrc ()
+
+

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

+ +
+
+ +

◆ enableCheckSum()

+ +
+
+ + + + + + + +
bool Tiny::ProtoHdlc::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.
+ +
+
+ +

◆ enableCrc()

+ +
+
+ + + + + + + + +
void Tiny::ProtoHdlc::enableCrc (hdlc_crc_t crc)
+
+

Enables CRC by specified bit-size. 8-bit is supported by Nano version of Tiny library.

Parameters
+ + +
crccrc type
+
+
+ +
+
+ +

◆ enableCrc16()

+ +
+
+ + + + + + + +
bool Tiny::ProtoHdlc::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::ProtoHdlc::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.
+ +
+
+ +

◆ end()

+ +
+
+ + + + + + + +
void Tiny::ProtoHdlc::end ()
+
+

Resets protocol state.

+ +
+
+ +

◆ onReceive()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual void Tiny::ProtoHdlc::onReceive (uint8_t * pdata,
int size 
)
+ 		+inlineprotectedvirtual
+
+

Method called by hdlc protocol upon receiving new frame. Can be redefined in derived classes.

Parameters
+ + + +
pdatapointer to received data
sizesize of received payload in bytes
+
+
+ +
+
+ +

◆ onSend()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual void Tiny::ProtoHdlc::onSend (const uint8_t * pdata,
int size 
)
+ 		+inlineprotectedvirtual
+
+

Method called by hdlc protocol upon sending next frame. Can be redefined in derived classes.

Parameters
+ + + +
pdatapointer to sent data
sizesize of sent payload in bytes
+
+
+ +
+
+ +

◆ run_rx()

+ +
+
+ + + + + + + + + + + + + + + + + + +
int Tiny::ProtoHdlc::run_rx (const void * data,
int len 
)
+
+

Processes incoming rx data, specified by a user.

Returns
TINY_SUCCESS
+
Remarks
if Packet is receive during run execution callback is called.
+ +
+
+ +

◆ run_tx()

+ +
+
+ + + + + + + + + + + + + + + + + + +
int Tiny::ProtoHdlc::run_tx (void * data,
int max_len 
)
+
+

Generates data for tx channel

Parameters
+ + + +
databuffer to fill
max_lenlength of buffer
+
+
+
Returns
number of bytes generated
+ +
+
+ +

◆ setReceiveCallback()

+ +
+
+ + + + + +
+ + + + + + + + +
void Tiny::ProtoHdlc::setReceiveCallback (void(*)(IPacket &pkt) on_receive = nullptr)
+ 		+inline
+
+

Sets receive callback for incoming messages

Parameters
+ + +
on_receiveuser callback to process incoming messages. The processing must be non-blocking
+
+
+ +
+
+ +

◆ setSendCallback()

+ +
+
+ + + + + +
+ + + + + + + + +
void Tiny::ProtoHdlc::setSendCallback (void(*)(IPacket &pkt) on_send = nullptr)
+ 		+inline
+
+

Sets send callback for outgoing messages

Parameters
+ + +
on_senduser callback to process outgoing messages. The processing must be non-blocking
+
+
+ +
+
+ +

◆ write() [1/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
int Tiny::ProtoHdlc::write (char * buf,
int size 
)
+
+

Sends data block over communication channel.

Parameters
+ + + +
buf- data to send
size- length of the data in bytes
+
+
+
Returns
negative value in case of error zero if nothing is sent positive - should be equal to size parameter
+ +
+
+ +

◆ write() [2/2]

+ +
+
+ + + + + + + + +
int Tiny::ProtoHdlc::write (IPacket & pkt)
+
+

Sends packet over communication channel.

Parameters
+ + +
pkt- Packet to send
+
+
+
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_1ProtoLight-members.html b/docs/classTiny_1_1ProtoLight-members.html index 61ec45bb..0dbbd43b 100644 --- a/docs/classTiny_1_1ProtoLight-members.html +++ b/docs/classTiny_1_1ProtoLight-members.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classTiny_1_1ProtoLight.html b/docs/classTiny_1_1ProtoLight.html index 41c1a260..5a4ce111 100644 --- a/docs/classTiny_1_1ProtoLight.html +++ b/docs/classTiny_1_1ProtoLight.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
diff --git a/docs/classes.html b/docs/classes.html index cd33b817..d7d56d5b 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -67,19 +67,18 @@
_ | i | l | p | s | t
+ - + + + - - - + + +
  _  
-		IProtoFd (Tiny)   PacketD (Tiny)   STinyHdInit_   tiny_request_   
IProtoFd (Tiny)   PacketD (Tiny)   
  s  
+
  t  
+
  l  
-		ProtoFd (Tiny)   STinyLightData   
_hdlc_handle_t   ProtoFdD (Tiny)   STinyStats   
ProtoFd (Tiny)   
_hdlc_handle_t   ProtoFdD (Tiny)   STinyHdData_   tiny_fd_init_t_   
  i  
-		list_element_   ProtoHd (Tiny)   
  t  
-
list_element_   ProtoHd (Tiny)   STinyHdInit_   tiny_request_   
  p  
-		ProtoLight (Tiny)   
IPacket (Tiny)   
  s  
-		tiny_fd_init_t_   
Packet (Tiny)   
STinyHdData_   
ProtoHdlc (Tiny)   STinyLightData   
IPacket (Tiny)   ProtoLight (Tiny)   STinyStats   
Packet (Tiny)   
_ | i | l | p | s | t
diff --git a/docs/crc_8h_source.html b/docs/crc_8h_source.html index 53d128fc..47d67b17 100644 --- a/docs/crc_8h_source.html +++ b/docs/crc_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_000002_000004.html b/docs/dir_000002_000004.html index f070ab79..707a0883 100644 --- a/docs/dir_000002_000004.html +++ b/docs/dir_000002_000004.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_000003_000004.html b/docs/dir_000003_000004.html index 1a64de1b..2770fdd9 100644 --- a/docs/dir_000003_000004.html +++ b/docs/dir_000003_000004.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_000007_000004.html b/docs/dir_000007_000004.html index 57593749..c037f0e1 100644 --- a/docs/dir_000007_000004.html +++ b/docs/dir_000007_000004.html @@ -5,7 +5,7 @@ -Tiny protocol: src/proto/hdlc -> hal Relation +Tiny protocol: src/proto/half_duplex -> hal Relation @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -60,11 +60,11 @@
-

hdlc → hal Relation

File in src/proto/hdlcIncludes file in src/proto/hal
tiny_hdlc.htiny_types.h
+

half_duplex → hal Relation

File in src/proto/half_duplexIncludes file in src/proto/hal
tiny_hd.ctiny_types.h
tiny_hd.htiny_types.h
tiny_rq_pool.ctiny_types.h
tiny_rq_pool.htiny_types.h
Generated by   diff --git a/docs/dir_000008_000004.html b/docs/dir_000008_000004.html index f1068f4a..5c7d3957 100644 --- a/docs/dir_000008_000004.html +++ b/docs/dir_000008_000004.html @@ -5,7 +5,7 @@ -Tiny protocol: src/proto/light -> hal Relation +Tiny protocol: src/proto/hdlc -> hal Relation @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -60,11 +60,11 @@
-

light → hal Relation

File in src/proto/lightIncludes file in src/proto/hal
tiny_light.htiny_types.h
+

hdlc → hal Relation

File in src/proto/hdlcIncludes file in src/proto/hal
tiny_hdlc.htiny_types.h
Generated by   diff --git a/docs/dir_000009_000004.html b/docs/dir_000009_000004.html new file mode 100644 index 00000000..84b13e6f --- /dev/null +++ b/docs/dir_000009_000004.html @@ -0,0 +1,75 @@ + + + + + + + +Tiny protocol: src/proto/light -> hal Relation + + + + + + + + + + +
+

light → hal Relation

File in src/proto/lightIncludes file in src/proto/hal
tiny_light.htiny_types.h
+ +
+Generated by   +doxygen + 1.8.13 +
+ + diff --git a/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4.html b/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4.html index 78c8150d..9a722a47 100644 --- a/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4.html +++ b/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -73,19 +73,19 @@
src/proto
- - - - - - - + + + + + + + - + - - - + + +
diff --git a/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.map b/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.map index 91544a57..93be03f2 100644 --- a/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.map +++ b/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.map @@ -1,15 +1,15 @@ - - - - - - - + + + + + + + - + - - - + + + diff --git a/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.md5 b/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.md5 index 38efcc26..d8e3925b 100644 --- a/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.md5 +++ b/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.md5 @@ -1 +1 @@ -96b55d5b09940f17cd9a4b5888be570f \ No newline at end of file +cfd7e1323a4f9745b9b78c66eb3d8ce2 \ No newline at end of file diff --git a/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.png b/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.png index 710c0ada..9da052a6 100644 Binary files a/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.png and b/docs/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.png differ diff --git a/docs/dir_5f912d25950dbd750c3eed60d2c339b1.html b/docs/dir_5f912d25950dbd750c3eed60d2c339b1.html index aa219a6e..f634f9f7 100644 --- a/docs/dir_5f912d25950dbd750c3eed60d2c339b1.html +++ b/docs/dir_5f912d25950dbd750c3eed60d2c339b1.html @@ -22,7 +22,7 @@ @@ -75,7 +75,7 @@ - + diff --git a/docs/dir_5f912d25950dbd750c3eed60d2c339b1_dep.map b/docs/dir_5f912d25950dbd750c3eed60d2c339b1_dep.map index 67d1fe9a..909fdaa4 100644 --- a/docs/dir_5f912d25950dbd750c3eed60d2c339b1_dep.map +++ b/docs/dir_5f912d25950dbd750c3eed60d2c339b1_dep.map @@ -1,6 +1,6 @@ - + diff --git a/docs/dir_5f912d25950dbd750c3eed60d2c339b1_dep.png b/docs/dir_5f912d25950dbd750c3eed60d2c339b1_dep.png index 6d2ded05..247fb4af 100644 Binary files a/docs/dir_5f912d25950dbd750c3eed60d2c339b1_dep.png and b/docs/dir_5f912d25950dbd750c3eed60d2c339b1_dep.png differ diff --git a/docs/dir_61a763563eb3728beb0014ac26e3418e.html b/docs/dir_61a763563eb3728beb0014ac26e3418e.html index db88791a..a806c0b5 100644 --- a/docs/dir_61a763563eb3728beb0014ac26e3418e.html +++ b/docs/dir_61a763563eb3728beb0014ac26e3418e.html @@ -22,7 +22,7 @@ @@ -73,10 +73,10 @@
src/proto/half_duplex
- - - - + + + +
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
diff --git a/docs/dir_61a763563eb3728beb0014ac26e3418e_dep.map b/docs/dir_61a763563eb3728beb0014ac26e3418e_dep.map index 6845c0c9..0fa50a63 100644 --- a/docs/dir_61a763563eb3728beb0014ac26e3418e_dep.map +++ b/docs/dir_61a763563eb3728beb0014ac26e3418e_dep.map @@ -1,6 +1,6 @@ - - - - + + + + diff --git a/docs/dir_61a763563eb3728beb0014ac26e3418e_dep.md5 b/docs/dir_61a763563eb3728beb0014ac26e3418e_dep.md5 index e6376353..4f86117a 100644 --- a/docs/dir_61a763563eb3728beb0014ac26e3418e_dep.md5 +++ b/docs/dir_61a763563eb3728beb0014ac26e3418e_dep.md5 @@ -1 +1 @@ -06c9cd4ec6c85c4e9dc071b3773eaff8 \ No newline at end of file +279455efd96d59efea26ff5cd2c4654b \ No newline at end of file diff --git a/docs/dir_61a763563eb3728beb0014ac26e3418e_dep.png b/docs/dir_61a763563eb3728beb0014ac26e3418e_dep.png index 76b70b3c..3bf01314 100644 Binary files a/docs/dir_61a763563eb3728beb0014ac26e3418e_dep.png and b/docs/dir_61a763563eb3728beb0014ac26e3418e_dep.png differ diff --git a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html index 4df6e17c..3c25a6cc 100644 --- a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -22,7 +22,7 @@ @@ -95,6 +95,9 @@ + + +
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
file  TinyProtocolHd.h [code]
 Tiny protocol Arduino API.
 
file  TinyProtocolHdlc.h [code]
 Tiny protocol Arduino API.
 
diff --git a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png index 61037863..a1a70be3 100644 Binary files a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png and b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png differ diff --git a/docs/dir_75a472a4d9716ba9c1151370abaacaf0.html b/docs/dir_75a472a4d9716ba9c1151370abaacaf0.html index aaff74b0..0c4186b6 100644 --- a/docs/dir_75a472a4d9716ba9c1151370abaacaf0.html +++ b/docs/dir_75a472a4d9716ba9c1151370abaacaf0.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -74,6 +74,9 @@ + + + diff --git a/docs/dir_9c7dc50cded8f3aee51a209935ca1b53.html b/docs/dir_9c7dc50cded8f3aee51a209935ca1b53.html index 3b9770e1..8b9c0e2b 100644 --- a/docs/dir_9c7dc50cded8f3aee51a209935ca1b53.html +++ b/docs/dir_9c7dc50cded8f3aee51a209935ca1b53.html @@ -22,7 +22,7 @@ @@ -75,7 +75,7 @@ - + diff --git a/docs/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.map b/docs/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.map index 600f4598..dad5ed1b 100644 --- a/docs/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.map +++ b/docs/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.map @@ -1,6 +1,6 @@ - + diff --git a/docs/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.md5 b/docs/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.md5 index 3b1c91cd..15152560 100644 --- a/docs/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.md5 +++ b/docs/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.md5 @@ -1 +1 @@ -a72fb967d940e7e1cd45990f002f4c25 \ No newline at end of file +ee91ee20e156331b5decdca3dc8525ea \ No newline at end of file diff --git a/docs/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.png b/docs/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.png index 529239cb..297ecde2 100644 Binary files a/docs/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.png and b/docs/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.png differ diff --git a/docs/dir_d6ed9889db13bd70873de213d090a747.html b/docs/dir_d6ed9889db13bd70873de213d090a747.html index fe1c6617..cb75733c 100644 --- a/docs/dir_d6ed9889db13bd70873de213d090a747.html +++ b/docs/dir_d6ed9889db13bd70873de213d090a747.html @@ -22,7 +22,7 @@ diff --git a/docs/dir_f468ab7bd64995917426f65613b4e1f4.html b/docs/dir_f468ab7bd64995917426f65613b4e1f4.html index 4b059755..b32e469a 100644 --- a/docs/dir_f468ab7bd64995917426f65613b4e1f4.html +++ b/docs/dir_f468ab7bd64995917426f65613b4e1f4.html @@ -22,7 +22,7 @@ @@ -75,7 +75,7 @@ - + diff --git a/docs/dir_f468ab7bd64995917426f65613b4e1f4_dep.map b/docs/dir_f468ab7bd64995917426f65613b4e1f4_dep.map index 390a097d..676e4190 100644 --- a/docs/dir_f468ab7bd64995917426f65613b4e1f4_dep.map +++ b/docs/dir_f468ab7bd64995917426f65613b4e1f4_dep.map @@ -1,6 +1,6 @@ - + diff --git a/docs/dir_f468ab7bd64995917426f65613b4e1f4_dep.md5 b/docs/dir_f468ab7bd64995917426f65613b4e1f4_dep.md5 index 1166e215..604b9bf0 100644 --- a/docs/dir_f468ab7bd64995917426f65613b4e1f4_dep.md5 +++ b/docs/dir_f468ab7bd64995917426f65613b4e1f4_dep.md5 @@ -1 +1 @@ -2eb0cb1f0fe8bbe1077861c4333a10bf \ No newline at end of file +25f63740b7ab1bab119cbfb3289b5a33 \ No newline at end of file diff --git a/docs/dir_f468ab7bd64995917426f65613b4e1f4_dep.png b/docs/dir_f468ab7bd64995917426f65613b4e1f4_dep.png index 3e9a933f..d283c538 100644 Binary files a/docs/dir_f468ab7bd64995917426f65613b4e1f4_dep.png and b/docs/dir_f468ab7bd64995917426f65613b4e1f4_dep.png differ diff --git a/docs/dir_000006_000004.html b/docs/dir_f5baaad8cebc633554cca9d618218d60.html similarity index 71% rename from docs/dir_000006_000004.html rename to docs/dir_f5baaad8cebc633554cca9d618218d60.html index 166503cf..4c4670f8 100644 --- a/docs/dir_000006_000004.html +++ b/docs/dir_f5baaad8cebc633554cca9d618218d60.html @@ -5,7 +5,7 @@ -Tiny protocol: src/proto/half_duplex -> hal Relation +Tiny protocol: src/proto/hal/serial Directory Reference @@ -22,7 +22,7 @@ @@ -60,11 +60,22 @@ +
+
+
serial Directory Reference
+
-

half_duplex → hal Relation

Files

file  tiny_serial.h [code]
 Tiny UART serial API.
 
file  tiny_types.h [code]
 Tiny protocol Types.
 
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
File in src/proto/half_duplexIncludes file in src/proto/hal
tiny_hd.ctiny_types.h
tiny_hd.htiny_types.h
tiny_rq_pool.ctiny_types.h
tiny_rq_pool.htiny_types.h
+ + + + + +

+Files

file  win32_serial.h [code]
 UART serial API.
 
+
Generated by   diff --git a/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab.html b/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab.html index f0875b6f..4a66e3c1 100644 --- a/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab.html +++ b/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -75,7 +75,7 @@ - + diff --git a/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.map b/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.map index b03537d8..6710614f 100644 --- a/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.map +++ b/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.map @@ -1,6 +1,6 @@ - + diff --git a/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.png b/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.png index 85b1fc72..03326a07 100644 Binary files a/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.png and b/docs/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.png differ diff --git a/docs/esp32__hal_8h_source.html b/docs/esp32__hal_8h_source.html index be5a844f..86bf82d6 100644 --- a/docs/esp32__hal_8h_source.html +++ b/docs/esp32__hal_8h_source.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
diff --git a/docs/files.html b/docs/files.html index 7d62fa06..cdcb15ea 100644 --- a/docs/files.html +++ b/docs/files.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -81,9 +81,15 @@  linux_hal.h  mingw32_hal.h  no_platform_hal.h - tiny_debug.h - tiny_list.h - tiny_types.hTiny protocol Types + win32_hal.h + ▼ serial + linux_serial.h + noplatform_serial.h + win32_serial.hUART serial API + tiny_debug.h + tiny_list.h + tiny_serial.hTiny UART serial API + tiny_types.hTiny protocol Types  ▼ half_duplex  tiny_hd.hTiny Protocol Half Duplex API  tiny_rq_pool.h @@ -96,6 +102,7 @@  TinyProtocol.hTiny protocol Arduino API  TinyProtocolFd.hTiny protocol Arduino API  TinyProtocolHd.hTiny protocol Arduino API + TinyProtocolHdlc.hTiny protocol Arduino API diff --git a/docs/functions.html b/docs/functions.html index a866a87b..f6d8cad0 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -66,26 +66,31 @@

- b -

Remarks
This function is not thread safe.
+ + + +

◆ tiny_fd_on_rx_data()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int tiny_fd_on_rx_data (tiny_fd_handle_t handle,
const void * data,
int len 
)
+
+ +

runs rx bytes processing for specified buffer.

+

Runs rx bytes processing for specified buffer. This is alternative method to run Full-duplex protocol for rx data. Use it, when you wish to control reading from hardware by yourself.

+
Parameters
+ + + + +
handlehandle of full-duplex protocol
datapointer to data to process
lenlength of data to process
+
+
+
Returns
TINY_SUCCESS
+
@@ -314,6 +412,7 @@

Returns
TINY_ERR_TIMEOUT, or TINY_SUCCESS

diff --git a/docs/group__HALF__DUPLEX__API.html b/docs/group__HALF__DUPLEX__API.html index 16884dec..ae6131c9 100644 --- a/docs/group__HALF__DUPLEX__API.html +++ b/docs/group__HALF__DUPLEX__API.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
diff --git a/docs/group__HDLC__API.html b/docs/group__HDLC__API.html index a812fc7e..667011e7 100644 --- a/docs/group__HDLC__API.html +++ b/docs/group__HDLC__API.html @@ -22,7 +22,7 @@
Tiny protocol -  0.9.3 +  0.11.0
Tiny communication protocol for microcontrollers
@@ -77,6 +77,8 @@ Classes

struct  _hdlc_handle_t   +class  Tiny::ProtoHdlc +  @@ -116,6 +118,8 @@ + +

Typedefs

 
int hdlc_run_tx (hdlc_handle_t handle)
 
int hdlc_get_tx_data (hdlc_handle_t handle, void *data, int len)
 
int hdlc_send (hdlc_handle_t handle, const void *data, int len, uint32_t timeout)
 
@@ -190,6 +194,50 @@

+

◆ hdlc_get_tx_data()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int hdlc_get_tx_data (hdlc_handle_t handle,
void * data,
int len 
)
+
+

If hdlc protocol has some data to send it will full data with This function returns either if no more data to send, or specified buffer is filled completely.

+
Parameters
+ + + + +
handlehandle to hdlc instance
datapointer to buffer to fill with data
lenlength of specified buffer
+
+
+
Returns
number of bytes written to specified buffer
+
@@ -282,6 +330,8 @@

Processes incoming data. Implementation of reading data from hw is user responsibility. If hdlc_run_rx() returns value less than size of data passed to the function, then hdlc_run_rx() must be called later second time with the pointer to and size of not processed bytes.

+

If you don't care about errors on RX line, it is allowed to ignore all error codes except TINY_ERR_FAILED, which means general failure.

+

if hdlc_run_rx() returns 0 bytes processed, just call it once again. It is guaranteed, that at least second call will process bytes.

This function will return the following codes in error field:

  • TINY_ERR_DATA_TOO_LARGE if receiving data fails to fit incoming buffer
  • TINY_ERR_FAILED if generic failure happened
    • diff --git a/docs/group__LIGHT__API.html b/docs/group__LIGHT__API.html index e42c83a5..91267a84 100644 --- a/docs/group__LIGHT__API.html +++ b/docs/group__LIGHT__API.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 948c0742..e50e3d3a 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    @@ -77,13 +77,14 @@  CTiny::ProtoFdD  Clist_element_Structure defines base type for the lists  CTiny::ProtoHd - CTiny::ProtoLight - CSTinyHdData_ - CSTinyHdInit_ - CSTinyLightData - CSTinyStats - Ctiny_fd_init_t_ - Ctiny_request_Defines type for tiny request list item + CTiny::ProtoHdlc + CTiny::ProtoLight + CSTinyHdData_ + CSTinyHdInit_ + CSTinyLightData + CSTinyStats + Ctiny_fd_init_t_ + Ctiny_request_Defines type for tiny request list item diff --git a/docs/index.html b/docs/index.html index 27cf21ca..3f4cfe8f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    diff --git a/docs/inherit_graph_0.map b/docs/inherit_graph_0.map index 0c0b2219..1ea998bb 100644 --- a/docs/inherit_graph_0.map +++ b/docs/inherit_graph_0.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_0.png b/docs/inherit_graph_0.png index 63a767a4..265d746e 100644 Binary files a/docs/inherit_graph_0.png and b/docs/inherit_graph_0.png differ diff --git a/docs/inherit_graph_1.map b/docs/inherit_graph_1.map index 97bf4c90..dd906d4c 100644 --- a/docs/inherit_graph_1.map +++ b/docs/inherit_graph_1.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_1.png b/docs/inherit_graph_1.png index 97d857dc..94b9f837 100644 Binary files a/docs/inherit_graph_1.png and b/docs/inherit_graph_1.png differ diff --git a/docs/inherit_graph_10.map b/docs/inherit_graph_10.map index 5cc2480a..f09c2755 100644 --- a/docs/inherit_graph_10.map +++ b/docs/inherit_graph_10.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_10.md5 b/docs/inherit_graph_10.md5 index 3ff5350f..52903eb9 100644 --- a/docs/inherit_graph_10.md5 +++ b/docs/inherit_graph_10.md5 @@ -1 +1 @@ -bcc3812d961a3bb2d1bf057c03730282 \ No newline at end of file +3e9ea64d0b991b2142dfe6717e58845e \ No newline at end of file diff --git a/docs/inherit_graph_10.png b/docs/inherit_graph_10.png index 6777bc67..db0e97cd 100644 Binary files a/docs/inherit_graph_10.png and b/docs/inherit_graph_10.png differ diff --git a/docs/inherit_graph_11.map b/docs/inherit_graph_11.map index 0e5456d5..709795be 100644 --- a/docs/inherit_graph_11.map +++ b/docs/inherit_graph_11.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_11.md5 b/docs/inherit_graph_11.md5 index db554168..3ff5350f 100644 --- a/docs/inherit_graph_11.md5 +++ b/docs/inherit_graph_11.md5 @@ -1 +1 @@ -1bb10ba87ddccdec84d6934cb9132e0a \ No newline at end of file +bcc3812d961a3bb2d1bf057c03730282 \ No newline at end of file diff --git a/docs/inherit_graph_11.png b/docs/inherit_graph_11.png index ad175f27..7eb776c0 100644 Binary files a/docs/inherit_graph_11.png and b/docs/inherit_graph_11.png differ diff --git a/docs/inherit_graph_12.map b/docs/inherit_graph_12.map new file mode 100644 index 00000000..751916c1 --- /dev/null +++ b/docs/inherit_graph_12.map @@ -0,0 +1,3 @@ + + + diff --git a/docs/inherit_graph_12.md5 b/docs/inherit_graph_12.md5 new file mode 100644 index 00000000..db554168 --- /dev/null +++ b/docs/inherit_graph_12.md5 @@ -0,0 +1 @@ +1bb10ba87ddccdec84d6934cb9132e0a \ No newline at end of file diff --git a/docs/inherit_graph_12.png b/docs/inherit_graph_12.png new file mode 100644 index 00000000..d98b8254 Binary files /dev/null and b/docs/inherit_graph_12.png differ diff --git a/docs/inherit_graph_2.map b/docs/inherit_graph_2.map index 6f7d8143..108c19ba 100644 --- a/docs/inherit_graph_2.map +++ b/docs/inherit_graph_2.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_2.png b/docs/inherit_graph_2.png index aaf7c6d2..709d77a8 100644 Binary files a/docs/inherit_graph_2.png and b/docs/inherit_graph_2.png differ diff --git a/docs/inherit_graph_3.map b/docs/inherit_graph_3.map index 9f4b213d..8c287495 100644 --- a/docs/inherit_graph_3.map +++ b/docs/inherit_graph_3.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_3.png b/docs/inherit_graph_3.png index b3e9e0ea..88d877e1 100644 Binary files a/docs/inherit_graph_3.png and b/docs/inherit_graph_3.png differ diff --git a/docs/inherit_graph_4.map b/docs/inherit_graph_4.map index 2795565e..0e331ffc 100644 --- a/docs/inherit_graph_4.map +++ b/docs/inherit_graph_4.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_4.png b/docs/inherit_graph_4.png index 03f32764..e5109399 100644 Binary files a/docs/inherit_graph_4.png and b/docs/inherit_graph_4.png differ diff --git a/docs/inherit_graph_5.map b/docs/inherit_graph_5.map index c501c49d..1cbc1569 100644 --- a/docs/inherit_graph_5.map +++ b/docs/inherit_graph_5.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_5.png b/docs/inherit_graph_5.png index 004dcd84..3b8f2f82 100644 Binary files a/docs/inherit_graph_5.png and b/docs/inherit_graph_5.png differ diff --git a/docs/inherit_graph_6.map b/docs/inherit_graph_6.map index 1b40e250..4273587d 100644 --- a/docs/inherit_graph_6.map +++ b/docs/inherit_graph_6.map @@ -1,5 +1,5 @@ - - - + + + diff --git a/docs/inherit_graph_6.png b/docs/inherit_graph_6.png index 34b95888..025d3f84 100644 Binary files a/docs/inherit_graph_6.png and b/docs/inherit_graph_6.png differ diff --git a/docs/inherit_graph_7.map b/docs/inherit_graph_7.map index 51fe2108..692e7d8a 100644 --- a/docs/inherit_graph_7.map +++ b/docs/inherit_graph_7.map @@ -1,5 +1,5 @@ - - - + + + diff --git a/docs/inherit_graph_7.png b/docs/inherit_graph_7.png index 4c5ce758..64b4773f 100644 Binary files a/docs/inherit_graph_7.png and b/docs/inherit_graph_7.png differ diff --git a/docs/inherit_graph_8.map b/docs/inherit_graph_8.map index 0e62d6cc..e577967f 100644 --- a/docs/inherit_graph_8.map +++ b/docs/inherit_graph_8.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_8.png b/docs/inherit_graph_8.png index 6d9a9c67..f4274b03 100644 Binary files a/docs/inherit_graph_8.png and b/docs/inherit_graph_8.png differ diff --git a/docs/inherit_graph_9.map b/docs/inherit_graph_9.map index dc844f14..205ee3b1 100644 --- a/docs/inherit_graph_9.map +++ b/docs/inherit_graph_9.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_9.md5 b/docs/inherit_graph_9.md5 index 52903eb9..f2dbf0c2 100644 --- a/docs/inherit_graph_9.md5 +++ b/docs/inherit_graph_9.md5 @@ -1 +1 @@ -3e9ea64d0b991b2142dfe6717e58845e \ No newline at end of file +85af9e94eebd902a7fa4666c785a4f05 \ No newline at end of file diff --git a/docs/inherit_graph_9.png b/docs/inherit_graph_9.png index ce3138c4..915d91e1 100644 Binary files a/docs/inherit_graph_9.png and b/docs/inherit_graph_9.png differ diff --git a/docs/inherits.html b/docs/inherits.html index 80e43869..e7052d35 100644 --- a/docs/inherits.html +++ b/docs/inherits.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    @@ -69,66 +69,71 @@ - + - -
    - +
    - +
    - +
    - +
    - +
    - +
    - - - + + +
    - - - + + +
    - +
    +
    + + + +
    - +
    +
    - +
    +
    - +
    diff --git a/docs/latex/TinyLightProtocol_8h.tex b/docs/latex/TinyLightProtocol_8h.tex index 70cb54c1..fe1f9f72 100644 --- a/docs/latex/TinyLightProtocol_8h.tex +++ b/docs/latex/TinyLightProtocol_8h.tex @@ -8,18 +8,20 @@ {\ttfamily \#include \char`\"{}Tiny\+Packet.\+h\char`\"{}}\newline {\ttfamily \#include \char`\"{}proto/light/tiny\+\_\+light.\+h\char`\"{}}\newline {\ttfamily \#include $<$Hardware\+Serial.\+h$>$}\newline -Include dependency graph for Tiny\+Light\+Protocol.\+h\+:\nopagebreak +Include dependency graph for Tiny\+Light\+Protocol.\+h\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode \includegraphics[width=350pt]{TinyLightProtocol_8h__incl} \end{center} \end{figure} -This graph shows which files directly or indirectly include this file\+:\nopagebreak +This graph shows which files directly or indirectly include this file\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=197pt]{TinyLightProtocol_8h__dep__incl} +\includegraphics[width=208pt]{TinyLightProtocol_8h__dep__incl} \end{center} \end{figure} \subsection*{Classes} diff --git a/docs/latex/TinyLightProtocol_8h__dep__incl.pdf b/docs/latex/TinyLightProtocol_8h__dep__incl.pdf index fcb5fbb2..f22a9d17 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 c74a9819..03e61883 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.tex b/docs/latex/TinyPacket_8h.tex index 2334770e..075d4202 100644 --- a/docs/latex/TinyPacket_8h.tex +++ b/docs/latex/TinyPacket_8h.tex @@ -7,14 +7,16 @@ {\ttfamily \#include $<$Hardware\+Serial.\+h$>$}\newline {\ttfamily \#include $<$stdio.\+h$>$}\newline -Include dependency graph for Tiny\+Packet.\+h\+:\nopagebreak +Include dependency graph for Tiny\+Packet.\+h\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=236pt]{TinyPacket_8h__incl} +\includegraphics[width=250pt]{TinyPacket_8h__incl} \end{center} \end{figure} -This graph shows which files directly or indirectly include this file\+:\nopagebreak +This graph shows which files directly or indirectly include this file\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode diff --git a/docs/latex/TinyPacket_8h__dep__incl.md5 b/docs/latex/TinyPacket_8h__dep__incl.md5 index 2086b876..8c575296 100644 --- a/docs/latex/TinyPacket_8h__dep__incl.md5 +++ b/docs/latex/TinyPacket_8h__dep__incl.md5 @@ -1 +1 @@ -dfd8be910fa5bb1507c6e8bd09a97bdc \ No newline at end of file +49acd28a39f43bfedea4e60c3a1771a0 \ No newline at end of file diff --git a/docs/latex/TinyPacket_8h__dep__incl.pdf b/docs/latex/TinyPacket_8h__dep__incl.pdf index 9a06f5ba..dd671232 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 92ab69c3..89279ae7 100644 Binary files a/docs/latex/TinyPacket_8h__incl.pdf and b/docs/latex/TinyPacket_8h__incl.pdf differ diff --git a/docs/latex/TinyProtocolFd_8h.tex b/docs/latex/TinyProtocolFd_8h.tex index 192d3501..a4e07119 100644 --- a/docs/latex/TinyProtocolFd_8h.tex +++ b/docs/latex/TinyProtocolFd_8h.tex @@ -8,18 +8,20 @@ {\ttfamily \#include \char`\"{}Tiny\+Packet.\+h\char`\"{}}\newline {\ttfamily \#include \char`\"{}proto/fd/tiny\+\_\+fd.\+h\char`\"{}}\newline {\ttfamily \#include $<$Hardware\+Serial.\+h$>$}\newline -Include dependency graph for Tiny\+Protocol\+Fd.\+h\+:\nopagebreak +Include dependency graph for Tiny\+Protocol\+Fd.\+h\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode \includegraphics[width=350pt]{TinyProtocolFd_8h__incl} \end{center} \end{figure} -This graph shows which files directly or indirectly include this file\+:\nopagebreak +This graph shows which files directly or indirectly include this file\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=187pt]{TinyProtocolFd_8h__dep__incl} +\includegraphics[width=195pt]{TinyProtocolFd_8h__dep__incl} \end{center} \end{figure} \subsection*{Classes} diff --git a/docs/latex/TinyProtocolFd_8h__dep__incl.pdf b/docs/latex/TinyProtocolFd_8h__dep__incl.pdf index 616cbc18..c52b7b0c 100644 Binary files a/docs/latex/TinyProtocolFd_8h__dep__incl.pdf and b/docs/latex/TinyProtocolFd_8h__dep__incl.pdf differ diff --git a/docs/latex/TinyProtocolFd_8h__incl.pdf b/docs/latex/TinyProtocolFd_8h__incl.pdf index 6b5de601..0875a8d0 100644 Binary files a/docs/latex/TinyProtocolFd_8h__incl.pdf and b/docs/latex/TinyProtocolFd_8h__incl.pdf differ diff --git a/docs/latex/TinyProtocolHd_8h.tex b/docs/latex/TinyProtocolHd_8h.tex index 7a8ff0bf..1b307625 100644 --- a/docs/latex/TinyProtocolHd_8h.tex +++ b/docs/latex/TinyProtocolHd_8h.tex @@ -8,18 +8,20 @@ {\ttfamily \#include \char`\"{}Tiny\+Packet.\+h\char`\"{}}\newline {\ttfamily \#include \char`\"{}proto/half\+\_\+duplex/tiny\+\_\+hd.\+h\char`\"{}}\newline {\ttfamily \#include $<$Hardware\+Serial.\+h$>$}\newline -Include dependency graph for Tiny\+Protocol\+Hd.\+h\+:\nopagebreak +Include dependency graph for Tiny\+Protocol\+Hd.\+h\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode \includegraphics[width=350pt]{TinyProtocolHd_8h__incl} \end{center} \end{figure} -This graph shows which files directly or indirectly include this file\+:\nopagebreak +This graph shows which files directly or indirectly include this file\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=189pt]{TinyProtocolHd_8h__dep__incl} +\includegraphics[width=197pt]{TinyProtocolHd_8h__dep__incl} \end{center} \end{figure} \subsection*{Classes} diff --git a/docs/latex/TinyProtocolHd_8h__dep__incl.pdf b/docs/latex/TinyProtocolHd_8h__dep__incl.pdf index 73b09aa2..98ec344a 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 871c2e2a..e079e26c 100644 Binary files a/docs/latex/TinyProtocolHd_8h__incl.pdf and b/docs/latex/TinyProtocolHd_8h__incl.pdf differ diff --git a/docs/latex/TinyProtocolHdlc_8h.tex b/docs/latex/TinyProtocolHdlc_8h.tex new file mode 100644 index 00000000..709216e2 --- /dev/null +++ b/docs/latex/TinyProtocolHdlc_8h.tex @@ -0,0 +1,37 @@ +\hypertarget{TinyProtocolHdlc_8h}{}\section{src/\+Tiny\+Protocol\+Hdlc.h File Reference} +\label{TinyProtocolHdlc_8h}\index{src/\+Tiny\+Protocol\+Hdlc.\+h@{src/\+Tiny\+Protocol\+Hdlc.\+h}} + + +Tiny protocol Arduino A\+PI. + + +{\ttfamily \#include \char`\"{}Tiny\+Packet.\+h\char`\"{}}\newline +{\ttfamily \#include \char`\"{}proto/hdlc/tiny\+\_\+hdlc.\+h\char`\"{}}\newline +{\ttfamily \#include $<$Hardware\+Serial.\+h$>$}\newline +Include dependency graph for Tiny\+Protocol\+Hdlc.\+h\+: +\nopagebreak +\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[width=350pt]{TinyProtocolHdlc_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=205pt]{TinyProtocolHdlc_8h__dep__incl} +\end{center} +\end{figure} +\subsection*{Classes} +\begin{DoxyCompactItemize} +\item +class \hyperlink{classTiny_1_1ProtoHdlc}{Tiny\+::\+Proto\+Hdlc} +\end{DoxyCompactItemize} + + +\subsection{Detailed Description} +Tiny protocol Arduino A\+PI. + +This is Tiny protocol implementation for microcontrollers \ No newline at end of file diff --git a/docs/latex/TinyProtocolHdlc_8h__dep__incl.md5 b/docs/latex/TinyProtocolHdlc_8h__dep__incl.md5 new file mode 100644 index 00000000..835384ff --- /dev/null +++ b/docs/latex/TinyProtocolHdlc_8h__dep__incl.md5 @@ -0,0 +1 @@ +33bed6b8f3aae9b046f10096831d2a04 \ No newline at end of file diff --git a/docs/latex/TinyProtocolHdlc_8h__dep__incl.pdf b/docs/latex/TinyProtocolHdlc_8h__dep__incl.pdf new file mode 100644 index 00000000..f1446d63 Binary files /dev/null and b/docs/latex/TinyProtocolHdlc_8h__dep__incl.pdf differ diff --git a/docs/latex/TinyProtocolHdlc_8h__incl.md5 b/docs/latex/TinyProtocolHdlc_8h__incl.md5 new file mode 100644 index 00000000..d15f2e4d --- /dev/null +++ b/docs/latex/TinyProtocolHdlc_8h__incl.md5 @@ -0,0 +1 @@ +3851b0bbde7b5830b6f1243537ba7a81 \ No newline at end of file diff --git a/docs/latex/TinyProtocolHdlc_8h__incl.pdf b/docs/latex/TinyProtocolHdlc_8h__incl.pdf new file mode 100644 index 00000000..5e846d10 Binary files /dev/null and b/docs/latex/TinyProtocolHdlc_8h__incl.pdf differ diff --git a/docs/latex/TinyProtocol_8h.tex b/docs/latex/TinyProtocol_8h.tex index 50fd1fe6..b530c37a 100644 --- a/docs/latex/TinyProtocol_8h.tex +++ b/docs/latex/TinyProtocol_8h.tex @@ -7,9 +7,11 @@ {\ttfamily \#include \char`\"{}Tiny\+Packet.\+h\char`\"{}}\newline {\ttfamily \#include \char`\"{}Tiny\+Light\+Protocol.\+h\char`\"{}}\newline +{\ttfamily \#include \char`\"{}Tiny\+Protocol\+Hdlc.\+h\char`\"{}}\newline {\ttfamily \#include \char`\"{}Tiny\+Protocol\+Hd.\+h\char`\"{}}\newline {\ttfamily \#include \char`\"{}Tiny\+Protocol\+Fd.\+h\char`\"{}}\newline -Include dependency graph for Tiny\+Protocol.\+h\+:\nopagebreak +Include dependency graph for Tiny\+Protocol.\+h\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode diff --git a/docs/latex/TinyProtocol_8h__incl.md5 b/docs/latex/TinyProtocol_8h__incl.md5 index 77ec1cd1..f6f52870 100644 --- a/docs/latex/TinyProtocol_8h__incl.md5 +++ b/docs/latex/TinyProtocol_8h__incl.md5 @@ -1 +1 @@ -6abbdfc844d2075d64b475b4f061720b \ No newline at end of file +de1d4d1c1df6fbff9a1a283991dca115 \ No newline at end of file diff --git a/docs/latex/TinyProtocol_8h__incl.pdf b/docs/latex/TinyProtocol_8h__incl.pdf index 682021c7..1677a3a4 100644 Binary files a/docs/latex/TinyProtocol_8h__incl.pdf and b/docs/latex/TinyProtocol_8h__incl.pdf differ diff --git a/docs/latex/annotated.tex b/docs/latex/annotated.tex index 967a2f8b..0396b1f5 100644 --- a/docs/latex/annotated.tex +++ b/docs/latex/annotated.tex @@ -9,6 +9,7 @@ \section{Class List} \item\contentsline{section}{\hyperlink{classTiny_1_1ProtoFd}{Tiny\+::\+Proto\+Fd$<$ S $>$} }{\pageref{classTiny_1_1ProtoFd}}{} \item\contentsline{section}{\hyperlink{classTiny_1_1ProtoFdD}{Tiny\+::\+Proto\+FdD} }{\pageref{classTiny_1_1ProtoFdD}}{} \item\contentsline{section}{\hyperlink{classTiny_1_1ProtoHd}{Tiny\+::\+Proto\+Hd} }{\pageref{classTiny_1_1ProtoHd}}{} +\item\contentsline{section}{\hyperlink{classTiny_1_1ProtoHdlc}{Tiny\+::\+Proto\+Hdlc} }{\pageref{classTiny_1_1ProtoHdlc}}{} \item\contentsline{section}{\hyperlink{classTiny_1_1ProtoLight}{Tiny\+::\+Proto\+Light} }{\pageref{classTiny_1_1ProtoLight}}{} \item\contentsline{section}{\hyperlink{structSTinyHdData__}{S\+Tiny\+Hd\+Data\+\_\+} }{\pageref{structSTinyHdData__}}{} \item\contentsline{section}{\hyperlink{structSTinyHdInit__}{S\+Tiny\+Hd\+Init\+\_\+} }{\pageref{structSTinyHdInit__}}{} diff --git a/docs/latex/classTiny_1_1IPacket.tex b/docs/latex/classTiny_1_1IPacket.tex index e2bf233a..66c1fb5f 100644 --- a/docs/latex/classTiny_1_1IPacket.tex +++ b/docs/latex/classTiny_1_1IPacket.tex @@ -6,11 +6,12 @@ -Inheritance diagram for Tiny\+:\+:I\+Packet\+:\nopagebreak +Inheritance diagram for Tiny\+:\+:I\+Packet\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=276pt]{classTiny_1_1IPacket__inherit__graph} +\includegraphics[width=286pt]{classTiny_1_1IPacket__inherit__graph} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -59,6 +60,9 @@ \subsection*{Public Member Functions} \subsection*{Friends} \begin{DoxyCompactItemize} \item +\mbox{\Hypertarget{classTiny_1_1IPacket_aa98e64c7cbec336d31f68722ad385bb9}\label{classTiny_1_1IPacket_aa98e64c7cbec336d31f68722ad385bb9}} +class {\bfseries Proto\+Hdlc} +\item \mbox{\Hypertarget{classTiny_1_1IPacket_a7f90e063a34c3417ed1ea25e64608857}\label{classTiny_1_1IPacket_a7f90e063a34c3417ed1ea25e64608857}} class {\bfseries Proto\+Hd} \item diff --git a/docs/latex/classTiny_1_1IPacket__inherit__graph.pdf b/docs/latex/classTiny_1_1IPacket__inherit__graph.pdf index 83fa346b..cb14cedc 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_1IProtoFd.tex b/docs/latex/classTiny_1_1IProtoFd.tex index 38e3deaf..c43a6468 100644 --- a/docs/latex/classTiny_1_1IProtoFd.tex +++ b/docs/latex/classTiny_1_1IProtoFd.tex @@ -6,11 +6,12 @@ -Inheritance diagram for Tiny\+:\+:I\+Proto\+Fd\+:\nopagebreak +Inheritance diagram for Tiny\+:\+:I\+Proto\+Fd\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=282pt]{classTiny_1_1IProtoFd__inherit__graph} +\includegraphics[width=294pt]{classTiny_1_1IProtoFd__inherit__graph} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -20,6 +21,8 @@ \subsection*{Public Member Functions} \item void \hyperlink{classTiny_1_1IProtoFd_aae4e613316866105c130d613ecb25dd4}{begin} (\hyperlink{tiny__types_8h_aafd634660bba76cace57a8f9b01e044d}{write\+\_\+block\+\_\+cb\+\_\+t} writecb, \hyperlink{tiny__types_8h_a15bec127d9ee63658563d62e92b5261b}{read\+\_\+block\+\_\+cb\+\_\+t} readcb) \item +void \hyperlink{classTiny_1_1IProtoFd_a33f836591bf981b484d495d678d02442}{begin} () +\item void \hyperlink{classTiny_1_1IProtoFd_a1cf42b4182e49dcde4862a768d07c811}{begin\+To\+Serial} () \item void \hyperlink{classTiny_1_1IProtoFd_a7d41a0caae1d5e6808a441c821ed8927}{begin\+To\+Serial1} () @@ -36,8 +39,12 @@ \subsection*{Public Member Functions} \item int \hyperlink{classTiny_1_1IProtoFd_a37292eb5c9faf1be8c4850985e0ae2eb}{run\+\_\+rx} (uint16\+\_\+t timeout=0) \item +int \hyperlink{classTiny_1_1IProtoFd_ab297fec86ef473612a745865403b4dd0}{run\+\_\+rx} (const void $\ast$data, int len) +\item int \hyperlink{classTiny_1_1IProtoFd_a19be0bd5124009c7de051554841070b3}{run\+\_\+tx} (uint16\+\_\+t timeout=0) \item +int \hyperlink{classTiny_1_1IProtoFd_a5510f1f28ff72c709305826c96473ffb}{run\+\_\+tx} (void $\ast$data, int max\+\_\+size) +\item void \hyperlink{classTiny_1_1IProtoFd_af41446f47a7c520ff8f9683e6ae45614}{disable\+Crc} () \item void \hyperlink{classTiny_1_1IProtoFd_a7dec2906051505034e91b503318a5563}{enable\+Crc} (\hyperlink{group__HDLC__API_gabb73b32d08d8e79eefe9385634a74bf7}{hdlc\+\_\+crc\+\_\+t} crc) @@ -94,7 +101,7 @@ \subsection{Member Function Documentation} \mbox{\Hypertarget{classTiny_1_1IProtoFd_aae4e613316866105c130d613ecb25dd4}\label{classTiny_1_1IProtoFd_aae4e613316866105c130d613ecb25dd4}} \index{Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}!begin@{begin}} \index{begin@{begin}!Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}} -\subsubsection{\texorpdfstring{begin()}{begin()}} +\subsubsection{\texorpdfstring{begin()}{begin()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily void Tiny\+::\+I\+Proto\+Fd\+::begin (\begin{DoxyParamCaption}\item[{\hyperlink{tiny__types_8h_aafd634660bba76cace57a8f9b01e044d}{write\+\_\+block\+\_\+cb\+\_\+t}}]{writecb, }\item[{\hyperlink{tiny__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_1IProtoFd_ad17e76d0ef7ea40838e51acc2498c482}{end()}. @@ -107,6 +114,15 @@ \subsubsection{\texorpdfstring{begin()}{begin()}} \begin{DoxyReturn}{Returns} None \end{DoxyReturn} +\mbox{\Hypertarget{classTiny_1_1IProtoFd_a33f836591bf981b484d495d678d02442}\label{classTiny_1_1IProtoFd_a33f836591bf981b484d495d678d02442}} +\index{Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}!begin@{begin}} +\index{begin@{begin}!Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}} +\subsubsection{\texorpdfstring{begin()}{begin()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} +{\footnotesize\ttfamily void Tiny\+::\+I\+Proto\+Fd\+::begin (\begin{DoxyParamCaption}{ }\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_1IProtoFd_ad17e76d0ef7ea40838e51acc2498c482}{end()}. Use this method if you want to control write and read data by yourself \begin{DoxyReturn}{Returns} +None +\end{DoxyReturn} \mbox{\Hypertarget{classTiny_1_1IProtoFd_a1cf42b4182e49dcde4862a768d07c811}\label{classTiny_1_1IProtoFd_a1cf42b4182e49dcde4862a768d07c811}} \index{Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}!begin\+To\+Serial@{begin\+To\+Serial}} \index{begin\+To\+Serial@{begin\+To\+Serial}!Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}} @@ -222,7 +238,7 @@ \subsubsection{\texorpdfstring{on\+Send()}{onSend()}} \mbox{\Hypertarget{classTiny_1_1IProtoFd_a37292eb5c9faf1be8c4850985e0ae2eb}\label{classTiny_1_1IProtoFd_a37292eb5c9faf1be8c4850985e0ae2eb}} \index{Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}!run\+\_\+rx@{run\+\_\+rx}} \index{run\+\_\+rx@{run\+\_\+rx}!Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}} -\subsubsection{\texorpdfstring{run\+\_\+rx()}{run\_rx()}} +\subsubsection{\texorpdfstring{run\+\_\+rx()}{run\_rx()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily int Tiny\+::\+I\+Proto\+Fd\+::run\+\_\+rx (\begin{DoxyParamCaption}\item[{uint16\+\_\+t}]{timeout = {\ttfamily 0} }\end{DoxyParamCaption})} Checks communcation channel for incoming messages. \begin{DoxyReturn}{Returns} @@ -231,15 +247,43 @@ \subsubsection{\texorpdfstring{run\+\_\+rx()}{run\_rx()}} \begin{DoxyRemark}{Remarks} if \hyperlink{classTiny_1_1Packet}{Packet} is receive during run execution callback is called. \end{DoxyRemark} +\mbox{\Hypertarget{classTiny_1_1IProtoFd_ab297fec86ef473612a745865403b4dd0}\label{classTiny_1_1IProtoFd_ab297fec86ef473612a745865403b4dd0}} +\index{Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}!run\+\_\+rx@{run\+\_\+rx}} +\index{run\+\_\+rx@{run\+\_\+rx}!Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}} +\subsubsection{\texorpdfstring{run\+\_\+rx()}{run\_rx()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} +{\footnotesize\ttfamily int Tiny\+::\+I\+Proto\+Fd\+::run\+\_\+rx (\begin{DoxyParamCaption}\item[{const void $\ast$}]{data, }\item[{int}]{len }\end{DoxyParamCaption})} + +Processes incoming rx data, specified by a user. \begin{DoxyReturn}{Returns} +T\+I\+N\+Y\+\_\+\+S\+U\+C\+C\+E\+SS +\end{DoxyReturn} +\begin{DoxyRemark}{Remarks} +if \hyperlink{classTiny_1_1Packet}{Packet} is receive during run execution callback is called. +\end{DoxyRemark} \mbox{\Hypertarget{classTiny_1_1IProtoFd_a19be0bd5124009c7de051554841070b3}\label{classTiny_1_1IProtoFd_a19be0bd5124009c7de051554841070b3}} \index{Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}!run\+\_\+tx@{run\+\_\+tx}} \index{run\+\_\+tx@{run\+\_\+tx}!Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}} -\subsubsection{\texorpdfstring{run\+\_\+tx()}{run\_tx()}} +\subsubsection{\texorpdfstring{run\+\_\+tx()}{run\_tx()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily int Tiny\+::\+I\+Proto\+Fd\+::run\+\_\+tx (\begin{DoxyParamCaption}\item[{uint16\+\_\+t}]{timeout = {\ttfamily 0} }\end{DoxyParamCaption})} Sends data to communcation channel. \begin{DoxyReturn}{Returns} negative value in case of error \end{DoxyReturn} +\mbox{\Hypertarget{classTiny_1_1IProtoFd_a5510f1f28ff72c709305826c96473ffb}\label{classTiny_1_1IProtoFd_a5510f1f28ff72c709305826c96473ffb}} +\index{Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}!run\+\_\+tx@{run\+\_\+tx}} +\index{run\+\_\+tx@{run\+\_\+tx}!Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}} +\subsubsection{\texorpdfstring{run\+\_\+tx()}{run\_tx()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} +{\footnotesize\ttfamily int Tiny\+::\+I\+Proto\+Fd\+::run\+\_\+tx (\begin{DoxyParamCaption}\item[{void $\ast$}]{data, }\item[{int}]{max\+\_\+size }\end{DoxyParamCaption})} + +Force protocol to generate tx data for you. In this case you will need to send data to remote side by yourself. +\begin{DoxyParams}{Parameters} +{\em data} & buffer to fill with tx data \\ +\hline +{\em max\+\_\+size} & maximum size of the buffer \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +number of bytes written to buffer +\end{DoxyReturn} \mbox{\Hypertarget{classTiny_1_1IProtoFd_a70aa7c85b5fe83513eebb63b803d5825}\label{classTiny_1_1IProtoFd_a70aa7c85b5fe83513eebb63b803d5825}} \index{Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}!set\+Receive\+Callback@{set\+Receive\+Callback}} \index{set\+Receive\+Callback@{set\+Receive\+Callback}!Tiny\+::\+I\+Proto\+Fd@{Tiny\+::\+I\+Proto\+Fd}} @@ -279,7 +323,7 @@ \subsubsection{\texorpdfstring{set\+Send\+Timeout()}{setSendTimeout()}} \subsubsection{\texorpdfstring{set\+Window\+Size()}{setWindowSize()}} {\footnotesize\ttfamily void Tiny\+::\+I\+Proto\+Fd\+::set\+Window\+Size (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{window }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}} -Sets desired window size. Use this function only before \hyperlink{classTiny_1_1IProtoFd_aae4e613316866105c130d613ecb25dd4}{begin()} call. window size is number of frames, which confirmation may be deferred for. +Sets desired window size. Use this function only before \hyperlink{classTiny_1_1IProtoFd_a33f836591bf981b484d495d678d02442}{begin()} call. window size is number of frames, which confirmation may be deferred for. \begin{DoxyParams}{Parameters} {\em window} & window size, valid between 1 -\/ 7 inclusively \\ \hline diff --git a/docs/latex/classTiny_1_1IProtoFd__inherit__graph.pdf b/docs/latex/classTiny_1_1IProtoFd__inherit__graph.pdf index 92f8272c..d3616146 100644 Binary files a/docs/latex/classTiny_1_1IProtoFd__inherit__graph.pdf and b/docs/latex/classTiny_1_1IProtoFd__inherit__graph.pdf differ diff --git a/docs/latex/classTiny_1_1Packet.tex b/docs/latex/classTiny_1_1Packet.tex index e3038cf5..5512cb44 100644 --- a/docs/latex/classTiny_1_1Packet.tex +++ b/docs/latex/classTiny_1_1Packet.tex @@ -6,20 +6,22 @@ -Inheritance diagram for Tiny\+:\+:Packet$<$ S $>$\+:\nopagebreak +Inheritance diagram for Tiny\+:\+:Packet$<$ S $>$\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=177pt]{classTiny_1_1Packet__inherit__graph} +\includegraphics[width=184pt]{classTiny_1_1Packet__inherit__graph} \end{center} \end{figure} -Collaboration diagram for Tiny\+:\+:Packet$<$ S $>$\+:\nopagebreak +Collaboration diagram for Tiny\+:\+:Packet$<$ S $>$\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=177pt]{classTiny_1_1Packet__coll__graph} +\includegraphics[width=184pt]{classTiny_1_1Packet__coll__graph} \end{center} \end{figure} \subsection*{Public Member Functions} diff --git a/docs/latex/classTiny_1_1PacketD.tex b/docs/latex/classTiny_1_1PacketD.tex index 2e2e32bc..f0424b79 100644 --- a/docs/latex/classTiny_1_1PacketD.tex +++ b/docs/latex/classTiny_1_1PacketD.tex @@ -6,20 +6,22 @@ -Inheritance diagram for Tiny\+:\+:PacketD\+:\nopagebreak +Inheritance diagram for Tiny\+:\+:PacketD\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=160pt]{classTiny_1_1PacketD__inherit__graph} +\includegraphics[width=163pt]{classTiny_1_1PacketD__inherit__graph} \end{center} \end{figure} -Collaboration diagram for Tiny\+:\+:PacketD\+:\nopagebreak +Collaboration diagram for Tiny\+:\+:PacketD\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=160pt]{classTiny_1_1PacketD__coll__graph} +\includegraphics[width=163pt]{classTiny_1_1PacketD__coll__graph} \end{center} \end{figure} \subsection*{Public Member Functions} diff --git a/docs/latex/classTiny_1_1PacketD__coll__graph.pdf b/docs/latex/classTiny_1_1PacketD__coll__graph.pdf index b643683c..c80b1393 100644 Binary files a/docs/latex/classTiny_1_1PacketD__coll__graph.pdf and b/docs/latex/classTiny_1_1PacketD__coll__graph.pdf differ diff --git a/docs/latex/classTiny_1_1PacketD__inherit__graph.pdf b/docs/latex/classTiny_1_1PacketD__inherit__graph.pdf index b643683c..c80b1393 100644 Binary files a/docs/latex/classTiny_1_1PacketD__inherit__graph.pdf and b/docs/latex/classTiny_1_1PacketD__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 3910e11b..ca0c6b70 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 3910e11b..821fae4c 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_1ProtoFd.tex b/docs/latex/classTiny_1_1ProtoFd.tex index 66208424..1c6aff8c 100644 --- a/docs/latex/classTiny_1_1ProtoFd.tex +++ b/docs/latex/classTiny_1_1ProtoFd.tex @@ -6,20 +6,22 @@ -Inheritance diagram for Tiny\+:\+:Proto\+Fd$<$ S $>$\+:\nopagebreak +Inheritance diagram for Tiny\+:\+:Proto\+Fd$<$ S $>$\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=181pt]{classTiny_1_1ProtoFd__inherit__graph} +\includegraphics[width=188pt]{classTiny_1_1ProtoFd__inherit__graph} \end{center} \end{figure} -Collaboration diagram for Tiny\+:\+:Proto\+Fd$<$ S $>$\+:\nopagebreak +Collaboration diagram for Tiny\+:\+:Proto\+Fd$<$ S $>$\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=181pt]{classTiny_1_1ProtoFd__coll__graph} +\includegraphics[width=188pt]{classTiny_1_1ProtoFd__coll__graph} \end{center} \end{figure} \subsection*{Additional Inherited Members} diff --git a/docs/latex/classTiny_1_1ProtoFdD.tex b/docs/latex/classTiny_1_1ProtoFdD.tex index 35c1b07e..27f8377d 100644 --- a/docs/latex/classTiny_1_1ProtoFdD.tex +++ b/docs/latex/classTiny_1_1ProtoFdD.tex @@ -6,20 +6,22 @@ -Inheritance diagram for Tiny\+:\+:Proto\+FdD\+:\nopagebreak +Inheritance diagram for Tiny\+:\+:Proto\+FdD\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=163pt]{classTiny_1_1ProtoFdD__inherit__graph} +\includegraphics[width=167pt]{classTiny_1_1ProtoFdD__inherit__graph} \end{center} \end{figure} -Collaboration diagram for Tiny\+:\+:Proto\+FdD\+:\nopagebreak +Collaboration diagram for Tiny\+:\+:Proto\+FdD\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=163pt]{classTiny_1_1ProtoFdD__coll__graph} +\includegraphics[width=167pt]{classTiny_1_1ProtoFdD__coll__graph} \end{center} \end{figure} \subsection*{Public Member Functions} diff --git a/docs/latex/classTiny_1_1ProtoFdD__coll__graph.pdf b/docs/latex/classTiny_1_1ProtoFdD__coll__graph.pdf index ceb77a76..bd42e3ef 100644 Binary files a/docs/latex/classTiny_1_1ProtoFdD__coll__graph.pdf and b/docs/latex/classTiny_1_1ProtoFdD__coll__graph.pdf differ diff --git a/docs/latex/classTiny_1_1ProtoFdD__inherit__graph.pdf b/docs/latex/classTiny_1_1ProtoFdD__inherit__graph.pdf index ceb77a76..bd42e3ef 100644 Binary files a/docs/latex/classTiny_1_1ProtoFdD__inherit__graph.pdf and b/docs/latex/classTiny_1_1ProtoFdD__inherit__graph.pdf differ diff --git a/docs/latex/classTiny_1_1ProtoFd__coll__graph.pdf b/docs/latex/classTiny_1_1ProtoFd__coll__graph.pdf index 0ee2922f..951a3e15 100644 Binary files a/docs/latex/classTiny_1_1ProtoFd__coll__graph.pdf and b/docs/latex/classTiny_1_1ProtoFd__coll__graph.pdf differ diff --git a/docs/latex/classTiny_1_1ProtoFd__inherit__graph.pdf b/docs/latex/classTiny_1_1ProtoFd__inherit__graph.pdf index 88b95c21..951a3e15 100644 Binary files a/docs/latex/classTiny_1_1ProtoFd__inherit__graph.pdf and b/docs/latex/classTiny_1_1ProtoFd__inherit__graph.pdf differ diff --git a/docs/latex/classTiny_1_1ProtoHdlc.tex b/docs/latex/classTiny_1_1ProtoHdlc.tex new file mode 100644 index 00000000..7e065add --- /dev/null +++ b/docs/latex/classTiny_1_1ProtoHdlc.tex @@ -0,0 +1,301 @@ +\hypertarget{classTiny_1_1ProtoHdlc}{}\section{Tiny\+:\+:Proto\+Hdlc Class Reference} +\label{classTiny_1_1ProtoHdlc}\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} + + +{\ttfamily \#include $<$Tiny\+Protocol\+Hdlc.\+h$>$} + +\subsection*{Public Member Functions} +\begin{DoxyCompactItemize} +\item +\hyperlink{classTiny_1_1ProtoHdlc_a82160439269af053f034d69a1b350cbc}{Proto\+Hdlc} (void $\ast$buffer, int buffer\+Size) +\item +void \hyperlink{classTiny_1_1ProtoHdlc_acdc849f66b9f9a51d8930552ade56324}{begin} (\hyperlink{tiny__types_8h_aafd634660bba76cace57a8f9b01e044d}{write\+\_\+block\+\_\+cb\+\_\+t} writecb, \hyperlink{tiny__types_8h_a15bec127d9ee63658563d62e92b5261b}{read\+\_\+block\+\_\+cb\+\_\+t} readcb) +\item +void \hyperlink{classTiny_1_1ProtoHdlc_aaaca3c70444d6a5f20e7e1fef492e99b}{begin} () +\item +void \hyperlink{classTiny_1_1ProtoHdlc_a8a54409e420954d93ada44ad0710740e}{begin\+To\+Serial} () +\item +void \hyperlink{classTiny_1_1ProtoHdlc_aadaf2dbaad53bba682d37e0650585491}{begin\+To\+Serial1} () +\item +void \hyperlink{classTiny_1_1ProtoHdlc_aed9903c8e65495e0260b4095113ee641}{begin\+To\+Serial2} () +\item +void \hyperlink{classTiny_1_1ProtoHdlc_a1c895863c008b9dbd4316ae10c6e4ea0}{begin\+To\+Serial3} () +\item +void \hyperlink{classTiny_1_1ProtoHdlc_ad4b84cbcd33d65e7df73321a0c19c420}{end} () +\item +int \hyperlink{classTiny_1_1ProtoHdlc_ae79c01f1c3614f0f382e8d8bf847b567}{write} (char $\ast$buf, int size) +\item +int \hyperlink{classTiny_1_1ProtoHdlc_a3d02f2589397fb4a0e5be24a44321f9b}{write} (\hyperlink{classTiny_1_1IPacket}{I\+Packet} \&pkt) +\item +int \hyperlink{classTiny_1_1ProtoHdlc_ae54e74de1a47d386f079c840fd830fe0}{run\+\_\+rx} (const void $\ast$data, int len) +\item +int \hyperlink{classTiny_1_1ProtoHdlc_a73415a63c389b3cbd0601a2ed49fd6e9}{run\+\_\+tx} (void $\ast$data, int max\+\_\+len) +\item +void \hyperlink{classTiny_1_1ProtoHdlc_a37506cfddcc0e1ed9a2ed697f4860b98}{disable\+Crc} () +\item +void \hyperlink{classTiny_1_1ProtoHdlc_a84e93210f940385a9408419ed605c8e5}{enable\+Crc} (\hyperlink{group__HDLC__API_gabb73b32d08d8e79eefe9385634a74bf7}{hdlc\+\_\+crc\+\_\+t} crc) +\item +bool \hyperlink{classTiny_1_1ProtoHdlc_a3c9ed356b3d6dd4496b1655a0704e890}{enable\+Check\+Sum} () +\item +bool \hyperlink{classTiny_1_1ProtoHdlc_a693fb4301071e0b2d3bfd818265f22c6}{enable\+Crc16} () +\item +bool \hyperlink{classTiny_1_1ProtoHdlc_a2f0b1557415ea384e7b1279c3618d4c0}{enable\+Crc32} () +\item +void \hyperlink{classTiny_1_1ProtoHdlc_a781e046caaeaeeecd03fadd07c138f9f}{set\+Receive\+Callback} (void($\ast$on\+\_\+receive)(\hyperlink{classTiny_1_1IPacket}{I\+Packet} \&pkt)=nullptr) +\item +void \hyperlink{classTiny_1_1ProtoHdlc_a1a2a3005901312563aad00154b8bfcf8}{set\+Send\+Callback} (void($\ast$on\+\_\+send)(\hyperlink{classTiny_1_1IPacket}{I\+Packet} \&pkt)=nullptr) +\end{DoxyCompactItemize} +\subsection*{Protected Member Functions} +\begin{DoxyCompactItemize} +\item +virtual void \hyperlink{classTiny_1_1ProtoHdlc_afe7bd4445fb69598b80357869e2b785c}{on\+Receive} (uint8\+\_\+t $\ast$pdata, int size) +\item +virtual void \hyperlink{classTiny_1_1ProtoHdlc_ae197714a219bf38e2408818334ee3108}{on\+Send} (const uint8\+\_\+t $\ast$pdata, int size) +\end{DoxyCompactItemize} + + +\subsection{Detailed Description} +\hyperlink{classTiny_1_1ProtoHdlc}{Proto\+Hdlc} class incapsulates hdlc Protocol functionality. hdlc version of the Protocol allows to send messages with confirmation. Remember that you may use always C-\/style A\+PI functions instead C++. Please refer to documentation. + +\subsection{Constructor \& Destructor Documentation} +\mbox{\Hypertarget{classTiny_1_1ProtoHdlc_a82160439269af053f034d69a1b350cbc}\label{classTiny_1_1ProtoHdlc_a82160439269af053f034d69a1b350cbc}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!Proto\+Hdlc@{Proto\+Hdlc}} +\index{Proto\+Hdlc@{Proto\+Hdlc}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{Proto\+Hdlc()}{ProtoHdlc()}} +{\footnotesize\ttfamily Tiny\+::\+Proto\+Hdlc\+::\+Proto\+Hdlc (\begin{DoxyParamCaption}\item[{void $\ast$}]{buffer, }\item[{int}]{buffer\+Size }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}} + +Initializes \hyperlink{classTiny_1_1ProtoHdlc}{Proto\+Hdlc} object +\begin{DoxyParams}{Parameters} +{\em buffer} & -\/ buffer to store the frames being received. \\ +\hline +{\em buffer\+Size} & -\/ size of the buffer \\ +\hline +\end{DoxyParams} + + +\subsection{Member Function Documentation} +\mbox{\Hypertarget{classTiny_1_1ProtoHdlc_acdc849f66b9f9a51d8930552ade56324}\label{classTiny_1_1ProtoHdlc_acdc849f66b9f9a51d8930552ade56324}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!begin@{begin}} +\index{begin@{begin}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{begin()}{begin()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} +{\footnotesize\ttfamily void Tiny\+::\+Proto\+Hdlc\+::begin (\begin{DoxyParamCaption}\item[{\hyperlink{tiny__types_8h_aafd634660bba76cace57a8f9b01e044d}{write\+\_\+block\+\_\+cb\+\_\+t}}]{writecb, }\item[{\hyperlink{tiny__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_1ProtoHdlc_ad4b84cbcd33d65e7df73321a0c19c420}{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_1ProtoHdlc_aaaca3c70444d6a5f20e7e1fef492e99b}\label{classTiny_1_1ProtoHdlc_aaaca3c70444d6a5f20e7e1fef492e99b}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!begin@{begin}} +\index{begin@{begin}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{begin()}{begin()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} +{\footnotesize\ttfamily void Tiny\+::\+Proto\+Hdlc\+::begin (\begin{DoxyParamCaption}{ }\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_1ProtoHdlc_ad4b84cbcd33d65e7df73321a0c19c420}{end()}. \begin{DoxyReturn}{Returns} +None +\end{DoxyReturn} +\mbox{\Hypertarget{classTiny_1_1ProtoHdlc_a8a54409e420954d93ada44ad0710740e}\label{classTiny_1_1ProtoHdlc_a8a54409e420954d93ada44ad0710740e}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!begin\+To\+Serial@{begin\+To\+Serial}} +\index{begin\+To\+Serial@{begin\+To\+Serial}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{begin\+To\+Serial()}{beginToSerial()}} +{\footnotesize\ttfamily void Tiny\+::\+Proto\+Hdlc\+::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_1ProtoHdlc_aadaf2dbaad53bba682d37e0650585491}\label{classTiny_1_1ProtoHdlc_aadaf2dbaad53bba682d37e0650585491}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!begin\+To\+Serial1@{begin\+To\+Serial1}} +\index{begin\+To\+Serial1@{begin\+To\+Serial1}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{begin\+To\+Serial1()}{beginToSerial1()}} +{\footnotesize\ttfamily void Tiny\+::\+Proto\+Hdlc\+::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_1ProtoHdlc_aed9903c8e65495e0260b4095113ee641}\label{classTiny_1_1ProtoHdlc_aed9903c8e65495e0260b4095113ee641}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!begin\+To\+Serial2@{begin\+To\+Serial2}} +\index{begin\+To\+Serial2@{begin\+To\+Serial2}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{begin\+To\+Serial2()}{beginToSerial2()}} +{\footnotesize\ttfamily void Tiny\+::\+Proto\+Hdlc\+::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_1ProtoHdlc_a1c895863c008b9dbd4316ae10c6e4ea0}\label{classTiny_1_1ProtoHdlc_a1c895863c008b9dbd4316ae10c6e4ea0}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!begin\+To\+Serial3@{begin\+To\+Serial3}} +\index{begin\+To\+Serial3@{begin\+To\+Serial3}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{begin\+To\+Serial3()}{beginToSerial3()}} +{\footnotesize\ttfamily void Tiny\+::\+Proto\+Hdlc\+::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_1ProtoHdlc_a37506cfddcc0e1ed9a2ed697f4860b98}\label{classTiny_1_1ProtoHdlc_a37506cfddcc0e1ed9a2ed697f4860b98}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!disable\+Crc@{disable\+Crc}} +\index{disable\+Crc@{disable\+Crc}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{disable\+Crc()}{disableCrc()}} +{\footnotesize\ttfamily void Tiny\+::\+Proto\+Hdlc\+::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_1ProtoHdlc_a3c9ed356b3d6dd4496b1655a0704e890}\label{classTiny_1_1ProtoHdlc_a3c9ed356b3d6dd4496b1655a0704e890}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!enable\+Check\+Sum@{enable\+Check\+Sum}} +\index{enable\+Check\+Sum@{enable\+Check\+Sum}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{enable\+Check\+Sum()}{enableCheckSum()}} +{\footnotesize\ttfamily bool Tiny\+::\+Proto\+Hdlc\+::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_1ProtoHdlc_a84e93210f940385a9408419ed605c8e5}\label{classTiny_1_1ProtoHdlc_a84e93210f940385a9408419ed605c8e5}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!enable\+Crc@{enable\+Crc}} +\index{enable\+Crc@{enable\+Crc}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{enable\+Crc()}{enableCrc()}} +{\footnotesize\ttfamily void Tiny\+::\+Proto\+Hdlc\+::enable\+Crc (\begin{DoxyParamCaption}\item[{\hyperlink{group__HDLC__API_gabb73b32d08d8e79eefe9385634a74bf7}{hdlc\+\_\+crc\+\_\+t}}]{crc }\end{DoxyParamCaption})} + +Enables C\+RC by specified bit-\/size. 8-\/bit is supported by Nano version of Tiny library. +\begin{DoxyParams}{Parameters} +{\em crc} & crc type \\ +\hline +\end{DoxyParams} +\mbox{\Hypertarget{classTiny_1_1ProtoHdlc_a693fb4301071e0b2d3bfd818265f22c6}\label{classTiny_1_1ProtoHdlc_a693fb4301071e0b2d3bfd818265f22c6}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!enable\+Crc16@{enable\+Crc16}} +\index{enable\+Crc16@{enable\+Crc16}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{enable\+Crc16()}{enableCrc16()}} +{\footnotesize\ttfamily bool Tiny\+::\+Proto\+Hdlc\+::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_1ProtoHdlc_a2f0b1557415ea384e7b1279c3618d4c0}\label{classTiny_1_1ProtoHdlc_a2f0b1557415ea384e7b1279c3618d4c0}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!enable\+Crc32@{enable\+Crc32}} +\index{enable\+Crc32@{enable\+Crc32}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{enable\+Crc32()}{enableCrc32()}} +{\footnotesize\ttfamily bool Tiny\+::\+Proto\+Hdlc\+::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_1ProtoHdlc_ad4b84cbcd33d65e7df73321a0c19c420}\label{classTiny_1_1ProtoHdlc_ad4b84cbcd33d65e7df73321a0c19c420}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!end@{end}} +\index{end@{end}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{end()}{end()}} +{\footnotesize\ttfamily void Tiny\+::\+Proto\+Hdlc\+::end (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} + +Resets protocol state. \mbox{\Hypertarget{classTiny_1_1ProtoHdlc_afe7bd4445fb69598b80357869e2b785c}\label{classTiny_1_1ProtoHdlc_afe7bd4445fb69598b80357869e2b785c}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!on\+Receive@{on\+Receive}} +\index{on\+Receive@{on\+Receive}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{on\+Receive()}{onReceive()}} +{\footnotesize\ttfamily virtual void Tiny\+::\+Proto\+Hdlc\+::on\+Receive (\begin{DoxyParamCaption}\item[{uint8\+\_\+t $\ast$}]{pdata, }\item[{int}]{size }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} + +Method called by hdlc protocol upon receiving new frame. Can be redefined in derived classes. +\begin{DoxyParams}{Parameters} +{\em pdata} & pointer to received data \\ +\hline +{\em size} & size of received payload in bytes \\ +\hline +\end{DoxyParams} +\mbox{\Hypertarget{classTiny_1_1ProtoHdlc_ae197714a219bf38e2408818334ee3108}\label{classTiny_1_1ProtoHdlc_ae197714a219bf38e2408818334ee3108}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!on\+Send@{on\+Send}} +\index{on\+Send@{on\+Send}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{on\+Send()}{onSend()}} +{\footnotesize\ttfamily virtual void Tiny\+::\+Proto\+Hdlc\+::on\+Send (\begin{DoxyParamCaption}\item[{const uint8\+\_\+t $\ast$}]{pdata, }\item[{int}]{size }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}, {\ttfamily [virtual]}} + +Method called by hdlc protocol upon sending next frame. Can be redefined in derived classes. +\begin{DoxyParams}{Parameters} +{\em pdata} & pointer to sent data \\ +\hline +{\em size} & size of sent payload in bytes \\ +\hline +\end{DoxyParams} +\mbox{\Hypertarget{classTiny_1_1ProtoHdlc_ae54e74de1a47d386f079c840fd830fe0}\label{classTiny_1_1ProtoHdlc_ae54e74de1a47d386f079c840fd830fe0}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!run\+\_\+rx@{run\+\_\+rx}} +\index{run\+\_\+rx@{run\+\_\+rx}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{run\+\_\+rx()}{run\_rx()}} +{\footnotesize\ttfamily int Tiny\+::\+Proto\+Hdlc\+::run\+\_\+rx (\begin{DoxyParamCaption}\item[{const void $\ast$}]{data, }\item[{int}]{len }\end{DoxyParamCaption})} + +Processes incoming rx data, specified by a user. \begin{DoxyReturn}{Returns} +T\+I\+N\+Y\+\_\+\+S\+U\+C\+C\+E\+SS +\end{DoxyReturn} +\begin{DoxyRemark}{Remarks} +if \hyperlink{classTiny_1_1Packet}{Packet} is receive during run execution callback is called. +\end{DoxyRemark} +\mbox{\Hypertarget{classTiny_1_1ProtoHdlc_a73415a63c389b3cbd0601a2ed49fd6e9}\label{classTiny_1_1ProtoHdlc_a73415a63c389b3cbd0601a2ed49fd6e9}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!run\+\_\+tx@{run\+\_\+tx}} +\index{run\+\_\+tx@{run\+\_\+tx}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{run\+\_\+tx()}{run\_tx()}} +{\footnotesize\ttfamily int Tiny\+::\+Proto\+Hdlc\+::run\+\_\+tx (\begin{DoxyParamCaption}\item[{void $\ast$}]{data, }\item[{int}]{max\+\_\+len }\end{DoxyParamCaption})} + +Generates data for tx channel +\begin{DoxyParams}{Parameters} +{\em data} & buffer to fill \\ +\hline +{\em max\+\_\+len} & length of buffer \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +number of bytes generated +\end{DoxyReturn} +\mbox{\Hypertarget{classTiny_1_1ProtoHdlc_a781e046caaeaeeecd03fadd07c138f9f}\label{classTiny_1_1ProtoHdlc_a781e046caaeaeeecd03fadd07c138f9f}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!set\+Receive\+Callback@{set\+Receive\+Callback}} +\index{set\+Receive\+Callback@{set\+Receive\+Callback}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{set\+Receive\+Callback()}{setReceiveCallback()}} +{\footnotesize\ttfamily void Tiny\+::\+Proto\+Hdlc\+::set\+Receive\+Callback (\begin{DoxyParamCaption}\item[{void($\ast$)(\hyperlink{classTiny_1_1IPacket}{I\+Packet} \&pkt)}]{on\+\_\+receive = {\ttfamily nullptr} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}} + +Sets receive callback for incoming messages +\begin{DoxyParams}{Parameters} +{\em on\+\_\+receive} & user callback to process incoming messages. The processing must be non-\/blocking \\ +\hline +\end{DoxyParams} +\mbox{\Hypertarget{classTiny_1_1ProtoHdlc_a1a2a3005901312563aad00154b8bfcf8}\label{classTiny_1_1ProtoHdlc_a1a2a3005901312563aad00154b8bfcf8}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!set\+Send\+Callback@{set\+Send\+Callback}} +\index{set\+Send\+Callback@{set\+Send\+Callback}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{set\+Send\+Callback()}{setSendCallback()}} +{\footnotesize\ttfamily void Tiny\+::\+Proto\+Hdlc\+::set\+Send\+Callback (\begin{DoxyParamCaption}\item[{void($\ast$)(\hyperlink{classTiny_1_1IPacket}{I\+Packet} \&pkt)}]{on\+\_\+send = {\ttfamily nullptr} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}} + +Sets send callback for outgoing messages +\begin{DoxyParams}{Parameters} +{\em on\+\_\+send} & user callback to process outgoing messages. The processing must be non-\/blocking \\ +\hline +\end{DoxyParams} +\mbox{\Hypertarget{classTiny_1_1ProtoHdlc_ae79c01f1c3614f0f382e8d8bf847b567}\label{classTiny_1_1ProtoHdlc_ae79c01f1c3614f0f382e8d8bf847b567}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!write@{write}} +\index{write@{write}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} +{\footnotesize\ttfamily int Tiny\+::\+Proto\+Hdlc\+::write (\begin{DoxyParamCaption}\item[{char $\ast$}]{buf, }\item[{int}]{size }\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 +\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_1ProtoHdlc_a3d02f2589397fb4a0e5be24a44321f9b}\label{classTiny_1_1ProtoHdlc_a3d02f2589397fb4a0e5be24a44321f9b}} +\index{Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}!write@{write}} +\index{write@{write}!Tiny\+::\+Proto\+Hdlc@{Tiny\+::\+Proto\+Hdlc}} +\subsubsection{\texorpdfstring{write()}{write()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} +{\footnotesize\ttfamily int Tiny\+::\+Proto\+Hdlc\+::write (\begin{DoxyParamCaption}\item[{\hyperlink{classTiny_1_1IPacket}{I\+Packet} \&}]{pkt }\end{DoxyParamCaption})} + +Sends packet over communication channel. +\begin{DoxyParams}{Parameters} +{\em pkt} & -\/ \hyperlink{classTiny_1_1Packet}{Packet} to send \\ +\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{TinyProtocolHdlc_8h}{Tiny\+Protocol\+Hdlc.\+h}\end{DoxyCompactItemize} diff --git a/docs/latex/dir_51b8ddc8ad9e5a56f13bccf85e770ab4.tex b/docs/latex/dir_51b8ddc8ad9e5a56f13bccf85e770ab4.tex index 8db386b1..3580e377 100644 --- a/docs/latex/dir_51b8ddc8ad9e5a56f13bccf85e770ab4.tex +++ b/docs/latex/dir_51b8ddc8ad9e5a56f13bccf85e770ab4.tex @@ -1,6 +1,7 @@ \hypertarget{dir_51b8ddc8ad9e5a56f13bccf85e770ab4}{}\section{src/proto Directory Reference} \label{dir_51b8ddc8ad9e5a56f13bccf85e770ab4}\index{src/proto Directory Reference@{src/proto Directory Reference}} -Directory dependency graph for proto\+:\nopagebreak +Directory dependency graph for proto\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode diff --git a/docs/latex/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.md5 b/docs/latex/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.md5 index 38efcc26..d8e3925b 100644 --- a/docs/latex/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.md5 +++ b/docs/latex/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.md5 @@ -1 +1 @@ -96b55d5b09940f17cd9a4b5888be570f \ No newline at end of file +cfd7e1323a4f9745b9b78c66eb3d8ce2 \ No newline at end of file diff --git a/docs/latex/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.pdf b/docs/latex/dir_51b8ddc8ad9e5a56f13bccf85e770ab4_dep.pdf index 9495fa60..9f01d4c7 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_5f912d25950dbd750c3eed60d2c339b1.tex b/docs/latex/dir_5f912d25950dbd750c3eed60d2c339b1.tex index 3a245834..23074d24 100644 --- a/docs/latex/dir_5f912d25950dbd750c3eed60d2c339b1.tex +++ b/docs/latex/dir_5f912d25950dbd750c3eed60d2c339b1.tex @@ -1,6 +1,7 @@ \hypertarget{dir_5f912d25950dbd750c3eed60d2c339b1}{}\section{src/proto/fd Directory Reference} \label{dir_5f912d25950dbd750c3eed60d2c339b1}\index{src/proto/fd Directory Reference@{src/proto/fd Directory Reference}} -Directory dependency graph for fd\+:\nopagebreak +Directory dependency graph for fd\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode diff --git a/docs/latex/dir_5f912d25950dbd750c3eed60d2c339b1_dep.pdf b/docs/latex/dir_5f912d25950dbd750c3eed60d2c339b1_dep.pdf index 2568150a..52f86e5b 100644 Binary files a/docs/latex/dir_5f912d25950dbd750c3eed60d2c339b1_dep.pdf and b/docs/latex/dir_5f912d25950dbd750c3eed60d2c339b1_dep.pdf differ diff --git a/docs/latex/dir_61a763563eb3728beb0014ac26e3418e.tex b/docs/latex/dir_61a763563eb3728beb0014ac26e3418e.tex index bd75708d..196694f6 100644 --- a/docs/latex/dir_61a763563eb3728beb0014ac26e3418e.tex +++ b/docs/latex/dir_61a763563eb3728beb0014ac26e3418e.tex @@ -1,10 +1,11 @@ \hypertarget{dir_61a763563eb3728beb0014ac26e3418e}{}\section{src/proto/half\+\_\+duplex Directory Reference} \label{dir_61a763563eb3728beb0014ac26e3418e}\index{src/proto/half\+\_\+duplex Directory Reference@{src/proto/half\+\_\+duplex Directory Reference}} -Directory dependency graph for half\+\_\+duplex\+:\nopagebreak +Directory dependency graph for half\+\_\+duplex\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=178pt]{dir_61a763563eb3728beb0014ac26e3418e_dep} +\includegraphics[width=186pt]{dir_61a763563eb3728beb0014ac26e3418e_dep} \end{center} \end{figure} \subsection*{Files} diff --git a/docs/latex/dir_61a763563eb3728beb0014ac26e3418e_dep.md5 b/docs/latex/dir_61a763563eb3728beb0014ac26e3418e_dep.md5 index e6376353..4f86117a 100644 --- a/docs/latex/dir_61a763563eb3728beb0014ac26e3418e_dep.md5 +++ b/docs/latex/dir_61a763563eb3728beb0014ac26e3418e_dep.md5 @@ -1 +1 @@ -06c9cd4ec6c85c4e9dc071b3773eaff8 \ No newline at end of file +279455efd96d59efea26ff5cd2c4654b \ No newline at end of file diff --git a/docs/latex/dir_61a763563eb3728beb0014ac26e3418e_dep.pdf b/docs/latex/dir_61a763563eb3728beb0014ac26e3418e_dep.pdf index b76f3d76..41ba9a9a 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 1d590a01..5fdcb327 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 @@ -19,4 +20,6 @@ \subsection*{Files} file \hyperlink{TinyProtocolFd_8h}{Tiny\+Protocol\+Fd.\+h} \begin{DoxyCompactList}\small\item\em Tiny protocol Arduino A\+PI. \end{DoxyCompactList}\item file \hyperlink{TinyProtocolHd_8h}{Tiny\+Protocol\+Hd.\+h} +\begin{DoxyCompactList}\small\item\em Tiny protocol Arduino A\+PI. \end{DoxyCompactList}\item +file \hyperlink{TinyProtocolHdlc_8h}{Tiny\+Protocol\+Hdlc.\+h} \begin{DoxyCompactList}\small\item\em Tiny protocol Arduino A\+PI. \end{DoxyCompactList}\end{DoxyCompactItemize} diff --git a/docs/latex/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.pdf b/docs/latex/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.pdf index 66bc3929..0d173735 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.tex b/docs/latex/dir_75a472a4d9716ba9c1151370abaacaf0.tex index d318505f..6157c74b 100644 --- a/docs/latex/dir_75a472a4d9716ba9c1151370abaacaf0.tex +++ b/docs/latex/dir_75a472a4d9716ba9c1151370abaacaf0.tex @@ -6,5 +6,7 @@ \subsection*{Directories} \subsection*{Files} \begin{DoxyCompactItemize} \item +file \hyperlink{tiny__serial_8h}{tiny\+\_\+serial.\+h} +\begin{DoxyCompactList}\small\item\em Tiny U\+A\+RT serial A\+PI. \end{DoxyCompactList}\item file \hyperlink{tiny__types_8h}{tiny\+\_\+types.\+h} \begin{DoxyCompactList}\small\item\em Tiny protocol Types. \end{DoxyCompactList}\end{DoxyCompactItemize} diff --git a/docs/latex/dir_9c7dc50cded8f3aee51a209935ca1b53.tex b/docs/latex/dir_9c7dc50cded8f3aee51a209935ca1b53.tex index 44300f40..1b657b55 100644 --- a/docs/latex/dir_9c7dc50cded8f3aee51a209935ca1b53.tex +++ b/docs/latex/dir_9c7dc50cded8f3aee51a209935ca1b53.tex @@ -1,6 +1,7 @@ \hypertarget{dir_9c7dc50cded8f3aee51a209935ca1b53}{}\section{src/proto/hdlc Directory Reference} \label{dir_9c7dc50cded8f3aee51a209935ca1b53}\index{src/proto/hdlc Directory Reference@{src/proto/hdlc Directory Reference}} -Directory dependency graph for hdlc\+:\nopagebreak +Directory dependency graph for hdlc\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode diff --git a/docs/latex/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.md5 b/docs/latex/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.md5 index 3b1c91cd..15152560 100644 --- a/docs/latex/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.md5 +++ b/docs/latex/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.md5 @@ -1 +1 @@ -a72fb967d940e7e1cd45990f002f4c25 \ No newline at end of file +ee91ee20e156331b5decdca3dc8525ea \ No newline at end of file diff --git a/docs/latex/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.pdf b/docs/latex/dir_9c7dc50cded8f3aee51a209935ca1b53_dep.pdf index e39fc134..35a58bf1 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_f468ab7bd64995917426f65613b4e1f4.tex b/docs/latex/dir_f468ab7bd64995917426f65613b4e1f4.tex index f474db51..e70c1341 100644 --- a/docs/latex/dir_f468ab7bd64995917426f65613b4e1f4.tex +++ b/docs/latex/dir_f468ab7bd64995917426f65613b4e1f4.tex @@ -1,6 +1,7 @@ \hypertarget{dir_f468ab7bd64995917426f65613b4e1f4}{}\section{src/proto/light Directory Reference} \label{dir_f468ab7bd64995917426f65613b4e1f4}\index{src/proto/light Directory Reference@{src/proto/light Directory Reference}} -Directory dependency graph for light\+:\nopagebreak +Directory dependency graph for light\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode diff --git a/docs/latex/dir_f468ab7bd64995917426f65613b4e1f4_dep.md5 b/docs/latex/dir_f468ab7bd64995917426f65613b4e1f4_dep.md5 index 1166e215..604b9bf0 100644 --- a/docs/latex/dir_f468ab7bd64995917426f65613b4e1f4_dep.md5 +++ b/docs/latex/dir_f468ab7bd64995917426f65613b4e1f4_dep.md5 @@ -1 +1 @@ -2eb0cb1f0fe8bbe1077861c4333a10bf \ No newline at end of file +25f63740b7ab1bab119cbfb3289b5a33 \ No newline at end of file diff --git a/docs/latex/dir_f468ab7bd64995917426f65613b4e1f4_dep.pdf b/docs/latex/dir_f468ab7bd64995917426f65613b4e1f4_dep.pdf index cb779e5e..4cab6fd4 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_f5baaad8cebc633554cca9d618218d60.tex b/docs/latex/dir_f5baaad8cebc633554cca9d618218d60.tex new file mode 100644 index 00000000..d350ccb4 --- /dev/null +++ b/docs/latex/dir_f5baaad8cebc633554cca9d618218d60.tex @@ -0,0 +1,7 @@ +\hypertarget{dir_f5baaad8cebc633554cca9d618218d60}{}\section{src/proto/hal/serial Directory Reference} +\label{dir_f5baaad8cebc633554cca9d618218d60}\index{src/proto/hal/serial Directory Reference@{src/proto/hal/serial Directory Reference}} +\subsection*{Files} +\begin{DoxyCompactItemize} +\item +file \hyperlink{win32__serial_8h}{win32\+\_\+serial.\+h} +\begin{DoxyCompactList}\small\item\em U\+A\+RT serial A\+PI. \end{DoxyCompactList}\end{DoxyCompactItemize} diff --git a/docs/latex/dir_ffe34aff0f0ffb6c8084a9781fabcbab.tex b/docs/latex/dir_ffe34aff0f0ffb6c8084a9781fabcbab.tex index 989b8268..374cd902 100644 --- a/docs/latex/dir_ffe34aff0f0ffb6c8084a9781fabcbab.tex +++ b/docs/latex/dir_ffe34aff0f0ffb6c8084a9781fabcbab.tex @@ -1,6 +1,7 @@ \hypertarget{dir_ffe34aff0f0ffb6c8084a9781fabcbab}{}\section{src/proto/crc Directory Reference} \label{dir_ffe34aff0f0ffb6c8084a9781fabcbab}\index{src/proto/crc Directory Reference@{src/proto/crc Directory Reference}} -Directory dependency graph for crc\+:\nopagebreak +Directory dependency graph for crc\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode diff --git a/docs/latex/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.pdf b/docs/latex/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.pdf index 853535dc..3f4c6a6f 100644 Binary files a/docs/latex/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.pdf and b/docs/latex/dir_ffe34aff0f0ffb6c8084a9781fabcbab_dep.pdf differ diff --git a/docs/latex/files.tex b/docs/latex/files.tex index fc8fccd9..5a5f8128 100644 --- a/docs/latex/files.tex +++ b/docs/latex/files.tex @@ -5,11 +5,13 @@ \section{File List} \item\contentsline{section}{src/\hyperlink{TinyProtocol_8h}{Tiny\+Protocol.\+h} \\*Tiny protocol Arduino A\+PI }{\pageref{TinyProtocol_8h}}{} \item\contentsline{section}{src/\hyperlink{TinyProtocolFd_8h}{Tiny\+Protocol\+Fd.\+h} \\*Tiny protocol Arduino A\+PI }{\pageref{TinyProtocolFd_8h}}{} \item\contentsline{section}{src/\hyperlink{TinyProtocolHd_8h}{Tiny\+Protocol\+Hd.\+h} \\*Tiny protocol Arduino A\+PI }{\pageref{TinyProtocolHd_8h}}{} +\item\contentsline{section}{src/\hyperlink{TinyProtocolHdlc_8h}{Tiny\+Protocol\+Hdlc.\+h} \\*Tiny protocol Arduino A\+PI }{\pageref{TinyProtocolHdlc_8h}}{} \item\contentsline{section}{src/proto/crc/{\bfseries crc.\+h} }{\pageref{crc_8h}}{} \item\contentsline{section}{src/proto/fd/\hyperlink{tiny__fd_8h}{tiny\+\_\+fd.\+h} \\*Tiny Protocol Full Duplex A\+PI }{\pageref{tiny__fd_8h}}{} \item\contentsline{section}{src/proto/fd/{\bfseries tiny\+\_\+fd\+\_\+int.\+h} }{\pageref{tiny__fd__int_8h}}{} \item\contentsline{section}{src/proto/hal/{\bfseries tiny\+\_\+debug.\+h} }{\pageref{tiny__debug_8h}}{} \item\contentsline{section}{src/proto/hal/{\bfseries tiny\+\_\+list.\+h} }{\pageref{tiny__list_8h}}{} +\item\contentsline{section}{src/proto/hal/\hyperlink{tiny__serial_8h}{tiny\+\_\+serial.\+h} \\*Tiny U\+A\+RT serial A\+PI }{\pageref{tiny__serial_8h}}{} \item\contentsline{section}{src/proto/hal/\hyperlink{tiny__types_8h}{tiny\+\_\+types.\+h} \\*Tiny protocol Types }{\pageref{tiny__types_8h}}{} \item\contentsline{section}{src/proto/hal/include/{\bfseries arduino\+\_\+hal.\+h} }{\pageref{arduino__hal_8h}}{} \item\contentsline{section}{src/proto/hal/include/{\bfseries avr\+\_\+hal.\+h} }{\pageref{avr__hal_8h}}{} @@ -17,6 +19,10 @@ \section{File List} \item\contentsline{section}{src/proto/hal/include/{\bfseries linux\+\_\+hal.\+h} }{\pageref{linux__hal_8h}}{} \item\contentsline{section}{src/proto/hal/include/{\bfseries mingw32\+\_\+hal.\+h} }{\pageref{mingw32__hal_8h}}{} \item\contentsline{section}{src/proto/hal/include/{\bfseries no\+\_\+platform\+\_\+hal.\+h} }{\pageref{no__platform__hal_8h}}{} +\item\contentsline{section}{src/proto/hal/include/{\bfseries win32\+\_\+hal.\+h} }{\pageref{win32__hal_8h}}{} +\item\contentsline{section}{src/proto/hal/serial/{\bfseries linux\+\_\+serial.\+h} }{\pageref{linux__serial_8h}}{} +\item\contentsline{section}{src/proto/hal/serial/{\bfseries noplatform\+\_\+serial.\+h} }{\pageref{noplatform__serial_8h}}{} +\item\contentsline{section}{src/proto/hal/serial/\hyperlink{win32__serial_8h}{win32\+\_\+serial.\+h} \\*U\+A\+RT serial A\+PI }{\pageref{win32__serial_8h}}{} \item\contentsline{section}{src/proto/half\+\_\+duplex/\hyperlink{tiny__hd_8h}{tiny\+\_\+hd.\+h} \\*Tiny Protocol Half Duplex A\+PI }{\pageref{tiny__hd_8h}}{} \item\contentsline{section}{src/proto/half\+\_\+duplex/{\bfseries tiny\+\_\+rq\+\_\+pool.\+h} }{\pageref{tiny__rq__pool_8h}}{} \item\contentsline{section}{src/proto/hdlc/{\bfseries tiny\+\_\+hdlc.\+h} }{\pageref{tiny__hdlc_8h}}{} diff --git a/docs/latex/group__FULL__DUPLEX__API.tex b/docs/latex/group__FULL__DUPLEX__API.tex index eec145db..728217fb 100644 --- a/docs/latex/group__FULL__DUPLEX__API.tex +++ b/docs/latex/group__FULL__DUPLEX__API.tex @@ -23,8 +23,12 @@ \subsection*{Functions} \begin{DoxyCompactList}\small\item\em stops Tiny Full Duplex state machine \end{DoxyCompactList}\item int \hyperlink{group__FULL__DUPLEX__API_ga601c9874a570331580856c1ea28f7914}{tiny\+\_\+fd\+\_\+run\+\_\+tx} (\hyperlink{group__FULL__DUPLEX__API_ga91e6b79431fe38570fb102701ef0b7e8}{tiny\+\_\+fd\+\_\+handle\+\_\+t} handle, uint16\+\_\+t timeout) \begin{DoxyCompactList}\small\item\em runs tx processing for specified period of time. \end{DoxyCompactList}\item +int \hyperlink{group__FULL__DUPLEX__API_ga047059c29688cfcbfd95584e5e435ad2}{tiny\+\_\+fd\+\_\+get\+\_\+tx\+\_\+data} (\hyperlink{group__FULL__DUPLEX__API_ga91e6b79431fe38570fb102701ef0b7e8}{tiny\+\_\+fd\+\_\+handle\+\_\+t} handle, void $\ast$data, int len) +\begin{DoxyCompactList}\small\item\em runs tx processing to fill specified buffer with data. \end{DoxyCompactList}\item int \hyperlink{group__FULL__DUPLEX__API_gad31f944514aef01e27bc3ec67fdbe140}{tiny\+\_\+fd\+\_\+run\+\_\+rx} (\hyperlink{group__FULL__DUPLEX__API_ga91e6b79431fe38570fb102701ef0b7e8}{tiny\+\_\+fd\+\_\+handle\+\_\+t} handle, uint16\+\_\+t timeout) \begin{DoxyCompactList}\small\item\em runs rx processing for specified period of time. \end{DoxyCompactList}\item +int \hyperlink{group__FULL__DUPLEX__API_ga894298485a7b0901a61863ef7c2632b4}{tiny\+\_\+fd\+\_\+on\+\_\+rx\+\_\+data} (\hyperlink{group__FULL__DUPLEX__API_ga91e6b79431fe38570fb102701ef0b7e8}{tiny\+\_\+fd\+\_\+handle\+\_\+t} handle, const void $\ast$data, int len) +\begin{DoxyCompactList}\small\item\em runs rx bytes processing for specified buffer. \end{DoxyCompactList}\item int \hyperlink{group__FULL__DUPLEX__API_ga490157ee98ea6148f99a5bb1f26c5f60}{tiny\+\_\+fd\+\_\+send} (\hyperlink{group__FULL__DUPLEX__API_ga91e6b79431fe38570fb102701ef0b7e8}{tiny\+\_\+fd\+\_\+handle\+\_\+t} handle, const void $\ast$buf, int len) \begin{DoxyCompactList}\small\item\em Sends userdata over full-\/duplex protocol. \end{DoxyCompactList}\item int \hyperlink{group__FULL__DUPLEX__API_ga19789bea5b5acd68804773f0d6b0e3f7}{tiny\+\_\+fd\+\_\+buffer\+\_\+size\+\_\+by\+\_\+mtu} (int mtu, int max\+\_\+tx\+\_\+frames) @@ -82,6 +86,30 @@ \subsubsection{\texorpdfstring{tiny\+\_\+fd\+\_\+close()}{tiny\_fd\_close()}} {\em handle} & handle of full-\/duplex protocol \\ \hline \end{DoxyParams} +\mbox{\Hypertarget{group__FULL__DUPLEX__API_ga047059c29688cfcbfd95584e5e435ad2}\label{group__FULL__DUPLEX__API_ga047059c29688cfcbfd95584e5e435ad2}} +\index{Tiny Full Duplex A\+P\+I functions@{Tiny Full Duplex A\+P\+I functions}!tiny\+\_\+fd\+\_\+get\+\_\+tx\+\_\+data@{tiny\+\_\+fd\+\_\+get\+\_\+tx\+\_\+data}} +\index{tiny\+\_\+fd\+\_\+get\+\_\+tx\+\_\+data@{tiny\+\_\+fd\+\_\+get\+\_\+tx\+\_\+data}!Tiny Full Duplex A\+P\+I functions@{Tiny Full Duplex A\+P\+I functions}} +\subsubsection{\texorpdfstring{tiny\+\_\+fd\+\_\+get\+\_\+tx\+\_\+data()}{tiny\_fd\_get\_tx\_data()}} +{\footnotesize\ttfamily int tiny\+\_\+fd\+\_\+get\+\_\+tx\+\_\+data (\begin{DoxyParamCaption}\item[{\hyperlink{group__FULL__DUPLEX__API_ga91e6b79431fe38570fb102701ef0b7e8}{tiny\+\_\+fd\+\_\+handle\+\_\+t}}]{handle, }\item[{void $\ast$}]{data, }\item[{int}]{len }\end{DoxyParamCaption})} + + + +runs tx processing to fill specified buffer with data. + +Runs tx processing to fill specified buffer with data. + + +\begin{DoxyParams}{Parameters} +{\em handle} & handle of full-\/duplex protocol \\ +\hline +{\em data} & pointer to buffer to fill with tx data \\ +\hline +{\em len} & maximum size of specified buffer \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +number of bytes written to specified buffer +\end{DoxyReturn} \mbox{\Hypertarget{group__FULL__DUPLEX__API_ga27fa59dffd1575419753beb35282bad5}\label{group__FULL__DUPLEX__API_ga27fa59dffd1575419753beb35282bad5}} \index{Tiny Full Duplex A\+P\+I functions@{Tiny Full Duplex A\+P\+I functions}!tiny\+\_\+fd\+\_\+init@{tiny\+\_\+fd\+\_\+init}} \index{tiny\+\_\+fd\+\_\+init@{tiny\+\_\+fd\+\_\+init}!Tiny Full Duplex A\+P\+I functions@{Tiny Full Duplex A\+P\+I functions}} @@ -107,6 +135,30 @@ \subsubsection{\texorpdfstring{tiny\+\_\+fd\+\_\+init()}{tiny\_fd\_init()}} \begin{DoxyRemark}{Remarks} This function is not thread safe. \end{DoxyRemark} +\mbox{\Hypertarget{group__FULL__DUPLEX__API_ga894298485a7b0901a61863ef7c2632b4}\label{group__FULL__DUPLEX__API_ga894298485a7b0901a61863ef7c2632b4}} +\index{Tiny Full Duplex A\+P\+I functions@{Tiny Full Duplex A\+P\+I functions}!tiny\+\_\+fd\+\_\+on\+\_\+rx\+\_\+data@{tiny\+\_\+fd\+\_\+on\+\_\+rx\+\_\+data}} +\index{tiny\+\_\+fd\+\_\+on\+\_\+rx\+\_\+data@{tiny\+\_\+fd\+\_\+on\+\_\+rx\+\_\+data}!Tiny Full Duplex A\+P\+I functions@{Tiny Full Duplex A\+P\+I functions}} +\subsubsection{\texorpdfstring{tiny\+\_\+fd\+\_\+on\+\_\+rx\+\_\+data()}{tiny\_fd\_on\_rx\_data()}} +{\footnotesize\ttfamily int tiny\+\_\+fd\+\_\+on\+\_\+rx\+\_\+data (\begin{DoxyParamCaption}\item[{\hyperlink{group__FULL__DUPLEX__API_ga91e6b79431fe38570fb102701ef0b7e8}{tiny\+\_\+fd\+\_\+handle\+\_\+t}}]{handle, }\item[{const void $\ast$}]{data, }\item[{int}]{len }\end{DoxyParamCaption})} + + + +runs rx bytes processing for specified buffer. + +Runs rx bytes processing for specified buffer. This is alternative method to run Full-\/duplex protocol for rx data. Use it, when you wish to control reading from hardware by yourself. + + +\begin{DoxyParams}{Parameters} +{\em handle} & handle of full-\/duplex protocol \\ +\hline +{\em data} & pointer to data to process \\ +\hline +{\em len} & length of data to process \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +T\+I\+N\+Y\+\_\+\+S\+U\+C\+C\+E\+SS +\end{DoxyReturn} \mbox{\Hypertarget{group__FULL__DUPLEX__API_gad31f944514aef01e27bc3ec67fdbe140}\label{group__FULL__DUPLEX__API_gad31f944514aef01e27bc3ec67fdbe140}} \index{Tiny Full Duplex A\+P\+I functions@{Tiny Full Duplex A\+P\+I functions}!tiny\+\_\+fd\+\_\+run\+\_\+rx@{tiny\+\_\+fd\+\_\+run\+\_\+rx}} \index{tiny\+\_\+fd\+\_\+run\+\_\+rx@{tiny\+\_\+fd\+\_\+run\+\_\+rx}!Tiny Full Duplex A\+P\+I functions@{Tiny Full Duplex A\+P\+I functions}} @@ -148,6 +200,9 @@ \subsubsection{\texorpdfstring{tiny\+\_\+fd\+\_\+run\+\_\+tx()}{tiny\_fd\_run\_t {\em timeout} & maximum timeout in milliseconds to perform tx operations \\ \hline \end{DoxyParams} +\begin{DoxyReturn}{Returns} +T\+I\+N\+Y\+\_\+\+E\+R\+R\+\_\+\+T\+I\+M\+E\+O\+UT, or T\+I\+N\+Y\+\_\+\+S\+U\+C\+C\+E\+SS +\end{DoxyReturn} \mbox{\Hypertarget{group__FULL__DUPLEX__API_ga490157ee98ea6148f99a5bb1f26c5f60}\label{group__FULL__DUPLEX__API_ga490157ee98ea6148f99a5bb1f26c5f60}} \index{Tiny Full Duplex A\+P\+I functions@{Tiny Full Duplex A\+P\+I functions}!tiny\+\_\+fd\+\_\+send@{tiny\+\_\+fd\+\_\+send}} \index{tiny\+\_\+fd\+\_\+send@{tiny\+\_\+fd\+\_\+send}!Tiny Full Duplex A\+P\+I functions@{Tiny Full Duplex A\+P\+I functions}} diff --git a/docs/latex/group__HDLC__API.tex b/docs/latex/group__HDLC__API.tex index c1b4898e..7178944c 100644 --- a/docs/latex/group__HDLC__API.tex +++ b/docs/latex/group__HDLC__API.tex @@ -9,6 +9,8 @@ \subsection*{Classes} \begin{DoxyCompactItemize} \item struct \hyperlink{struct__hdlc__handle__t}{\+\_\+hdlc\+\_\+handle\+\_\+t} +\item +class \hyperlink{classTiny_1_1ProtoHdlc}{Tiny\+::\+Proto\+Hdlc} \end{DoxyCompactItemize} \subsection*{Typedefs} \begin{DoxyCompactItemize} @@ -47,6 +49,8 @@ \subsection*{Functions} \item int \hyperlink{group__HDLC__API_gae31d921043b4f175603114c206b6b829}{hdlc\+\_\+run\+\_\+tx} (\hyperlink{group__HDLC__API_gabeaf7578aed5279d3af891bd85a9f961}{hdlc\+\_\+handle\+\_\+t} handle) \item +int \hyperlink{group__HDLC__API_gaaeece06ea6894a19402f76158e1d101d}{hdlc\+\_\+get\+\_\+tx\+\_\+data} (\hyperlink{group__HDLC__API_gabeaf7578aed5279d3af891bd85a9f961}{hdlc\+\_\+handle\+\_\+t} handle, void $\ast$data, int len) +\item int \hyperlink{group__HDLC__API_ga8b5cc456927145cebd82b2b560a6fa10}{hdlc\+\_\+send} (\hyperlink{group__HDLC__API_gabeaf7578aed5279d3af891bd85a9f961}{hdlc\+\_\+handle\+\_\+t} handle, const void $\ast$data, int len, uint32\+\_\+t timeout) \end{DoxyCompactItemize} @@ -110,6 +114,26 @@ \subsubsection{\texorpdfstring{hdlc\+\_\+close()}{hdlc\_close()}} {\em handle} & handle to hdlc instance \\ \hline \end{DoxyParams} +\mbox{\Hypertarget{group__HDLC__API_gaaeece06ea6894a19402f76158e1d101d}\label{group__HDLC__API_gaaeece06ea6894a19402f76158e1d101d}} +\index{Tiny H\+D\+L\+C protocol A\+P\+I functions@{Tiny H\+D\+L\+C protocol A\+P\+I functions}!hdlc\+\_\+get\+\_\+tx\+\_\+data@{hdlc\+\_\+get\+\_\+tx\+\_\+data}} +\index{hdlc\+\_\+get\+\_\+tx\+\_\+data@{hdlc\+\_\+get\+\_\+tx\+\_\+data}!Tiny H\+D\+L\+C protocol A\+P\+I functions@{Tiny H\+D\+L\+C protocol A\+P\+I functions}} +\subsubsection{\texorpdfstring{hdlc\+\_\+get\+\_\+tx\+\_\+data()}{hdlc\_get\_tx\_data()}} +{\footnotesize\ttfamily int hdlc\+\_\+get\+\_\+tx\+\_\+data (\begin{DoxyParamCaption}\item[{\hyperlink{group__HDLC__API_gabeaf7578aed5279d3af891bd85a9f961}{hdlc\+\_\+handle\+\_\+t}}]{handle, }\item[{void $\ast$}]{data, }\item[{int}]{len }\end{DoxyParamCaption})} + +If hdlc protocol has some data to send it will full data with This function returns either if no more data to send, or specified buffer is filled completely. + + +\begin{DoxyParams}{Parameters} +{\em handle} & handle to hdlc instance \\ +\hline +{\em data} & pointer to buffer to fill with data \\ +\hline +{\em len} & length of specified buffer \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +number of bytes written to specified buffer +\end{DoxyReturn} \mbox{\Hypertarget{group__HDLC__API_gaa41c388433273a76460ddfbaff0f8f5d}\label{group__HDLC__API_gaa41c388433273a76460ddfbaff0f8f5d}} \index{Tiny H\+D\+L\+C protocol A\+P\+I functions@{Tiny H\+D\+L\+C protocol A\+P\+I functions}!hdlc\+\_\+init@{hdlc\+\_\+init}} \index{hdlc\+\_\+init@{hdlc\+\_\+init}!Tiny H\+D\+L\+C protocol A\+P\+I functions@{Tiny H\+D\+L\+C protocol A\+P\+I functions}} @@ -150,6 +174,10 @@ \subsubsection{\texorpdfstring{hdlc\+\_\+run\+\_\+rx()}{hdlc\_run\_rx()}} Processes incoming data. Implementation of reading data from hw is user responsibility. If \hyperlink{group__HDLC__API_ga911a3f1cb32dd6cadd00223e0097642c}{hdlc\+\_\+run\+\_\+rx()} returns value less than size of data passed to the function, then \hyperlink{group__HDLC__API_ga911a3f1cb32dd6cadd00223e0097642c}{hdlc\+\_\+run\+\_\+rx()} must be called later second time with the pointer to and size of not processed bytes. +If you don\textquotesingle{}t care about errors on RX line, it is allowed to ignore all error codes except T\+I\+N\+Y\+\_\+\+E\+R\+R\+\_\+\+F\+A\+I\+L\+ED, which means general failure. + +if \hyperlink{group__HDLC__API_ga911a3f1cb32dd6cadd00223e0097642c}{hdlc\+\_\+run\+\_\+rx()} returns 0 bytes processed, just call it once again. It is guaranteed, that at least second call will process bytes. + This function will return the following codes in error field\+: \begin{DoxyItemize} \item T\+I\+N\+Y\+\_\+\+E\+R\+R\+\_\+\+D\+A\+T\+A\+\_\+\+T\+O\+O\+\_\+\+L\+A\+R\+GE if receiving data fails to fit incoming buffer diff --git a/docs/latex/hierarchy.tex b/docs/latex/hierarchy.tex index c245e885..999c12d5 100644 --- a/docs/latex/hierarchy.tex +++ b/docs/latex/hierarchy.tex @@ -13,6 +13,7 @@ \section{Class Hierarchy} \end{DoxyCompactList} \item \contentsline{section}{list\+\_\+element\+\_\+}{\pageref{structlist__element__}}{} \item \contentsline{section}{Tiny\+:\+:Proto\+Hd}{\pageref{classTiny_1_1ProtoHd}}{} +\item \contentsline{section}{Tiny\+:\+:Proto\+Hdlc}{\pageref{classTiny_1_1ProtoHdlc}}{} \item \contentsline{section}{Tiny\+:\+:Proto\+Light}{\pageref{classTiny_1_1ProtoLight}}{} \item \contentsline{section}{S\+Tiny\+Hd\+Data\+\_\+}{\pageref{structSTinyHdData__}}{} \item \contentsline{section}{S\+Tiny\+Hd\+Init\+\_\+}{\pageref{structSTinyHdInit__}}{} diff --git a/docs/latex/refman.tex b/docs/latex/refman.tex index 5d3173a6..b9b5b821 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.\+9.\+3 }\\ +{\Large Tiny protocol \\[1ex]\large 0.\+11.\+0 }\\ \vspace*{1cm} {\large Generated by Doxygen 1.8.13}\\ \end{center} @@ -169,6 +169,7 @@ \chapter{Class Documentation} \input{classTiny_1_1ProtoFd} \input{classTiny_1_1ProtoFdD} \input{classTiny_1_1ProtoHd} +\input{classTiny_1_1ProtoHdlc} \input{classTiny_1_1ProtoLight} \input{structSTinyHdData__} \input{structSTinyHdInit__} @@ -180,6 +181,8 @@ \chapter{File Documentation} \input{arduino_8dox} \input{mainpage_8dox} \input{tiny__fd_8h} +\input{win32__serial_8h} +\input{tiny__serial_8h} \input{tiny__types_8h} \input{tiny__hd_8h} \input{tiny__light_8h} @@ -188,6 +191,7 @@ \chapter{File Documentation} \input{TinyProtocol_8h} \input{TinyProtocolFd_8h} \input{TinyProtocolHd_8h} +\input{TinyProtocolHdlc_8h} %--- End generated contents --- % Index diff --git a/docs/latex/structSTinyLightData.tex b/docs/latex/structSTinyLightData.tex index 187bc74f..5d36d624 100644 --- a/docs/latex/structSTinyLightData.tex +++ b/docs/latex/structSTinyLightData.tex @@ -6,11 +6,12 @@ -Collaboration diagram for S\+Tiny\+Light\+Data\+:\nopagebreak +Collaboration diagram for S\+Tiny\+Light\+Data\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=164pt]{structSTinyLightData__coll__graph} +\includegraphics[width=171pt]{structSTinyLightData__coll__graph} \end{center} \end{figure} \subsection*{Public Attributes} diff --git a/docs/latex/structSTinyLightData__coll__graph.pdf b/docs/latex/structSTinyLightData__coll__graph.pdf index 6a9a28b5..c2eea0ae 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..841bb066 100644 --- a/docs/latex/structlist__element__.tex +++ b/docs/latex/structlist__element__.tex @@ -11,11 +11,12 @@ -Collaboration diagram for list\+\_\+element\+\_\+\+:\nopagebreak +Collaboration diagram for list\+\_\+element\+\_\+\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=200pt]{structlist__element____coll__graph} +\includegraphics[width=212pt]{structlist__element____coll__graph} \end{center} \end{figure} \subsection*{Public Attributes} diff --git a/docs/latex/structlist__element____coll__graph.pdf b/docs/latex/structlist__element____coll__graph.pdf index f523e1ab..c93d177d 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..7ab4b748 100644 --- a/docs/latex/structtiny__request__.tex +++ b/docs/latex/structtiny__request__.tex @@ -11,11 +11,12 @@ -Collaboration diagram for tiny\+\_\+request\+\_\+\+:\nopagebreak +Collaboration diagram for tiny\+\_\+request\+\_\+\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=201pt]{structtiny__request____coll__graph} +\includegraphics[width=212pt]{structtiny__request____coll__graph} \end{center} \end{figure} \subsection*{Public Attributes} diff --git a/docs/latex/structtiny__request____coll__graph.pdf b/docs/latex/structtiny__request____coll__graph.pdf index 81e676d4..ba6e48f1 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__fd_8h.tex b/docs/latex/tiny__fd_8h.tex index cf1013c4..a7b71ef3 100644 --- a/docs/latex/tiny__fd_8h.tex +++ b/docs/latex/tiny__fd_8h.tex @@ -8,18 +8,20 @@ {\ttfamily \#include $<$stdint.\+h$>$}\newline {\ttfamily \#include \char`\"{}proto/hdlc/tiny\+\_\+hdlc.\+h\char`\"{}}\newline {\ttfamily \#include \char`\"{}proto/hal/tiny\+\_\+types.\+h\char`\"{}}\newline -Include dependency graph for tiny\+\_\+fd.\+h\+:\nopagebreak +Include dependency graph for tiny\+\_\+fd.\+h\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=312pt]{tiny__fd_8h__incl} +\includegraphics[width=333pt]{tiny__fd_8h__incl} \end{center} \end{figure} -This graph shows which files directly or indirectly include this file\+:\nopagebreak +This graph shows which files directly or indirectly include this file\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=187pt]{tiny__fd_8h__dep__incl} +\includegraphics[width=198pt]{tiny__fd_8h__dep__incl} \end{center} \end{figure} \subsection*{Classes} @@ -43,8 +45,12 @@ \subsection*{Functions} \begin{DoxyCompactList}\small\item\em stops Tiny Full Duplex state machine \end{DoxyCompactList}\item int \hyperlink{group__FULL__DUPLEX__API_ga601c9874a570331580856c1ea28f7914}{tiny\+\_\+fd\+\_\+run\+\_\+tx} (\hyperlink{group__FULL__DUPLEX__API_ga91e6b79431fe38570fb102701ef0b7e8}{tiny\+\_\+fd\+\_\+handle\+\_\+t} handle, uint16\+\_\+t timeout) \begin{DoxyCompactList}\small\item\em runs tx processing for specified period of time. \end{DoxyCompactList}\item +int \hyperlink{group__FULL__DUPLEX__API_ga047059c29688cfcbfd95584e5e435ad2}{tiny\+\_\+fd\+\_\+get\+\_\+tx\+\_\+data} (\hyperlink{group__FULL__DUPLEX__API_ga91e6b79431fe38570fb102701ef0b7e8}{tiny\+\_\+fd\+\_\+handle\+\_\+t} handle, void $\ast$data, int len) +\begin{DoxyCompactList}\small\item\em runs tx processing to fill specified buffer with data. \end{DoxyCompactList}\item int \hyperlink{group__FULL__DUPLEX__API_gad31f944514aef01e27bc3ec67fdbe140}{tiny\+\_\+fd\+\_\+run\+\_\+rx} (\hyperlink{group__FULL__DUPLEX__API_ga91e6b79431fe38570fb102701ef0b7e8}{tiny\+\_\+fd\+\_\+handle\+\_\+t} handle, uint16\+\_\+t timeout) \begin{DoxyCompactList}\small\item\em runs rx processing for specified period of time. \end{DoxyCompactList}\item +int \hyperlink{group__FULL__DUPLEX__API_ga894298485a7b0901a61863ef7c2632b4}{tiny\+\_\+fd\+\_\+on\+\_\+rx\+\_\+data} (\hyperlink{group__FULL__DUPLEX__API_ga91e6b79431fe38570fb102701ef0b7e8}{tiny\+\_\+fd\+\_\+handle\+\_\+t} handle, const void $\ast$data, int len) +\begin{DoxyCompactList}\small\item\em runs rx bytes processing for specified buffer. \end{DoxyCompactList}\item int \hyperlink{group__FULL__DUPLEX__API_ga490157ee98ea6148f99a5bb1f26c5f60}{tiny\+\_\+fd\+\_\+send} (\hyperlink{group__FULL__DUPLEX__API_ga91e6b79431fe38570fb102701ef0b7e8}{tiny\+\_\+fd\+\_\+handle\+\_\+t} handle, const void $\ast$buf, int len) \begin{DoxyCompactList}\small\item\em Sends userdata over full-\/duplex protocol. \end{DoxyCompactList}\item int \hyperlink{group__FULL__DUPLEX__API_ga19789bea5b5acd68804773f0d6b0e3f7}{tiny\+\_\+fd\+\_\+buffer\+\_\+size\+\_\+by\+\_\+mtu} (int mtu, int max\+\_\+tx\+\_\+frames) diff --git a/docs/latex/tiny__fd_8h__dep__incl.pdf b/docs/latex/tiny__fd_8h__dep__incl.pdf index 7849433f..aef76830 100644 Binary files a/docs/latex/tiny__fd_8h__dep__incl.pdf and b/docs/latex/tiny__fd_8h__dep__incl.pdf differ diff --git a/docs/latex/tiny__fd_8h__incl.pdf b/docs/latex/tiny__fd_8h__incl.pdf index a0d7498e..0d14e3d6 100644 Binary files a/docs/latex/tiny__fd_8h__incl.pdf and b/docs/latex/tiny__fd_8h__incl.pdf differ diff --git a/docs/latex/tiny__hd_8h.tex b/docs/latex/tiny__hd_8h.tex index 29da12a7..5ed99e03 100644 --- a/docs/latex/tiny__hd_8h.tex +++ b/docs/latex/tiny__hd_8h.tex @@ -8,18 +8,20 @@ {\ttfamily \#include $<$stdint.\+h$>$}\newline {\ttfamily \#include \char`\"{}proto/hdlc/tiny\+\_\+hdlc.\+h\char`\"{}}\newline {\ttfamily \#include \char`\"{}proto/hal/tiny\+\_\+types.\+h\char`\"{}}\newline -Include dependency graph for tiny\+\_\+hd.\+h\+:\nopagebreak +Include dependency graph for tiny\+\_\+hd.\+h\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=311pt]{tiny__hd_8h__incl} +\includegraphics[width=332pt]{tiny__hd_8h__incl} \end{center} \end{figure} -This graph shows which files directly or indirectly include this file\+:\nopagebreak +This graph shows which files directly or indirectly include this file\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=189pt]{tiny__hd_8h__dep__incl} +\includegraphics[width=199pt]{tiny__hd_8h__dep__incl} \end{center} \end{figure} \subsection*{Classes} diff --git a/docs/latex/tiny__hd_8h__dep__incl.pdf b/docs/latex/tiny__hd_8h__dep__incl.pdf index a176095c..dfae2c11 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 99e8769b..e5e5188f 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__light_8h.tex b/docs/latex/tiny__light_8h.tex index 24ce2e17..8899412b 100644 --- a/docs/latex/tiny__light_8h.tex +++ b/docs/latex/tiny__light_8h.tex @@ -7,18 +7,20 @@ {\ttfamily \#include \char`\"{}proto/hdlc/tiny\+\_\+hdlc.\+h\char`\"{}}\newline {\ttfamily \#include \char`\"{}proto/hal/tiny\+\_\+types.\+h\char`\"{}}\newline -Include dependency graph for tiny\+\_\+light.\+h\+:\nopagebreak +Include dependency graph for tiny\+\_\+light.\+h\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=338pt]{tiny__light_8h__incl} +\includegraphics[width=350pt]{tiny__light_8h__incl} \end{center} \end{figure} -This graph shows which files directly or indirectly include this file\+:\nopagebreak +This graph shows which files directly or indirectly include this file\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=197pt]{tiny__light_8h__dep__incl} +\includegraphics[width=208pt]{tiny__light_8h__dep__incl} \end{center} \end{figure} \subsection*{Classes} diff --git a/docs/latex/tiny__light_8h__dep__incl.pdf b/docs/latex/tiny__light_8h__dep__incl.pdf index fe38e665..c677a2ae 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 0a062c76..59a4d26a 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__serial_8h.tex b/docs/latex/tiny__serial_8h.tex new file mode 100644 index 00000000..34ef23fa --- /dev/null +++ b/docs/latex/tiny__serial_8h.tex @@ -0,0 +1,169 @@ +\hypertarget{tiny__serial_8h}{}\section{src/proto/hal/tiny\+\_\+serial.h File Reference} +\label{tiny__serial_8h}\index{src/proto/hal/tiny\+\_\+serial.\+h@{src/proto/hal/tiny\+\_\+serial.\+h}} + + +Tiny U\+A\+RT serial A\+PI. + + +{\ttfamily \#include $<$stdint.\+h$>$}\newline +{\ttfamily \#include \char`\"{}serial/noplatform\+\_\+serial.\+h\char`\"{}}\newline +Include dependency graph for tiny\+\_\+serial.\+h\+: +\nopagebreak +\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[width=251pt]{tiny__serial_8h__incl} +\end{center} +\end{figure} +\subsection*{Functions} +\begin{DoxyCompactItemize} +\item +\hyperlink{win32__serial_8h_af7196cefe9f93fd4b3f69e408588ed21}{tiny\+\_\+serial\+\_\+handle\+\_\+t} \hyperlink{tiny__serial_8h_aabc11e4315d2d2fa664fe5bb666acd7f}{tiny\+\_\+serial\+\_\+open} (const char $\ast$name, uint32\+\_\+t baud) +\begin{DoxyCompactList}\small\item\em Opens serial port. \end{DoxyCompactList}\item +void \hyperlink{tiny__serial_8h_acceca82d586bc5927f0fdb445cb02363}{tiny\+\_\+serial\+\_\+close} (\hyperlink{win32__serial_8h_af7196cefe9f93fd4b3f69e408588ed21}{tiny\+\_\+serial\+\_\+handle\+\_\+t} port) +\begin{DoxyCompactList}\small\item\em Closes serial connection. \end{DoxyCompactList}\item +int \hyperlink{tiny__serial_8h_ae588ea1b6e3fda3783ed886e364e2051}{tiny\+\_\+serial\+\_\+send} (\hyperlink{win32__serial_8h_af7196cefe9f93fd4b3f69e408588ed21}{tiny\+\_\+serial\+\_\+handle\+\_\+t} port, const void $\ast$buf, int len) +\begin{DoxyCompactList}\small\item\em Sends data over serial connection. \end{DoxyCompactList}\item +int \hyperlink{tiny__serial_8h_af951caf8cb5871d8a85607f4478e5854}{tiny\+\_\+serial\+\_\+send\+\_\+timeout} (\hyperlink{win32__serial_8h_af7196cefe9f93fd4b3f69e408588ed21}{tiny\+\_\+serial\+\_\+handle\+\_\+t} port, const void $\ast$buf, int len, uint32\+\_\+t timeout\+\_\+ms) +\begin{DoxyCompactList}\small\item\em Sends data over serial connection. \end{DoxyCompactList}\item +int \hyperlink{tiny__serial_8h_a18aa3f4ae486d2c966bd2fe79ca0e3f0}{tiny\+\_\+serial\+\_\+read} (\hyperlink{win32__serial_8h_af7196cefe9f93fd4b3f69e408588ed21}{tiny\+\_\+serial\+\_\+handle\+\_\+t} port, void $\ast$buf, int len) +\begin{DoxyCompactList}\small\item\em Receive data from serial connection. \end{DoxyCompactList}\item +int \hyperlink{tiny__serial_8h_a4c995597ed592e4ded630213b7f08d37}{tiny\+\_\+serial\+\_\+read\+\_\+timeout} (\hyperlink{win32__serial_8h_af7196cefe9f93fd4b3f69e408588ed21}{tiny\+\_\+serial\+\_\+handle\+\_\+t} port, void $\ast$buf, int len, uint32\+\_\+t timeout\+\_\+ms) +\begin{DoxyCompactList}\small\item\em Receive data from serial connection. \end{DoxyCompactList}\end{DoxyCompactItemize} + + +\subsection{Detailed Description} +Tiny U\+A\+RT serial A\+PI. + +This is U\+A\+RT support implementation. + +\subsection{Function Documentation} +\mbox{\Hypertarget{tiny__serial_8h_acceca82d586bc5927f0fdb445cb02363}\label{tiny__serial_8h_acceca82d586bc5927f0fdb445cb02363}} +\index{tiny\+\_\+serial.\+h@{tiny\+\_\+serial.\+h}!tiny\+\_\+serial\+\_\+close@{tiny\+\_\+serial\+\_\+close}} +\index{tiny\+\_\+serial\+\_\+close@{tiny\+\_\+serial\+\_\+close}!tiny\+\_\+serial.\+h@{tiny\+\_\+serial.\+h}} +\subsubsection{\texorpdfstring{tiny\+\_\+serial\+\_\+close()}{tiny\_serial\_close()}} +{\footnotesize\ttfamily void tiny\+\_\+serial\+\_\+close (\begin{DoxyParamCaption}\item[{\hyperlink{win32__serial_8h_af7196cefe9f93fd4b3f69e408588ed21}{tiny\+\_\+serial\+\_\+handle\+\_\+t}}]{port }\end{DoxyParamCaption})} + + + +Closes serial connection. + +Closes serial connection +\begin{DoxyParams}{Parameters} +{\em port} & handle to serial port \\ +\hline +\end{DoxyParams} +\mbox{\Hypertarget{tiny__serial_8h_aabc11e4315d2d2fa664fe5bb666acd7f}\label{tiny__serial_8h_aabc11e4315d2d2fa664fe5bb666acd7f}} +\index{tiny\+\_\+serial.\+h@{tiny\+\_\+serial.\+h}!tiny\+\_\+serial\+\_\+open@{tiny\+\_\+serial\+\_\+open}} +\index{tiny\+\_\+serial\+\_\+open@{tiny\+\_\+serial\+\_\+open}!tiny\+\_\+serial.\+h@{tiny\+\_\+serial.\+h}} +\subsubsection{\texorpdfstring{tiny\+\_\+serial\+\_\+open()}{tiny\_serial\_open()}} +{\footnotesize\ttfamily \hyperlink{win32__serial_8h_af7196cefe9f93fd4b3f69e408588ed21}{tiny\+\_\+serial\+\_\+handle\+\_\+t} tiny\+\_\+serial\+\_\+open (\begin{DoxyParamCaption}\item[{const char $\ast$}]{name, }\item[{uint32\+\_\+t}]{baud }\end{DoxyParamCaption})} + + + +Opens serial port. + +Opens serial port by name + + +\begin{DoxyParams}{Parameters} +{\em name} & path to the port to open For linux this can be /dev/tty\+O1, /dev/tty\+S1, /dev/tty\+U\+S\+B0, etc. For windows this can be C\+O\+M1, C\+O\+M2, etc. \\ +\hline +{\em baud} & baud rate in bits \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +valid serial handle or T\+I\+N\+Y\+\_\+\+S\+E\+R\+I\+A\+L\+\_\+\+I\+N\+V\+A\+L\+ID in case of error +\end{DoxyReturn} +\mbox{\Hypertarget{tiny__serial_8h_a18aa3f4ae486d2c966bd2fe79ca0e3f0}\label{tiny__serial_8h_a18aa3f4ae486d2c966bd2fe79ca0e3f0}} +\index{tiny\+\_\+serial.\+h@{tiny\+\_\+serial.\+h}!tiny\+\_\+serial\+\_\+read@{tiny\+\_\+serial\+\_\+read}} +\index{tiny\+\_\+serial\+\_\+read@{tiny\+\_\+serial\+\_\+read}!tiny\+\_\+serial.\+h@{tiny\+\_\+serial.\+h}} +\subsubsection{\texorpdfstring{tiny\+\_\+serial\+\_\+read()}{tiny\_serial\_read()}} +{\footnotesize\ttfamily int tiny\+\_\+serial\+\_\+read (\begin{DoxyParamCaption}\item[{\hyperlink{win32__serial_8h_af7196cefe9f93fd4b3f69e408588ed21}{tiny\+\_\+serial\+\_\+handle\+\_\+t}}]{port, }\item[{void $\ast$}]{buf, }\item[{int}]{len }\end{DoxyParamCaption})} + + + +Receive data from serial connection. + +Receive data from serial connection with 100ms timeout. +\begin{DoxyParams}{Parameters} +{\em port} & handle to serial port \\ +\hline +{\em buf} & pointer to data buffer to read to \\ +\hline +{\em len} & maximum size of receive buffer \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +negative value in case of error. or number of bytes received +\end{DoxyReturn} +\mbox{\Hypertarget{tiny__serial_8h_a4c995597ed592e4ded630213b7f08d37}\label{tiny__serial_8h_a4c995597ed592e4ded630213b7f08d37}} +\index{tiny\+\_\+serial.\+h@{tiny\+\_\+serial.\+h}!tiny\+\_\+serial\+\_\+read\+\_\+timeout@{tiny\+\_\+serial\+\_\+read\+\_\+timeout}} +\index{tiny\+\_\+serial\+\_\+read\+\_\+timeout@{tiny\+\_\+serial\+\_\+read\+\_\+timeout}!tiny\+\_\+serial.\+h@{tiny\+\_\+serial.\+h}} +\subsubsection{\texorpdfstring{tiny\+\_\+serial\+\_\+read\+\_\+timeout()}{tiny\_serial\_read\_timeout()}} +{\footnotesize\ttfamily int tiny\+\_\+serial\+\_\+read\+\_\+timeout (\begin{DoxyParamCaption}\item[{\hyperlink{win32__serial_8h_af7196cefe9f93fd4b3f69e408588ed21}{tiny\+\_\+serial\+\_\+handle\+\_\+t}}]{port, }\item[{void $\ast$}]{buf, }\item[{int}]{len, }\item[{uint32\+\_\+t}]{timeout\+\_\+ms }\end{DoxyParamCaption})} + + + +Receive data from serial connection. + +Receive data from serial connection. +\begin{DoxyParams}{Parameters} +{\em port} & handle to serial port \\ +\hline +{\em buf} & pointer to data buffer to read to \\ +\hline +{\em len} & maximum size of receive buffer \\ +\hline +{\em timeout\+\_\+ms} & timeout in milliseconds to wait for incoming data \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +negative value in case of error. or number of bytes received +\end{DoxyReturn} +\mbox{\Hypertarget{tiny__serial_8h_ae588ea1b6e3fda3783ed886e364e2051}\label{tiny__serial_8h_ae588ea1b6e3fda3783ed886e364e2051}} +\index{tiny\+\_\+serial.\+h@{tiny\+\_\+serial.\+h}!tiny\+\_\+serial\+\_\+send@{tiny\+\_\+serial\+\_\+send}} +\index{tiny\+\_\+serial\+\_\+send@{tiny\+\_\+serial\+\_\+send}!tiny\+\_\+serial.\+h@{tiny\+\_\+serial.\+h}} +\subsubsection{\texorpdfstring{tiny\+\_\+serial\+\_\+send()}{tiny\_serial\_send()}} +{\footnotesize\ttfamily int tiny\+\_\+serial\+\_\+send (\begin{DoxyParamCaption}\item[{\hyperlink{win32__serial_8h_af7196cefe9f93fd4b3f69e408588ed21}{tiny\+\_\+serial\+\_\+handle\+\_\+t}}]{port, }\item[{const void $\ast$}]{buf, }\item[{int}]{len }\end{DoxyParamCaption})} + + + +Sends data over serial connection. + +Sends data over serial connection with 100 ms timeout. +\begin{DoxyParams}{Parameters} +{\em port} & handle to serial port \\ +\hline +{\em buf} & pointer to data buffer to send \\ +\hline +{\em len} & length of data to send \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +negative value in case of error. or number of bytes sent +\end{DoxyReturn} +\mbox{\Hypertarget{tiny__serial_8h_af951caf8cb5871d8a85607f4478e5854}\label{tiny__serial_8h_af951caf8cb5871d8a85607f4478e5854}} +\index{tiny\+\_\+serial.\+h@{tiny\+\_\+serial.\+h}!tiny\+\_\+serial\+\_\+send\+\_\+timeout@{tiny\+\_\+serial\+\_\+send\+\_\+timeout}} +\index{tiny\+\_\+serial\+\_\+send\+\_\+timeout@{tiny\+\_\+serial\+\_\+send\+\_\+timeout}!tiny\+\_\+serial.\+h@{tiny\+\_\+serial.\+h}} +\subsubsection{\texorpdfstring{tiny\+\_\+serial\+\_\+send\+\_\+timeout()}{tiny\_serial\_send\_timeout()}} +{\footnotesize\ttfamily int tiny\+\_\+serial\+\_\+send\+\_\+timeout (\begin{DoxyParamCaption}\item[{\hyperlink{win32__serial_8h_af7196cefe9f93fd4b3f69e408588ed21}{tiny\+\_\+serial\+\_\+handle\+\_\+t}}]{port, }\item[{const void $\ast$}]{buf, }\item[{int}]{len, }\item[{uint32\+\_\+t}]{timeout\+\_\+ms }\end{DoxyParamCaption})} + + + +Sends data over serial connection. + +Sends data over serial connection. +\begin{DoxyParams}{Parameters} +{\em port} & handle to serial port \\ +\hline +{\em buf} & pointer to data buffer to send \\ +\hline +{\em len} & length of data to send \\ +\hline +{\em timeout\+\_\+ms} & timeout in milliseconds to wait until data are sent \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +negative value in case of error. or number of bytes sent +\end{DoxyReturn} diff --git a/docs/latex/tiny__serial_8h__incl.md5 b/docs/latex/tiny__serial_8h__incl.md5 new file mode 100644 index 00000000..547324c5 --- /dev/null +++ b/docs/latex/tiny__serial_8h__incl.md5 @@ -0,0 +1 @@ +e4e57507323b45b24e231e65538e40b5 \ No newline at end of file diff --git a/docs/latex/tiny__serial_8h__incl.pdf b/docs/latex/tiny__serial_8h__incl.pdf new file mode 100644 index 00000000..61d05168 Binary files /dev/null and b/docs/latex/tiny__serial_8h__incl.pdf differ diff --git a/docs/latex/tiny__types_8h.tex b/docs/latex/tiny__types_8h.tex index 41db82f0..9ef6eb8a 100644 --- a/docs/latex/tiny__types_8h.tex +++ b/docs/latex/tiny__types_8h.tex @@ -7,14 +7,16 @@ {\ttfamily \#include \char`\"{}include/arduino\+\_\+hal.\+h\char`\"{}}\newline {\ttfamily \#include $<$stdint.\+h$>$}\newline -Include dependency graph for tiny\+\_\+types.\+h\+:\nopagebreak +Include dependency graph for tiny\+\_\+types.\+h\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode -\includegraphics[width=220pt]{tiny__types_8h__incl} +\includegraphics[width=234pt]{tiny__types_8h__incl} \end{center} \end{figure} -This graph shows which files directly or indirectly include this file\+:\nopagebreak +This graph shows which files directly or indirectly include this file\+: +\nopagebreak \begin{figure}[H] \begin{center} \leavevmode diff --git a/docs/latex/tiny__types_8h__dep__incl.md5 b/docs/latex/tiny__types_8h__dep__incl.md5 index 0af16b75..dbf2fdc4 100644 --- a/docs/latex/tiny__types_8h__dep__incl.md5 +++ b/docs/latex/tiny__types_8h__dep__incl.md5 @@ -1 +1 @@ -7760112caf73c99289b23008e19100a5 \ No newline at end of file +ae79b3a1110d4d3c54838d05a61947ba \ No newline at end of file diff --git a/docs/latex/tiny__types_8h__dep__incl.pdf b/docs/latex/tiny__types_8h__dep__incl.pdf index 50165df8..52b96011 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 c54ac943..536842c6 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/latex/win32__serial_8h.tex b/docs/latex/win32__serial_8h.tex new file mode 100644 index 00000000..95c3a214 --- /dev/null +++ b/docs/latex/win32__serial_8h.tex @@ -0,0 +1,42 @@ +\hypertarget{win32__serial_8h}{}\section{src/proto/hal/serial/win32\+\_\+serial.h File Reference} +\label{win32__serial_8h}\index{src/proto/hal/serial/win32\+\_\+serial.\+h@{src/proto/hal/serial/win32\+\_\+serial.\+h}} + + +U\+A\+RT serial A\+PI. + + +{\ttfamily \#include $<$windows.\+h$>$}\newline +Include dependency graph for win32\+\_\+serial.\+h\+: +\nopagebreak +\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[width=187pt]{win32__serial_8h__incl} +\end{center} +\end{figure} +\subsection*{Macros} +\begin{DoxyCompactItemize} +\item +\#define \hyperlink{win32__serial_8h_a522e85af073f5824b93b77225d08b90e}{T\+I\+N\+Y\+\_\+\+S\+E\+R\+I\+A\+L\+\_\+\+I\+N\+V\+A\+L\+ID}~I\+N\+V\+A\+L\+I\+D\+\_\+\+H\+A\+N\+D\+L\+E\+\_\+\+V\+A\+L\+UE +\end{DoxyCompactItemize} +\subsection*{Typedefs} +\begin{DoxyCompactItemize} +\item +\mbox{\Hypertarget{win32__serial_8h_af7196cefe9f93fd4b3f69e408588ed21}\label{win32__serial_8h_af7196cefe9f93fd4b3f69e408588ed21}} +typedef H\+A\+N\+D\+LE \hyperlink{win32__serial_8h_af7196cefe9f93fd4b3f69e408588ed21}{tiny\+\_\+serial\+\_\+handle\+\_\+t} +\begin{DoxyCompactList}\small\item\em Unique port handle. \end{DoxyCompactList}\end{DoxyCompactItemize} + + +\subsection{Detailed Description} +U\+A\+RT serial A\+PI. + +This is U\+A\+RT support implementation. + +\subsection{Macro Definition Documentation} +\mbox{\Hypertarget{win32__serial_8h_a522e85af073f5824b93b77225d08b90e}\label{win32__serial_8h_a522e85af073f5824b93b77225d08b90e}} +\index{win32\+\_\+serial.\+h@{win32\+\_\+serial.\+h}!T\+I\+N\+Y\+\_\+\+S\+E\+R\+I\+A\+L\+\_\+\+I\+N\+V\+A\+L\+ID@{T\+I\+N\+Y\+\_\+\+S\+E\+R\+I\+A\+L\+\_\+\+I\+N\+V\+A\+L\+ID}} +\index{T\+I\+N\+Y\+\_\+\+S\+E\+R\+I\+A\+L\+\_\+\+I\+N\+V\+A\+L\+ID@{T\+I\+N\+Y\+\_\+\+S\+E\+R\+I\+A\+L\+\_\+\+I\+N\+V\+A\+L\+ID}!win32\+\_\+serial.\+h@{win32\+\_\+serial.\+h}} +\subsubsection{\texorpdfstring{T\+I\+N\+Y\+\_\+\+S\+E\+R\+I\+A\+L\+\_\+\+I\+N\+V\+A\+L\+ID}{TINY\_SERIAL\_INVALID}} +{\footnotesize\ttfamily \#define T\+I\+N\+Y\+\_\+\+S\+E\+R\+I\+A\+L\+\_\+\+I\+N\+V\+A\+L\+ID~I\+N\+V\+A\+L\+I\+D\+\_\+\+H\+A\+N\+D\+L\+E\+\_\+\+V\+A\+L\+UE} + +Invalid serial handle definition \ No newline at end of file diff --git a/docs/latex/win32__serial_8h__incl.md5 b/docs/latex/win32__serial_8h__incl.md5 new file mode 100644 index 00000000..a621469e --- /dev/null +++ b/docs/latex/win32__serial_8h__incl.md5 @@ -0,0 +1 @@ +77b4c71da3328ef04ae5b66519e0d72e \ No newline at end of file diff --git a/docs/latex/win32__serial_8h__incl.pdf b/docs/latex/win32__serial_8h__incl.pdf new file mode 100644 index 00000000..a1b3a13e Binary files /dev/null and b/docs/latex/win32__serial_8h__incl.pdf differ diff --git a/docs/linux__hal_8h_source.html b/docs/linux__hal_8h_source.html index db2ff745..84ebb2ce 100644 --- a/docs/linux__hal_8h_source.html +++ b/docs/linux__hal_8h_source.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    diff --git a/docs/linux__serial_8h_source.html b/docs/linux__serial_8h_source.html new file mode 100644 index 00000000..a15190bd --- /dev/null +++ b/docs/linux__serial_8h_source.html @@ -0,0 +1,80 @@ + + + + + + + +Tiny protocol: src/proto/hal/serial/linux_serial.h Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    Tiny protocol +  0.11.0 +
    +
    Tiny communication protocol for microcontrollers
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    linux_serial.h
    +
    +
    +
    1 /*
    2  Copyright 2017,2020 (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 #ifdef __cplusplus
    23 extern "C" {
    24 #endif
    25 
    26 #include <stdint.h>
    27 
    29 typedef int tiny_serial_handle_t;
    30 
    32 #define TINY_SERIAL_INVALID (-1)
    33 
    34 #ifdef __cplusplus
    35 }
    36 #endif
    tiny_serial_handle_t
    HANDLE tiny_serial_handle_t
    Unique port handle.
    Definition: win32_serial.h:35
    +
    + +
    +Generated by   +doxygen + 1.8.13 +
    + + diff --git a/docs/mainpage_8dox.html b/docs/mainpage_8dox.html index e18e3ef1..68272986 100644 --- a/docs/mainpage_8dox.html +++ b/docs/mainpage_8dox.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    diff --git a/docs/mingw32__hal_8h_source.html b/docs/mingw32__hal_8h_source.html index 638ed721..3b2e0011 100644 --- a/docs/mingw32__hal_8h_source.html +++ b/docs/mingw32__hal_8h_source.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    diff --git a/docs/modules.html b/docs/modules.html index aecb4ed0..e6ae5dda 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    diff --git a/docs/no__platform__hal_8h_source.html b/docs/no__platform__hal_8h_source.html index e8262d4c..abd9c59f 100644 --- a/docs/no__platform__hal_8h_source.html +++ b/docs/no__platform__hal_8h_source.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    diff --git a/docs/noplatform__serial_8h_source.html b/docs/noplatform__serial_8h_source.html new file mode 100644 index 00000000..2301ce07 --- /dev/null +++ b/docs/noplatform__serial_8h_source.html @@ -0,0 +1,80 @@ + + + + + + + +Tiny protocol: src/proto/hal/serial/noplatform_serial.h Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    Tiny protocol +  0.11.0 +
    +
    Tiny communication protocol for microcontrollers
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    noplatform_serial.h
    +
    +
    +
    1 /*
    2  Copyright 2017,2020 (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 #ifdef __cplusplus
    23 extern "C" {
    24 #endif
    25 
    26 #include <stdint.h>
    27 
    29 typedef int tiny_serial_handle_t;
    30 
    32 #define TINY_SERIAL_INVALID (-1)
    33 
    34 #ifdef __cplusplus
    35 }
    36 #endif
    tiny_serial_handle_t
    HANDLE tiny_serial_handle_t
    Unique port handle.
    Definition: win32_serial.h:35
    +
    + +
    +Generated by   +doxygen + 1.8.13 +
    + + diff --git a/docs/pages.html b/docs/pages.html index c42e20f5..7a7a6ba8 100644 --- a/docs/pages.html +++ b/docs/pages.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    diff --git a/docs/search/all_10.js b/docs/search/all_10.js index a810a92d..c808b370 100644 --- a/docs/search/all_10.js +++ b/docs/search/all_10.js @@ -23,10 +23,12 @@ var searchData= ['tiny_5ffd_2eh',['tiny_fd.h',['../tiny__fd_8h.html',1,'']]], ['tiny_5ffd_5fbuffer_5fsize_5fby_5fmtu',['tiny_fd_buffer_size_by_mtu',['../group__FULL__DUPLEX__API.html#ga19789bea5b5acd68804773f0d6b0e3f7',1,'tiny_fd_buffer_size_by_mtu(int mtu, int window_frames): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#ga19789bea5b5acd68804773f0d6b0e3f7',1,'tiny_fd_buffer_size_by_mtu(int mtu, int max_tx_frames): tiny_fd.c']]], ['tiny_5ffd_5fclose',['tiny_fd_close',['../group__FULL__DUPLEX__API.html#ga11e470503e3359bc29a5bcb65a9771d5',1,'tiny_fd_close(tiny_fd_handle_t handle): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#ga11e470503e3359bc29a5bcb65a9771d5',1,'tiny_fd_close(tiny_fd_handle_t handle): tiny_fd.c']]], + ['tiny_5ffd_5fget_5ftx_5fdata',['tiny_fd_get_tx_data',['../group__FULL__DUPLEX__API.html#ga047059c29688cfcbfd95584e5e435ad2',1,'tiny_fd_get_tx_data(tiny_fd_handle_t handle, void *data, int len): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#ga047059c29688cfcbfd95584e5e435ad2',1,'tiny_fd_get_tx_data(tiny_fd_handle_t handle, void *data, int len): tiny_fd.c']]], ['tiny_5ffd_5fhandle_5ft',['tiny_fd_handle_t',['../group__FULL__DUPLEX__API.html#ga91e6b79431fe38570fb102701ef0b7e8',1,'tiny_fd.h']]], ['tiny_5ffd_5finit',['tiny_fd_init',['../group__FULL__DUPLEX__API.html#ga27fa59dffd1575419753beb35282bad5',1,'tiny_fd_init(tiny_fd_handle_t *handle, tiny_fd_init_t *init): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#ga27fa59dffd1575419753beb35282bad5',1,'tiny_fd_init(tiny_fd_handle_t *handle, tiny_fd_init_t *init): tiny_fd.c']]], ['tiny_5ffd_5finit_5ft',['tiny_fd_init_t',['../group__FULL__DUPLEX__API.html#gad19ac27f4ba1d2b807e0a440b0c927d2',1,'tiny_fd.h']]], ['tiny_5ffd_5finit_5ft_5f',['tiny_fd_init_t_',['../structtiny__fd__init__t__.html',1,'']]], + ['tiny_5ffd_5fon_5frx_5fdata',['tiny_fd_on_rx_data',['../group__FULL__DUPLEX__API.html#ga894298485a7b0901a61863ef7c2632b4',1,'tiny_fd_on_rx_data(tiny_fd_handle_t handle, const void *data, int len): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#ga894298485a7b0901a61863ef7c2632b4',1,'tiny_fd_on_rx_data(tiny_fd_handle_t handle, const void *data, int len): tiny_fd.c']]], ['tiny_5ffd_5frun_5frx',['tiny_fd_run_rx',['../group__FULL__DUPLEX__API.html#gad31f944514aef01e27bc3ec67fdbe140',1,'tiny_fd_run_rx(tiny_fd_handle_t handle, uint16_t timeout): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#gad31f944514aef01e27bc3ec67fdbe140',1,'tiny_fd_run_rx(tiny_fd_handle_t handle, uint16_t timeout): tiny_fd.c']]], ['tiny_5ffd_5frun_5ftx',['tiny_fd_run_tx',['../group__FULL__DUPLEX__API.html#ga601c9874a570331580856c1ea28f7914',1,'tiny_fd_run_tx(tiny_fd_handle_t handle, uint16_t timeout): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#ga601c9874a570331580856c1ea28f7914',1,'tiny_fd_run_tx(tiny_fd_handle_t handle, uint16_t timeout): tiny_fd.c']]], ['tiny_5ffd_5fsend',['tiny_fd_send',['../group__FULL__DUPLEX__API.html#ga490157ee98ea6148f99a5bb1f26c5f60',1,'tiny_fd_send(tiny_fd_handle_t handle, const void *data, int len): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#ga490157ee98ea6148f99a5bb1f26c5f60',1,'tiny_fd_send(tiny_fd_handle_t handle, const void *buf, int len): tiny_fd.c']]], @@ -55,6 +57,15 @@ var searchData= ['tiny_5fmutex_5funlock',['tiny_mutex_unlock',['../tiny__types_8h.html#aef1ccb057b482b334079565a0e75eb6c',1,'tiny_types.h']]], ['tiny_5frequest_5f',['tiny_request_',['../structtiny__request__.html',1,'']]], ['tiny_5fsend_5fwait_5fack',['tiny_send_wait_ack',['../group__HALF__DUPLEX__API.html#ga5aad8dcb504b80bac923496f2686a6d6',1,'tiny_send_wait_ack(STinyHdData *handle, void *buf, uint16_t len): tiny_hd.c'],['../group__HALF__DUPLEX__API.html#ga5aad8dcb504b80bac923496f2686a6d6',1,'tiny_send_wait_ack(STinyHdData *handle, void *buf, uint16_t len): tiny_hd.c']]], + ['tiny_5fserial_2eh',['tiny_serial.h',['../tiny__serial_8h.html',1,'']]], + ['tiny_5fserial_5fclose',['tiny_serial_close',['../tiny__serial_8h.html#acceca82d586bc5927f0fdb445cb02363',1,'tiny_serial.h']]], + ['tiny_5fserial_5fhandle_5ft',['tiny_serial_handle_t',['../win32__serial_8h.html#af7196cefe9f93fd4b3f69e408588ed21',1,'win32_serial.h']]], + ['tiny_5fserial_5finvalid',['TINY_SERIAL_INVALID',['../win32__serial_8h.html#a522e85af073f5824b93b77225d08b90e',1,'win32_serial.h']]], + ['tiny_5fserial_5fopen',['tiny_serial_open',['../tiny__serial_8h.html#aabc11e4315d2d2fa664fe5bb666acd7f',1,'tiny_serial.h']]], + ['tiny_5fserial_5fread',['tiny_serial_read',['../tiny__serial_8h.html#a18aa3f4ae486d2c966bd2fe79ca0e3f0',1,'tiny_serial.h']]], + ['tiny_5fserial_5fread_5ftimeout',['tiny_serial_read_timeout',['../tiny__serial_8h.html#a4c995597ed592e4ded630213b7f08d37',1,'tiny_serial.h']]], + ['tiny_5fserial_5fsend',['tiny_serial_send',['../tiny__serial_8h.html#ae588ea1b6e3fda3783ed886e364e2051',1,'tiny_serial.h']]], + ['tiny_5fserial_5fsend_5ftimeout',['tiny_serial_send_timeout',['../tiny__serial_8h.html#af951caf8cb5871d8a85607f4478e5854',1,'tiny_serial.h']]], ['tiny_5fsleep',['tiny_sleep',['../tiny__types_8h.html#ae024e04660c8b9a9a231965f7aee5112',1,'tiny_types.h']]], ['tiny_5fsuccess',['TINY_SUCCESS',['../group__ERROR__FLAGS.html#ga16cd043c890ed1fa381b3a20f75a626c',1,'tiny_types.h']]], ['tiny_5ftypes_2eh',['tiny_types.h',['../tiny__types_8h.html',1,'']]], @@ -62,5 +73,6 @@ var searchData= ['tinypacket_2eh',['TinyPacket.h',['../TinyPacket_8h.html',1,'']]], ['tinyprotocol_2eh',['TinyProtocol.h',['../TinyProtocol_8h.html',1,'']]], ['tinyprotocolfd_2eh',['TinyProtocolFd.h',['../TinyProtocolFd_8h.html',1,'']]], - ['tinyprotocolhd_2eh',['TinyProtocolHd.h',['../TinyProtocolHd_8h.html',1,'']]] + ['tinyprotocolhd_2eh',['TinyProtocolHd.h',['../TinyProtocolHd_8h.html',1,'']]], + ['tinyprotocolhdlc_2eh',['TinyProtocolHdlc.h',['../TinyProtocolHdlc_8h.html',1,'']]] ]; diff --git a/docs/search/all_12.js b/docs/search/all_12.js index 10312b6f..92393b8c 100644 --- a/docs/search/all_12.js +++ b/docs/search/all_12.js @@ -1,7 +1,8 @@ var searchData= [ + ['win32_5fserial_2eh',['win32_serial.h',['../win32__serial_8h.html',1,'']]], ['window_5fframes',['window_frames',['../structtiny__fd__init__t__.html#ae4da012c3e39c4e7dda587191b4c2f77',1,'tiny_fd_init_t_']]], - ['write',['write',['../classTiny_1_1ProtoLight.html#a46a27ee9d0b55c88672c98abf04dbdce',1,'Tiny::ProtoLight::write(char *buf, int size)'],['../classTiny_1_1ProtoLight.html#ad980940fd5eca35204a70a5cfe5ccccd',1,'Tiny::ProtoLight::write(IPacket &pkt)'],['../classTiny_1_1IProtoFd.html#adea59df6702e16fd986a91c7ee62012a',1,'Tiny::IProtoFd::write(char *buf, int size)'],['../classTiny_1_1IProtoFd.html#aa822a1dec320e6edc70a84699371fe81',1,'Tiny::IProtoFd::write(IPacket &pkt)'],['../classTiny_1_1ProtoHd.html#af53c8817317d3a62535e68ca236a038f',1,'Tiny::ProtoHd::write(char *buf, int size)'],['../classTiny_1_1ProtoHd.html#a1f4e0864f08191bfc66dce68b339250f',1,'Tiny::ProtoHd::write(IPacket &pkt)']]], + ['write',['write',['../classTiny_1_1ProtoLight.html#a46a27ee9d0b55c88672c98abf04dbdce',1,'Tiny::ProtoLight::write(char *buf, int size)'],['../classTiny_1_1ProtoLight.html#ad980940fd5eca35204a70a5cfe5ccccd',1,'Tiny::ProtoLight::write(IPacket &pkt)'],['../classTiny_1_1IProtoFd.html#adea59df6702e16fd986a91c7ee62012a',1,'Tiny::IProtoFd::write(char *buf, int size)'],['../classTiny_1_1IProtoFd.html#aa822a1dec320e6edc70a84699371fe81',1,'Tiny::IProtoFd::write(IPacket &pkt)'],['../classTiny_1_1ProtoHd.html#af53c8817317d3a62535e68ca236a038f',1,'Tiny::ProtoHd::write(char *buf, int size)'],['../classTiny_1_1ProtoHd.html#a1f4e0864f08191bfc66dce68b339250f',1,'Tiny::ProtoHd::write(IPacket &pkt)'],['../classTiny_1_1ProtoHdlc.html#ae79c01f1c3614f0f382e8d8bf847b567',1,'Tiny::ProtoHdlc::write(char *buf, int size)'],['../classTiny_1_1ProtoHdlc.html#a3d02f2589397fb4a0e5be24a44321f9b',1,'Tiny::ProtoHdlc::write(IPacket &pkt)']]], ['write_5fblock_5fcb_5ft',['write_block_cb_t',['../tiny__types_8h.html#aafd634660bba76cace57a8f9b01e044d',1,'tiny_types.h']]], ['write_5ffunc',['write_func',['../structtiny__fd__init__t__.html#a09606a8bdc239aeb3744a63f48585844',1,'tiny_fd_init_t_::write_func()'],['../structSTinyHdData__.html#a38e79c64fc438348421c3dac60349cbe',1,'STinyHdData_::write_func()'],['../structSTinyHdInit__.html#a0bd05a4fc43236ff37d67aec4d2a0952',1,'STinyHdInit_::write_func()'],['../structSTinyLightData.html#a0bd1b1a01e1eaa15f22dec1e886c2e3c',1,'STinyLightData::write_func()']]] ]; diff --git a/docs/search/all_2.js b/docs/search/all_2.js index 92f06c05..15bed08e 100644 --- a/docs/search/all_2.js +++ b/docs/search/all_2.js @@ -1,10 +1,10 @@ var searchData= [ - ['begin',['begin',['../classTiny_1_1ProtoLight.html#ad27dfcef54a8316228469ef0a4267962',1,'Tiny::ProtoLight::begin()'],['../classTiny_1_1IProtoFd.html#aae4e613316866105c130d613ecb25dd4',1,'Tiny::IProtoFd::begin()'],['../classTiny_1_1ProtoHd.html#a112ae02531837a852af7ca3c9a32a7eb',1,'Tiny::ProtoHd::begin()']]], - ['begintoserial',['beginToSerial',['../classTiny_1_1ProtoLight.html#a50bf63fe1891edda48980ca2893485d7',1,'Tiny::ProtoLight::beginToSerial()'],['../classTiny_1_1IProtoFd.html#a1cf42b4182e49dcde4862a768d07c811',1,'Tiny::IProtoFd::beginToSerial()'],['../classTiny_1_1ProtoHd.html#a0e88ac5b3c67ca67c566742c22180050',1,'Tiny::ProtoHd::beginToSerial()']]], - ['begintoserial1',['beginToSerial1',['../classTiny_1_1ProtoLight.html#a4de4d11cc7f68dcefa5ca1357e6dfc35',1,'Tiny::ProtoLight::beginToSerial1()'],['../classTiny_1_1IProtoFd.html#a7d41a0caae1d5e6808a441c821ed8927',1,'Tiny::IProtoFd::beginToSerial1()'],['../classTiny_1_1ProtoHd.html#a1b2975217b0523c3de4b534644cfa501',1,'Tiny::ProtoHd::beginToSerial1()']]], - ['begintoserial2',['beginToSerial2',['../classTiny_1_1ProtoLight.html#a40a4d002f53c842b1a3577a8a9c8eebb',1,'Tiny::ProtoLight::beginToSerial2()'],['../classTiny_1_1IProtoFd.html#ae7582aca0fa5472da6f4ae2911d56259',1,'Tiny::IProtoFd::beginToSerial2()'],['../classTiny_1_1ProtoHd.html#a450fc792e515ffd150072988bc632c9e',1,'Tiny::ProtoHd::beginToSerial2()']]], - ['begintoserial3',['beginToSerial3',['../classTiny_1_1IProtoFd.html#a2d4df949358d4e8afa391e8960729d71',1,'Tiny::IProtoFd::beginToSerial3()'],['../classTiny_1_1ProtoHd.html#acd6519f6652c279b3a3b98aabbaeed65',1,'Tiny::ProtoHd::beginToSerial3()']]], + ['begin',['begin',['../classTiny_1_1ProtoLight.html#ad27dfcef54a8316228469ef0a4267962',1,'Tiny::ProtoLight::begin()'],['../classTiny_1_1IProtoFd.html#aae4e613316866105c130d613ecb25dd4',1,'Tiny::IProtoFd::begin(write_block_cb_t writecb, read_block_cb_t readcb)'],['../classTiny_1_1IProtoFd.html#a33f836591bf981b484d495d678d02442',1,'Tiny::IProtoFd::begin()'],['../classTiny_1_1ProtoHd.html#a112ae02531837a852af7ca3c9a32a7eb',1,'Tiny::ProtoHd::begin()'],['../classTiny_1_1ProtoHdlc.html#acdc849f66b9f9a51d8930552ade56324',1,'Tiny::ProtoHdlc::begin(write_block_cb_t writecb, read_block_cb_t readcb)'],['../classTiny_1_1ProtoHdlc.html#aaaca3c70444d6a5f20e7e1fef492e99b',1,'Tiny::ProtoHdlc::begin()']]], + ['begintoserial',['beginToSerial',['../classTiny_1_1ProtoLight.html#a50bf63fe1891edda48980ca2893485d7',1,'Tiny::ProtoLight::beginToSerial()'],['../classTiny_1_1IProtoFd.html#a1cf42b4182e49dcde4862a768d07c811',1,'Tiny::IProtoFd::beginToSerial()'],['../classTiny_1_1ProtoHd.html#a0e88ac5b3c67ca67c566742c22180050',1,'Tiny::ProtoHd::beginToSerial()'],['../classTiny_1_1ProtoHdlc.html#a8a54409e420954d93ada44ad0710740e',1,'Tiny::ProtoHdlc::beginToSerial()']]], + ['begintoserial1',['beginToSerial1',['../classTiny_1_1ProtoLight.html#a4de4d11cc7f68dcefa5ca1357e6dfc35',1,'Tiny::ProtoLight::beginToSerial1()'],['../classTiny_1_1IProtoFd.html#a7d41a0caae1d5e6808a441c821ed8927',1,'Tiny::IProtoFd::beginToSerial1()'],['../classTiny_1_1ProtoHd.html#a1b2975217b0523c3de4b534644cfa501',1,'Tiny::ProtoHd::beginToSerial1()'],['../classTiny_1_1ProtoHdlc.html#aadaf2dbaad53bba682d37e0650585491',1,'Tiny::ProtoHdlc::beginToSerial1()']]], + ['begintoserial2',['beginToSerial2',['../classTiny_1_1ProtoLight.html#a40a4d002f53c842b1a3577a8a9c8eebb',1,'Tiny::ProtoLight::beginToSerial2()'],['../classTiny_1_1IProtoFd.html#ae7582aca0fa5472da6f4ae2911d56259',1,'Tiny::IProtoFd::beginToSerial2()'],['../classTiny_1_1ProtoHd.html#a450fc792e515ffd150072988bc632c9e',1,'Tiny::ProtoHd::beginToSerial2()'],['../classTiny_1_1ProtoHdlc.html#aed9903c8e65495e0260b4095113ee641',1,'Tiny::ProtoHdlc::beginToSerial2()']]], + ['begintoserial3',['beginToSerial3',['../classTiny_1_1IProtoFd.html#a2d4df949358d4e8afa391e8960729d71',1,'Tiny::IProtoFd::beginToSerial3()'],['../classTiny_1_1ProtoHd.html#acd6519f6652c279b3a3b98aabbaeed65',1,'Tiny::ProtoHd::beginToSerial3()'],['../classTiny_1_1ProtoHdlc.html#a1c895863c008b9dbd4316ae10c6e4ea0',1,'Tiny::ProtoHdlc::beginToSerial3()']]], ['buffer',['buffer',['../structtiny__fd__init__t__.html#a9a82b8c6c060dbc17022a0c902d436f2',1,'tiny_fd_init_t_']]], ['buffer_5fsize',['buffer_size',['../structtiny__fd__init__t__.html#af76a7f851dc110e5c3f506f66ae91320',1,'tiny_fd_init_t_']]], ['bytesreceived',['bytesReceived',['../structSTinyStats.html#ab58c342d0fc862c193bff6f71dc725ac',1,'STinyStats']]], diff --git a/docs/search/all_4.js b/docs/search/all_4.js index de28d52b..45804fb8 100644 --- a/docs/search/all_4.js +++ b/docs/search/all_4.js @@ -1,5 +1,5 @@ var searchData= [ ['data',['data',['../classTiny_1_1IPacket.html#aedf2ba31c5a29e3829458bd9f03a7051',1,'Tiny::IPacket']]], - ['disablecrc',['disableCrc',['../classTiny_1_1ProtoLight.html#af93e0591ca33137ad79ffb054953001c',1,'Tiny::ProtoLight::disableCrc()'],['../classTiny_1_1IProtoFd.html#af41446f47a7c520ff8f9683e6ae45614',1,'Tiny::IProtoFd::disableCrc()'],['../classTiny_1_1ProtoHd.html#ae90a0a40de0b71a015f7f7f940440fa0',1,'Tiny::ProtoHd::disableCrc()']]] + ['disablecrc',['disableCrc',['../classTiny_1_1ProtoLight.html#af93e0591ca33137ad79ffb054953001c',1,'Tiny::ProtoLight::disableCrc()'],['../classTiny_1_1IProtoFd.html#af41446f47a7c520ff8f9683e6ae45614',1,'Tiny::IProtoFd::disableCrc()'],['../classTiny_1_1ProtoHd.html#ae90a0a40de0b71a015f7f7f940440fa0',1,'Tiny::ProtoHd::disableCrc()'],['../classTiny_1_1ProtoHdlc.html#a37506cfddcc0e1ed9a2ed697f4860b98',1,'Tiny::ProtoHdlc::disableCrc()']]] ]; diff --git a/docs/search/all_5.js b/docs/search/all_5.js index f74f6b14..07f20284 100644 --- a/docs/search/all_5.js +++ b/docs/search/all_5.js @@ -1,11 +1,11 @@ var searchData= [ ['element',['element',['../structtiny__request__.html#a02c8fb6d26d0cfb0264423a1cb643159',1,'tiny_request_']]], - ['enablechecksum',['enableCheckSum',['../classTiny_1_1ProtoLight.html#ad7b4ef5a43c187f0d1915efe7450bc40',1,'Tiny::ProtoLight::enableCheckSum()'],['../classTiny_1_1IProtoFd.html#a0f43402e86ea64f5c0154477d84b0c7c',1,'Tiny::IProtoFd::enableCheckSum()'],['../classTiny_1_1ProtoHd.html#ace4e6b993532b3eb47d025b8db94192d',1,'Tiny::ProtoHd::enableCheckSum()']]], - ['enablecrc',['enableCrc',['../classTiny_1_1ProtoLight.html#a5232e938a70c64eb7fbb8908509cd3fa',1,'Tiny::ProtoLight::enableCrc()'],['../classTiny_1_1IProtoFd.html#a7dec2906051505034e91b503318a5563',1,'Tiny::IProtoFd::enableCrc()']]], - ['enablecrc16',['enableCrc16',['../classTiny_1_1ProtoLight.html#a110b654e476691518790edcc5bf1bd80',1,'Tiny::ProtoLight::enableCrc16()'],['../classTiny_1_1IProtoFd.html#a8b57afdb66434aa35409af34b04e1db9',1,'Tiny::IProtoFd::enableCrc16()'],['../classTiny_1_1ProtoHd.html#a0887adedc93b7538dbaef3fc8e0b2819',1,'Tiny::ProtoHd::enableCrc16()']]], - ['enablecrc32',['enableCrc32',['../classTiny_1_1ProtoLight.html#a8ae8a3ace46234a65f83c564dc56fd26',1,'Tiny::ProtoLight::enableCrc32()'],['../classTiny_1_1IProtoFd.html#a1bf1f5211ae3a49caf73ee3de3bb9247',1,'Tiny::IProtoFd::enableCrc32()'],['../classTiny_1_1ProtoHd.html#a4110a0112548d5e47d312d190930ad20',1,'Tiny::ProtoHd::enableCrc32()']]], - ['end',['end',['../classTiny_1_1ProtoLight.html#a948b2a0e37177b7434581adc64b36497',1,'Tiny::ProtoLight::end()'],['../classTiny_1_1IProtoFd.html#ad17e76d0ef7ea40838e51acc2498c482',1,'Tiny::IProtoFd::end()'],['../classTiny_1_1ProtoHd.html#ac87bf8264895b654025001a0e6014f3f',1,'Tiny::ProtoHd::end()']]], + ['enablechecksum',['enableCheckSum',['../classTiny_1_1ProtoLight.html#ad7b4ef5a43c187f0d1915efe7450bc40',1,'Tiny::ProtoLight::enableCheckSum()'],['../classTiny_1_1IProtoFd.html#a0f43402e86ea64f5c0154477d84b0c7c',1,'Tiny::IProtoFd::enableCheckSum()'],['../classTiny_1_1ProtoHd.html#ace4e6b993532b3eb47d025b8db94192d',1,'Tiny::ProtoHd::enableCheckSum()'],['../classTiny_1_1ProtoHdlc.html#a3c9ed356b3d6dd4496b1655a0704e890',1,'Tiny::ProtoHdlc::enableCheckSum()']]], + ['enablecrc',['enableCrc',['../classTiny_1_1ProtoLight.html#a5232e938a70c64eb7fbb8908509cd3fa',1,'Tiny::ProtoLight::enableCrc()'],['../classTiny_1_1IProtoFd.html#a7dec2906051505034e91b503318a5563',1,'Tiny::IProtoFd::enableCrc()'],['../classTiny_1_1ProtoHdlc.html#a84e93210f940385a9408419ed605c8e5',1,'Tiny::ProtoHdlc::enableCrc()']]], + ['enablecrc16',['enableCrc16',['../classTiny_1_1ProtoLight.html#a110b654e476691518790edcc5bf1bd80',1,'Tiny::ProtoLight::enableCrc16()'],['../classTiny_1_1IProtoFd.html#a8b57afdb66434aa35409af34b04e1db9',1,'Tiny::IProtoFd::enableCrc16()'],['../classTiny_1_1ProtoHd.html#a0887adedc93b7538dbaef3fc8e0b2819',1,'Tiny::ProtoHd::enableCrc16()'],['../classTiny_1_1ProtoHdlc.html#a693fb4301071e0b2d3bfd818265f22c6',1,'Tiny::ProtoHdlc::enableCrc16()']]], + ['enablecrc32',['enableCrc32',['../classTiny_1_1ProtoLight.html#a8ae8a3ace46234a65f83c564dc56fd26',1,'Tiny::ProtoLight::enableCrc32()'],['../classTiny_1_1IProtoFd.html#a1bf1f5211ae3a49caf73ee3de3bb9247',1,'Tiny::IProtoFd::enableCrc32()'],['../classTiny_1_1ProtoHd.html#a4110a0112548d5e47d312d190930ad20',1,'Tiny::ProtoHd::enableCrc32()'],['../classTiny_1_1ProtoHdlc.html#a2f0b1557415ea384e7b1279c3618d4c0',1,'Tiny::ProtoHdlc::enableCrc32()']]], + ['end',['end',['../classTiny_1_1ProtoLight.html#a948b2a0e37177b7434581adc64b36497',1,'Tiny::ProtoLight::end()'],['../classTiny_1_1IProtoFd.html#ad17e76d0ef7ea40838e51acc2498c482',1,'Tiny::IProtoFd::end()'],['../classTiny_1_1ProtoHd.html#ac87bf8264895b654025001a0e6014f3f',1,'Tiny::ProtoHd::end()'],['../classTiny_1_1ProtoHdlc.html#ad4b84cbcd33d65e7df73321a0c19c420',1,'Tiny::ProtoHdlc::end()']]], ['event_5fbis_5fall',['EVENT_BIS_ALL',['../tiny__types_8h.html#a27b8fac677976106d127489aed30c6ea',1,'tiny_types.h']]], ['event_5fbits_5fclear',['EVENT_BITS_CLEAR',['../tiny__types_8h.html#ad1077ed0be1ef067bb34790e17829eff',1,'tiny_types.h']]], ['event_5fbits_5fleave',['EVENT_BITS_LEAVE',['../tiny__types_8h.html#aa5326a270b651a7a0d23e219e63de174',1,'tiny_types.h']]] diff --git a/docs/search/all_8.js b/docs/search/all_8.js index e2dbe237..d408f50d 100644 --- a/docs/search/all_8.js +++ b/docs/search/all_8.js @@ -7,6 +7,7 @@ var searchData= ['hdlc_5fcrc_5fdefault',['HDLC_CRC_DEFAULT',['../group__HDLC__API.html#ggabb73b32d08d8e79eefe9385634a74bf7a5f34a095f94c39357e31badd2feb9426',1,'tiny_hdlc.h']]], ['hdlc_5fcrc_5foff',['HDLC_CRC_OFF',['../group__HDLC__API.html#ggabb73b32d08d8e79eefe9385634a74bf7a6ed874f871614e9de6358d678256a140',1,'tiny_hdlc.h']]], ['hdlc_5fcrc_5ft',['hdlc_crc_t',['../group__HDLC__API.html#gabb73b32d08d8e79eefe9385634a74bf7',1,'tiny_hdlc.h']]], + ['hdlc_5fget_5ftx_5fdata',['hdlc_get_tx_data',['../group__HDLC__API.html#gaaeece06ea6894a19402f76158e1d101d',1,'hdlc_get_tx_data(hdlc_handle_t handle, void *data, int len): tiny_hdlc.c'],['../group__HDLC__API.html#gaaeece06ea6894a19402f76158e1d101d',1,'hdlc_get_tx_data(hdlc_handle_t handle, void *data, int len): tiny_hdlc.c']]], ['hdlc_5fhandle_5ft',['hdlc_handle_t',['../group__HDLC__API.html#gabeaf7578aed5279d3af891bd85a9f961',1,'tiny_hdlc.h']]], ['hdlc_5finit',['hdlc_init',['../group__HDLC__API.html#gaa41c388433273a76460ddfbaff0f8f5d',1,'hdlc_init(hdlc_struct_t *hdlc_info): tiny_hdlc.c'],['../group__HDLC__API.html#gaa41c388433273a76460ddfbaff0f8f5d',1,'hdlc_init(hdlc_struct_t *hdlc_info): tiny_hdlc.c']]], ['hdlc_5freset',['hdlc_reset',['../group__HDLC__API.html#ga532836280097de1c8881df8336f21075',1,'hdlc_reset(hdlc_handle_t handle): tiny_hdlc.c'],['../group__HDLC__API.html#ga532836280097de1c8881df8336f21075',1,'hdlc_reset(hdlc_handle_t handle): tiny_hdlc.c']]], diff --git a/docs/search/all_c.js b/docs/search/all_c.js index 7d181d71..c22489bd 100644 --- a/docs/search/all_c.js +++ b/docs/search/all_c.js @@ -5,8 +5,8 @@ var searchData= ['on_5fframe_5fread',['on_frame_read',['../struct__hdlc__handle__t.html#a751872adfef39b5b1325fa8826bae689',1,'_hdlc_handle_t']]], ['on_5fframe_5fsent',['on_frame_sent',['../struct__hdlc__handle__t.html#a9aba360df83395af01ff448bca03e259',1,'_hdlc_handle_t']]], ['on_5fsent_5fcb',['on_sent_cb',['../structtiny__fd__init__t__.html#ab256903ac157e22647dc37d4aee6a986',1,'tiny_fd_init_t_::on_sent_cb()'],['../structSTinyHdData__.html#a159a56591682bfb0ff6c5020b26590f6',1,'STinyHdData_::on_sent_cb()'],['../structSTinyHdInit__.html#aa1d724d6a284de5f995273e0e3e70318',1,'STinyHdInit_::on_sent_cb()']]], - ['onreceive',['onReceive',['../classTiny_1_1IProtoFd.html#a795b41c969708964cd4646580af1c3ab',1,'Tiny::IProtoFd']]], - ['onsend',['onSend',['../classTiny_1_1IProtoFd.html#acd324920c1f35d378fb5153b51cd6561',1,'Tiny::IProtoFd']]], + ['onreceive',['onReceive',['../classTiny_1_1IProtoFd.html#a795b41c969708964cd4646580af1c3ab',1,'Tiny::IProtoFd::onReceive()'],['../classTiny_1_1ProtoHdlc.html#afe7bd4445fb69598b80357869e2b785c',1,'Tiny::ProtoHdlc::onReceive()']]], + ['onsend',['onSend',['../classTiny_1_1IProtoFd.html#acd324920c1f35d378fb5153b51cd6561',1,'Tiny::IProtoFd::onSend()'],['../classTiny_1_1ProtoHdlc.html#ae197714a219bf38e2408818334ee3108',1,'Tiny::ProtoHdlc::onSend()']]], ['oosyncbytes',['oosyncBytes',['../structSTinyStats.html#a79119146606964d4e3345a0c019db329',1,'STinyStats']]], ['operator_5b_5d',['operator[]',['../classTiny_1_1IPacket.html#aa1d796806e21d1c72a1fc12d2f6db592',1,'Tiny::IPacket']]] ]; diff --git a/docs/search/all_d.js b/docs/search/all_d.js index 5170381e..28cf9822 100644 --- a/docs/search/all_d.js +++ b/docs/search/all_d.js @@ -8,6 +8,7 @@ var searchData= ['protofd',['ProtoFd',['../classTiny_1_1ProtoFd.html',1,'Tiny']]], ['protofdd',['ProtoFdD',['../classTiny_1_1ProtoFdD.html',1,'Tiny::ProtoFdD'],['../classTiny_1_1ProtoFdD.html#ac6d3b1143cb0776b9ae16e57068f03dc',1,'Tiny::ProtoFdD::ProtoFdD()']]], ['protohd',['ProtoHd',['../classTiny_1_1ProtoHd.html',1,'Tiny::ProtoHd'],['../classTiny_1_1ProtoHd.html#a1a55191980c259f2c760997d9c07cb48',1,'Tiny::ProtoHd::ProtoHd()']]], + ['protohdlc',['ProtoHdlc',['../classTiny_1_1ProtoHdlc.html',1,'Tiny::ProtoHdlc'],['../classTiny_1_1ProtoHdlc.html#a82160439269af053f034d69a1b350cbc',1,'Tiny::ProtoHdlc::ProtoHdlc()']]], ['protolight',['ProtoLight',['../classTiny_1_1ProtoLight.html',1,'Tiny']]], ['put',['put',['../classTiny_1_1IPacket.html#a9d5ba62a453b9cd364c0e214c245f11d',1,'Tiny::IPacket::put(uint8_t byte)'],['../classTiny_1_1IPacket.html#a9dd0344bbed4500af63a3f700d31945b',1,'Tiny::IPacket::put(char chr)'],['../classTiny_1_1IPacket.html#a4dd6118251a5557691e4ed358a3b2ddc',1,'Tiny::IPacket::put(uint16_t data)'],['../classTiny_1_1IPacket.html#a5ec37c88a536d710fb1561cd62f52c91',1,'Tiny::IPacket::put(uint32_t data)'],['../classTiny_1_1IPacket.html#abf21aef6652da2e975c8be13e6a643e9',1,'Tiny::IPacket::put(int16_t data)'],['../classTiny_1_1IPacket.html#a46eaf3eb0232288dfb36ce7cc01b12e5',1,'Tiny::IPacket::put(const char *str)'],['../classTiny_1_1IPacket.html#a5ebc1e6507e7255a8babddbae82dcb2a',1,'Tiny::IPacket::put(const IPacket &pkt)']]] ]; diff --git a/docs/search/all_e.js b/docs/search/all_e.js index b24dce4b..ee5bd6b3 100644 --- a/docs/search/all_e.js +++ b/docs/search/all_e.js @@ -7,8 +7,8 @@ var searchData= ['retries',['retries',['../structtiny__fd__init__t__.html#ae366ae6e7626b0d92a6e5088c29169cd',1,'tiny_fd_init_t_']]], ['retry_5ftimeout',['retry_timeout',['../structtiny__fd__init__t__.html#a54b9c689fba5aae8ccc0c29f05a159ca',1,'tiny_fd_init_t_']]], ['run',['run',['../classTiny_1_1ProtoHd.html#af07b1f5d0df3021e00a4b4f04af4150b',1,'Tiny::ProtoHd']]], - ['run_5frx',['run_rx',['../classTiny_1_1IProtoFd.html#a37292eb5c9faf1be8c4850985e0ae2eb',1,'Tiny::IProtoFd']]], - ['run_5ftx',['run_tx',['../classTiny_1_1IProtoFd.html#a19be0bd5124009c7de051554841070b3',1,'Tiny::IProtoFd']]], + ['run_5frx',['run_rx',['../classTiny_1_1IProtoFd.html#a37292eb5c9faf1be8c4850985e0ae2eb',1,'Tiny::IProtoFd::run_rx(uint16_t timeout=0)'],['../classTiny_1_1IProtoFd.html#ab297fec86ef473612a745865403b4dd0',1,'Tiny::IProtoFd::run_rx(const void *data, int len)'],['../classTiny_1_1ProtoHdlc.html#ae54e74de1a47d386f079c840fd830fe0',1,'Tiny::ProtoHdlc::run_rx()']]], + ['run_5ftx',['run_tx',['../classTiny_1_1IProtoFd.html#a19be0bd5124009c7de051554841070b3',1,'Tiny::IProtoFd::run_tx(uint16_t timeout=0)'],['../classTiny_1_1IProtoFd.html#a5510f1f28ff72c709305826c96473ffb',1,'Tiny::IProtoFd::run_tx(void *data, int max_size)'],['../classTiny_1_1ProtoHdlc.html#a73415a63c389b3cbd0601a2ed49fd6e9',1,'Tiny::ProtoHdlc::run_tx()']]], ['rx_5fbuf',['rx_buf',['../struct__hdlc__handle__t.html#a4736ab7a858df79cf74bd19e6dbacb13',1,'_hdlc_handle_t']]], ['rx_5fbuf_5fsize',['rx_buf_size',['../struct__hdlc__handle__t.html#a40baccf093b26c08d9108c8238f95675',1,'_hdlc_handle_t']]] ]; diff --git a/docs/search/all_f.js b/docs/search/all_f.js index 7647f5b3..7b08067e 100644 --- a/docs/search/all_f.js +++ b/docs/search/all_f.js @@ -2,8 +2,8 @@ var searchData= [ ['send_5ftimeout',['send_timeout',['../structtiny__fd__init__t__.html#ae6653af324c07711c4b20360760c3e3a',1,'tiny_fd_init_t_']]], ['send_5ftx',['send_tx',['../struct__hdlc__handle__t.html#a1b3432eda3d865c6edd355ff9e8d588c',1,'_hdlc_handle_t']]], - ['setreceivecallback',['setReceiveCallback',['../classTiny_1_1IProtoFd.html#a70aa7c85b5fe83513eebb63b803d5825',1,'Tiny::IProtoFd']]], - ['setsendcallback',['setSendCallback',['../classTiny_1_1IProtoFd.html#ac3c8efc9a30ab547c5d575a8de0ef1e5',1,'Tiny::IProtoFd']]], + ['setreceivecallback',['setReceiveCallback',['../classTiny_1_1IProtoFd.html#a70aa7c85b5fe83513eebb63b803d5825',1,'Tiny::IProtoFd::setReceiveCallback()'],['../classTiny_1_1ProtoHdlc.html#a781e046caaeaeeecd03fadd07c138f9f',1,'Tiny::ProtoHdlc::setReceiveCallback()']]], + ['setsendcallback',['setSendCallback',['../classTiny_1_1IProtoFd.html#ac3c8efc9a30ab547c5d575a8de0ef1e5',1,'Tiny::IProtoFd::setSendCallback()'],['../classTiny_1_1ProtoHdlc.html#a1a2a3005901312563aad00154b8bfcf8',1,'Tiny::ProtoHdlc::setSendCallback()']]], ['setsendtimeout',['setSendTimeout',['../classTiny_1_1IProtoFd.html#a2492655abda41d5b0fbda6f0e1c6badc',1,'Tiny::IProtoFd']]], ['setwindowsize',['setWindowSize',['../classTiny_1_1IProtoFd.html#adddcc24bf1ef40d39c944679a97c1ec4',1,'Tiny::IProtoFd']]], ['size',['size',['../classTiny_1_1IPacket.html#a76b6389f0d47b67c8428c58c2b09df51',1,'Tiny::IPacket']]], diff --git a/docs/search/classes_3.js b/docs/search/classes_3.js index 6183a8b4..06092fa8 100644 --- a/docs/search/classes_3.js +++ b/docs/search/classes_3.js @@ -5,5 +5,6 @@ var searchData= ['protofd',['ProtoFd',['../classTiny_1_1ProtoFd.html',1,'Tiny']]], ['protofdd',['ProtoFdD',['../classTiny_1_1ProtoFdD.html',1,'Tiny']]], ['protohd',['ProtoHd',['../classTiny_1_1ProtoHd.html',1,'Tiny']]], + ['protohdlc',['ProtoHdlc',['../classTiny_1_1ProtoHdlc.html',1,'Tiny']]], ['protolight',['ProtoLight',['../classTiny_1_1ProtoLight.html',1,'Tiny']]] ]; diff --git a/docs/search/defines_1.html b/docs/search/defines_1.html new file mode 100644 index 00000000..91488cb5 --- /dev/null +++ b/docs/search/defines_1.html @@ -0,0 +1,26 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/search/defines_1.js b/docs/search/defines_1.js new file mode 100644 index 00000000..ed20525b --- /dev/null +++ b/docs/search/defines_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['tiny_5fserial_5finvalid',['TINY_SERIAL_INVALID',['../win32__serial_8h.html#a522e85af073f5824b93b77225d08b90e',1,'win32_serial.h']]] +]; diff --git a/docs/search/files_2.js b/docs/search/files_2.js index 1e6cc5b9..57e1d699 100644 --- a/docs/search/files_2.js +++ b/docs/search/files_2.js @@ -3,10 +3,12 @@ var searchData= ['tiny_5ffd_2eh',['tiny_fd.h',['../tiny__fd_8h.html',1,'']]], ['tiny_5fhd_2eh',['tiny_hd.h',['../tiny__hd_8h.html',1,'']]], ['tiny_5flight_2eh',['tiny_light.h',['../tiny__light_8h.html',1,'']]], + ['tiny_5fserial_2eh',['tiny_serial.h',['../tiny__serial_8h.html',1,'']]], ['tiny_5ftypes_2eh',['tiny_types.h',['../tiny__types_8h.html',1,'']]], ['tinylightprotocol_2eh',['TinyLightProtocol.h',['../TinyLightProtocol_8h.html',1,'']]], ['tinypacket_2eh',['TinyPacket.h',['../TinyPacket_8h.html',1,'']]], ['tinyprotocol_2eh',['TinyProtocol.h',['../TinyProtocol_8h.html',1,'']]], ['tinyprotocolfd_2eh',['TinyProtocolFd.h',['../TinyProtocolFd_8h.html',1,'']]], - ['tinyprotocolhd_2eh',['TinyProtocolHd.h',['../TinyProtocolHd_8h.html',1,'']]] + ['tinyprotocolhd_2eh',['TinyProtocolHd.h',['../TinyProtocolHd_8h.html',1,'']]], + ['tinyprotocolhdlc_2eh',['TinyProtocolHdlc.h',['../TinyProtocolHdlc_8h.html',1,'']]] ]; diff --git a/docs/search/files_3.html b/docs/search/files_3.html new file mode 100644 index 00000000..d5a95284 --- /dev/null +++ b/docs/search/files_3.html @@ -0,0 +1,26 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/search/files_3.js b/docs/search/files_3.js new file mode 100644 index 00000000..9a83c57a --- /dev/null +++ b/docs/search/files_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['win32_5fserial_2eh',['win32_serial.h',['../win32__serial_8h.html',1,'']]] +]; diff --git a/docs/search/functions_0.js b/docs/search/functions_0.js index 3ca1c5a1..34e00be9 100644 --- a/docs/search/functions_0.js +++ b/docs/search/functions_0.js @@ -1,8 +1,8 @@ var searchData= [ - ['begin',['begin',['../classTiny_1_1ProtoLight.html#ad27dfcef54a8316228469ef0a4267962',1,'Tiny::ProtoLight::begin()'],['../classTiny_1_1IProtoFd.html#aae4e613316866105c130d613ecb25dd4',1,'Tiny::IProtoFd::begin()'],['../classTiny_1_1ProtoHd.html#a112ae02531837a852af7ca3c9a32a7eb',1,'Tiny::ProtoHd::begin()']]], - ['begintoserial',['beginToSerial',['../classTiny_1_1ProtoLight.html#a50bf63fe1891edda48980ca2893485d7',1,'Tiny::ProtoLight::beginToSerial()'],['../classTiny_1_1IProtoFd.html#a1cf42b4182e49dcde4862a768d07c811',1,'Tiny::IProtoFd::beginToSerial()'],['../classTiny_1_1ProtoHd.html#a0e88ac5b3c67ca67c566742c22180050',1,'Tiny::ProtoHd::beginToSerial()']]], - ['begintoserial1',['beginToSerial1',['../classTiny_1_1ProtoLight.html#a4de4d11cc7f68dcefa5ca1357e6dfc35',1,'Tiny::ProtoLight::beginToSerial1()'],['../classTiny_1_1IProtoFd.html#a7d41a0caae1d5e6808a441c821ed8927',1,'Tiny::IProtoFd::beginToSerial1()'],['../classTiny_1_1ProtoHd.html#a1b2975217b0523c3de4b534644cfa501',1,'Tiny::ProtoHd::beginToSerial1()']]], - ['begintoserial2',['beginToSerial2',['../classTiny_1_1ProtoLight.html#a40a4d002f53c842b1a3577a8a9c8eebb',1,'Tiny::ProtoLight::beginToSerial2()'],['../classTiny_1_1IProtoFd.html#ae7582aca0fa5472da6f4ae2911d56259',1,'Tiny::IProtoFd::beginToSerial2()'],['../classTiny_1_1ProtoHd.html#a450fc792e515ffd150072988bc632c9e',1,'Tiny::ProtoHd::beginToSerial2()']]], - ['begintoserial3',['beginToSerial3',['../classTiny_1_1IProtoFd.html#a2d4df949358d4e8afa391e8960729d71',1,'Tiny::IProtoFd::beginToSerial3()'],['../classTiny_1_1ProtoHd.html#acd6519f6652c279b3a3b98aabbaeed65',1,'Tiny::ProtoHd::beginToSerial3()']]] + ['begin',['begin',['../classTiny_1_1ProtoLight.html#ad27dfcef54a8316228469ef0a4267962',1,'Tiny::ProtoLight::begin()'],['../classTiny_1_1IProtoFd.html#aae4e613316866105c130d613ecb25dd4',1,'Tiny::IProtoFd::begin(write_block_cb_t writecb, read_block_cb_t readcb)'],['../classTiny_1_1IProtoFd.html#a33f836591bf981b484d495d678d02442',1,'Tiny::IProtoFd::begin()'],['../classTiny_1_1ProtoHd.html#a112ae02531837a852af7ca3c9a32a7eb',1,'Tiny::ProtoHd::begin()'],['../classTiny_1_1ProtoHdlc.html#acdc849f66b9f9a51d8930552ade56324',1,'Tiny::ProtoHdlc::begin(write_block_cb_t writecb, read_block_cb_t readcb)'],['../classTiny_1_1ProtoHdlc.html#aaaca3c70444d6a5f20e7e1fef492e99b',1,'Tiny::ProtoHdlc::begin()']]], + ['begintoserial',['beginToSerial',['../classTiny_1_1ProtoLight.html#a50bf63fe1891edda48980ca2893485d7',1,'Tiny::ProtoLight::beginToSerial()'],['../classTiny_1_1IProtoFd.html#a1cf42b4182e49dcde4862a768d07c811',1,'Tiny::IProtoFd::beginToSerial()'],['../classTiny_1_1ProtoHd.html#a0e88ac5b3c67ca67c566742c22180050',1,'Tiny::ProtoHd::beginToSerial()'],['../classTiny_1_1ProtoHdlc.html#a8a54409e420954d93ada44ad0710740e',1,'Tiny::ProtoHdlc::beginToSerial()']]], + ['begintoserial1',['beginToSerial1',['../classTiny_1_1ProtoLight.html#a4de4d11cc7f68dcefa5ca1357e6dfc35',1,'Tiny::ProtoLight::beginToSerial1()'],['../classTiny_1_1IProtoFd.html#a7d41a0caae1d5e6808a441c821ed8927',1,'Tiny::IProtoFd::beginToSerial1()'],['../classTiny_1_1ProtoHd.html#a1b2975217b0523c3de4b534644cfa501',1,'Tiny::ProtoHd::beginToSerial1()'],['../classTiny_1_1ProtoHdlc.html#aadaf2dbaad53bba682d37e0650585491',1,'Tiny::ProtoHdlc::beginToSerial1()']]], + ['begintoserial2',['beginToSerial2',['../classTiny_1_1ProtoLight.html#a40a4d002f53c842b1a3577a8a9c8eebb',1,'Tiny::ProtoLight::beginToSerial2()'],['../classTiny_1_1IProtoFd.html#ae7582aca0fa5472da6f4ae2911d56259',1,'Tiny::IProtoFd::beginToSerial2()'],['../classTiny_1_1ProtoHd.html#a450fc792e515ffd150072988bc632c9e',1,'Tiny::ProtoHd::beginToSerial2()'],['../classTiny_1_1ProtoHdlc.html#aed9903c8e65495e0260b4095113ee641',1,'Tiny::ProtoHdlc::beginToSerial2()']]], + ['begintoserial3',['beginToSerial3',['../classTiny_1_1IProtoFd.html#a2d4df949358d4e8afa391e8960729d71',1,'Tiny::IProtoFd::beginToSerial3()'],['../classTiny_1_1ProtoHd.html#acd6519f6652c279b3a3b98aabbaeed65',1,'Tiny::ProtoHd::beginToSerial3()'],['../classTiny_1_1ProtoHdlc.html#a1c895863c008b9dbd4316ae10c6e4ea0',1,'Tiny::ProtoHdlc::beginToSerial3()']]] ]; diff --git a/docs/search/functions_2.js b/docs/search/functions_2.js index de28d52b..45804fb8 100644 --- a/docs/search/functions_2.js +++ b/docs/search/functions_2.js @@ -1,5 +1,5 @@ var searchData= [ ['data',['data',['../classTiny_1_1IPacket.html#aedf2ba31c5a29e3829458bd9f03a7051',1,'Tiny::IPacket']]], - ['disablecrc',['disableCrc',['../classTiny_1_1ProtoLight.html#af93e0591ca33137ad79ffb054953001c',1,'Tiny::ProtoLight::disableCrc()'],['../classTiny_1_1IProtoFd.html#af41446f47a7c520ff8f9683e6ae45614',1,'Tiny::IProtoFd::disableCrc()'],['../classTiny_1_1ProtoHd.html#ae90a0a40de0b71a015f7f7f940440fa0',1,'Tiny::ProtoHd::disableCrc()']]] + ['disablecrc',['disableCrc',['../classTiny_1_1ProtoLight.html#af93e0591ca33137ad79ffb054953001c',1,'Tiny::ProtoLight::disableCrc()'],['../classTiny_1_1IProtoFd.html#af41446f47a7c520ff8f9683e6ae45614',1,'Tiny::IProtoFd::disableCrc()'],['../classTiny_1_1ProtoHd.html#ae90a0a40de0b71a015f7f7f940440fa0',1,'Tiny::ProtoHd::disableCrc()'],['../classTiny_1_1ProtoHdlc.html#a37506cfddcc0e1ed9a2ed697f4860b98',1,'Tiny::ProtoHdlc::disableCrc()']]] ]; diff --git a/docs/search/functions_3.js b/docs/search/functions_3.js index 712d254f..910c3b24 100644 --- a/docs/search/functions_3.js +++ b/docs/search/functions_3.js @@ -1,8 +1,8 @@ var searchData= [ - ['enablechecksum',['enableCheckSum',['../classTiny_1_1ProtoLight.html#ad7b4ef5a43c187f0d1915efe7450bc40',1,'Tiny::ProtoLight::enableCheckSum()'],['../classTiny_1_1IProtoFd.html#a0f43402e86ea64f5c0154477d84b0c7c',1,'Tiny::IProtoFd::enableCheckSum()'],['../classTiny_1_1ProtoHd.html#ace4e6b993532b3eb47d025b8db94192d',1,'Tiny::ProtoHd::enableCheckSum()']]], - ['enablecrc',['enableCrc',['../classTiny_1_1ProtoLight.html#a5232e938a70c64eb7fbb8908509cd3fa',1,'Tiny::ProtoLight::enableCrc()'],['../classTiny_1_1IProtoFd.html#a7dec2906051505034e91b503318a5563',1,'Tiny::IProtoFd::enableCrc()']]], - ['enablecrc16',['enableCrc16',['../classTiny_1_1ProtoLight.html#a110b654e476691518790edcc5bf1bd80',1,'Tiny::ProtoLight::enableCrc16()'],['../classTiny_1_1IProtoFd.html#a8b57afdb66434aa35409af34b04e1db9',1,'Tiny::IProtoFd::enableCrc16()'],['../classTiny_1_1ProtoHd.html#a0887adedc93b7538dbaef3fc8e0b2819',1,'Tiny::ProtoHd::enableCrc16()']]], - ['enablecrc32',['enableCrc32',['../classTiny_1_1ProtoLight.html#a8ae8a3ace46234a65f83c564dc56fd26',1,'Tiny::ProtoLight::enableCrc32()'],['../classTiny_1_1IProtoFd.html#a1bf1f5211ae3a49caf73ee3de3bb9247',1,'Tiny::IProtoFd::enableCrc32()'],['../classTiny_1_1ProtoHd.html#a4110a0112548d5e47d312d190930ad20',1,'Tiny::ProtoHd::enableCrc32()']]], - ['end',['end',['../classTiny_1_1ProtoLight.html#a948b2a0e37177b7434581adc64b36497',1,'Tiny::ProtoLight::end()'],['../classTiny_1_1IProtoFd.html#ad17e76d0ef7ea40838e51acc2498c482',1,'Tiny::IProtoFd::end()'],['../classTiny_1_1ProtoHd.html#ac87bf8264895b654025001a0e6014f3f',1,'Tiny::ProtoHd::end()']]] + ['enablechecksum',['enableCheckSum',['../classTiny_1_1ProtoLight.html#ad7b4ef5a43c187f0d1915efe7450bc40',1,'Tiny::ProtoLight::enableCheckSum()'],['../classTiny_1_1IProtoFd.html#a0f43402e86ea64f5c0154477d84b0c7c',1,'Tiny::IProtoFd::enableCheckSum()'],['../classTiny_1_1ProtoHd.html#ace4e6b993532b3eb47d025b8db94192d',1,'Tiny::ProtoHd::enableCheckSum()'],['../classTiny_1_1ProtoHdlc.html#a3c9ed356b3d6dd4496b1655a0704e890',1,'Tiny::ProtoHdlc::enableCheckSum()']]], + ['enablecrc',['enableCrc',['../classTiny_1_1ProtoLight.html#a5232e938a70c64eb7fbb8908509cd3fa',1,'Tiny::ProtoLight::enableCrc()'],['../classTiny_1_1IProtoFd.html#a7dec2906051505034e91b503318a5563',1,'Tiny::IProtoFd::enableCrc()'],['../classTiny_1_1ProtoHdlc.html#a84e93210f940385a9408419ed605c8e5',1,'Tiny::ProtoHdlc::enableCrc()']]], + ['enablecrc16',['enableCrc16',['../classTiny_1_1ProtoLight.html#a110b654e476691518790edcc5bf1bd80',1,'Tiny::ProtoLight::enableCrc16()'],['../classTiny_1_1IProtoFd.html#a8b57afdb66434aa35409af34b04e1db9',1,'Tiny::IProtoFd::enableCrc16()'],['../classTiny_1_1ProtoHd.html#a0887adedc93b7538dbaef3fc8e0b2819',1,'Tiny::ProtoHd::enableCrc16()'],['../classTiny_1_1ProtoHdlc.html#a693fb4301071e0b2d3bfd818265f22c6',1,'Tiny::ProtoHdlc::enableCrc16()']]], + ['enablecrc32',['enableCrc32',['../classTiny_1_1ProtoLight.html#a8ae8a3ace46234a65f83c564dc56fd26',1,'Tiny::ProtoLight::enableCrc32()'],['../classTiny_1_1IProtoFd.html#a1bf1f5211ae3a49caf73ee3de3bb9247',1,'Tiny::IProtoFd::enableCrc32()'],['../classTiny_1_1ProtoHd.html#a4110a0112548d5e47d312d190930ad20',1,'Tiny::ProtoHd::enableCrc32()'],['../classTiny_1_1ProtoHdlc.html#a2f0b1557415ea384e7b1279c3618d4c0',1,'Tiny::ProtoHdlc::enableCrc32()']]], + ['end',['end',['../classTiny_1_1ProtoLight.html#a948b2a0e37177b7434581adc64b36497',1,'Tiny::ProtoLight::end()'],['../classTiny_1_1IProtoFd.html#ad17e76d0ef7ea40838e51acc2498c482',1,'Tiny::IProtoFd::end()'],['../classTiny_1_1ProtoHd.html#ac87bf8264895b654025001a0e6014f3f',1,'Tiny::ProtoHd::end()'],['../classTiny_1_1ProtoHdlc.html#ad4b84cbcd33d65e7df73321a0c19c420',1,'Tiny::ProtoHdlc::end()']]] ]; diff --git a/docs/search/functions_5.js b/docs/search/functions_5.js index 0680153f..21b7149e 100644 --- a/docs/search/functions_5.js +++ b/docs/search/functions_5.js @@ -1,6 +1,7 @@ var searchData= [ ['hdlc_5fclose',['hdlc_close',['../group__HDLC__API.html#ga21d727583f0f4534c8e4688eafcec66f',1,'hdlc_close(hdlc_handle_t handle): tiny_hdlc.c'],['../group__HDLC__API.html#ga21d727583f0f4534c8e4688eafcec66f',1,'hdlc_close(hdlc_handle_t handle): tiny_hdlc.c']]], + ['hdlc_5fget_5ftx_5fdata',['hdlc_get_tx_data',['../group__HDLC__API.html#gaaeece06ea6894a19402f76158e1d101d',1,'hdlc_get_tx_data(hdlc_handle_t handle, void *data, int len): tiny_hdlc.c'],['../group__HDLC__API.html#gaaeece06ea6894a19402f76158e1d101d',1,'hdlc_get_tx_data(hdlc_handle_t handle, void *data, int len): tiny_hdlc.c']]], ['hdlc_5finit',['hdlc_init',['../group__HDLC__API.html#gaa41c388433273a76460ddfbaff0f8f5d',1,'hdlc_init(hdlc_struct_t *hdlc_info): tiny_hdlc.c'],['../group__HDLC__API.html#gaa41c388433273a76460ddfbaff0f8f5d',1,'hdlc_init(hdlc_struct_t *hdlc_info): tiny_hdlc.c']]], ['hdlc_5freset',['hdlc_reset',['../group__HDLC__API.html#ga532836280097de1c8881df8336f21075',1,'hdlc_reset(hdlc_handle_t handle): tiny_hdlc.c'],['../group__HDLC__API.html#ga532836280097de1c8881df8336f21075',1,'hdlc_reset(hdlc_handle_t handle): tiny_hdlc.c']]], ['hdlc_5frun_5frx',['hdlc_run_rx',['../group__HDLC__API.html#ga911a3f1cb32dd6cadd00223e0097642c',1,'hdlc_run_rx(hdlc_handle_t handle, const void *data, int len, int *error): tiny_hdlc.c'],['../group__HDLC__API.html#ga911a3f1cb32dd6cadd00223e0097642c',1,'hdlc_run_rx(hdlc_handle_t handle, const void *data, int len, int *error): tiny_hdlc.c']]], diff --git a/docs/search/functions_8.js b/docs/search/functions_8.js index 13be1c8c..8c910035 100644 --- a/docs/search/functions_8.js +++ b/docs/search/functions_8.js @@ -1,6 +1,6 @@ var searchData= [ - ['onreceive',['onReceive',['../classTiny_1_1IProtoFd.html#a795b41c969708964cd4646580af1c3ab',1,'Tiny::IProtoFd']]], - ['onsend',['onSend',['../classTiny_1_1IProtoFd.html#acd324920c1f35d378fb5153b51cd6561',1,'Tiny::IProtoFd']]], + ['onreceive',['onReceive',['../classTiny_1_1IProtoFd.html#a795b41c969708964cd4646580af1c3ab',1,'Tiny::IProtoFd::onReceive()'],['../classTiny_1_1ProtoHdlc.html#afe7bd4445fb69598b80357869e2b785c',1,'Tiny::ProtoHdlc::onReceive()']]], + ['onsend',['onSend',['../classTiny_1_1IProtoFd.html#acd324920c1f35d378fb5153b51cd6561',1,'Tiny::IProtoFd::onSend()'],['../classTiny_1_1ProtoHdlc.html#ae197714a219bf38e2408818334ee3108',1,'Tiny::ProtoHdlc::onSend()']]], ['operator_5b_5d',['operator[]',['../classTiny_1_1IPacket.html#aa1d796806e21d1c72a1fc12d2f6db592',1,'Tiny::IPacket']]] ]; diff --git a/docs/search/functions_9.js b/docs/search/functions_9.js index adec57a8..2eca789e 100644 --- a/docs/search/functions_9.js +++ b/docs/search/functions_9.js @@ -4,5 +4,6 @@ var searchData= ['packetd',['PacketD',['../classTiny_1_1PacketD.html#a337a74c5e513be616aff0c1a0746612a',1,'Tiny::PacketD']]], ['protofdd',['ProtoFdD',['../classTiny_1_1ProtoFdD.html#ac6d3b1143cb0776b9ae16e57068f03dc',1,'Tiny::ProtoFdD']]], ['protohd',['ProtoHd',['../classTiny_1_1ProtoHd.html#a1a55191980c259f2c760997d9c07cb48',1,'Tiny::ProtoHd']]], + ['protohdlc',['ProtoHdlc',['../classTiny_1_1ProtoHdlc.html#a82160439269af053f034d69a1b350cbc',1,'Tiny::ProtoHdlc']]], ['put',['put',['../classTiny_1_1IPacket.html#a9d5ba62a453b9cd364c0e214c245f11d',1,'Tiny::IPacket::put(uint8_t byte)'],['../classTiny_1_1IPacket.html#a9dd0344bbed4500af63a3f700d31945b',1,'Tiny::IPacket::put(char chr)'],['../classTiny_1_1IPacket.html#a4dd6118251a5557691e4ed358a3b2ddc',1,'Tiny::IPacket::put(uint16_t data)'],['../classTiny_1_1IPacket.html#a5ec37c88a536d710fb1561cd62f52c91',1,'Tiny::IPacket::put(uint32_t data)'],['../classTiny_1_1IPacket.html#abf21aef6652da2e975c8be13e6a643e9',1,'Tiny::IPacket::put(int16_t data)'],['../classTiny_1_1IPacket.html#a46eaf3eb0232288dfb36ce7cc01b12e5',1,'Tiny::IPacket::put(const char *str)'],['../classTiny_1_1IPacket.html#a5ebc1e6507e7255a8babddbae82dcb2a',1,'Tiny::IPacket::put(const IPacket &pkt)']]] ]; diff --git a/docs/search/functions_a.js b/docs/search/functions_a.js index 26a05ae6..f5c69b34 100644 --- a/docs/search/functions_a.js +++ b/docs/search/functions_a.js @@ -2,6 +2,6 @@ var searchData= [ ['read',['read',['../classTiny_1_1ProtoLight.html#acf18a8b73ee6c6394270c903ad7882b8',1,'Tiny::ProtoLight::read(char *buf, int size)'],['../classTiny_1_1ProtoLight.html#aa040cbf16f9c074959fb410db6858b9b',1,'Tiny::ProtoLight::read(IPacket &pkt)']]], ['run',['run',['../classTiny_1_1ProtoHd.html#af07b1f5d0df3021e00a4b4f04af4150b',1,'Tiny::ProtoHd']]], - ['run_5frx',['run_rx',['../classTiny_1_1IProtoFd.html#a37292eb5c9faf1be8c4850985e0ae2eb',1,'Tiny::IProtoFd']]], - ['run_5ftx',['run_tx',['../classTiny_1_1IProtoFd.html#a19be0bd5124009c7de051554841070b3',1,'Tiny::IProtoFd']]] + ['run_5frx',['run_rx',['../classTiny_1_1IProtoFd.html#a37292eb5c9faf1be8c4850985e0ae2eb',1,'Tiny::IProtoFd::run_rx(uint16_t timeout=0)'],['../classTiny_1_1IProtoFd.html#ab297fec86ef473612a745865403b4dd0',1,'Tiny::IProtoFd::run_rx(const void *data, int len)'],['../classTiny_1_1ProtoHdlc.html#ae54e74de1a47d386f079c840fd830fe0',1,'Tiny::ProtoHdlc::run_rx()']]], + ['run_5ftx',['run_tx',['../classTiny_1_1IProtoFd.html#a19be0bd5124009c7de051554841070b3',1,'Tiny::IProtoFd::run_tx(uint16_t timeout=0)'],['../classTiny_1_1IProtoFd.html#a5510f1f28ff72c709305826c96473ffb',1,'Tiny::IProtoFd::run_tx(void *data, int max_size)'],['../classTiny_1_1ProtoHdlc.html#a73415a63c389b3cbd0601a2ed49fd6e9',1,'Tiny::ProtoHdlc::run_tx()']]] ]; diff --git a/docs/search/functions_b.js b/docs/search/functions_b.js index dd7da45f..4d0308bd 100644 --- a/docs/search/functions_b.js +++ b/docs/search/functions_b.js @@ -1,7 +1,7 @@ var searchData= [ - ['setreceivecallback',['setReceiveCallback',['../classTiny_1_1IProtoFd.html#a70aa7c85b5fe83513eebb63b803d5825',1,'Tiny::IProtoFd']]], - ['setsendcallback',['setSendCallback',['../classTiny_1_1IProtoFd.html#ac3c8efc9a30ab547c5d575a8de0ef1e5',1,'Tiny::IProtoFd']]], + ['setreceivecallback',['setReceiveCallback',['../classTiny_1_1IProtoFd.html#a70aa7c85b5fe83513eebb63b803d5825',1,'Tiny::IProtoFd::setReceiveCallback()'],['../classTiny_1_1ProtoHdlc.html#a781e046caaeaeeecd03fadd07c138f9f',1,'Tiny::ProtoHdlc::setReceiveCallback()']]], + ['setsendcallback',['setSendCallback',['../classTiny_1_1IProtoFd.html#ac3c8efc9a30ab547c5d575a8de0ef1e5',1,'Tiny::IProtoFd::setSendCallback()'],['../classTiny_1_1ProtoHdlc.html#a1a2a3005901312563aad00154b8bfcf8',1,'Tiny::ProtoHdlc::setSendCallback()']]], ['setsendtimeout',['setSendTimeout',['../classTiny_1_1IProtoFd.html#a2492655abda41d5b0fbda6f0e1c6badc',1,'Tiny::IProtoFd']]], ['setwindowsize',['setWindowSize',['../classTiny_1_1IProtoFd.html#adddcc24bf1ef40d39c944679a97c1ec4',1,'Tiny::IProtoFd']]], ['size',['size',['../classTiny_1_1IPacket.html#a76b6389f0d47b67c8428c58c2b09df51',1,'Tiny::IPacket']]] diff --git a/docs/search/functions_c.js b/docs/search/functions_c.js index 0f7e7b92..11eff367 100644 --- a/docs/search/functions_c.js +++ b/docs/search/functions_c.js @@ -8,7 +8,9 @@ var searchData= ['tiny_5fevents_5fwait',['tiny_events_wait',['../tiny__types_8h.html#aa9f8404c92b31f6df4b2b929ad54588b',1,'tiny_types.h']]], ['tiny_5ffd_5fbuffer_5fsize_5fby_5fmtu',['tiny_fd_buffer_size_by_mtu',['../group__FULL__DUPLEX__API.html#ga19789bea5b5acd68804773f0d6b0e3f7',1,'tiny_fd_buffer_size_by_mtu(int mtu, int window_frames): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#ga19789bea5b5acd68804773f0d6b0e3f7',1,'tiny_fd_buffer_size_by_mtu(int mtu, int max_tx_frames): tiny_fd.c']]], ['tiny_5ffd_5fclose',['tiny_fd_close',['../group__FULL__DUPLEX__API.html#ga11e470503e3359bc29a5bcb65a9771d5',1,'tiny_fd_close(tiny_fd_handle_t handle): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#ga11e470503e3359bc29a5bcb65a9771d5',1,'tiny_fd_close(tiny_fd_handle_t handle): tiny_fd.c']]], + ['tiny_5ffd_5fget_5ftx_5fdata',['tiny_fd_get_tx_data',['../group__FULL__DUPLEX__API.html#ga047059c29688cfcbfd95584e5e435ad2',1,'tiny_fd_get_tx_data(tiny_fd_handle_t handle, void *data, int len): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#ga047059c29688cfcbfd95584e5e435ad2',1,'tiny_fd_get_tx_data(tiny_fd_handle_t handle, void *data, int len): tiny_fd.c']]], ['tiny_5ffd_5finit',['tiny_fd_init',['../group__FULL__DUPLEX__API.html#ga27fa59dffd1575419753beb35282bad5',1,'tiny_fd_init(tiny_fd_handle_t *handle, tiny_fd_init_t *init): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#ga27fa59dffd1575419753beb35282bad5',1,'tiny_fd_init(tiny_fd_handle_t *handle, tiny_fd_init_t *init): tiny_fd.c']]], + ['tiny_5ffd_5fon_5frx_5fdata',['tiny_fd_on_rx_data',['../group__FULL__DUPLEX__API.html#ga894298485a7b0901a61863ef7c2632b4',1,'tiny_fd_on_rx_data(tiny_fd_handle_t handle, const void *data, int len): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#ga894298485a7b0901a61863ef7c2632b4',1,'tiny_fd_on_rx_data(tiny_fd_handle_t handle, const void *data, int len): tiny_fd.c']]], ['tiny_5ffd_5frun_5frx',['tiny_fd_run_rx',['../group__FULL__DUPLEX__API.html#gad31f944514aef01e27bc3ec67fdbe140',1,'tiny_fd_run_rx(tiny_fd_handle_t handle, uint16_t timeout): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#gad31f944514aef01e27bc3ec67fdbe140',1,'tiny_fd_run_rx(tiny_fd_handle_t handle, uint16_t timeout): tiny_fd.c']]], ['tiny_5ffd_5frun_5ftx',['tiny_fd_run_tx',['../group__FULL__DUPLEX__API.html#ga601c9874a570331580856c1ea28f7914',1,'tiny_fd_run_tx(tiny_fd_handle_t handle, uint16_t timeout): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#ga601c9874a570331580856c1ea28f7914',1,'tiny_fd_run_tx(tiny_fd_handle_t handle, uint16_t timeout): tiny_fd.c']]], ['tiny_5ffd_5fsend',['tiny_fd_send',['../group__FULL__DUPLEX__API.html#ga490157ee98ea6148f99a5bb1f26c5f60',1,'tiny_fd_send(tiny_fd_handle_t handle, const void *data, int len): tiny_fd.c'],['../group__FULL__DUPLEX__API.html#ga490157ee98ea6148f99a5bb1f26c5f60',1,'tiny_fd_send(tiny_fd_handle_t handle, const void *buf, int len): tiny_fd.c']]], @@ -30,5 +32,11 @@ var searchData= ['tiny_5fmutex_5ftry_5flock',['tiny_mutex_try_lock',['../tiny__types_8h.html#a3c5ef9a47c4bcb2d4f7f59ec91b8dc68',1,'tiny_types.h']]], ['tiny_5fmutex_5funlock',['tiny_mutex_unlock',['../tiny__types_8h.html#aef1ccb057b482b334079565a0e75eb6c',1,'tiny_types.h']]], ['tiny_5fsend_5fwait_5fack',['tiny_send_wait_ack',['../group__HALF__DUPLEX__API.html#ga5aad8dcb504b80bac923496f2686a6d6',1,'tiny_send_wait_ack(STinyHdData *handle, void *buf, uint16_t len): tiny_hd.c'],['../group__HALF__DUPLEX__API.html#ga5aad8dcb504b80bac923496f2686a6d6',1,'tiny_send_wait_ack(STinyHdData *handle, void *buf, uint16_t len): tiny_hd.c']]], + ['tiny_5fserial_5fclose',['tiny_serial_close',['../tiny__serial_8h.html#acceca82d586bc5927f0fdb445cb02363',1,'tiny_serial.h']]], + ['tiny_5fserial_5fopen',['tiny_serial_open',['../tiny__serial_8h.html#aabc11e4315d2d2fa664fe5bb666acd7f',1,'tiny_serial.h']]], + ['tiny_5fserial_5fread',['tiny_serial_read',['../tiny__serial_8h.html#a18aa3f4ae486d2c966bd2fe79ca0e3f0',1,'tiny_serial.h']]], + ['tiny_5fserial_5fread_5ftimeout',['tiny_serial_read_timeout',['../tiny__serial_8h.html#a4c995597ed592e4ded630213b7f08d37',1,'tiny_serial.h']]], + ['tiny_5fserial_5fsend',['tiny_serial_send',['../tiny__serial_8h.html#ae588ea1b6e3fda3783ed886e364e2051',1,'tiny_serial.h']]], + ['tiny_5fserial_5fsend_5ftimeout',['tiny_serial_send_timeout',['../tiny__serial_8h.html#af951caf8cb5871d8a85607f4478e5854',1,'tiny_serial.h']]], ['tiny_5fsleep',['tiny_sleep',['../tiny__types_8h.html#ae024e04660c8b9a9a231965f7aee5112',1,'tiny_types.h']]] ]; diff --git a/docs/search/functions_d.js b/docs/search/functions_d.js index c1d3ddf1..0f18e556 100644 --- a/docs/search/functions_d.js +++ b/docs/search/functions_d.js @@ -1,4 +1,4 @@ var searchData= [ - ['write',['write',['../classTiny_1_1ProtoLight.html#a46a27ee9d0b55c88672c98abf04dbdce',1,'Tiny::ProtoLight::write(char *buf, int size)'],['../classTiny_1_1ProtoLight.html#ad980940fd5eca35204a70a5cfe5ccccd',1,'Tiny::ProtoLight::write(IPacket &pkt)'],['../classTiny_1_1IProtoFd.html#adea59df6702e16fd986a91c7ee62012a',1,'Tiny::IProtoFd::write(char *buf, int size)'],['../classTiny_1_1IProtoFd.html#aa822a1dec320e6edc70a84699371fe81',1,'Tiny::IProtoFd::write(IPacket &pkt)'],['../classTiny_1_1ProtoHd.html#af53c8817317d3a62535e68ca236a038f',1,'Tiny::ProtoHd::write(char *buf, int size)'],['../classTiny_1_1ProtoHd.html#a1f4e0864f08191bfc66dce68b339250f',1,'Tiny::ProtoHd::write(IPacket &pkt)']]] + ['write',['write',['../classTiny_1_1ProtoLight.html#a46a27ee9d0b55c88672c98abf04dbdce',1,'Tiny::ProtoLight::write(char *buf, int size)'],['../classTiny_1_1ProtoLight.html#ad980940fd5eca35204a70a5cfe5ccccd',1,'Tiny::ProtoLight::write(IPacket &pkt)'],['../classTiny_1_1IProtoFd.html#adea59df6702e16fd986a91c7ee62012a',1,'Tiny::IProtoFd::write(char *buf, int size)'],['../classTiny_1_1IProtoFd.html#aa822a1dec320e6edc70a84699371fe81',1,'Tiny::IProtoFd::write(IPacket &pkt)'],['../classTiny_1_1ProtoHd.html#af53c8817317d3a62535e68ca236a038f',1,'Tiny::ProtoHd::write(char *buf, int size)'],['../classTiny_1_1ProtoHd.html#a1f4e0864f08191bfc66dce68b339250f',1,'Tiny::ProtoHd::write(IPacket &pkt)'],['../classTiny_1_1ProtoHdlc.html#ae79c01f1c3614f0f382e8d8bf847b567',1,'Tiny::ProtoHdlc::write(char *buf, int size)'],['../classTiny_1_1ProtoHdlc.html#a3d02f2589397fb4a0e5be24a44321f9b',1,'Tiny::ProtoHdlc::write(IPacket &pkt)']]] ]; diff --git a/docs/search/searchdata.js b/docs/search/searchdata.js index f7aad331..67f672df 100644 --- a/docs/search/searchdata.js +++ b/docs/search/searchdata.js @@ -2,13 +2,13 @@ var indexSectionsWithContent = { 0: "_abcdefghilmoprstuw~", 1: "_ilpst", - 2: "amt", + 2: "amtw", 3: "bcdeghimoprstw~", 4: "bcefimoprstuw", 5: "horstw", 6: "h", 7: "h", - 8: "e", + 8: "et", 9: "frt", 10: "at" }; diff --git a/docs/search/typedefs_4.js b/docs/search/typedefs_4.js index cc233893..eb255fef 100644 --- a/docs/search/typedefs_4.js +++ b/docs/search/typedefs_4.js @@ -1,5 +1,6 @@ var searchData= [ ['tiny_5ffd_5fhandle_5ft',['tiny_fd_handle_t',['../group__FULL__DUPLEX__API.html#ga91e6b79431fe38570fb102701ef0b7e8',1,'tiny_fd.h']]], - ['tiny_5ffd_5finit_5ft',['tiny_fd_init_t',['../group__FULL__DUPLEX__API.html#gad19ac27f4ba1d2b807e0a440b0c927d2',1,'tiny_fd.h']]] + ['tiny_5ffd_5finit_5ft',['tiny_fd_init_t',['../group__FULL__DUPLEX__API.html#gad19ac27f4ba1d2b807e0a440b0c927d2',1,'tiny_fd.h']]], + ['tiny_5fserial_5fhandle_5ft',['tiny_serial_handle_t',['../win32__serial_8h.html#af7196cefe9f93fd4b3f69e408588ed21',1,'win32_serial.h']]] ]; diff --git a/docs/structSTinyHdData__-members.html b/docs/structSTinyHdData__-members.html index 2121b58c..82b3fbf7 100644 --- a/docs/structSTinyHdData__-members.html +++ b/docs/structSTinyHdData__-members.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    diff --git a/docs/structSTinyHdData__.html b/docs/structSTinyHdData__.html index 164a4610..16b2e39d 100644 --- a/docs/structSTinyHdData__.html +++ b/docs/structSTinyHdData__.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    diff --git a/docs/structSTinyHdInit__-members.html b/docs/structSTinyHdInit__-members.html index 680a7436..925dcc4e 100644 --- a/docs/structSTinyHdInit__-members.html +++ b/docs/structSTinyHdInit__-members.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    diff --git a/docs/structSTinyHdInit__.html b/docs/structSTinyHdInit__.html index 5a0c59ee..74bb207f 100644 --- a/docs/structSTinyHdInit__.html +++ b/docs/structSTinyHdInit__.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    diff --git a/docs/structSTinyLightData-members.html b/docs/structSTinyLightData-members.html index 3b936827..3cdefac7 100644 --- a/docs/structSTinyLightData-members.html +++ b/docs/structSTinyLightData-members.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    diff --git a/docs/structSTinyLightData.html b/docs/structSTinyLightData.html index 3773205d..73146591 100644 --- a/docs/structSTinyLightData.html +++ b/docs/structSTinyLightData.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    @@ -74,7 +74,7 @@
    Collaboration graph
    - +
    [legend]
    diff --git a/docs/structSTinyLightData__coll__graph.map b/docs/structSTinyLightData__coll__graph.map index 47973561..4802e4c7 100644 --- a/docs/structSTinyLightData__coll__graph.map +++ b/docs/structSTinyLightData__coll__graph.map @@ -1,3 +1,3 @@ - + diff --git a/docs/structSTinyLightData__coll__graph.png b/docs/structSTinyLightData__coll__graph.png index a9469aaf..21a7a990 100644 Binary files a/docs/structSTinyLightData__coll__graph.png and b/docs/structSTinyLightData__coll__graph.png differ diff --git a/docs/structSTinyStats-members.html b/docs/structSTinyStats-members.html index 9533a9c2..e5fdb733 100644 --- a/docs/structSTinyStats-members.html +++ b/docs/structSTinyStats-members.html @@ -22,7 +22,7 @@ diff --git a/docs/structSTinyStats.html b/docs/structSTinyStats.html index c2f7d38e..3616c60e 100644 --- a/docs/structSTinyStats.html +++ b/docs/structSTinyStats.html @@ -22,7 +22,7 @@ diff --git a/docs/struct__hdlc__handle__t-members.html b/docs/struct__hdlc__handle__t-members.html index 86a7c01c..d23f377c 100644 --- a/docs/struct__hdlc__handle__t-members.html +++ b/docs/struct__hdlc__handle__t-members.html @@ -22,7 +22,7 @@ diff --git a/docs/struct__hdlc__handle__t.html b/docs/struct__hdlc__handle__t.html index fcb99e57..835934f5 100644 --- a/docs/struct__hdlc__handle__t.html +++ b/docs/struct__hdlc__handle__t.html @@ -22,7 +22,7 @@ diff --git a/docs/structlist__element__-members.html b/docs/structlist__element__-members.html index 5749578e..51a1c8d9 100644 --- a/docs/structlist__element__-members.html +++ b/docs/structlist__element__-members.html @@ -22,7 +22,7 @@ diff --git a/docs/structlist__element__.html b/docs/structlist__element__.html index a200682a..99645151 100644 --- a/docs/structlist__element__.html +++ b/docs/structlist__element__.html @@ -22,7 +22,7 @@ @@ -76,6 +76,8 @@ Collaboration diagram for list_element_:
    Collaboration graph
    + +
    [legend]
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    diff --git a/docs/structtiny__fd__init__t__.html b/docs/structtiny__fd__init__t__.html index 79fd3d2e..acaa4e66 100644 --- a/docs/structtiny__fd__init__t__.html +++ b/docs/structtiny__fd__init__t__.html @@ -22,7 +22,7 @@ diff --git a/docs/structtiny__request__-members.html b/docs/structtiny__request__-members.html index bc7ac10c..3ea2a01c 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 024cff30..0c4e1824 100644 --- a/docs/structtiny__request__.html +++ b/docs/structtiny__request__.html @@ -22,7 +22,7 @@ @@ -77,7 +77,7 @@
    Collaboration graph
    - +
    [legend]

    diff --git a/docs/structlist__element____coll__graph.png b/docs/structlist__element____coll__graph.png index 46037df8..4ad7868a 100644 Binary files a/docs/structlist__element____coll__graph.png and b/docs/structlist__element____coll__graph.png differ diff --git a/docs/structtiny__fd__init__t__-members.html b/docs/structtiny__fd__init__t__-members.html index 5ec547d5..baf70d86 100644 --- a/docs/structtiny__fd__init__t__-members.html +++ b/docs/structtiny__fd__init__t__-members.html @@ -22,7 +22,7 @@

    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    diff --git a/docs/structtiny__request____coll__graph.map b/docs/structtiny__request____coll__graph.map index 836fe43c..02f2becb 100644 --- a/docs/structtiny__request____coll__graph.map +++ b/docs/structtiny__request____coll__graph.map @@ -1,3 +1,3 @@ - + diff --git a/docs/structtiny__request____coll__graph.png b/docs/structtiny__request____coll__graph.png index 2342f85b..15472fc8 100644 Binary files a/docs/structtiny__request____coll__graph.png and b/docs/structtiny__request____coll__graph.png differ diff --git a/docs/tiny__debug_8h_source.html b/docs/tiny__debug_8h_source.html index f44732b2..7563caae 100644 --- a/docs/tiny__debug_8h_source.html +++ b/docs/tiny__debug_8h_source.html @@ -22,7 +22,7 @@ diff --git a/docs/tiny__fd_8h.html b/docs/tiny__fd_8h.html index 4dd504c9..23bdbe93 100644 --- a/docs/tiny__fd_8h.html +++ b/docs/tiny__fd_8h.html @@ -22,7 +22,7 @@ @@ -83,9 +83,9 @@
    - - - + + +
    @@ -93,8 +93,8 @@
    - - + +
    @@ -123,9 +123,15 @@
    + + + + + + diff --git a/docs/tiny__fd_8h__dep__incl.map b/docs/tiny__fd_8h__dep__incl.map index 5190b844..6e999618 100644 --- a/docs/tiny__fd_8h__dep__incl.map +++ b/docs/tiny__fd_8h__dep__incl.map @@ -1,4 +1,4 @@ - - + + diff --git a/docs/tiny__fd_8h__dep__incl.png b/docs/tiny__fd_8h__dep__incl.png index e528f8df..a1e30f8c 100644 Binary files a/docs/tiny__fd_8h__dep__incl.png and b/docs/tiny__fd_8h__dep__incl.png differ diff --git a/docs/tiny__fd_8h__incl.map b/docs/tiny__fd_8h__incl.map index 57d81626..219f3a78 100644 --- a/docs/tiny__fd_8h__incl.map +++ b/docs/tiny__fd_8h__incl.map @@ -1,5 +1,5 @@ - - - + + + diff --git a/docs/tiny__fd_8h__incl.png b/docs/tiny__fd_8h__incl.png index ae5dc1c2..f42aadf6 100644 Binary files a/docs/tiny__fd_8h__incl.png and b/docs/tiny__fd_8h__incl.png differ diff --git a/docs/tiny__fd_8h_source.html b/docs/tiny__fd_8h_source.html index 7662b984..d0764c0f 100644 --- a/docs/tiny__fd_8h_source.html +++ b/docs/tiny__fd_8h_source.html @@ -22,7 +22,7 @@ @@ -68,30 +68,32 @@
    tiny_fd.h
    -Go to the documentation of this file.
    1 /*
    2  Copyright 2019-2020 (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 
    29 #pragma once
    30 
    31 #ifdef __cplusplus
    32 extern "C" {
    33 #endif
    34 
    35 #include <stdint.h>
    36 #include "proto/hdlc/tiny_hdlc.h"
    37 #include "proto/hal/tiny_types.h"
    38 
    44 struct tiny_fd_data_t;
    45 
    50 typedef struct tiny_fd_data_t *tiny_fd_handle_t;
    51 
    55 typedef struct tiny_fd_init_t_
    56 {
    58  write_block_cb_t write_func;
    60  read_block_cb_t read_func;
    62  void * pdata;
    64  on_frame_cb_t on_frame_cb;
    66  on_frame_cb_t on_sent_cb;
    67 
    72  void * buffer;
    73 
    75  uint16_t buffer_size;
    76 
    81  uint16_t send_timeout;
    82 
    87  uint16_t retry_timeout;
    88 
    92  uint8_t retries;
    93 
    99  hdlc_crc_t crc_type;
    100 
    107  uint8_t window_frames;
    108 } tiny_fd_init_t;
    109 
    121 extern int tiny_fd_init(tiny_fd_handle_t *handle,
    122  tiny_fd_init_t *init);
    123 
    131 extern void tiny_fd_close(tiny_fd_handle_t handle);
    132 
    146 extern int tiny_fd_run_tx(tiny_fd_handle_t handle, uint16_t timeout);
    147 
    158 extern int tiny_fd_run_rx(tiny_fd_handle_t handle, uint16_t timeout);
    159 
    181 extern int tiny_fd_send(tiny_fd_handle_t handle, const void *buf, int len);
    182 
    188 extern int tiny_fd_buffer_size_by_mtu( int mtu, int max_tx_frames );
    189 
    196 extern void tiny_fd_set_ka_timeout( tiny_fd_handle_t handle, uint32_t keep_alive );
    197 
    202 #ifdef __cplusplus
    203 }
    204 #endif
    hdlc_crc_t
    hdlc_crc_t
    Definition: tiny_hdlc.h:51
    -
    tiny_fd_buffer_size_by_mtu
    int tiny_fd_buffer_size_by_mtu(int mtu, int max_tx_frames)
    Definition: tiny_fd.c:790
    +Go to the documentation of this file.
    1 /*
    2  Copyright 2019-2020 (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 
    29 #pragma once
    30 
    31 #ifdef __cplusplus
    32 extern "C" {
    33 #endif
    34 
    35 #include <stdint.h>
    36 #include "proto/hdlc/tiny_hdlc.h"
    37 #include "proto/hal/tiny_types.h"
    38 
    44 struct tiny_fd_data_t;
    45 
    50 typedef struct tiny_fd_data_t *tiny_fd_handle_t;
    51 
    55 typedef struct tiny_fd_init_t_
    56 {
    58  write_block_cb_t write_func;
    60  read_block_cb_t read_func;
    62  void * pdata;
    64  on_frame_cb_t on_frame_cb;
    66  on_frame_cb_t on_sent_cb;
    67 
    72  void * buffer;
    73 
    75  uint16_t buffer_size;
    76 
    81  uint16_t send_timeout;
    82 
    87  uint16_t retry_timeout;
    88 
    92  uint8_t retries;
    93 
    99  hdlc_crc_t crc_type;
    100 
    107  uint8_t window_frames;
    108 } tiny_fd_init_t;
    109 
    121 extern int tiny_fd_init(tiny_fd_handle_t *handle,
    122  tiny_fd_init_t *init);
    123 
    131 extern void tiny_fd_close(tiny_fd_handle_t handle);
    132 
    147 extern int tiny_fd_run_tx(tiny_fd_handle_t handle, uint16_t timeout);
    148 
    159 extern int tiny_fd_get_tx_data(tiny_fd_handle_t handle, void *data, int len );
    160 
    171 extern int tiny_fd_run_rx(tiny_fd_handle_t handle, uint16_t timeout);
    172 
    186 extern int tiny_fd_on_rx_data(tiny_fd_handle_t handle, const void *data, int len);
    187 
    209 extern int tiny_fd_send(tiny_fd_handle_t handle, const void *buf, int len);
    210 
    216 extern int tiny_fd_buffer_size_by_mtu( int mtu, int max_tx_frames );
    217 
    224 extern void tiny_fd_set_ka_timeout( tiny_fd_handle_t handle, uint32_t keep_alive );
    225 
    230 #ifdef __cplusplus
    231 }
    232 #endif
    hdlc_crc_t
    hdlc_crc_t
    Definition: tiny_hdlc.h:54
    +
    tiny_fd_buffer_size_by_mtu
    int tiny_fd_buffer_size_by_mtu(int mtu, int max_tx_frames)
    Definition: tiny_fd.c:881
    tiny_fd_init_t_::on_sent_cb
    on_frame_cb_t on_sent_cb
    Callback to get notification of sent frames. Callback is called from tiny_fd_run_tx() context...
    Definition: tiny_fd.h:66
    -
    tiny_fd_run_rx
    int tiny_fd_run_rx(tiny_fd_handle_t handle, uint16_t timeout)
    runs rx processing for specified period of time.
    Definition: tiny_fd.c:580
    -
    tiny_fd_send
    int tiny_fd_send(tiny_fd_handle_t handle, const void *buf, int len)
    Sends userdata over full-duplex protocol.
    Definition: tiny_fd.c:743
    +
    tiny_fd_run_rx
    int tiny_fd_run_rx(tiny_fd_handle_t handle, uint16_t timeout)
    runs rx processing for specified period of time.
    Definition: tiny_fd.c:582
    +
    tiny_fd_send
    int tiny_fd_send(tiny_fd_handle_t handle, const void *buf, int len)
    Sends userdata over full-duplex protocol.
    Definition: tiny_fd.c:834
    tiny_fd_init_t_::read_func
    read_block_cb_t read_func
    callback function to read bytes from the physical channel
    Definition: tiny_fd.h:60
    tiny_fd_init_t
    struct tiny_fd_init_t_ tiny_fd_init_t
    tiny_fd_handle_t
    struct tiny_fd_data_t * tiny_fd_handle_t
    Definition: tiny_fd.h:50
    tiny_fd_init_t_::buffer_size
    uint16_t buffer_size
    maximum input buffer size, see tiny_fd_buffer_size_by_mtu()
    Definition: tiny_fd.h:75
    tiny_fd_init_t_::window_frames
    uint8_t window_frames
    Definition: tiny_fd.h:107
    tiny_fd_init_t_::retry_timeout
    uint16_t retry_timeout
    Definition: tiny_fd.h:87
    -
    read_block_cb_t
    int(* read_block_cb_t)(void *pdata, void *buffer, int size)
    Definition: tiny_types.h:139
    -
    tiny_fd_run_tx
    int tiny_fd_run_tx(tiny_fd_handle_t handle, uint16_t timeout)
    runs tx processing for specified period of time.
    Definition: tiny_fd.c:706
    +
    read_block_cb_t
    int(* read_block_cb_t)(void *pdata, void *buffer, int size)
    Definition: tiny_types.h:141
    +
    tiny_fd_run_tx
    int tiny_fd_run_tx(tiny_fd_handle_t handle, uint16_t timeout)
    runs tx processing for specified period of time.
    Definition: tiny_fd.c:742
    tiny_fd_init_t_::send_timeout
    uint16_t send_timeout
    Definition: tiny_fd.h:81
    -
    on_frame_cb_t
    void(* on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size)
    Definition: tiny_types.h:152
    +
    on_frame_cb_t
    void(* on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size)
    Definition: tiny_types.h:154
    tiny_types.h
    Tiny protocol Types.
    tiny_fd_init_t_::crc_type
    hdlc_crc_t crc_type
    Definition: tiny_fd.h:99
    tiny_fd_init_t_::buffer
    void * buffer
    Definition: tiny_fd.h:72
    -
    write_block_cb_t
    int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
    Definition: tiny_types.h:128
    +
    tiny_fd_get_tx_data
    int tiny_fd_get_tx_data(tiny_fd_handle_t handle, void *data, int len)
    runs tx processing to fill specified buffer with data.
    Definition: tiny_fd.c:779
    +
    write_block_cb_t
    int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
    Definition: tiny_types.h:130
    tiny_fd_init_t_::on_frame_cb
    on_frame_cb_t on_frame_cb
    callback function to process incoming frames. Callback is called from tiny_fd_run_rx() context...
    Definition: tiny_fd.h:64
    -
    tiny_fd_close
    void tiny_fd_close(tiny_fd_handle_t handle)
    stops Tiny Full Duplex state machine
    Definition: tiny_fd.c:563
    +
    tiny_fd_close
    void tiny_fd_close(tiny_fd_handle_t handle)
    stops Tiny Full Duplex state machine
    Definition: tiny_fd.c:565
    tiny_fd_init_t_::pdata
    void * pdata
    user data for block read/write functions
    Definition: tiny_fd.h:62
    -
    tiny_fd_init
    int tiny_fd_init(tiny_fd_handle_t *handle, tiny_fd_init_t *init)
    Initialized communication for Tiny Full Duplex protocol.
    Definition: tiny_fd.c:481
    -
    tiny_fd_set_ka_timeout
    void tiny_fd_set_ka_timeout(tiny_fd_handle_t handle, uint32_t keep_alive)
    Definition: tiny_fd.c:797
    +
    tiny_fd_init
    int tiny_fd_init(tiny_fd_handle_t *handle, tiny_fd_init_t *init)
    Initialized communication for Tiny Full Duplex protocol.
    Definition: tiny_fd.c:483
    +
    tiny_fd_set_ka_timeout
    void tiny_fd_set_ka_timeout(tiny_fd_handle_t handle, uint32_t keep_alive)
    Definition: tiny_fd.c:888
    +
    tiny_fd_on_rx_data
    int tiny_fd_on_rx_data(tiny_fd_handle_t handle, const void *data, int len)
    runs rx bytes processing for specified buffer.
    Definition: tiny_fd.c:614
    tiny_fd_init_t_::retries
    uint8_t retries
    Definition: tiny_fd.h:92
    tiny_fd_init_t_
    Definition: tiny_fd.h:55
    tiny_fd_init_t_::write_func
    write_block_cb_t write_func
    callback function to write bytes to the physical channel
    Definition: tiny_fd.h:58
    diff --git a/docs/tiny__fd__int_8h_source.html b/docs/tiny__fd__int_8h_source.html index 6884cd6a..75b6a3e5 100644 --- a/docs/tiny__fd__int_8h_source.html +++ b/docs/tiny__fd__int_8h_source.html @@ -22,7 +22,7 @@
    @@ -68,11 +68,11 @@
    tiny_fd_int.h
    -
    1 /*
    2  Copyright 2019-2020 (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 #ifndef DOXYGEN_SHOULD_SKIP_THIS
    23 
    24 #define TINY_FD_U_QUEUE_MAX_SIZE 4
    25 
    26 #ifdef __cplusplus
    27 extern "C" {
    28 #endif
    29 
    30 #include <stdint.h>
    31 #include "proto/hdlc/tiny_hdlc.h"
    32 #include "proto/hal/tiny_types.h"
    33 
    34 #define FD_MIN_BUF_SIZE(mtu,window) (sizeof(tiny_fd_data_t) + \
    35  (sizeof(tiny_i_frame_info_t *) + sizeof(tiny_i_frame_info_t) + mtu) * ( window + 1 ))
    36 
    37 #define FD_MTU_SIZE(bsize,window) ( (bsize - sizeof(tiny_fd_data_t)) / (window + 1) - \
    38  (sizeof(tiny_i_frame_info_t *) + sizeof(tiny_i_frame_info_t)) )
    39 
    40 typedef enum
    41 {
    42  TINY_FD_STATE_DISCONNECTED,
    43  TINY_FD_STATE_CONNECTING,
    44  TINY_FD_STATE_CONNECTED_ABM,
    45 } tiny_fd_state_t;
    46 
    47 typedef struct
    48 {
    49  uint8_t address;
    50  uint8_t control;
    51 } tiny_frame_header_t;
    52 
    53 typedef struct
    54 {
    55  tiny_frame_header_t header;
    56 } tiny_s_frame_info_t;
    57 
    58 typedef struct
    59 {
    60  tiny_frame_header_t header;
    61  uint8_t data1;
    62  uint8_t data2;
    63  uint8_t data3;
    64 } tiny_u_frame_info_t;
    65 
    66 typedef struct
    67 {
    68  uint8_t type;
    69  int len;
    70  tiny_frame_header_t header;
    71  uint8_t user_payload;
    72 } tiny_i_frame_info_t;
    73 
    74 typedef struct
    75 {
    76  int len;
    77  union
    78  {
    79  tiny_s_frame_info_t s_frame;
    80  tiny_u_frame_info_t u_frame;
    81  };
    82 } tiny_frame_info_t;
    83 
    84 typedef struct
    85 {
    86  tiny_i_frame_info_t **i_frames;
    87  uint8_t max_i_frames;
    88  uint8_t head_ptr;
    89 
    90  uint8_t *rx_buffer;
    91  uint8_t *tx_buffer;
    92  int mtu;
    93 
    94  tiny_mutex_t mutex;
    95  uint8_t next_nr; // frame waiting to receive
    96  uint8_t sent_nr; // frame index last sent back
    97  uint8_t sent_reject; // If reject was already sent
    98  uint8_t next_ns; // next frame to be sent
    99  uint8_t confirm_ns; // next frame to be confirmed
    100  uint8_t last_ns; // next free frame in cycle buffer
    101 
    102  uint32_t last_i_ts; // last sent I-frame timestamp
    103  uint32_t last_ka_ts; // last keep alive timestamp
    104  uint8_t ka_confirmed;
    105 
    106  uint8_t retries; // Number of retries to perform before timeout takes place
    107 
    108  tiny_events_t events;
    109 } tiny_frames_info_t;
    110 
    111 typedef struct tiny_fd_data_t
    112 {
    114  hdlc_struct_t _hdlc;
    116  tiny_fd_state_t state;
    118  write_block_cb_t write_func;
    120  read_block_cb_t read_func;
    122  on_frame_cb_t on_frame_cb;
    124  on_frame_cb_t on_sent_cb;
    126  uint16_t send_timeout;
    128  uint16_t retry_timeout;
    130  uint16_t ka_timeout;
    132  uint8_t retries;
    134  tiny_frames_info_t frames;
    135  struct
    136  {
    137  tiny_frame_info_t queue[TINY_FD_U_QUEUE_MAX_SIZE];
    138  uint8_t queue_ptr;
    139  uint8_t queue_len;
    140  } s_u_frames;
    142  void * user_data;
    143 } tiny_fd_data_t;
    144 
    145 #ifdef __cplusplus
    146 }
    147 #endif
    148 
    149 #endif
    read_block_cb_t
    int(* read_block_cb_t)(void *pdata, void *buffer, int size)
    Definition: tiny_types.h:139
    -
    on_frame_cb_t
    void(* on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size)
    Definition: tiny_types.h:152
    +
    1 /*
    2  Copyright 2019-2020 (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 #ifndef DOXYGEN_SHOULD_SKIP_THIS
    23 
    24 #define TINY_FD_U_QUEUE_MAX_SIZE 4
    25 
    26 #ifdef __cplusplus
    27 extern "C" {
    28 #endif
    29 
    30 #include <stdint.h>
    31 #include "proto/hdlc/tiny_hdlc.h"
    32 #include "proto/hal/tiny_types.h"
    33 
    34 #define FD_MIN_BUF_SIZE(mtu,window) (sizeof(tiny_fd_data_t) + \
    35  (sizeof(tiny_i_frame_info_t *) + sizeof(tiny_i_frame_info_t) + mtu) * ( window + 1 ))
    36 
    37 #define FD_MTU_SIZE(bsize,window) ( (bsize - sizeof(tiny_fd_data_t)) / (window + 1) - \
    38  (sizeof(tiny_i_frame_info_t *) + sizeof(tiny_i_frame_info_t)) )
    39 
    40 typedef enum
    41 {
    42  TINY_FD_STATE_DISCONNECTED,
    43  TINY_FD_STATE_CONNECTING,
    44  TINY_FD_STATE_CONNECTED_ABM,
    45 } tiny_fd_state_t;
    46 
    47 typedef struct
    48 {
    49  uint8_t address;
    50  uint8_t control;
    51 } tiny_frame_header_t;
    52 
    53 typedef struct
    54 {
    55  tiny_frame_header_t header;
    56 } tiny_s_frame_info_t;
    57 
    58 typedef struct
    59 {
    60  tiny_frame_header_t header;
    61  uint8_t data1;
    62  uint8_t data2;
    63  uint8_t data3;
    64 } tiny_u_frame_info_t;
    65 
    66 typedef struct
    67 {
    68  uint8_t type;
    69  int len;
    70  tiny_frame_header_t header;
    71  uint8_t user_payload;
    72 } tiny_i_frame_info_t;
    73 
    74 typedef struct
    75 {
    76  int len;
    77  union
    78  {
    79  tiny_s_frame_info_t s_frame;
    80  tiny_u_frame_info_t u_frame;
    81  };
    82 } tiny_frame_info_t;
    83 
    84 typedef struct
    85 {
    86  tiny_i_frame_info_t **i_frames;
    87  uint8_t max_i_frames;
    88  uint8_t head_ptr;
    89 
    90  uint8_t *rx_buffer;
    91  uint8_t *tx_buffer;
    92  int mtu;
    93 
    94  tiny_mutex_t mutex;
    95  uint8_t next_nr; // frame waiting to receive
    96  uint8_t sent_nr; // frame index last sent back
    97  uint8_t sent_reject; // If reject was already sent
    98  uint8_t next_ns; // next frame to be sent
    99  uint8_t confirm_ns; // next frame to be confirmed
    100  uint8_t last_ns; // next free frame in cycle buffer
    101 
    102  uint32_t last_i_ts; // last sent I-frame timestamp
    103  uint32_t last_ka_ts; // last keep alive timestamp
    104  uint8_t ka_confirmed;
    105 
    106  uint8_t retries; // Number of retries to perform before timeout takes place
    107 
    108  tiny_events_t events;
    109 } tiny_frames_info_t;
    110 
    111 typedef struct tiny_fd_data_t
    112 {
    114  hdlc_struct_t _hdlc;
    116  tiny_fd_state_t state;
    118  write_block_cb_t write_func;
    120  read_block_cb_t read_func;
    122  on_frame_cb_t on_frame_cb;
    124  on_frame_cb_t on_sent_cb;
    126  uint16_t send_timeout;
    128  uint16_t retry_timeout;
    130  uint16_t ka_timeout;
    132  uint8_t retries;
    134  tiny_frames_info_t frames;
    135  struct
    136  {
    137  tiny_frame_info_t queue[TINY_FD_U_QUEUE_MAX_SIZE];
    138  uint8_t queue_ptr;
    139  uint8_t queue_len;
    140  } s_u_frames;
    142  void * user_data;
    143 } tiny_fd_data_t;
    144 
    145 #ifdef __cplusplus
    146 }
    147 #endif
    148 
    149 #endif
    read_block_cb_t
    int(* read_block_cb_t)(void *pdata, void *buffer, int size)
    Definition: tiny_types.h:141
    +
    on_frame_cb_t
    void(* on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size)
    Definition: tiny_types.h:154
    tiny_types.h
    Tiny protocol Types.
    -
    _hdlc_handle_t
    Definition: tiny_hdlc.h:65
    -
    write_block_cb_t
    int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
    Definition: tiny_types.h:128
    +
    _hdlc_handle_t
    Definition: tiny_hdlc.h:68
    +
    write_block_cb_t
    int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
    Definition: tiny_types.h:130
    diff --git a/docs/tiny__hd_8h.html b/docs/tiny__hd_8h.html index 73a4792c..cc0ed154 100644 --- a/docs/tiny__hd_8h.html +++ b/docs/tiny__hd_8h.html @@ -22,7 +22,7 @@
    @@ -83,9 +83,9 @@
    - - - + + +
    @@ -93,8 +93,8 @@
    - - + +
    diff --git a/docs/tiny__hd_8h__dep__incl.map b/docs/tiny__hd_8h__dep__incl.map index dd3f47d4..f1cd787d 100644 --- a/docs/tiny__hd_8h__dep__incl.map +++ b/docs/tiny__hd_8h__dep__incl.map @@ -1,4 +1,4 @@ - - + + diff --git a/docs/tiny__hd_8h__dep__incl.png b/docs/tiny__hd_8h__dep__incl.png index 0c711962..a26460d8 100644 Binary files a/docs/tiny__hd_8h__dep__incl.png and b/docs/tiny__hd_8h__dep__incl.png differ diff --git a/docs/tiny__hd_8h__incl.map b/docs/tiny__hd_8h__incl.map index 61182e58..37da19fe 100644 --- a/docs/tiny__hd_8h__incl.map +++ b/docs/tiny__hd_8h__incl.map @@ -1,5 +1,5 @@ - - - + + + diff --git a/docs/tiny__hd_8h__incl.png b/docs/tiny__hd_8h__incl.png index b94afff0..b0d67918 100644 Binary files a/docs/tiny__hd_8h__incl.png and b/docs/tiny__hd_8h__incl.png differ diff --git a/docs/tiny__hd_8h_source.html b/docs/tiny__hd_8h_source.html index 4348dcd9..5c82bea4 100644 --- a/docs/tiny__hd_8h_source.html +++ b/docs/tiny__hd_8h_source.html @@ -22,7 +22,7 @@
    @@ -68,7 +68,7 @@
    tiny_hd.h
    -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 
    47 typedef struct STinyHdData_
    48 {
    49 #ifndef DOXYGEN_SHOULD_SKIP_THIS
    50  hdlc_struct_t _hdlc;
    51  uint8_t _sent;
    52 #endif
    53  write_block_cb_t write_func;
    56  read_block_cb_t read_func;
    58  on_frame_cb_t on_frame_cb;
    60  on_frame_cb_t on_sent_cb;
    62  uint16_t timeout;
    64  uint16_t uid;
    70  bool multithread_mode;
    72  void * user_data;
    73 } STinyHdData;
    74 
    75 
    79 typedef struct STinyHdInit_
    80 {
    82  write_block_cb_t write_func;
    84  read_block_cb_t read_func;
    86  void * pdata;
    88  on_frame_cb_t on_frame_cb;
    90  on_frame_cb_t on_sent_cb;
    96  void * inbuf;
    98  uint16_t inbuf_size;
    100  uint16_t timeout;
    102  uint8_t multithread_mode;
    108  hdlc_crc_t crc_type;
    109 } STinyHdInit;
    110 
    122 extern int tiny_hd_init(STinyHdData * handle,
    123  STinyHdInit * init);
    124 
    132 extern void tiny_hd_close(STinyHdData * handle);
    133 
    157 extern int tiny_hd_run(STinyHdData * handle);
    158 
    166 extern int tiny_hd_run_tx(STinyHdData * handle);
    167 
    187 extern int tiny_send_wait_ack(STinyHdData *handle, void *buf, uint16_t len);
    188 
    189 #if 0
    190 static inline STinyData * hd_to_tiny(STinyHdData * handle)
    191 {
    192  return &handle->handle;
    193 }
    194 
    195 static inline STinyHdData * tiny_to_hd(STinyHdData * handle)
    196 {
    197  return (STinyHdData *)handle;
    198 }
    199 #endif
    200 
    205 #ifdef __cplusplus
    206 }
    207 #endif
    208 
    209 #endif /* _TINY_HALFDUPLEX_PROTOCOL_H_ */
    hdlc_crc_t
    hdlc_crc_t
    Definition: tiny_hdlc.h:51
    +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 
    47 typedef struct STinyHdData_
    48 {
    49 #ifndef DOXYGEN_SHOULD_SKIP_THIS
    50  hdlc_struct_t _hdlc;
    51  uint8_t _sent;
    52 #endif
    53  write_block_cb_t write_func;
    56  read_block_cb_t read_func;
    58  on_frame_cb_t on_frame_cb;
    60  on_frame_cb_t on_sent_cb;
    62  uint16_t timeout;
    64  uint16_t uid;
    70  bool multithread_mode;
    72  void * user_data;
    73 } STinyHdData;
    74 
    75 
    79 typedef struct STinyHdInit_
    80 {
    82  write_block_cb_t write_func;
    84  read_block_cb_t read_func;
    86  void * pdata;
    88  on_frame_cb_t on_frame_cb;
    90  on_frame_cb_t on_sent_cb;
    96  void * inbuf;
    98  uint16_t inbuf_size;
    100  uint16_t timeout;
    102  uint8_t multithread_mode;
    108  hdlc_crc_t crc_type;
    109 } STinyHdInit;
    110 
    122 extern int tiny_hd_init(STinyHdData * handle,
    123  STinyHdInit * init);
    124 
    132 extern void tiny_hd_close(STinyHdData * handle);
    133 
    157 extern int tiny_hd_run(STinyHdData * handle);
    158 
    166 extern int tiny_hd_run_tx(STinyHdData * handle);
    167 
    187 extern int tiny_send_wait_ack(STinyHdData *handle, void *buf, uint16_t len);
    188 
    189 #if 0
    190 static inline STinyData * hd_to_tiny(STinyHdData * handle)
    191 {
    192  return &handle->handle;
    193 }
    194 
    195 static inline STinyHdData * tiny_to_hd(STinyHdData * handle)
    196 {
    197  return (STinyHdData *)handle;
    198 }
    199 #endif
    200 
    205 #ifdef __cplusplus
    206 }
    207 #endif
    208 
    209 #endif /* _TINY_HALFDUPLEX_PROTOCOL_H_ */
    hdlc_crc_t
    hdlc_crc_t
    Definition: tiny_hdlc.h:54
    tiny_hd_init
    int tiny_hd_init(STinyHdData *handle, STinyHdInit *init)
    Initialized communication for Tiny Half Duplex protocol.
    Definition: tiny_hd.c:182
    STinyHdData_::on_sent_cb
    on_frame_cb_t on_sent_cb
    Callback to get notification of sent frames.
    Definition: tiny_hd.h:60
    tiny_hd_run_tx
    int tiny_hd_run_tx(STinyHdData *handle)
    Definition: tiny_hd.c:238
    @@ -80,8 +80,8 @@
    STinyHdData
    struct STinyHdData_ STinyHdData
    STinyHdData_::read_func
    read_block_cb_t read_func
    callback function to read bytes from the physical channel
    Definition: tiny_hd.h:56
    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:81
    -
    read_block_cb_t
    int(* read_block_cb_t)(void *pdata, void *buffer, int size)
    Definition: tiny_types.h:139
    -
    on_frame_cb_t
    void(* on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size)
    Definition: tiny_types.h:152
    +
    read_block_cb_t
    int(* read_block_cb_t)(void *pdata, void *buffer, int size)
    Definition: tiny_types.h:141
    +
    on_frame_cb_t
    void(* on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size)
    Definition: tiny_types.h:154
    STinyHdInit_::on_frame_cb
    on_frame_cb_t on_frame_cb
    callback function to process incoming frames
    Definition: tiny_hd.h:88
    STinyHdInit_::write_func
    write_block_cb_t write_func
    callback function to write bytes to the physical channel
    Definition: tiny_hd.h:82
    STinyHdInit_::crc_type
    hdlc_crc_t crc_type
    Definition: tiny_hd.h:108
    @@ -91,9 +91,9 @@
    STinyHdInit_::inbuf
    void * inbuf
    Definition: tiny_hd.h:96
    STinyHdInit_
    Definition: tiny_hd.h:79
    STinyHdInit_::multithread_mode
    uint8_t multithread_mode
    multithread mode. At present should be 0
    Definition: tiny_hd.h:102
    -
    _hdlc_handle_t
    Definition: tiny_hdlc.h:65
    +
    _hdlc_handle_t
    Definition: tiny_hdlc.h:68
    STinyHdData_::timeout
    uint16_t timeout
    Timeout for operations with acknowledge.
    Definition: tiny_hd.h:62
    -
    write_block_cb_t
    int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
    Definition: tiny_types.h:128
    +
    write_block_cb_t
    int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
    Definition: tiny_types.h:130
    tiny_hd_run
    int tiny_hd_run(STinyHdData *handle)
    runs receive functions of Tiny Half Duplex protocol.
    Definition: tiny_hd.c:231
    STinyHdData_::uid
    uint16_t uid
    field used to store temporary uid
    Definition: tiny_hd.h:64
    STinyHdData_::user_data
    void * user_data
    user specific data
    Definition: tiny_hd.h:72
    diff --git a/docs/tiny__hdlc_8h_source.html b/docs/tiny__hdlc_8h_source.html index 714db512..01e9f6b5 100644 --- a/docs/tiny__hdlc_8h_source.html +++ b/docs/tiny__hdlc_8h_source.html @@ -22,7 +22,7 @@
    @@ -68,34 +68,35 @@
    tiny_hdlc.h
    -
    1 /*
    2  Copyright 2019-2020 (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 #pragma once
    20 
    21 #include "proto/hal/tiny_types.h"
    22 #include <stdint.h>
    23 #include <stdbool.h>
    24 
    25 #ifdef __cplusplus
    26 extern "C"
    27 {
    28 #endif
    29 
    40 #ifdef CONFIG_ENABLE_FCS32
    42  typedef uint32_t crc_t;
    43 #else
    44  typedef uint16_t crc_t;
    45 #endif
    46 
    51 typedef enum
    52 {
    53  HDLC_CRC_DEFAULT = 0,
    54  HDLC_CRC_8 = 8,
    55  HDLC_CRC_16 = 16,
    56  HDLC_CRC_32 = 32,
    57  HDLC_CRC_OFF = 0xFF,
    58 } hdlc_crc_t;
    59 
    65 typedef struct _hdlc_handle_t
    66 {
    77  write_block_cb_t send_tx;
    78 
    90  int (*on_frame_read)(void *user_data, void *data, int len);
    91 
    102  int (*on_frame_sent)(void *user_data, const void *data, int len);
    103 
    107  void *rx_buf;
    108 
    112  int rx_buf_size;
    113 
    119  hdlc_crc_t crc_type;
    120 
    125  bool multithread_mode;
    126 
    128  void *user_data;
    129 
    130 #ifndef DOXYGEN_SHOULD_SKIP_THIS
    131 
    132  tiny_events_t events;
    133  struct
    134  {
    135  uint8_t *data;
    136  int (*state)( struct _hdlc_handle_t *handle, const uint8_t *data, int len );
    137  uint8_t escape;
    138  } rx;
    139  struct
    140  {
    141  const uint8_t *origin_data;
    142  const uint8_t *data;
    143  int len;
    144  crc_t crc;
    145  uint8_t escape;
    146  int (*state)( struct _hdlc_handle_t *handle );
    147  } tx;
    148 #endif
    149 } hdlc_struct_t, *hdlc_handle_t;
    150 
    151 //------------------------ GENERIC FUNCIONS ------------------------------
    152 
    160 hdlc_handle_t hdlc_init( hdlc_struct_t *hdlc_info );
    161 
    167 int hdlc_close( hdlc_handle_t handle );
    168 
    175 void hdlc_reset( hdlc_handle_t handle );
    176 
    177 //------------------------ RX FUNCIONS ------------------------------
    178 
    199 int hdlc_run_rx( hdlc_handle_t handle, const void *data, int len, int *error );
    200 
    213 int hdlc_run_rx_until_read( hdlc_handle_t handle, read_block_cb_t readcb, void *user_data, uint16_t timeout );
    214 
    222 void hdlc_set_rx_buffer( hdlc_handle_t handle, void *data, int size);
    223 
    224 //------------------------ TX FUNCIONS ------------------------------
    225 
    239 int hdlc_run_tx( hdlc_handle_t handle );
    240 
    282 int hdlc_send( hdlc_handle_t handle, const void *data, int len, uint32_t timeout );
    283 
    288 #ifdef __cplusplus
    289 }
    290 #endif
    291 
    hdlc_crc_t
    hdlc_crc_t
    Definition: tiny_hdlc.h:51
    -
    _hdlc_handle_t::rx_buf_size
    int rx_buf_size
    Definition: tiny_hdlc.h:112
    -
    HDLC_CRC_DEFAULT
    If default is specified HDLC will auto select CRC option.
    Definition: tiny_hdlc.h:53
    -
    _hdlc_handle_t::send_tx
    write_block_cb_t send_tx
    Definition: tiny_hdlc.h:77
    +
    1 /*
    2  Copyright 2019-2020 (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 #pragma once
    20 
    21 #include "proto/hal/tiny_types.h"
    22 #include <stdint.h>
    23 #include <stdbool.h>
    24 
    25 #ifdef __cplusplus
    26 extern "C"
    27 {
    28 #endif
    29 
    31 #define TINY_HDLC_FILL_BYTE 0xFF
    32 
    43 #ifdef CONFIG_ENABLE_FCS32
    45  typedef uint32_t crc_t;
    46 #else
    47  typedef uint16_t crc_t;
    48 #endif
    49 
    54 typedef enum
    55 {
    56  HDLC_CRC_DEFAULT = 0,
    57  HDLC_CRC_8 = 8,
    58  HDLC_CRC_16 = 16,
    59  HDLC_CRC_32 = 32,
    60  HDLC_CRC_OFF = 0xFF,
    61 } hdlc_crc_t;
    62 
    68 typedef struct _hdlc_handle_t
    69 {
    80  write_block_cb_t send_tx;
    81 
    93  int (*on_frame_read)(void *user_data, void *data, int len);
    94 
    105  int (*on_frame_sent)(void *user_data, const void *data, int len);
    106 
    110  void *rx_buf;
    111 
    115  int rx_buf_size;
    116 
    122  hdlc_crc_t crc_type;
    123 
    128  bool multithread_mode;
    129 
    131  void *user_data;
    132 
    133 #ifndef DOXYGEN_SHOULD_SKIP_THIS
    134 
    135  tiny_events_t events;
    136  struct
    137  {
    138  uint8_t *data;
    139  int (*state)( struct _hdlc_handle_t *handle, const uint8_t *data, int len );
    140  uint8_t escape;
    141  } rx;
    142  struct
    143  {
    144  void *user_data;
    145  uint8_t *out_buffer;
    146  int out_buffer_len;
    147  const uint8_t *origin_data;
    148  const uint8_t *data;
    149  int len;
    150  crc_t crc;
    151  uint8_t escape;
    152  int (*state)( struct _hdlc_handle_t *handle );
    153  } tx;
    154 #endif
    155 } hdlc_struct_t, *hdlc_handle_t;
    156 
    157 //------------------------ GENERIC FUNCIONS ------------------------------
    158 
    166 hdlc_handle_t hdlc_init( hdlc_struct_t *hdlc_info );
    167 
    173 int hdlc_close( hdlc_handle_t handle );
    174 
    181 void hdlc_reset( hdlc_handle_t handle );
    182 
    183 //------------------------ RX FUNCIONS ------------------------------
    184 
    211 int hdlc_run_rx( hdlc_handle_t handle, const void *data, int len, int *error );
    212 
    225 int hdlc_run_rx_until_read( hdlc_handle_t handle, read_block_cb_t readcb, void *user_data, uint16_t timeout );
    226 
    234 void hdlc_set_rx_buffer( hdlc_handle_t handle, void *data, int size);
    235 
    236 //------------------------ TX FUNCIONS ------------------------------
    237 
    251 int hdlc_run_tx( hdlc_handle_t handle );
    252 
    263 int hdlc_get_tx_data( hdlc_handle_t handle, void *data, int len );
    264 
    306 int hdlc_send( hdlc_handle_t handle, const void *data, int len, uint32_t timeout );
    307 
    312 #ifdef __cplusplus
    313 }
    314 #endif
    315 
    hdlc_crc_t
    hdlc_crc_t
    Definition: tiny_hdlc.h:54
    +
    _hdlc_handle_t::rx_buf_size
    int rx_buf_size
    Definition: tiny_hdlc.h:115
    +
    HDLC_CRC_DEFAULT
    If default is specified HDLC will auto select CRC option.
    Definition: tiny_hdlc.h:56
    +
    _hdlc_handle_t::send_tx
    write_block_cb_t send_tx
    Definition: tiny_hdlc.h:80
    hdlc_handle_t
    struct _hdlc_handle_t * hdlc_handle_t
    hdlc handle
    -
    _hdlc_handle_t::on_frame_read
    int(* on_frame_read)(void *user_data, void *data, int len)
    Definition: tiny_hdlc.h:90
    -
    hdlc_run_rx_until_read
    int hdlc_run_rx_until_read(hdlc_handle_t handle, read_block_cb_t readcb, void *user_data, uint16_t timeout)
    Definition: tiny_hdlc.c:535
    -
    _hdlc_handle_t::multithread_mode
    bool multithread_mode
    Definition: tiny_hdlc.h:125
    -
    hdlc_run_tx
    int hdlc_run_tx(hdlc_handle_t handle)
    Definition: tiny_hdlc.c:265
    -
    _hdlc_handle_t::crc_type
    hdlc_crc_t crc_type
    Definition: tiny_hdlc.h:119
    -
    hdlc_init
    hdlc_handle_t hdlc_init(hdlc_struct_t *hdlc_info)
    Definition: tiny_hdlc.c:57
    -
    hdlc_reset
    void hdlc_reset(hdlc_handle_t handle)
    Definition: tiny_hdlc.c:96
    -
    read_block_cb_t
    int(* read_block_cb_t)(void *pdata, void *buffer, int size)
    Definition: tiny_types.h:139
    -
    HDLC_CRC_32
    CCITT-32.
    Definition: tiny_hdlc.h:56
    -
    _hdlc_handle_t::rx_buf
    void * rx_buf
    Definition: tiny_hdlc.h:107
    -
    HDLC_CRC_8
    Simple sum of all bytes in user payload.
    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:93
    +
    hdlc_run_rx_until_read
    int hdlc_run_rx_until_read(hdlc_handle_t handle, read_block_cb_t readcb, void *user_data, uint16_t timeout)
    Definition: tiny_hdlc.c:595
    +
    _hdlc_handle_t::multithread_mode
    bool multithread_mode
    Definition: tiny_hdlc.h:128
    +
    hdlc_run_tx
    int hdlc_run_tx(hdlc_handle_t handle)
    Definition: tiny_hdlc.c:275
    +
    _hdlc_handle_t::crc_type
    hdlc_crc_t crc_type
    Definition: tiny_hdlc.h:122
    +
    hdlc_init
    hdlc_handle_t hdlc_init(hdlc_struct_t *hdlc_info)
    Definition: tiny_hdlc.c:59
    +
    hdlc_reset
    void hdlc_reset(hdlc_handle_t handle)
    Definition: tiny_hdlc.c:104
    +
    read_block_cb_t
    int(* read_block_cb_t)(void *pdata, void *buffer, int size)
    Definition: tiny_types.h:141
    +
    HDLC_CRC_32
    CCITT-32.
    Definition: tiny_hdlc.h:59
    +
    _hdlc_handle_t::rx_buf
    void * rx_buf
    Definition: tiny_hdlc.h:110
    +
    HDLC_CRC_8
    Simple sum of all bytes in user payload.
    Definition: tiny_hdlc.h:57
    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:338
    -
    _hdlc_handle_t::on_frame_sent
    int(* on_frame_sent)(void *user_data, const void *data, int len)
    Definition: tiny_hdlc.h:102
    -
    _hdlc_handle_t
    Definition: tiny_hdlc.h:65
    -
    hdlc_close
    int hdlc_close(hdlc_handle_t handle)
    Definition: tiny_hdlc.c:82
    -
    HDLC_CRC_OFF
    Disable CRC field.
    Definition: tiny_hdlc.h:57
    -
    write_block_cb_t
    int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
    Definition: tiny_types.h:128
    -
    _hdlc_handle_t::user_data
    void * user_data
    Definition: tiny_hdlc.h:128
    -
    HDLC_CRC_16
    CCITT-16.
    Definition: tiny_hdlc.h:55
    -
    hdlc_set_rx_buffer
    void hdlc_set_rx_buffer(hdlc_handle_t handle, void *data, int size)
    Definition: tiny_hdlc.c:529
    -
    hdlc_run_rx
    int hdlc_run_rx(hdlc_handle_t handle, const void *data, int len, int *error)
    Definition: tiny_hdlc.c:505
    +
    hdlc_send
    int hdlc_send(hdlc_handle_t handle, const void *data, int len, uint32_t timeout)
    Definition: tiny_hdlc.c:389
    +
    _hdlc_handle_t::on_frame_sent
    int(* on_frame_sent)(void *user_data, const void *data, int len)
    Definition: tiny_hdlc.h:105
    +
    _hdlc_handle_t
    Definition: tiny_hdlc.h:68
    +
    hdlc_close
    int hdlc_close(hdlc_handle_t handle)
    Definition: tiny_hdlc.c:90
    +
    HDLC_CRC_OFF
    Disable CRC field.
    Definition: tiny_hdlc.h:60
    +
    write_block_cb_t
    int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
    Definition: tiny_types.h:130
    +
    _hdlc_handle_t::user_data
    void * user_data
    Definition: tiny_hdlc.h:131
    +
    HDLC_CRC_16
    CCITT-16.
    Definition: tiny_hdlc.h:58
    +
    hdlc_set_rx_buffer
    void hdlc_set_rx_buffer(hdlc_handle_t handle, void *data, int size)
    Definition: tiny_hdlc.c:589
    +
    hdlc_run_rx
    int hdlc_run_rx(hdlc_handle_t handle, const void *data, int len, int *error)
    Definition: tiny_hdlc.c:561
    +
    hdlc_get_tx_data
    int hdlc_get_tx_data(hdlc_handle_t handle, void *data, int len)
    Definition: tiny_hdlc.c:313
    diff --git a/docs/tiny__light_8h.html b/docs/tiny__light_8h.html index 1c3d430c..ec0a9db2 100644 --- a/docs/tiny__light_8h.html +++ b/docs/tiny__light_8h.html @@ -22,7 +22,7 @@
    @@ -81,9 +81,9 @@
    - - - + + +
    @@ -91,8 +91,8 @@
    - - + +
    diff --git a/docs/tiny__light_8h__dep__incl.map b/docs/tiny__light_8h__dep__incl.map index 6844b282..716d0720 100644 --- a/docs/tiny__light_8h__dep__incl.map +++ b/docs/tiny__light_8h__dep__incl.map @@ -1,4 +1,4 @@ - - + + diff --git a/docs/tiny__light_8h__dep__incl.png b/docs/tiny__light_8h__dep__incl.png index 6b4c89e9..2e54b447 100644 Binary files a/docs/tiny__light_8h__dep__incl.png and b/docs/tiny__light_8h__dep__incl.png differ diff --git a/docs/tiny__light_8h__incl.map b/docs/tiny__light_8h__incl.map index ae6836bf..7733e79f 100644 --- a/docs/tiny__light_8h__incl.map +++ b/docs/tiny__light_8h__incl.map @@ -1,5 +1,5 @@ - - - + + + diff --git a/docs/tiny__light_8h__incl.png b/docs/tiny__light_8h__incl.png index 1f95ab34..c62bda03 100644 Binary files a/docs/tiny__light_8h__incl.png and b/docs/tiny__light_8h__incl.png differ diff --git a/docs/tiny__light_8h_source.html b/docs/tiny__light_8h_source.html index d995dbf8..95b631a4 100644 --- a/docs/tiny__light_8h_source.html +++ b/docs/tiny__light_8h_source.html @@ -22,7 +22,7 @@
    @@ -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 
    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;
    64  hdlc_crc_t crc_type;
    65 #ifndef DOXYGEN_SHOULD_SKIP_THIS
    66  hdlc_struct_t _hdlc;
    67  uint8_t _received;
    68  uint8_t _sent;
    69 #endif
    70 } STinyLightData;
    71 
    72 
    73 
    87 extern int tiny_light_init(void *handle,
    88  write_block_cb_t write_func,
    89  read_block_cb_t read_func,
    90  void *pdata);
    91 
    92 
    100 extern int tiny_light_close(void *handle);
    101 
    116 extern int tiny_light_send(void *handle, const uint8_t *pbuf, int len);
    117 
    136 extern int tiny_light_read(void *handle, uint8_t *pbuf, int len);
    137 
    148 extern hdlc_handle_t tiny_light_get_hdlc(void *handle);
    149 
    154 #ifdef __cplusplus
    155 }
    156 #endif
    157 
    158 #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:164
    -
    hdlc_crc_t
    hdlc_crc_t
    Definition: tiny_hdlc.h:51
    +
    hdlc_crc_t
    hdlc_crc_t
    Definition: tiny_hdlc.h:54
    tiny_light_close
    int tiny_light_close(void *handle)
    Definition: tiny_light.c:102
    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:132
    -
    STinyStats
    Definition: tiny_types.h:103
    +
    STinyStats
    Definition: tiny_types.h:105
    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:153
    -
    read_block_cb_t
    int(* read_block_cb_t)(void *pdata, void *buffer, int size)
    Definition: tiny_types.h:139
    +
    read_block_cb_t
    int(* read_block_cb_t)(void *pdata, void *buffer, int size)
    Definition: tiny_types.h:141
    STinyLightData::read_func
    read_block_cb_t read_func
    pointer to platform related read function
    Definition: tiny_light.h:60
    STinyLightData::crc_type
    hdlc_crc_t crc_type
    CRC type to use.
    Definition: tiny_light.h:64
    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:65
    -
    write_block_cb_t
    int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
    Definition: tiny_types.h:128
    +
    _hdlc_handle_t
    Definition: tiny_hdlc.h:68
    +
    write_block_cb_t
    int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
    Definition: tiny_types.h:130
    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 b2d0c9c0..1d041820 100644 --- a/docs/tiny__list_8h_source.html +++ b/docs/tiny__list_8h_source.html @@ -22,7 +22,7 @@     diff --git a/docs/tiny__rq__pool_8h_source.html b/docs/tiny__rq__pool_8h_source.html index 2051bbe2..b0cc8098 100644 --- a/docs/tiny__rq__pool_8h_source.html +++ b/docs/tiny__rq__pool_8h_source.html @@ -22,7 +22,7 @@ diff --git a/docs/tiny__serial_8h.html b/docs/tiny__serial_8h.html new file mode 100644 index 00000000..03cb9c4b --- /dev/null +++ b/docs/tiny__serial_8h.html @@ -0,0 +1,381 @@ + + + + + + + +Tiny protocol: src/proto/hal/tiny_serial.h File Reference + + + + + + + + + +
    +
    +
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    int tiny_fd_run_tx (tiny_fd_handle_t handle, uint16_t timeout)
     runs tx processing for specified period of time. More...
     
    int tiny_fd_get_tx_data (tiny_fd_handle_t handle, void *data, int len)
     runs tx processing to fill specified buffer with data. More...
     
    int tiny_fd_run_rx (tiny_fd_handle_t handle, uint16_t timeout)
     runs rx processing for specified period of time. More...
     
    int tiny_fd_on_rx_data (tiny_fd_handle_t handle, const void *data, int len)
     runs rx bytes processing for specified buffer. More...
     
    int tiny_fd_send (tiny_fd_handle_t handle, const void *buf, int len)
     Sends userdata over full-duplex protocol. More...
     
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    + + + + + +
    +
    Tiny protocol +  0.11.0 +
    +
    Tiny communication protocol for microcontrollers
    +
    + + + + + + + + + +
    +
    + + +
    + +
    + + + +
    +
    +Functions
    +
    +
    tiny_serial.h File Reference
    +
    +
    + +

    Tiny UART serial API. +More...

    +
    #include <stdint.h>
    +#include "serial/noplatform_serial.h"
    +
    +Include dependency graph for tiny_serial.h:
    +
    +
    + + + +
    +
    +

    Go to the source code of this file.

    + + + + + + + + + + + + + + + + + + + + +

    +Functions

    tiny_serial_handle_t tiny_serial_open (const char *name, uint32_t baud)
     Opens serial port. More...
     
    void tiny_serial_close (tiny_serial_handle_t port)
     Closes serial connection. More...
     
    int tiny_serial_send (tiny_serial_handle_t port, const void *buf, int len)
     Sends data over serial connection. More...
     
    int tiny_serial_send_timeout (tiny_serial_handle_t port, const void *buf, int len, uint32_t timeout_ms)
     Sends data over serial connection. More...
     
    int tiny_serial_read (tiny_serial_handle_t port, void *buf, int len)
     Receive data from serial connection. More...
     
    int tiny_serial_read_timeout (tiny_serial_handle_t port, void *buf, int len, uint32_t timeout_ms)
     Receive data from serial connection. More...
     
    +

    Detailed Description

    +

    Tiny UART serial API.

    +

    This is UART support implementation.

    +

    Function Documentation

    + +

    ◆ tiny_serial_close()

    + +
    +
    + + + + + + + + +
    void tiny_serial_close (tiny_serial_handle_t port)
    +
    + +

    Closes serial connection.

    +

    Closes serial connection

    Parameters
    + + +
    porthandle to serial port
    +
    +
    + +
    +
    + +

    ◆ tiny_serial_open()

    + +
    +
    + + + + + + + + + + + + + + + + + + +
    tiny_serial_handle_t tiny_serial_open (const char * name,
    uint32_t baud 
    )
    +
    + +

    Opens serial port.

    +

    Opens serial port by name

    +
    Parameters
    + + + +
    namepath to the port to open For linux this can be /dev/ttyO1, /dev/ttyS1, /dev/ttyUSB0, etc. For windows this can be COM1, COM2, etc.
    baudbaud rate in bits
    +
    +
    +
    Returns
    valid serial handle or TINY_SERIAL_INVALID in case of error
    + +
    +
    + +

    ◆ tiny_serial_read()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    int tiny_serial_read (tiny_serial_handle_t port,
    void * buf,
    int len 
    )
    +
    + +

    Receive data from serial connection.

    +

    Receive data from serial connection with 100ms timeout.

    Parameters
    + + + + +
    porthandle to serial port
    bufpointer to data buffer to read to
    lenmaximum size of receive buffer
    +
    +
    +
    Returns
    negative value in case of error. or number of bytes received
    + +
    +
    + +

    ◆ tiny_serial_read_timeout()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    int tiny_serial_read_timeout (tiny_serial_handle_t port,
    void * buf,
    int len,
    uint32_t timeout_ms 
    )
    +
    + +

    Receive data from serial connection.

    +

    Receive data from serial connection.

    Parameters
    + + + + + +
    porthandle to serial port
    bufpointer to data buffer to read to
    lenmaximum size of receive buffer
    timeout_mstimeout in milliseconds to wait for incoming data
    +
    +
    +
    Returns
    negative value in case of error. or number of bytes received
    + +
    +
    + +

    ◆ tiny_serial_send()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    int tiny_serial_send (tiny_serial_handle_t port,
    const void * buf,
    int len 
    )
    +
    + +

    Sends data over serial connection.

    +

    Sends data over serial connection with 100 ms timeout.

    Parameters
    + + + + +
    porthandle to serial port
    bufpointer to data buffer to send
    lenlength of data to send
    +
    +
    +
    Returns
    negative value in case of error. or number of bytes sent
    + +
    +
    + +

    ◆ tiny_serial_send_timeout()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    int tiny_serial_send_timeout (tiny_serial_handle_t port,
    const void * buf,
    int len,
    uint32_t timeout_ms 
    )
    +
    + +

    Sends data over serial connection.

    +

    Sends data over serial connection.

    Parameters
    + + + + + +
    porthandle to serial port
    bufpointer to data buffer to send
    lenlength of data to send
    timeout_mstimeout in milliseconds to wait until data are sent
    +
    +
    +
    Returns
    negative value in case of error. or number of bytes sent
    + +
    +
    +
    + +
    +Generated by   +doxygen + 1.8.13 +
    + + diff --git a/docs/tiny__serial_8h__incl.map b/docs/tiny__serial_8h__incl.map new file mode 100644 index 00000000..2d5a44f8 --- /dev/null +++ b/docs/tiny__serial_8h__incl.map @@ -0,0 +1,3 @@ + + + diff --git a/docs/tiny__serial_8h__incl.md5 b/docs/tiny__serial_8h__incl.md5 new file mode 100644 index 00000000..91015349 --- /dev/null +++ b/docs/tiny__serial_8h__incl.md5 @@ -0,0 +1 @@ +518044c18161240420313c69be550615 \ No newline at end of file diff --git a/docs/tiny__serial_8h__incl.png b/docs/tiny__serial_8h__incl.png new file mode 100644 index 00000000..ee59b078 Binary files /dev/null and b/docs/tiny__serial_8h__incl.png differ diff --git a/docs/tiny__serial_8h_source.html b/docs/tiny__serial_8h_source.html new file mode 100644 index 00000000..293522bd --- /dev/null +++ b/docs/tiny__serial_8h_source.html @@ -0,0 +1,86 @@ + + + + + + + +Tiny protocol: src/proto/hal/tiny_serial.h Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    Tiny protocol +  0.11.0 +
    +
    Tiny communication protocol for microcontrollers
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    tiny_serial.h
    +
    +
    +Go to the documentation of this file.
    1 /*
    2  Copyright 2017,2020 (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 */
    26 #pragma once
    27 
    28 #ifdef __cplusplus
    29 extern "C" {
    30 #endif
    31 
    32 #include <stdint.h>
    33 #if defined(__linux__)
    34 #include "serial/linux_serial.h"
    35 #elif defined(_WIN32)
    36 #include "serial/win32_serial.h"
    37 #else
    38 #include "serial/noplatform_serial.h"
    39 #endif
    40 
    41 
    53 extern tiny_serial_handle_t tiny_serial_open(const char* name, uint32_t baud);
    54 
    61 extern void tiny_serial_close(tiny_serial_handle_t port);
    62 
    73 extern int tiny_serial_send(tiny_serial_handle_t port, const void *buf, int len);
    74 
    86 extern int tiny_serial_send_timeout(tiny_serial_handle_t port, const void *buf, int len, uint32_t timeout_ms);
    87 
    98 extern int tiny_serial_read(tiny_serial_handle_t port, void *buf, int len);
    99 
    111 extern int tiny_serial_read_timeout(tiny_serial_handle_t port, void *buf, int len, uint32_t timeout_ms);
    112 
    113 
    114 #ifdef __cplusplus
    115 }
    116 #endif
    tiny_serial_send
    int tiny_serial_send(tiny_serial_handle_t port, const void *buf, int len)
    Sends data over serial connection.
    +
    tiny_serial_read
    int tiny_serial_read(tiny_serial_handle_t port, void *buf, int len)
    Receive data from serial connection.
    +
    win32_serial.h
    UART serial API.
    +
    tiny_serial_read_timeout
    int tiny_serial_read_timeout(tiny_serial_handle_t port, void *buf, int len, uint32_t timeout_ms)
    Receive data from serial connection.
    +
    tiny_serial_close
    void tiny_serial_close(tiny_serial_handle_t port)
    Closes serial connection.
    +
    tiny_serial_send_timeout
    int tiny_serial_send_timeout(tiny_serial_handle_t port, const void *buf, int len, uint32_t timeout_ms)
    Sends data over serial connection.
    +
    tiny_serial_open
    tiny_serial_handle_t tiny_serial_open(const char *name, uint32_t baud)
    Opens serial port.
    +
    + +
    +Generated by   +doxygen + 1.8.13 +
    + + diff --git a/docs/tiny__types_8h.html b/docs/tiny__types_8h.html index f1644770..8123de8e 100644 --- a/docs/tiny__types_8h.html +++ b/docs/tiny__types_8h.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    @@ -83,7 +83,7 @@
    - +
    @@ -91,16 +91,17 @@
    - - - - - - - - - - + + + + + + + + + + +
    diff --git a/docs/tiny__types_8h__dep__incl.map b/docs/tiny__types_8h__dep__incl.map index 56cf7f21..974a6bef 100644 --- a/docs/tiny__types_8h__dep__incl.map +++ b/docs/tiny__types_8h__dep__incl.map @@ -1,12 +1,13 @@ - - - - - - - - - - + + + + + + + + + + + diff --git a/docs/tiny__types_8h__dep__incl.md5 b/docs/tiny__types_8h__dep__incl.md5 index 7cd8416b..153d85d1 100644 --- a/docs/tiny__types_8h__dep__incl.md5 +++ b/docs/tiny__types_8h__dep__incl.md5 @@ -1 +1 @@ -2f764561786298e071b93c0982b5786b \ No newline at end of file +4f10b3b4c9cf15f8e3a8bf68dfcf448f \ No newline at end of file diff --git a/docs/tiny__types_8h__dep__incl.png b/docs/tiny__types_8h__dep__incl.png index 1e3957cf..2b13adc3 100644 Binary files a/docs/tiny__types_8h__dep__incl.png and b/docs/tiny__types_8h__dep__incl.png differ diff --git a/docs/tiny__types_8h__incl.map b/docs/tiny__types_8h__incl.map index 8b503fbe..a872bbcf 100644 --- a/docs/tiny__types_8h__incl.map +++ b/docs/tiny__types_8h__incl.map @@ -1,3 +1,3 @@ - + diff --git a/docs/tiny__types_8h__incl.png b/docs/tiny__types_8h__incl.png index b54d80e2..673d103b 100644 Binary files a/docs/tiny__types_8h__incl.png and b/docs/tiny__types_8h__incl.png differ diff --git a/docs/tiny__types_8h_source.html b/docs/tiny__types_8h_source.html index 907e0e96..3232f57d 100644 --- a/docs/tiny__types_8h_source.html +++ b/docs/tiny__types_8h_source.html @@ -22,7 +22,7 @@
    Tiny protocol -  0.9.3 +  0.11.0
    Tiny communication protocol for microcontrollers
    @@ -68,28 +68,28 @@
    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 "include/avr_hal.h"
    35 #elif defined(__XTENSA__)
    36 #include "include/esp32_hal.h"
    37 #elif defined(ARDUINO)
    38 #include "include/arduino_hal.h"
    39 #elif defined(__linux__)
    40 #include "include/linux_hal.h"
    41 #elif defined(__MINGW32__)
    42 #include "include/mingw32_hal.h"
    43 #else
    44 #warning "Platform not supported. Multithread support is disabled"
    45 #include "include/no_platform_hal.h"
    46 #endif
    47 
    48 #include <stdint.h>
    49 
    51 #ifdef CONFIG_ENABLE_FCS32
    52  typedef uint32_t fcs_t;
    53 #else
    54  typedef uint16_t fcs_t;
    55 #endif
    56 
    62 #define TINY_SUCCESS (0)
    64 #define TINY_ERR_FAILED (-1)
    66 #define TINY_ERR_TIMEOUT (-2)
    68 #define TINY_ERR_DATA_TOO_LARGE (-3)
    70 #define TINY_ERR_INVALID_DATA (-4)
    72 #define TINY_ERR_BUSY (-5)
    74 #define TINY_ERR_OUT_OF_SYNC (-6)
    76 #define TINY_ERR_AGAIN (-7)
    78 #define TINY_ERR_WRONG_CRC (-8)
    80 
    88 #define TINY_FLAG_NO_WAIT (0)
    90 #define TINY_FLAG_READ_ALL (1)
    92 #define TINY_FLAG_LOCK_SEND (2)
    94 #define TINY_FLAG_WAIT_FOREVER (0x80)
    96 
    103 typedef struct
    104 {
    106  uint32_t oosyncBytes;
    108  uint32_t bytesSent;
    110  uint32_t bytesReceived;
    112  uint32_t framesSent;
    114  uint32_t framesReceived;
    116  uint32_t framesBroken;
    117 } STinyStats;
    118 
    128 typedef int (*write_block_cb_t)(void *pdata, const void *buffer, int size);
    129 
    139 typedef int (*read_block_cb_t)(void *pdata, void *buffer, int size);
    140 
    141 
    152 typedef void (*on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size);
    153 
    154 #define EVENT_BIS_ALL 0xFF
    155 #define EVENT_BITS_CLEAR 1
    156 #define EVENT_BITS_LEAVE 0
    157 
    158 
    162 void tiny_mutex_create(tiny_mutex_t *mutex);
    163 
    168 void tiny_mutex_destroy(tiny_mutex_t *mutex);
    169 
    174 void tiny_mutex_lock(tiny_mutex_t *mutex);
    175 
    182 uint8_t tiny_mutex_try_lock(tiny_mutex_t *mutex);
    183 
    188 void tiny_mutex_unlock(tiny_mutex_t *mutex);
    189 
    194 void tiny_events_create(tiny_events_t *events);
    195 
    200 void tiny_events_destroy(tiny_events_t *events);
    201 
    211 uint8_t tiny_events_wait(tiny_events_t *event, uint8_t bits,
    212  uint8_t clear, uint32_t timeout);
    213 
    223 uint8_t tiny_events_check_int(tiny_events_t *event, uint8_t bits, uint8_t clear);
    224 
    230 void tiny_events_set(tiny_events_t *event, uint8_t bits);
    231 
    237 void tiny_events_clear(tiny_events_t *event, uint8_t bits);
    238 
    243 void tiny_sleep(uint32_t ms);
    244 
    248 uint32_t tiny_millis();
    249 
    254 void tiny_log_level(uint8_t level);
    255 
    256 #ifdef __cplusplus
    257 }
    258 #endif
    259 
    tiny_mutex_destroy
    void tiny_mutex_destroy(tiny_mutex_t *mutex)
    -
    STinyStats::framesBroken
    uint32_t framesBroken
    Number of broken frames received.
    Definition: tiny_types.h:116
    -
    STinyStats::bytesReceived
    uint32_t bytesReceived
    Number of payload bytes totally received through the channel.
    Definition: tiny_types.h:110
    +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 "include/avr_hal.h"
    35 #elif defined(__XTENSA__)
    36 #include "include/esp32_hal.h"
    37 #elif defined(ARDUINO)
    38 #include "include/arduino_hal.h"
    39 #elif defined(__linux__)
    40 #include "include/linux_hal.h"
    41 #elif defined(__MINGW32__)
    42 #include "include/mingw32_hal.h"
    43 #elif defined(_WIN32)
    44 #include "include/win32_hal.h"
    45 #else
    46 #info "Platform not supported. Multithread support is disabled"
    47 #include "include/no_platform_hal.h"
    48 #endif
    49 
    50 #include <stdint.h>
    51 
    53 #ifdef CONFIG_ENABLE_FCS32
    54  typedef uint32_t fcs_t;
    55 #else
    56  typedef uint16_t fcs_t;
    57 #endif
    58 
    64 #define TINY_SUCCESS (0)
    66 #define TINY_ERR_FAILED (-1)
    68 #define TINY_ERR_TIMEOUT (-2)
    70 #define TINY_ERR_DATA_TOO_LARGE (-3)
    72 #define TINY_ERR_INVALID_DATA (-4)
    74 #define TINY_ERR_BUSY (-5)
    76 #define TINY_ERR_OUT_OF_SYNC (-6)
    78 #define TINY_ERR_AGAIN (-7)
    80 #define TINY_ERR_WRONG_CRC (-8)
    82 
    90 #define TINY_FLAG_NO_WAIT (0)
    92 #define TINY_FLAG_READ_ALL (1)
    94 #define TINY_FLAG_LOCK_SEND (2)
    96 #define TINY_FLAG_WAIT_FOREVER (0x80)
    98 
    105 typedef struct
    106 {
    108  uint32_t oosyncBytes;
    110  uint32_t bytesSent;
    112  uint32_t bytesReceived;
    114  uint32_t framesSent;
    116  uint32_t framesReceived;
    118  uint32_t framesBroken;
    119 } STinyStats;
    120 
    130 typedef int (*write_block_cb_t)(void *pdata, const void *buffer, int size);
    131 
    141 typedef int (*read_block_cb_t)(void *pdata, void *buffer, int size);
    142 
    143 
    154 typedef void (*on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size);
    155 
    156 #define EVENT_BIS_ALL 0xFF
    157 #define EVENT_BITS_CLEAR 1
    158 #define EVENT_BITS_LEAVE 0
    159 
    160 
    164 void tiny_mutex_create(tiny_mutex_t *mutex);
    165 
    170 void tiny_mutex_destroy(tiny_mutex_t *mutex);
    171 
    176 void tiny_mutex_lock(tiny_mutex_t *mutex);
    177 
    184 uint8_t tiny_mutex_try_lock(tiny_mutex_t *mutex);
    185 
    190 void tiny_mutex_unlock(tiny_mutex_t *mutex);
    191 
    196 void tiny_events_create(tiny_events_t *events);
    197 
    202 void tiny_events_destroy(tiny_events_t *events);
    203 
    213 uint8_t tiny_events_wait(tiny_events_t *event, uint8_t bits,
    214  uint8_t clear, uint32_t timeout);
    215 
    225 uint8_t tiny_events_check_int(tiny_events_t *event, uint8_t bits, uint8_t clear);
    226 
    232 void tiny_events_set(tiny_events_t *event, uint8_t bits);
    233 
    239 void tiny_events_clear(tiny_events_t *event, uint8_t bits);
    240 
    245 void tiny_sleep(uint32_t ms);
    246 
    250 uint32_t tiny_millis();
    251 
    256 void tiny_log_level(uint8_t level);
    257 
    258 #ifdef __cplusplus
    259 }
    260 #endif
    261 
    tiny_mutex_destroy
    void tiny_mutex_destroy(tiny_mutex_t *mutex)
    +
    STinyStats::framesBroken
    uint32_t framesBroken
    Number of broken frames received.
    Definition: tiny_types.h:118
    +
    STinyStats::bytesReceived
    uint32_t bytesReceived
    Number of payload bytes totally received through the channel.
    Definition: tiny_types.h:112
    tiny_events_wait
    uint8_t tiny_events_wait(tiny_events_t *event, uint8_t bits, uint8_t clear, uint32_t timeout)
    -
    STinyStats::framesSent
    uint32_t framesSent
    Number of frames, successfully sent through the channel.
    Definition: tiny_types.h:112
    +
    STinyStats::framesSent
    uint32_t framesSent
    Number of frames, successfully sent through the channel.
    Definition: tiny_types.h:114
    tiny_events_clear
    void tiny_events_clear(tiny_events_t *event, uint8_t bits)
    -
    STinyStats
    Definition: tiny_types.h:103
    +
    STinyStats
    Definition: tiny_types.h:105
    tiny_millis
    uint32_t tiny_millis()
    -
    read_block_cb_t
    int(* read_block_cb_t)(void *pdata, void *buffer, int size)
    Definition: tiny_types.h:139
    -
    on_frame_cb_t
    void(* on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size)
    Definition: tiny_types.h:152
    -
    STinyStats::framesReceived
    uint32_t framesReceived
    Number of frames, successfully received through the communication channel.
    Definition: tiny_types.h:114
    -
    STinyStats::oosyncBytes
    uint32_t oosyncBytes
    Number of bytes received out of frame bytes.
    Definition: tiny_types.h:106
    +
    read_block_cb_t
    int(* read_block_cb_t)(void *pdata, void *buffer, int size)
    Definition: tiny_types.h:141
    +
    on_frame_cb_t
    void(* on_frame_cb_t)(void *handle, uint16_t uid, uint8_t *pdata, int size)
    Definition: tiny_types.h:154
    +
    STinyStats::framesReceived
    uint32_t framesReceived
    Number of frames, successfully received through the communication channel.
    Definition: tiny_types.h:116
    +
    STinyStats::oosyncBytes
    uint32_t oosyncBytes
    Number of bytes received out of frame bytes.
    Definition: tiny_types.h:108
    tiny_mutex_lock
    void tiny_mutex_lock(tiny_mutex_t *mutex)
    tiny_mutex_unlock
    void tiny_mutex_unlock(tiny_mutex_t *mutex)
    tiny_mutex_try_lock
    uint8_t tiny_mutex_try_lock(tiny_mutex_t *mutex)
    tiny_sleep
    void tiny_sleep(uint32_t ms)
    -
    write_block_cb_t
    int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
    Definition: tiny_types.h:128
    +
    write_block_cb_t
    int(* write_block_cb_t)(void *pdata, const void *buffer, int size)
    Definition: tiny_types.h:130
    tiny_events_destroy
    void tiny_events_destroy(tiny_events_t *events)
    tiny_events_check_int
    uint8_t tiny_events_check_int(tiny_events_t *event, uint8_t bits, uint8_t clear)
    tiny_events_set
    void tiny_events_set(tiny_events_t *event, uint8_t bits)
    -
    STinyStats::bytesSent
    uint32_t bytesSent
    Number of payload bytes totally sent through the channel.
    Definition: tiny_types.h:108
    -
    tiny_log_level
    void tiny_log_level(uint8_t level)
    Definition: tiny_types.c:41
    +
    STinyStats::bytesSent
    uint32_t bytesSent
    Number of payload bytes totally sent through the channel.
    Definition: tiny_types.h:110
    +
    tiny_log_level
    void tiny_log_level(uint8_t level)
    Definition: tiny_types.c:43
    tiny_events_create
    void tiny_events_create(tiny_events_t *events)
    tiny_mutex_create
    void tiny_mutex_create(tiny_mutex_t *mutex)
    diff --git a/docs/win32__hal_8h_source.html b/docs/win32__hal_8h_source.html new file mode 100644 index 00000000..7c64eeb1 --- /dev/null +++ b/docs/win32__hal_8h_source.html @@ -0,0 +1,79 @@ + + + + + + + +Tiny protocol: src/proto/hal/include/win32_hal.h Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    Tiny protocol +  0.11.0 +
    +
    Tiny communication protocol for microcontrollers
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    win32_hal.h
    +
    +
    +
    1 /*
    2  Copyright 2020 (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 <windows.h>
    23 //#include <pthread.h>
    24 //#include <unistd.h>
    25 #include <stdint.h>
    26 #include <time.h>
    27 
    28 #ifndef CONFIG_ENABLE_CHECKSUM
    29 # define CONFIG_ENABLE_CHECKSUM
    30 #endif
    31 
    32 #ifndef CONFIG_ENABLE_FCS16
    33 # define CONFIG_ENABLE_FCS16
    34 #endif
    35 
    36 #ifndef CONFIG_ENABLE_FCS32
    37 # define CONFIG_ENABLE_FCS32
    38 #endif
    39 
    40 #ifndef DOXYGEN_SHOULD_SKIP_THIS
    41 
    46 typedef HANDLE tiny_mutex_t;
    47 
    52 typedef struct
    53 {
    54  uint8_t bits;
    55  uint16_t waiters;
    56  CRITICAL_SECTION mutex;
    57  CONDITION_VARIABLE cond;
    58 } tiny_events_t;
    59 
    60 #endif
    + +
    +Generated by   +doxygen + 1.8.13 +
    + + diff --git a/docs/win32__serial_8h.html b/docs/win32__serial_8h.html new file mode 100644 index 00000000..4c54eb9d --- /dev/null +++ b/docs/win32__serial_8h.html @@ -0,0 +1,127 @@ + + + + + + + +Tiny protocol: src/proto/hal/serial/win32_serial.h File Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    Tiny protocol +  0.11.0 +
    +
    Tiny communication protocol for microcontrollers
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Macros | +Typedefs
    +
    +
    win32_serial.h File Reference
    +
    +
    + +

    UART serial API. +More...

    +
    #include <windows.h>
    +
    +Include dependency graph for win32_serial.h:
    +
    +
    + + +
    +
    +

    Go to the source code of this file.

    + + + + +

    +Macros

    #define TINY_SERIAL_INVALID   INVALID_HANDLE_VALUE
     
    + + + + +

    +Typedefs

    +typedef HANDLE tiny_serial_handle_t
     Unique port handle.
     
    +

    Detailed Description

    +

    UART serial API.

    +

    This is UART support implementation.

    +

    Macro Definition Documentation

    + +

    ◆ TINY_SERIAL_INVALID

    + +
    +
    + + + + +
    #define TINY_SERIAL_INVALID   INVALID_HANDLE_VALUE
    +
    +

    Invalid serial handle definition

    + +
    +
    +
    + +
    +Generated by   +doxygen + 1.8.13 +
    + + diff --git a/docs/win32__serial_8h__incl.map b/docs/win32__serial_8h__incl.map new file mode 100644 index 00000000..f6a31289 --- /dev/null +++ b/docs/win32__serial_8h__incl.map @@ -0,0 +1,2 @@ + + diff --git a/docs/win32__serial_8h__incl.md5 b/docs/win32__serial_8h__incl.md5 new file mode 100644 index 00000000..ec762a0f --- /dev/null +++ b/docs/win32__serial_8h__incl.md5 @@ -0,0 +1 @@ +e225368e0fe2556c7b8cb962ff08c300 \ No newline at end of file diff --git a/docs/win32__serial_8h__incl.png b/docs/win32__serial_8h__incl.png new file mode 100644 index 00000000..71bc0ec1 Binary files /dev/null and b/docs/win32__serial_8h__incl.png differ diff --git a/docs/win32__serial_8h_source.html b/docs/win32__serial_8h_source.html new file mode 100644 index 00000000..c3d102d1 --- /dev/null +++ b/docs/win32__serial_8h_source.html @@ -0,0 +1,80 @@ + + + + + + + +Tiny protocol: src/proto/hal/serial/win32_serial.h Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    Tiny protocol +  0.11.0 +
    +
    Tiny communication protocol for microcontrollers
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    win32_serial.h
    +
    +
    +Go to the documentation of this file.
    1 /*
    2  Copyright 2017,2020 (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 */
    26 #pragma once
    27 
    28 #ifdef __cplusplus
    29 extern "C" {
    30 #endif
    31 
    32 #include <windows.h>
    33 
    35 typedef HANDLE tiny_serial_handle_t;
    37 #define TINY_SERIAL_INVALID INVALID_HANDLE_VALUE
    38 
    39 #ifdef __cplusplus
    40 }
    41 #endif
    42 
    tiny_serial_handle_t
    HANDLE tiny_serial_handle_t
    Unique port handle.
    Definition: win32_serial.h:35
    +
    + +
    +Generated by   +doxygen + 1.8.13 +
    + +