From 1843098412029a26c2b5918b9f430f1d99fd5a69 Mon Sep 17 00:00:00 2001 From: Rob Tillaart Date: Tue, 24 Oct 2023 15:46:58 +0200 Subject: [PATCH] 0.2.2 DEVRANDOM --- libraries/DEVRANDOM/CHANGELOG.md | 6 ++++- libraries/DEVRANDOM/DEVRANDOM.cpp | 6 ++--- libraries/DEVRANDOM/DEVRANDOM.h | 7 +++--- libraries/DEVRANDOM/README.md | 33 +++++++++++++++++++++++++- libraries/DEVRANDOM/library.json | 4 ++-- libraries/DEVRANDOM/library.properties | 2 +- 6 files changed, 45 insertions(+), 13 deletions(-) diff --git a/libraries/DEVRANDOM/CHANGELOG.md b/libraries/DEVRANDOM/CHANGELOG.md index ffb427d4..57bab96b 100644 --- a/libraries/DEVRANDOM/CHANGELOG.md +++ b/libraries/DEVRANDOM/CHANGELOG.md @@ -6,11 +6,15 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). +## [0.2.2] - 2023-10-24 +- update readme.md +- fix version in .cpp + + ## [0.2.1] - 2022-10-31 - add changelog.md - add rp2040 to build-CI - ## [0.2.0] - 2022-07-02 - add Marsaglia PRNG, is portable over platforms, becomes mode 3 - improved reseeding diff --git a/libraries/DEVRANDOM/DEVRANDOM.cpp b/libraries/DEVRANDOM/DEVRANDOM.cpp index a856df54..3eba9662 100644 --- a/libraries/DEVRANDOM/DEVRANDOM.cpp +++ b/libraries/DEVRANDOM/DEVRANDOM.cpp @@ -1,11 +1,9 @@ // // FILE: DEVRANDOM.cpp // AUTHOR: Rob Tillaart -// VERSION: 0.2.0 +// VERSION: 0.2.2 // PURPOSE: Arduino library for a /dev/random stream - useful for testing // URL: https://github.com/RobTillaart/DEVRANDOM -// -// HISTORY: see changelog.md #include "DEVRANDOM.h" @@ -168,5 +166,5 @@ uint32_t DEVRANDOM::_marsaglia() } -// -- END OF FILE -- +// -- END OF FILE -- diff --git a/libraries/DEVRANDOM/DEVRANDOM.h b/libraries/DEVRANDOM/DEVRANDOM.h index 28803057..1e2fb127 100644 --- a/libraries/DEVRANDOM/DEVRANDOM.h +++ b/libraries/DEVRANDOM/DEVRANDOM.h @@ -2,16 +2,15 @@ // // FILE: DEVRANDOM.h // AUTHOR: Rob Tillaart -// VERSION: 0.2.1 +// VERSION: 0.2.2 // PURPOSE: Arduino library for a /dev/random stream - useful for testing // URL: https://github.com/RobTillaart/DEVRANDOM -// #include "Arduino.h" -#define DEVRANDOM_LIB_VERSION (F("0.2.1")) +#define DEVRANDOM_LIB_VERSION (F("0.2.2")) #define DEVRANDOM_MODE_RANDOM 0 @@ -72,5 +71,5 @@ private: }; -// -- END OF FILE -- +// -- END OF FILE -- diff --git a/libraries/DEVRANDOM/README.md b/libraries/DEVRANDOM/README.md index e40b13b7..42a396bb 100644 --- a/libraries/DEVRANDOM/README.md +++ b/libraries/DEVRANDOM/README.md @@ -2,8 +2,11 @@ [![Arduino CI](https://github.com/RobTillaart/DEVRANDOM/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci) [![Arduino-lint](https://github.com/RobTillaart/DEVRANDOM/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/DEVRANDOM/actions/workflows/arduino-lint.yml) [![JSON check](https://github.com/RobTillaart/DEVRANDOM/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/DEVRANDOM/actions/workflows/jsoncheck.yml) +[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/DEVRANDOM.svg)](https://github.com/RobTillaart/DEVRANDOM/issues) + [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/DEVRANDOM/blob/master/LICENSE) [![GitHub release](https://img.shields.io/github/release/RobTillaart/DEVRANDOM.svg?maxAge=3600)](https://github.com/RobTillaart/DEVRANDOM/releases) +[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/DEVRANDOM.svg)](https://registry.platformio.org/libraries/robtillaart/DEVRANDOM) # DEVRANDOM @@ -17,8 +20,19 @@ The library implements a stream class that mimics the /dev/random device of a Linux system. It can be used for testing with streams. +#### Related + +- https://github.com/RobTillaart/DEVFULL +- https://github.com/RobTillaart/DEVNULL +- https://github.com/RobTillaart/DEVRANDOM + + ## Interface +```cpp +#include "DEVRANDOM.h" +``` + ### Constructor - **DEVRANDOM()** Constructor. @@ -106,7 +120,14 @@ So a password generator is a bit more difficult (and a good exercise). ## Future +#### Must + - improve documentation. + +#### Should + +#### Could + - add examples. - add other (portable) PRNG. - **available()** returns 1, @@ -116,4 +137,14 @@ So a password generator is a bit more difficult (and a good exercise). - when changing mode should \_next == **peek()** be reset? - yes, think so ```_next = _rnd();``` - when already in that mode? (=> complex) - + +#### Wont + +## Support + +If you appreciate my libraries, you can support the development and maintenance. +Improve the quality of the libraries by providing issues and Pull Requests, or +donate through PayPal or GitHub sponsors. + +Thank you, + diff --git a/libraries/DEVRANDOM/library.json b/libraries/DEVRANDOM/library.json index 9058f581..ed3bf22f 100644 --- a/libraries/DEVRANDOM/library.json +++ b/libraries/DEVRANDOM/library.json @@ -15,9 +15,9 @@ "type": "git", "url": "https://github.com/RobTillaart/DEVRANDOM.git" }, - "version": "0.2.1", + "version": "0.2.2", "license": "MIT", - "frameworks": "arduino", + "frameworks": "*", "platforms": "*", "headers": "DEVRANDOM.h" } diff --git a/libraries/DEVRANDOM/library.properties b/libraries/DEVRANDOM/library.properties index f8477f26..663c766b 100644 --- a/libraries/DEVRANDOM/library.properties +++ b/libraries/DEVRANDOM/library.properties @@ -1,5 +1,5 @@ name=DEVRANDOM -version=0.2.1 +version=0.2.2 author=Rob Tillaart maintainer=Rob Tillaart sentence=Arduino library to wrap a random generator in a stream