perf(ipcam2mqtt): Initial release

BREAKING CHANGE: Is it breaking if it is new??

Author: Stephan van Rooij

README.md

@@ -1,2 +1,94 @@
 # ipcam2mqtt
-IPCamera alarm to MQTT bridge inspired to the mqtt-smarthome project.
+
+[![npm](https://img.shields.io/npm/v/ipcam2mqtt.svg?style=flat-square)](https://www.npmjs.com/package/ipcam2mqtt)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
+
+This node.js application is a bridge between the your IP Cameras (with sound or motion detection) and a mqtt server. That way your can have your home respond to sound detection events.
+
+It's intended as a building block in heterogenous smart home environments where an MQTT message broker is used as the centralized message bus. See [MQTT Smarthome on Github](https://github.com/mqtt-smarthome/mqtt-smarthome) for a rationale and architectural overview.
+
+## Installation
+
+Using ipcam2mqtt is really easy, but it requires at least [Node.js](https://nodejs.org/) v6 or higher. (This app is tested against v6 and v8).
+
+`sudo npm install -g ipcam2mqtt`
+
+## Usage
+
+```plain
+ipcam2mqtt 0.0.0-development
+Usage: ipcam2mqtt [options]
+
+Options:
+  -m, --mqtt         mqtt broker url. See
+                     https://github.com/svrooij/ipcam2mqtt#mqtt-url
+                                                   [default: "mqtt://127.0.0.1"]
+  -n, --name         instance name. used as mqtt client id and as topic prefix
+                                                            [default: "cameras"]
+  -p, --port         The port to run on                          [default: 8000]
+  --timeout          The timeout in seconds for resetting back to inactive, -1
+                     for no reset                                  [default: 10]
+  -k, --keep-images  Set this if you want to keep the images in mqtt   [boolean]
+  -h, --help         Show help                                         [boolean]
+  -l, --logging      possiblevalues: "error", "warn","info","debug"
+                                                               [default: "info"]
+  --version          Show version number                               [boolean]
+```
+
+### MQTT Url
+
+Use the MQTT url to connect to your specific mqtt server. Check out [mqtt.connect](https://github.com/mqttjs/MQTT.js#connect) for the full description.
+
+```plain
+Connection without port (port 1883 gets used)
+[protocol]://[address] (eg. mqtt://127.0.0.1)
+
+Connection with port
+[protocol]://[address]:[port] (eg. mqtt://127.0.0.1:1883)
+
+Secure connection with username/password and port
+[protocol]://[username]:[password]@[address]:[port] (eg. mqtts://myuser:[email protected]:8883)
+```
+
+### Configure your cameras
+
+You now have and FTP server running on your computer. Now you can configure the cameras to send FTP snapshots to it when it detects movement or sound. The username you supply will be used as the device name.
+
+## Topics
+
+Every message starts with the instance name (specified with the `-n` argument), which defaults to `cameras` so we'll asume the default.
+
+### Connect messages
+
+This bridge uses the `cameras/connected` topic to send retained connection messages. Use this topic to check your if your hue bridge is still running.
+
+- `0` or missing is not connected (set by will functionality).
+- `1` is connected to mqtt, but have not received an image.
+- `2` is connected to mqtt and received our first image from a camera.
+
+### Motion detected
+
+If there is motion detected (eg. a file is received over FTP), you will see two messages on your mqtt server.
+A motion message on `cameras/username/motion` with the following properties
+
+- `name` The username used for the connection
+- `val` current state of the device. `active` or `inactive`
+- `filename` The filename of the uploaded image
+- `kind` The guessed kind of detection (based on the filename)
+- `ts` timestamp of last update.
+
+And an image message on `cameras/username/image`, this will just contain the raw image data. And can be displayed by various sources.
+
+## Use [PM2](http://pm2.keymetrics.io) to run in background
+
+If everything works as expected, you should make the app run in the background automatically. Personally I use PM2 for this. And they have a great [guide for this](http://pm2.keymetrics.io/docs/usage/quick-start/).
+
+## Special thanks
+
+This bridge is inspired on [hue2mqtt.js](https://github.com/hobbyquaker/hue2mqtt.js) by [Sabastian Raff](https://github.com/hobbyquaker). That was a great sample on how to create a globally installed, command-line, something2mqtt bridge.
+
+The actual FTP server part is mostly copied, improved and simplified from [mqtt-camera-ftpd](https://github.com/stjohnjohnson/mqtt-camera-ftpd/). It wasn't really working anymore and it wasn't a true CLI tool hence this new and improved version.
+
+## Beer
+
+This bridge took me a lot of hours to build, so I invite everyone using it to [Buy me a beer](https://✌️.tk/beer)