-
Notifications
You must be signed in to change notification settings - Fork 0
/
SimpleSerial.h
397 lines (333 loc) · 12.2 KB
/
SimpleSerial.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
/*
* If not stated otherwise in this file or this component's LICENSE file the
* following copyright and licenses apply:
*
* Copyright 2022 Metrological
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#include <algorithm>
#include <cstring>
#include <stdint.h>
#ifndef ASSERT
#define ASSERT(x)
#endif
namespace Thunder {
namespace SimpleSerial {
namespace Protocol {
// Super Simple Serial Protocol
//
// Request from Host
// | OperationType | SequenceType | DeviceAddressType | LengthType | DataType | CRC8 |
//
// Response from target
// | OperationType | SequenceType | ResultType | LengthType | DataType | CRC8 |
//
// Request from Host
// |0x01|0x00|0x12|0x00|CRC8|
// Response from target
// |0x01|0x00|0x01|0x00|CRC8|
//
// Request from Host
// |0x01|0x01|0x13|0x00|CRC8|
// Response from target
// |0x01|0x01|0x01|0x00|CRC8|
enum class OperationType : uint8_t {
RESET = 0x01, // reset/(dis)enable controller/peripheral
ALLOCATE,
FREE,
KEY, // Do a key action press/release + keycode
SETTINGS, // Send/Retrieve (VID/PID/NAME)
STATE, // Get the state of all devices
EVENT = 0x80 //
};
typedef uint8_t SequenceType;
typedef uint8_t DeviceAddressType;
typedef uint8_t LengthType;
typedef uint8_t* DataType;
typedef uint8_t CRC8Type;
constexpr uint8_t Preamble = 0xAA; // weird hook in ascii-2
constexpr uint8_t InvalidAddress = DeviceAddressType(~0);
enum class ResultType : uint8_t {
OK = 0x00,
NOT_CONNECTED,
UNSUPPORTED,
NOT_AVAILABLE,
TRANSMIT_FAILED,
CRC_INVALID,
OPERATION_INVALID,
PAYLOAD_INVALID
};
constexpr uint8_t MaxDataSize = 0xFF;
constexpr uint8_t MaxPayloadSize = MaxDataSize - (sizeof(SequenceType) + sizeof(OperationType) + sizeof(DeviceAddressType) + sizeof(LengthType) + sizeof(CRC8Type));
constexpr uint8_t HeaderSize = sizeof(OperationType) + sizeof(SequenceType) + sizeof(DeviceAddressType) + sizeof(LengthType);
static uint8_t CRC8(const uint8_t length, const uint8_t data[])
{
uint8_t crc(~0);
uint8_t i, j;
for (i = 0; i < length; i++) {
crc ^= data[i];
for (j = 0; j < 8; j++) {
if ((crc & 0x80) != 0)
crc = static_cast<uint8_t>(((crc << 1) ^ 0x31));
else
crc <<= 1;
}
}
return crc;
}
struct Message {
uint8_t _buffer[MaxDataSize];
uint8_t _size;
mutable uint8_t _offset;
mutable bool _preamble;
Message& operator=(const Message& message)
{
Clear();
memcpy(_buffer, message.Data(), message.Size());
_size = message.Size();
_offset = 0;
_preamble = false;
return *this;
}
void Clear()
{
std::memset(_buffer, 0, sizeof(_buffer));
_size = 0;
_offset = 0;
_preamble = false;
}
uint16_t Deserialize(const uint16_t length, const uint8_t data[])
{
uint16_t result(0);
uint8_t offset(0);
// Flush all data untill we find the preamble.
while ((_preamble == false) && (offset < length)) {
_preamble = (data[offset++] == Preamble);
}
// recover from a incomplete message in the buffer
if (((length - offset) > 0) && (data[offset] == Preamble)) {
_size = 0;
_offset = 0;
_preamble = true;
}
if ((length - offset) > 0) {
if (_size < HeaderSize) {
result = std::min(uint16_t(length - offset), uint16_t(HeaderSize - _size));
std::memcpy(&_buffer[_size], &data[offset], result);
_size += result;
}
if ((_size >= HeaderSize) && (result < length)) {
uint8_t copyLength = std::min(uint8_t(length - result - offset), uint8_t((HeaderSize + PayloadLength() + sizeof(CRC8Type)) - _size));
std::memcpy(&_buffer[_size], &(data[offset + result]), copyLength);
_size += copyLength;
result += copyLength;
}
}
return result + offset;
}
uint16_t Serialize(uint16_t length, uint8_t data[]) const
{
uint16_t copyLength(0);
uint8_t offset(0);
if (_preamble == false) {
std::memcpy(data, &Preamble, sizeof(Preamble));
offset += sizeof(Preamble);
_preamble = true;
}
if ((_preamble == true) && (length - offset > 0)) {
copyLength = std::min(uint16_t(length - offset), uint16_t(_size - _offset));
ASSERT(IsComplete() == true);
if (copyLength > 0) {
std::memcpy(&data[offset], &_buffer[_offset], copyLength);
_offset += copyLength;
}
}
return copyLength + offset;
}
bool IsComplete() const
{
return ((_size > HeaderSize) && (_size >= (HeaderSize + PayloadLength() + sizeof(CRC8Type))));
}
bool IsValid() const
{
return (IsComplete() && CRC8((HeaderSize + PayloadLength()), _buffer) == _buffer[(HeaderSize + PayloadLength())]);
}
inline uint8_t Size() const
{
return _size;
}
inline const uint8_t* Data() const
{
return _buffer;
}
inline DeviceAddressType Address() const
{
ASSERT(_size >= 3);
return static_cast<DeviceAddressType>(_buffer[2]);
}
inline void Address(const DeviceAddressType address)
{
if (_size < 3) {
_size = 3;
}
_buffer[2] = static_cast<uint8_t>(address);
}
inline OperationType Operation() const
{
ASSERT(_size >= 1);
return static_cast<OperationType>(_buffer[0]);
}
inline void Operation(const OperationType operation)
{
if (_size < 1) {
_size = 1;
}
_buffer[0] = static_cast<uint8_t>(operation);
}
inline LengthType PayloadLength() const
{
ASSERT(_size >= 4);
return static_cast<LengthType>(_buffer[3]);
}
inline void PayloadLength(const LengthType length)
{
if (_size < 4) {
_size = 4;
}
_buffer[3] = static_cast<uint8_t>(length);
}
inline const uint8_t* Payload() const
{
return &_buffer[HeaderSize];
}
inline uint8_t Payload(const uint8_t length, const uint8_t data[])
{
uint8_t result(0);
if ((length > 0) && (length <= MaxPayloadSize)) {
if (_size < (HeaderSize + length)) {
_size = (HeaderSize + length);
}
_buffer[3] = static_cast<uint8_t>(length);
memcpy(&_buffer[HeaderSize], data, length);
}
return result;
}
inline ResultType Result() const
{
ASSERT(_size >= 3);
return static_cast<ResultType>(_buffer[2]);
}
inline void Result(const ResultType result)
{
if (_size < 3) {
_size = 3;
}
_buffer[2] = static_cast<uint8_t>(result);
}
inline SequenceType Sequence() const
{
ASSERT(_size >= 2);
return static_cast<SequenceType>(_buffer[1]);
}
inline void Sequence(const SequenceType sequence)
{
if (_size < 2) {
_size = 2;
}
_buffer[1] = static_cast<uint8_t>(sequence);
}
inline uint8_t Finalize()
{
CRC8Type crc(0);
if ((_size >= HeaderSize) && (_size >= (HeaderSize + PayloadLength()))) {
crc = CRC8((HeaderSize + PayloadLength()), _buffer);
_buffer[HeaderSize + PayloadLength()] = crc;
_size = HeaderSize + PayloadLength() + sizeof(CRC8Type);
}
// Ready to be send...
_offset = 0;
_preamble = false;
return crc;
}
};
} // namespace Protocol
namespace Payload {
enum class Action : uint8_t {
RELEASED = 0x00,
PRESSED = 0x01
};
enum class Peripheral : uint8_t {
ROOT = 0x00,
IR = 0x20,
BLE = 0x40
};
#pragma pack(push, 1)
typedef struct KeyEvent {
Action pressed;
uint16_t code;
} KeyEvent;
typedef struct BLESettings {
uint16_t vid;
uint16_t pid;
char name[64];
char manufacturer[64];
} BLESettings;
typedef struct BatteryLevel {
uint8_t percentage;
} BatteryLevel;
//
// TODO:
// Somehow we need to be able to register keyCodes to ProntoHex codes or
// add a learn function to the plugin.
// more info:
// http://www.hifi-remote.com/wiki/index.php/Working_With_Pronto_Hex
// http://www.remotecentral.com/features/irdisp2.htm
//
// tools for analysing IR and generating ProntoHex.
// http://www.harctoolbox.org/IrScrutinizer.html (Opensource)
// https://www.analysir.com/ (Paid)
//
// generic IR signal [mark][space][address][command](stop bit)
//
// __||||||||||___________|||___|||______|||___|||______|||______|||___|||.....
// | mark | space |m s |m s | | | | |
// | header | 0 | 1 | 0 | 1 | 1 | 0 |
//
//
typedef struct IRSignal {
uint16_t mark_us;
uint16_t space_us;
} IRSignal;
typedef struct IRSettings {
uint16_t carrier_hz;
uint8_t address_bits;
uint16_t address;
IRSignal header;
IRSignal zero;
IRSignal one;
bool msb_first;
bool stopbit;
} IRSettings;
typedef struct Device {
Protocol::DeviceAddressType address;
Peripheral peripheral;
} Device;
typedef struct State {
Device* devices;
} State;
#pragma pack(pop)
} // namespace Payload
} // namespace SimpleSerial
} // namespace Thunder