readme update
[node-red-contrib-onvif.git] / README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# node-red-contrib-onvif

A <a href="http://nodered.org" target="_blank">Node-RED</a> node that interacts with ip cameras using the ONVIF protocol.

## Install

Run the following command in the root directory of your Node-RED install

    npm install node-red-contrib-onvif

## Flows usage

### Input
```json
msg.payload = {
    url: "", // IP camera URL
    username: "", // IP camera username
    password: "", // IP camera password
}
```

### Output
```json
msg.payload = {
    image: {
        "base64": "", // Base64 encoded image
        "binary": "", // Binary image
    }
}
```

## Dashboard Usage

ONVIF Snapshot returns msg.payload in the form of a base64 encoded image to use with a Node-RED Dashboard template

    <img src="{{ msg.payload.image.base64 }}">

comments