-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
22 changed files
with
1,809 additions
and
25 deletions.
There are no files selected for viewing
7 changes: 7 additions & 0 deletions
7
C3MikroBUS/PlatformIO/ESP32C3CDC_QuickEspNowSync/lib/MessagePack/CHANGELOG.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Project change log | ||
|
||
The format is based on [Keep a Changelog](http://keepachangelog.com/) | ||
and this project adheres to [Semantic Versioning](http://semver.org/). | ||
|
||
## [1.0.0] 2018-10-15 | ||
Initial version |
165 changes: 165 additions & 0 deletions
165
C3MikroBUS/PlatformIO/ESP32C3CDC_QuickEspNowSync/lib/MessagePack/LICENSE
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,165 @@ | ||
GNU LESSER GENERAL PUBLIC LICENSE | ||
Version 3, 29 June 2007 | ||
|
||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> | ||
Everyone is permitted to copy and distribute verbatim copies | ||
of this license document, but changing it is not allowed. | ||
|
||
|
||
This version of the GNU Lesser General Public License incorporates | ||
the terms and conditions of version 3 of the GNU General Public | ||
License, supplemented by the additional permissions listed below. | ||
|
||
0. Additional Definitions. | ||
|
||
As used herein, "this License" refers to version 3 of the GNU Lesser | ||
General Public License, and the "GNU GPL" refers to version 3 of the GNU | ||
General Public License. | ||
|
||
"The Library" refers to a covered work governed by this License, | ||
other than an Application or a Combined Work as defined below. | ||
|
||
An "Application" is any work that makes use of an interface provided | ||
by the Library, but which is not otherwise based on the Library. | ||
Defining a subclass of a class defined by the Library is deemed a mode | ||
of using an interface provided by the Library. | ||
|
||
A "Combined Work" is a work produced by combining or linking an | ||
Application with the Library. The particular version of the Library | ||
with which the Combined Work was made is also called the "Linked | ||
Version". | ||
|
||
The "Minimal Corresponding Source" for a Combined Work means the | ||
Corresponding Source for the Combined Work, excluding any source code | ||
for portions of the Combined Work that, considered in isolation, are | ||
based on the Application, and not on the Linked Version. | ||
|
||
The "Corresponding Application Code" for a Combined Work means the | ||
object code and/or source code for the Application, including any data | ||
and utility programs needed for reproducing the Combined Work from the | ||
Application, but excluding the System Libraries of the Combined Work. | ||
|
||
1. Exception to Section 3 of the GNU GPL. | ||
|
||
You may convey a covered work under sections 3 and 4 of this License | ||
without being bound by section 3 of the GNU GPL. | ||
|
||
2. Conveying Modified Versions. | ||
|
||
If you modify a copy of the Library, and, in your modifications, a | ||
facility refers to a function or data to be supplied by an Application | ||
that uses the facility (other than as an argument passed when the | ||
facility is invoked), then you may convey a copy of the modified | ||
version: | ||
|
||
a) under this License, provided that you make a good faith effort to | ||
ensure that, in the event an Application does not supply the | ||
function or data, the facility still operates, and performs | ||
whatever part of its purpose remains meaningful, or | ||
|
||
b) under the GNU GPL, with none of the additional permissions of | ||
this License applicable to that copy. | ||
|
||
3. Object Code Incorporating Material from Library Header Files. | ||
|
||
The object code form of an Application may incorporate material from | ||
a header file that is part of the Library. You may convey such object | ||
code under terms of your choice, provided that, if the incorporated | ||
material is not limited to numerical parameters, data structure | ||
layouts and accessors, or small macros, inline functions and templates | ||
(ten or fewer lines in length), you do both of the following: | ||
|
||
a) Give prominent notice with each copy of the object code that the | ||
Library is used in it and that the Library and its use are | ||
covered by this License. | ||
|
||
b) Accompany the object code with a copy of the GNU GPL and this license | ||
document. | ||
|
||
4. Combined Works. | ||
|
||
You may convey a Combined Work under terms of your choice that, | ||
taken together, effectively do not restrict modification of the | ||
portions of the Library contained in the Combined Work and reverse | ||
engineering for debugging such modifications, if you also do each of | ||
the following: | ||
|
||
a) Give prominent notice with each copy of the Combined Work that | ||
the Library is used in it and that the Library and its use are | ||
covered by this License. | ||
|
||
b) Accompany the Combined Work with a copy of the GNU GPL and this license | ||
document. | ||
|
||
c) For a Combined Work that displays copyright notices during | ||
execution, include the copyright notice for the Library among | ||
these notices, as well as a reference directing the user to the | ||
copies of the GNU GPL and this license document. | ||
|
||
d) Do one of the following: | ||
|
||
0) Convey the Minimal Corresponding Source under the terms of this | ||
License, and the Corresponding Application Code in a form | ||
suitable for, and under terms that permit, the user to | ||
recombine or relink the Application with a modified version of | ||
the Linked Version to produce a modified Combined Work, in the | ||
manner specified by section 6 of the GNU GPL for conveying | ||
Corresponding Source. | ||
|
||
1) Use a suitable shared library mechanism for linking with the | ||
Library. A suitable mechanism is one that (a) uses at run time | ||
a copy of the Library already present on the user's computer | ||
system, and (b) will operate properly with a modified version | ||
of the Library that is interface-compatible with the Linked | ||
Version. | ||
|
||
e) Provide Installation Information, but only if you would otherwise | ||
be required to provide such information under section 6 of the | ||
GNU GPL, and only to the extent that such information is | ||
necessary to install and execute a modified version of the | ||
Combined Work produced by recombining or relinking the | ||
Application with a modified version of the Linked Version. (If | ||
you use option 4d0, the Installation Information must accompany | ||
the Minimal Corresponding Source and Corresponding Application | ||
Code. If you use option 4d1, you must provide the Installation | ||
Information in the manner specified by section 6 of the GNU GPL | ||
for conveying Corresponding Source.) | ||
|
||
5. Combined Libraries. | ||
|
||
You may place library facilities that are a work based on the | ||
Library side by side in a single library together with other library | ||
facilities that are not Applications and are not covered by this | ||
License, and convey such a combined library under terms of your | ||
choice, if you do both of the following: | ||
|
||
a) Accompany the combined library with a copy of the same work based | ||
on the Library, uncombined with any other library facilities, | ||
conveyed under the terms of this License. | ||
|
||
b) Give prominent notice with the combined library that part of it | ||
is a work based on the Library, and explaining where to find the | ||
accompanying uncombined form of the same work. | ||
|
||
6. Revised Versions of the GNU Lesser General Public License. | ||
|
||
The Free Software Foundation may publish revised and/or new versions | ||
of the GNU Lesser General Public License from time to time. Such new | ||
versions will be similar in spirit to the present version, but may | ||
differ in detail to address new problems or concerns. | ||
|
||
Each version is given a distinguishing version number. If the | ||
Library as you received it specifies that a certain numbered version | ||
of the GNU Lesser General Public License "or any later version" | ||
applies to it, you have the option of following the terms and | ||
conditions either of that published version or of any later version | ||
published by the Free Software Foundation. If the Library as you | ||
received it does not specify a version number of the GNU Lesser | ||
General Public License, you may choose any version of the GNU Lesser | ||
General Public License ever published by the Free Software Foundation. | ||
|
||
If the Library as you received it specifies that a proxy can decide | ||
whether future versions of the GNU Lesser General Public License shall | ||
apply, that proxy's public statement of acceptance of any version is | ||
permanent authorization for you to choose that version for the | ||
Library. |
160 changes: 160 additions & 0 deletions
160
C3MikroBUS/PlatformIO/ESP32C3CDC_QuickEspNowSync/lib/MessagePack/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,160 @@ | ||
# MessagePack | ||
|
||
MessagePack is a library for AVR, SAMD, ESP8266 and ESP32 platforms to pack/unpack values into a compact, self-explanatory binary message. | ||
|
||
[![version](https://img.shields.io/badge/version-1.0.0-brightgreen.svg)](CHANGELOG.md) | ||
[![travis](https://travis-ci.org/xoseperez/messagepack.svg?branch=master)](https://travis-ci.org/xoseperez/messagepack) | ||
[![codacy](https://img.shields.io/codacy/grade/54c6bf3a367745509677e28dfbe1e0d1/master.svg)](https://www.codacy.com/app/xoseperez/messagepack/dashboard) | ||
[![license](https://img.shields.io/github/license/xoseperez/MessagePack.svg)](LICENSE) | ||
<br /> | ||
[![donate](https://img.shields.io/badge/donate-PayPal-blue.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=xose%2eperez%40gmail%2ecom&lc=US&no_note=0¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHostedGuest) | ||
[![twitter](https://img.shields.io/twitter/follow/xoseperez.svg?style=social)](https://twitter.com/intent/follow?screen_name=xoseperez) | ||
|
||
## Features | ||
|
||
The main features of the MessagePack library are: | ||
|
||
* Compact yet self-explanatory message format | ||
* Targeted to wireless communication | ||
* Support for boolean, short, integer, long, and float numbers and c-strings. | ||
|
||
## Usage | ||
|
||
Check the examples folder for working examples of the library. | ||
|
||
### Packing | ||
|
||
``` | ||
#include "MessagePack.h" | ||
void send(unsigned char * data, unsigned char length) { | ||
// ... | ||
} | ||
void setup() { | ||
MessagePack * message = new MessagePack(); | ||
// Add some values, for instance temperature, humidity and pressure | ||
message->addFloat(25.4); | ||
message->addShort(67); | ||
message->addFloat(1013.45); | ||
// Send message | ||
send(message->pack(), message->length()); | ||
} | ||
loop() {} | ||
``` | ||
|
||
### Unpacking | ||
|
||
``` | ||
#include "MessagePack.h" | ||
void parse(unsigned char * data, unsigned char length) { | ||
MessagePack * message = new MessagePack(); | ||
// Load the data | ||
message->unpack(data, length); | ||
// Number of elements | ||
unsigned char count = message->count(); | ||
Serial.print("Number of values: "); | ||
Serial.println(count); | ||
// Walk elements (only for integer numbers, see example for full functionality) | ||
char buffer[32]; | ||
for (unsigned char i=0; i<count; i++) { | ||
unsigned char type = message->type(i); | ||
if (MESSAGE_PACK_BOOLEAN == type) { | ||
snprintf(buffer, sizeof(buffer), "Value #%d is a BOOLEAN: %d\n", i, message->getBoolean(i) ? 1 : 0); | ||
} else if (MESSAGE_PACK_SHORT == type) { | ||
snprintf(buffer, sizeof(buffer), "Value #%d is a SHORT: %u\n", i, message->getShort(i)); | ||
} else if (MESSAGE_PACK_INTEGER == type) { | ||
snprintf(buffer, sizeof(buffer), "Value #%d is an INTEGER: %u\n", i, message->getInteger(i)); | ||
} else if (MESSAGE_PACK_LONG == type) { | ||
snprintf(buffer, sizeof(buffer), "Value #%d is a LONG: %lu\n", i, message->getLong(i)); | ||
} | ||
Serial.print(buffer); | ||
} | ||
} | ||
setup() {} | ||
loop() { | ||
if (Serial.available()) { | ||
// ... | ||
// send the message to the parser routine | ||
parse(data, length); | ||
} | ||
} | ||
``` | ||
|
||
## Format | ||
|
||
This library works under the following assumptions: | ||
|
||
* Data is in little-endian format (least significant byte, is at the lowest address) | ||
* Integers have a length of 8, 16 or 32 bits (for SHORT, INTEGER and LONG types) | ||
* Floats are represented in IEEE 754 single-precision format, and have a length of 32 bits | ||
* Booleans are represented in a byte (1 = true, 0 = false) | ||
* Strings are ended by the NULL char (0x00) | ||
|
||
Data is binary packed with this format: | ||
|
||
* First byte: number of values packed in the string | ||
* N bytes with the information about the data type of each packed value. Each byte have information about 2 packed values, one for each nibble. Data types are coded in this way: | ||
* 0b0000: Null | ||
* 0b0001: Boolean | ||
* 0b0010: Short | ||
* 0b0011: Integer | ||
* 0b0100: Long | ||
* 0b0101: Float | ||
* 0b0110: String | ||
* N bytes of data | ||
|
||
``` | ||
The pack string (without spaces) for 17 (short), true (boolean), nil and 452 (integer) are: | ||
03 21 30 11 01 C401 | ||
03 is the number of packed values, in this case 3 | ||
21 is the type of the first and second packed values: short and boolean | ||
30 is the type of the third and fourth packed values: integer and null | ||
11 is integer 17 (0x11) in hexadecimal 1-byte integer (a.k.a. short) | ||
01 is boolean true | ||
C401 is integer 452 (0x01C4) in 2-bytes little-endian | ||
Total length is 7 bytes. Take note that the nil value is only present in the header and has not representation in the data. | ||
``` | ||
|
||
## License | ||
|
||
Copyright (C) 2018 by Xose Pérez <xose dot perez at gmail dot com> | ||
|
||
The MessagePack library is free software: you can redistribute it and/or modify | ||
it under the terms of the GNU Lesser General Public License as published by | ||
the Free Software Foundation, either version 3 of the License, or | ||
(at your option) any later version. | ||
|
||
The MessagePack library is distributed in the hope that it will be useful, | ||
but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
GNU Lesser General Public License for more details. | ||
|
||
You should have received a copy of the GNU Lesser General Public License | ||
along with the MessagePack library. If not, see <http://www.gnu.org/licenses/>. |
53 changes: 53 additions & 0 deletions
53
C3MikroBUS/PlatformIO/ESP32C3CDC_QuickEspNowSync/lib/MessagePack/examples/pack/pack.ino
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
/* | ||
MessagePack - Packing example | ||
Copyright (C) 2018 by Xose Pérez <[email protected]> | ||
This program is free software: you can redistribute it and/or modify | ||
it under the terms of the GNU General Public License as published by | ||
the Free Software Foundation, either version 3 of the License, or | ||
(at your option) any later version. | ||
This program is distributed in the hope that it will be useful, | ||
but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
GNU Lesser General Public License for more details. | ||
You should have received a copy of the GNU Lesser General Public License | ||
along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
*/ | ||
|
||
#include "MessagePack.h" | ||
|
||
void setup() { | ||
|
||
// Init serial communications | ||
Serial.begin(115200); | ||
while (!Serial); | ||
Serial.println(); | ||
Serial.println("MessagePack Library - Packing example"); | ||
Serial.println(); | ||
|
||
// Create a message pack object, defaults to 100 bytes of memory | ||
MessagePack * message = new MessagePack(); | ||
|
||
// Add some values, for instance temperature, humidity and pressure | ||
message->addFloat(25.4); | ||
message->addShort(67); | ||
message->addFloat(1013.45); | ||
|
||
// Now dump message to serial | ||
char buffer[6]; | ||
Serial.print("Packed message: { "); | ||
for (unsigned char i=0; i<message->length(); i++) { | ||
if (i>0) Serial.print(", "); | ||
snprintf(buffer, sizeof(buffer), "0x%02X", message->pack()[i]); | ||
Serial.print(buffer); | ||
} | ||
Serial.println(" }"); | ||
|
||
} | ||
|
||
void loop() {} |
9 changes: 9 additions & 0 deletions
9
...kroBUS/PlatformIO/ESP32C3CDC_QuickEspNowSync/lib/MessagePack/examples/pack/platformio.ini
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
[platformio] | ||
src_dir = . | ||
lib_extra_dirs = ../.. | ||
env_default = leonardo | ||
|
||
[env:leonardo] | ||
platform = atmelavr | ||
board = leonardo | ||
framework = arduino |
Oops, something went wrong.