Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zanzythebar/easyhelpers
https://github.com/zanzythebar/easyhelpers
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/zanzythebar/easyhelpers
- Owner: ZanzyTHEbar
- License: mit
- Created: 2024-03-31T20:46:58.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-08T16:09:20.000Z (5 months ago)
- Last Synced: 2024-10-10T21:13:33.424Z (26 days ago)
- Language: C++
- Size: 163 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# EasyHelpers Library
> [!IMPORTANT]\
> This library requires c++17
> see [extras](#extras)
This project supports the following boards:
- Xtensa
- ARM
Technically this library does not rely on any board API's and can even be compiled for ARM, RISCV, and AMD64. However, I built the library for work with ARM and Xtensa, and have not tested on other arches yet.
## Installation
### Platformio (recommended)
You can install via the `Platformio Registry` by navigating to the `Libraries` section of `Platformio`.
The library is called `EasyHelpers` by `ZanzyTHEbar`.
if you like to install the bleading edge, in your `platformio.ini` file add the following:
```ini
lib_deps =
https://github.com/ZanzyTHEbar/EasyHelper.git
```
#### Dependencies used in this project
- [ArduinoJson](https://github.com/bblanchon/ArduinoJson)
## Headers
- [`EasyHelpers.h`](/include/EasyHelpers.h) - Main header file for the library, includes the `EasyHelpers.hpp` file
- [`EasyHelpers.hpp`](/include/Easyhelpers.hpp) - A header file that includes all the headers above
- [`helpers/helpers.hpp`](/include/helpers/helpers.hpp) - Main helpers file, containing various string helpers
- [`helpers/iter_queue.hpp`](/include/helpers/iter_queue.hpp) - A queue that can be iterated over
- [`helpers/logger.hpp`](/include/helpers/logger.hpp) - A logger class that can be used to log messages
- [`helpers/observer.hpp`](/include/helpers/observer.hpp) - A class for the observer pattern
- [`helpers/strategy.hpp`](/include/helpers/strategy.hpp) - A class for the strategy pattern
- [`helpers/visitor.hpp`](/include/helpers/visitor.hpp) - A class for the visitor pattern
- [`helpers/make_unique.hpp`](/include/helpers/make_unique.hpp) - A helper function to create unique pointers (not really needed in c++17 - it's legacy)
- [`events/event.hpp`](/include/events/event.hpp) - A class for event managment using the `iter_queue`
- [`events/event_interface.hpp`](/include/events/event_interface.hpp) - An interface for the `event` class
## Usage
> [!IMPORTANT]\
> Coming Soon
For basic usage please see the [examples](/examples) folder.
## Configuration
> [!WARNING]\
> It is **required** to add a build flag to your setup for the code to function properly.
For `platformio` add the following to your `platformio.ini` file:
```ini
build_flags =
-std=gnu++17
build_unflags = -std=gnu++11
```
> [!WARNING]\
> This library is still in development, if there are any bugs please report them in the issues section.
## Extras
To see any of the `log` statements used in this library - you need to add this to your `platformio.ini`:
```ini
build_flags =
-DCORE_DEBUG_LEVEL=4 # add debug logging in serial monitor
-std=gnu++17
build_unflags = -std=gnu++11
; other build parameters
build_type = debug
lib_ldf_mode = deep
```
If you want to build in debug mode add this (it's not a build flag):
```ini
build_type = debug
```
## License
This library is licensed under the MIT License.
## Contributions
Contributions are welcome 🙂🎓