public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[js-transform] Introduced support for additional parameters (#10901)

Browse Source 
* [js-transform] Introduced support for additional parameters


Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

* Added junit tests and updated readme

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

* Typo fixes

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

* Typo fix

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>

* Fixed junit test

Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>
This commit is contained in:
pali
2021-07-31 13:42:50 +03:00
committed by GitHub
parent 02c2513e28
commit 4b57ea28c8
8 changed files with 249 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
bundles/org.openhab.transform.javascript/README.md
View File

@@ -5,7 +5,7 @@ Transform an input to an output using JavaScript.
It expects the transformation rule to be read from a file which is stored under the `transform` folder.
To organize the various transformations, one should use subfolders.
## Example
## Examples
Let's assume we have received a string containing `foo bar baz` and we're looking for a length of the last word (`baz`).
@@ -18,6 +18,26 @@ transform/getValue.js:
})(input)
```
JavaScript transformation syntax also support additional parameters which can be passed to the script.
This can prevent redundancy when transformation is needed for several use cases, but with small adaptations.
additional parameters can be passed to the script via [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) query syntax.
As `input` name is reserved for transformed data, it can't be used in query parameters.
Also `?` and `&` characters are reserved, but if they need to passed as additional data, they can be escaped according to URI syntax.
transform/scale.js:
```
(function(data, cf, d) {
return parseFloat(data) * parseFloat(cf) / parseFloat(d);
})(input, correctionFactor, divider)
```
`transform/scale.js?correctionFactor=1.1&divider=10`
Following example will return value `23.54` when `input` data is `214`.
## Test JavaScript
You can use online JavaScript testers to validate your script.