durbok/noodl-docs
1
0
Fork 0
mirror of https://github.com/noodlapp/noodl-docs.git synced 2026-01-11 23:02:54 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Initial commit

Browse Source 
Co-Authored-By: kotte <14197736+mrtamagotchi@users.noreply.github.com>
Co-Authored-By: mikaeltellhed <2311083+mikaeltellhed@users.noreply.github.com>
Co-Authored-By: Tore Knudsen <18231882+torekndsn@users.noreply.github.com>
Co-Authored-By: Michael Cartner <32543275+michaelcartner@users.noreply.github.com>
This commit is contained in:
Eric Tuvesson
2023-09-05 12:08:55 +02:00
commit 53f0d6320e
2704 changed files with 76354 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
library/modules/qr-scanner/nodes/camera-qr-scanner/README.md Normal file
View File

@@ -0,0 +1,44 @@
---
title: Camera QR Scanner
hide_title: true
---
<##head##>
# Camera QR Scanner
The **Camera QR Scanner** node is used to open the camera view finder and scan for QR codes. It uses a [Video](/nodes/basic-elements/video) node to display the camera stream.
<div className="ndl-image-with-background l">
![](/library/modules/qr-scanner/nodes/camera-qr-scanner/camera-qr-scanner.png)
</div>
When a QR code has been successfully identified, the node will send a <span className="ndl-signal">Scan Successful</span> event and the decoded string, otherwise <span className="ndl-signal">Scan Failed</span>.
In this node, the decoding happens in real time, meaning if the QR code is not visible anymore the node will send an event to indicate that the scanning failed.
<##head##>
## Inputs
| Data | Description |
| ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Video Node</span> | This input should be connected to the **Dom Element** output of the **Video** node that's used render the camera view finder. |
| <span className="ndl-data">Front Facing</span> | A **boolean** that decides if the front facing camera should be used (default) or the user facing came. |
| <span className="ndl-data">Max Scans Per Second</span> | The number of scans per second the scanner will do to find QR codes. Lowering this number may improve performance if needed. Note that changing this number after triggering **Start** will have no effect. |
| Signal | Description |
| ----------------------------------------- | --------------------------------------------------------- |
| <span className="ndl-signal">Start</span> | Opens the camera stream and starts scanning for QR codes. |
| <span className="ndl-signal">Stop</span> | Stops the camera stream and stops scanning for QR codes. |
## Outputs
| Data | Description |
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Scan Result</span> | This output contains the decoded string when a QR code has been found and decoded. If no QR code is found this string will be empty. |
| <span className="ndl-data">Valid Scan</span> | A **boolean** that is **true** if the last scan was valid, otherwise **false**. |
| Signal | Description |
| --------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Scan Successful</span> | Sends a signal when a successful scan was done. The resulting scan is on the **Scan Result** output. |
| <span className="ndl-signal">Scan Failed</span> | Sends a signal when the latest scan failed, i.e. no QR code was found. |

41
library/modules/qr-scanner/nodes/image-qr-scanner/README.md Normal file
View File

@@ -0,0 +1,41 @@
---
title: Image QR Scanner
hide_title: true
---
<##head##>
# Image QR Scanner
The **Image QR Scanner** node is used to scane an image for a QR code. It's typically used in conjunction with the [Open File Picker](/nodes/utilities/open-file-picker/) node, to allow the user to upload a file.
<div className="ndl-image-with-background l">
![](/library/modules/qr-scanner/nodes/image-qr-scanner/image-qr-scanner.png)
</div>
When a QR code has been successfully identified, the node will send a <span className="ndl-signal">Scan Successful</span> event and the decoded string, otherwise <span className="ndl-signal">Scan Failed</span>.
<##head##>
## Inputs
| Data | Description |
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Image File</span> | The image file to look for the QR code in. Typically provided through an **Open File Picker** node. The input should be of type [File](https://developer.mozilla.org/en-US/docs/Web/API/File) |
| Signal | Description |
| ---------------------------------------- | ------------------------------------------------------------------------- |
| <span className="ndl-signal">Scan</span> | Triggers a QR code scan in the file provided in the **Image File** input. |
## Outputs
| Data | Description |
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Scan Result</span> | This output contains the decoded string when a QR code has been found and decoded. If no QR code is found this string will be empty. |
| <span className="ndl-data">Valid Scan</span> | A **boolean** that is **true** if the last scan was valid, otherwise **false**. |
| Signal | Description |
| --------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Scan Successful</span> | Sends a signal when a successful scan was done. The resulting scan is on the **Scan Result** output. |
| <span className="ndl-signal">Scan Failed</span> | Sends a signal when the latest scan failed, i.e. no QR code was found. |