Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/svrooij/ipcam2mqtt
:video_camera: IPCamera alarm to MQTT bridge inspired to the mqtt-smarthome project.
https://github.com/svrooij/ipcam2mqtt
ipcam mqtt mqtt-smarthome
Last synced: 3 months ago
JSON representation
:video_camera: IPCamera alarm to MQTT bridge inspired to the mqtt-smarthome project.
- Host: GitHub
- URL: https://github.com/svrooij/ipcam2mqtt
- Owner: svrooij
- License: mit
- Created: 2017-10-20T09:22:42.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-04-08T22:14:53.000Z (almost 3 years ago)
- Last Synced: 2024-09-28T14:01:23.399Z (4 months ago)
- Topics: ipcam, mqtt, mqtt-smarthome
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/ipcam2mqtt
- Size: 365 KB
- Stars: 26
- Watchers: 5
- Forks: 5
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ipcam2mqtt
[![npm][badge_npm]][link_npm]
[![docker pulls][badge_docker]][link_docker]
[![Support me on Github][badge_sponsor]][link_sponsor]
[![travis][badge_travis]][link_travis]
[![github issues][badge_issues]][link_issues]
[](https://github.com/mqtt-smarthome/mqtt-smarthome)
[](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 node v10, v13 and the latest lts version).
`npm install -g ipcam2mqtt`
## Usage
```plain
ipcam2mqtt 0.0.0-development
Usage: index.js [options]
Options:
-m, --mqtt mqtt broker url. See
https://github.com/svrooij/ipcam2mqtt#mqtt-url
[default: "mqtt://127.0.0.1"]
-i, --instance 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]
-v, --verbosity Set the verbosity.
[choices: "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 `-i` 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 ipcam2mqtt 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/).
To start ipcam2mqtt with PM2, you have to use this command.
```bash
pm2 start ipcam2mqtt -x -- [regular-options]
# the -x -- part is to tell pm2 you want to specify arguments to the script. example:
pm2 start ipcam2mqtt -x -- -i cameras -m mqtt://your.mqtt.host:1883
```
## Docker
You can also run this bridge on docker. Be sure to specify your own mqtt connection string! This command connects port `8021` (you can change this) to the container where the bridge runs at `8021`.
You can also set the other properties by using the `-e "IPCAM2MQTT_...=newvalue"` argument. All the properties can be set with the prefix `IPCAM2MQTT_` followed by the full name.
```Shell
docker run -d -e "IPCAM2MQTT_MQTT=mqtt://your.mqtt.nl:1883" -p 8021:8021 --name ipcam2mqtt svrooij/ipcam2mqtt:latest
# Open (and follow) the logs
docker logs ipcam2mqtt -f
```
## 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 check out my brand new Github [sponsor page][link_sponsor]
[badge_sponsor]: https://img.shields.io/badge/Sponsor-on%20Github-red
[badge_issues]: https://img.shields.io/github/issues/svrooij/ipcam2mqtt
[badge_npm]: https://img.shields.io/npm/v/ipcam2mqtt
[badge_travis]: https://img.shields.io/travis/svrooij/ipcam2mqtt
[badge_docker]: https://img.shields.io/docker/pulls/svrooij/ipcam2mqtt
[link_sponsor]: https://github.com/sponsors/svrooij
[link_issues]: https://github.com/svrooij/ipcam2mqtt/issues
[link_npm]: https://www.npmjs.com/package/ipcam2mqtt
[link_travis]: https://travis-ci.org/svrooij/ipcam2mqtt
[link_docker]: https://hub.docker.com/r/svrooij/ipcam2mqtt