npm package: @prescient-devices-oss/node-red-contrib-usb-camera
Description: Front-end to the fswebcam utility to enable image capturing from within Node-RED
Author: Pablo Acosta-Serafini
Latest version: 1.1.6

@prescient-devices-oss/node-red-contrib-usb-camera
==============================================

This module is a front-end to the [fswebcam](https://github.com/fsphil/fswebcam) utility to enable image capturing from within Node-RED. This node is disabled if fswebcam is not detected.

### Inputs

#### Mode

There are four capture modes:

*   Template: the node output is a string with a fully specified HTML `img` tag. The image is included as a Base64-encoded string.

*   Encode: the node output is a Base64-encoded string with the image information.

*   Buffer: the node output is an array of numbers with the image information.

*   File: the node output is a string with the full path of the image file.

#### Format

Supported image formats are JPEG and PNG.

#### File name

When the mode is `File` this input selects the location of the output image file, which is also communicated in the node output. The default is `${NODERED_HOME}/image.[png|jpg]`. The specified directory is created if it does not exist. 

#### Size

Width x height, both have to be greater than zero. The default is `320`x`240`.

#### Quality

Number between `1` and `100` that determines the amount of compression in the captured image. `100`, the default, indicates no compression.

#### Brightness

Percentage that sets the relative image brightness. The default is 50%. This setting may not be available in all cameras, in which case it is ignored.

#### Contrast

Percentage that sets the relative image contrast. The default is 50%. This setting may not be available in all cameras, in which case it is ignored.

#### Saturation

Percentage that sets the relative image saturation. The default is 50%. This setting may not be available in all cameras, in which case it is ignored.

#### Hue

Percentage that sets the relative image hue. The default is 50%. This setting may not be available in all cameras, in which case it is ignored.

#### Delay

Approximate delay in milliseconds between the input message and the moment the image is captured. The default is no delay.

#### Name

Node name.

### Output

The node output depends on the input `Mode`:

*   Template: string with a fully specified HTML `img` tag. The image is included as a Base64-encoded string.

*   Encode: Base64-encoded string with the image information.

*   Buffer: array of numbers with the image information.

*   File: string with the full path of the image file.

Copyright 2020 Prescient Devices, Inc.

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.