Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rzeldent/micro-moustache
Minimal moustache implementation for micro controllers
https://github.com/rzeldent/micro-moustache
arduino esp32 esp8266 microcontroller moustache template-engine text-templating
Last synced: 3 months ago
JSON representation
Minimal moustache implementation for micro controllers
- Host: GitHub
- URL: https://github.com/rzeldent/micro-moustache
- Owner: rzeldent
- License: mit
- Created: 2022-10-01T08:39:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-21T08:12:44.000Z (about 1 year ago)
- Last Synced: 2023-12-21T10:38:11.100Z (about 1 year ago)
- Topics: arduino, esp32, esp8266, microcontroller, moustache, template-engine, text-templating
- Language: C++
- Homepage:
- Size: 34.2 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Micro Moustache
Minimal moustache implementation for Arduino and other micro controllers.
## Introduction
Moustache is a logic-less template processor. This makes it easy to replace text or in- or exclude parts of text.
This is especially handy for creating dynamic HTML!
This library is a minimal implementation of the original library. The original library is available for many platforms but, to my knowledge, not Arduino... Until now!
The original project can be found at [http://mustache.github.io/](http://mustache.github.io/) and the manual at [http://mustache.github.io/mustache.5.html](http://mustache.github.io/mustache.5.html).
However, in this library only a few functionalities are implemented.
## Passing variables to the template
Variables need to be present in an array of the structure ```moustache_variable_t```. The original implementation of Moustache uses json but this is overkill for micro controllers. Micro Moustache uses an array of a structure that holds a key and a value.
```
typedef struct moustache_variable
{
const char *key;
String value;
} moustache_variable_t;
```
Some features like looping are not possible using this data structure but keeps it simple.
The value is defined as a string. This makes it easy to convert values to string as a lot of conversions are already implemented in the String class.
A typical definition of the variables will look like this. The immediate values below can of course be replaced by variables.
```
moustache_variable_t substitutions[] = {
{"Version", "1.0"},
{"LoggedIn", String(false)},
{"UserName", String("Jake")},
...
...
};
```
## Implemented features
The following sections contain a list of implemented features. The examples are take from the official Moustache documentation.
### Replacing variables
Variables can be replaced using the syntax: ```{{variable}}```.
example:
```
Hello {{name}}
You have just won {{value}} dollars!
```
with variables:
```
moustache_variable_t substitutions[] = {
{"name", "Chris"},
{"value", String(10000)}
};
auto result = moustache_render(taxes, substitutions);
Serial.println(result);
```
will render:
```
Hello Chris
You have just won 10000 dollars!
```
### Include Section
Sections can be included using the syntax: ```{{#expr}}Text to be included{/expr}```.
The expression needs to be a boolean expression and, as the String class is used, booleans convert to "0" or "1".
example:
```
{{#in_ca}}
Well, {{taxed_value}} dollars, after taxes.
{{/in_ca}}
```
with variables:
```
moustache_variable_t substitutions[] = {
{"taxed_value", String(10000 - (10000 * 0.4))},
{"in_ca", String(true)}
};
auto result = moustache_render(taxes, substitutions);
Serial.println(result);
```
will render:
```
Well, 6000.0 dollars, after taxes.
```
### Inverted Section
Sections can be included using the syntax: ```{{^expr}}Text to be included{/expr}```.
The expression needs to be a boolean expression and, as the String class is used, booleans convert to "0" or "1".
example:
```
{{#in_ca}}
Well, {{taxed_value}} dollars, after taxes.
{{/in_ca}}
{{^in_ca}}
And no taxes paid!
{{/in_ca}}
```
with variables:
```
moustache_variable_t substitutions[] = {
{"taxed_value", String(10000 - (10000 * 0.4))},
{"in_ca", String(false)}
};
auto result = moustache_render(taxes, substitutions);
Serial.println(result);
```
will render:
```
And no taxes paid!
```
## Collaboration
Collaboration is appreciated and bug reports or feature requests are welcome!
## Change history
- Oct 2022
- Initial version
- Feb 2023
- Changed the const String& value in the moustache variable to String value.
This will allow to change the variable without recreating the complete array.
This update requires removing the const for the moustache_variable_t.