-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Snapshot Binding
Documentation of the Snapshot binding bundle for use with CCTV cameras.
This binding is designed to be used in conjuction with cameras that can send snapshot JPG images to the server that OpenHab is running on. The binding continually monitors directories for new images and fires events when a new image arrives. This means that you can build rules to do cool things when your cameras detect movement such as ring a door bell, send a notification or sound an alarm.
The binding includes a web servlet which generates html pages and thumbnails so you can conveniently browse your snapshots.
The binding is also capable of capping the number of images in the directory based upon either file count or number of days so you don't run out of disk space.
In order to bind an item to a snapshot directory, all you need to do is configure a generic item binding in your items configuration folder like this:
DateTime cam1 "Cam 1 [%1$td/%1$tm/%1$tY %1$tT %1$tZ]" <calendar> { snapshot="path=/path/to/cam1;maxFiles=50" }
Note that the type of the item must be DateTime
because it contains the timestamp of the most recent snapshot.
You can of course have multiple items if you have multiple cameras/directories.
The sitemap entry to see the timestamp of the most recent snapshot is trivial:
Text item=cam1
Here's an example sitemap with two hikvision cameras with corresponding items gateSnapshot
and garageSnaphsot
. The cameras are on the local network at 192.168.1.5 and 192.168.1.6 using default hikvision credentials:
Text label="Cameras" icon="camera" {
Frame label="Cameras" {
Text label="Recent Activity" icon="none" {
Webview url="/snapshot" height=14
}
Text label="Garage Snapshot" icon="camera" {
Frame {
Image label="Camera" url="http://admin:[email protected]/Streaming/channels/1/picture"
}
}
Text item=garageSnapshot {
Frame {
Image url="http://localhost:8080/snapshot?action=snapshot&name=garageSnapshot&size=1217:614"
}
}
Text label="Gate Snapshot" icon="camera" {
Frame {
Image label="Camera" url="http://admin:[email protected]/Streaming/channels/1/picture"
}
}
Text item=gateSnapshot {
Frame {
Image url="http://localhost:8080/snapshot?action=snapshot&name=gateSnapshot&size=1217:619"
}
}
}
}
If you are using Foscam then try using URLs such as http://ip address:port/cgi-bin/CGIProxy.fcgi?cmd=snapPicture2&usr=admin&pwd=xxx (thanks to Zacofany for the tip)
Modify your logback.xml file to debug if needed:
<logger name="org.openhab.binding.snapshop" level="DEBUG" />
When a new snapshot appears then the binding does the following:
- if the option
maxDays
is configured, it deletes any snapshots older than the given value - if the option
maxFiles
is configured, it sorts the snapshots by creation date, then deletes the oldest files so that the file count for the given folder does not exceed the given value
The binding has a webservlet with the following features:
- renders a servlet at /snapshot to summarise the folders and their contents
- groups the snapshots based on timestamp (if snapshots are less than a minute apart they are presumed to relate to the same event and so are grouped together). This means it's easy to browse recent 'events'. The snapshot shown in the summary view is the middle snapshot.
- renders a webpage to provide a list of snapshots in a specific group
- uses tokens and template files (I took the concept from the excellent weather binding) so that you can fully customise the webpages
- can optionally resize snapshots to create thumbs/previews in the webpages
- can render the original snapshot
To use it, create a subdirectory in webapps called snapshot-resources
and provide template files for the various views. Please see this example zip of template files which should be self explanatory.
ℹ Please find all documentation for openHAB 2 under http://docs.openhab.org.
The wiki pages here contain (outdated) documentation for the older openHAB 1.x version. Please be aware that a lot of core details changed with openHAB 2.0 and this wiki as well as all tutorials found for openHAB 1.x might be misleading. Check http://docs.openhab.org for more details and consult the community forum for all remaining questions.
- Classic UI
- iOS Client
- Android Client
- Windows Phone Client
- GreenT UI
- CometVisu
- Kodi
- Chrome Extension
- Alfred Workflow
- Cosm Persistence
- db4o Persistence
- Amazon DynamoDB Persistence
- Exec Persistence
- Google Calendar Presence Simulator
- InfluxDB Persistence
- JDBC Persistence
- JPA Persistence
- Logging Persistence
- mapdb Persistence
- MongoDB Persistence
- MQTT Persistence
- my.openHAB Persistence
- MySQL Persistence
- rrd4j Persistence
- Sen.Se Persistence
- SiteWhere Persistence
- AKM868 Binding
- AlarmDecoder Binding
- Anel Binding
- Arduino SmartHome Souliss Binding
- Asterisk Binding
- Astro Binding
- Autelis Pool Control Binding
- BenQ Projector Binding
- Bluetooth Binding
- Bticino Binding
- CalDAV Binding
- Chamberlain MyQ Binding
- Comfo Air Binding
- Config Admin Binding
- CUL Transport
- CUL Intertechno Binding
- CUPS Binding
- DAIKIN Binding
- Davis Binding
- DD-WRT Binding
- Denon Binding
- digitalSTROM Binding
- DIY on XBee Binding
- DMX512 Binding
- DSC Alarm Binding
- DSMR Binding
- eBUS Binding
- Ecobee Binding
- EDS OWSever Binding
- eKey Binding
- Energenie Binding
- EnOcean Binding
- Enphase Energy Binding
- Epson Projector Binding
- Exec Binding
- Expire Binding
- Fatek PLC Binding
- Freebox Binding
- Freeswitch Binding
- Frontier Silicon Radio Binding
- Fritz AHA Binding
- Fritz!Box Binding
- FritzBox-TR064-Binding
- FS20 Binding
- Garadget Binding
- Global Caché IR Binding
- GPIO Binding
- HAI/Leviton OmniLink Binding
- HDAnywhere Binding
- Heatmiser Binding
- Homematic / Homegear Binding
- Horizon Mediabox Binding
- HTTP Binding
- IEC 62056-21 Binding
- IHC / ELKO Binding
- ImperiHome Binding
- Insteon Hub Binding
- Insteon PLM Binding
- IPX800 Binding
- IRtrans Binding
- jointSPACE-Binding
- KM200 Binding
- KNX Binding
- Koubachi Binding
- LCN Binding
- LightwaveRF Binding
- Leviton/HAI Omnilink Binding
- Lg TV Binding
- Logitech Harmony Hub
- MailControl Binding
- MAX!Cube-Binding
- MAX! CUL Binding
- MCP23017 I/O Expander Binding
- MCP3424 ADC Binding
- MiLight Binding
- MiOS Binding
- Mochad X10 Binding
- Modbus Binding
- MPD Binding
- MQTT Binding
- MQTTitude binding
- MystromEcoPower Binding
- Neohub Binding
- Nest Binding
- Netatmo Binding
- Network Health Binding
- Network UPS Tools Binding
- Nibe Heatpump Binding
- Nikobus Binding
- Novelan/Luxtronic Heatpump Binding
- NTP Binding
- One-Wire Binding
- Onkyo AV Receiver Binding
- Open Energy Monitor Binding
- OpenPaths presence detection binding
- OpenSprinkler Binding
- OSGi Configuration Admin Binding
- Panasonic TV Binding
- panStamp Binding
- Philips Hue Binding
- Picnet Binding
- Piface Binding
- PiXtend Binding
- pilight Binding
- Pioneer-AVR-Binding
- Plex Binding
- Plugwise Binding
- PLCBus Binding
- PowerDog Local API Binding
- Powermax alarm Binding
- Primare Binding
- Pulseaudio Binding
- Raspberry Pi RC Switch Binding
- RFXCOM Binding
- RWE Smarthome Binding
- Sager WeatherCaster Binding
- Samsung AC Binding
- Samsung TV Binding
- Serial Binding
- Sallegra Binding
- Satel Alarm Binding
- Siemens Logo! Binding
- SimpleBinary Binding
- Sinthesi Sapp Binding
- Smarthomatic Binding
- Snmp Binding
- Somfy URTSI II Binding
- Sonance Binding
- Sonos Binding
- Souliss Binding
- Squeezebox Binding
- Stiebel Eltron Heatpump
- Swegon ventilation Binding
- System Info Binding
- TA CMI Binding
- TCP/UDP Binding
- Tellstick Binding
- TinkerForge Binding
- Tivo Binding
- UCProjects.eu Relay Board Binding
- UPB Binding
- VDR Binding
- Velleman-K8055-Binding
- Wago Binding
- Wake-on-LAN Binding
- Waterkotte EcoTouch Heatpump Binding
- Weather Binding
- Wemo Binding
- Withings Binding
- XBMC Binding
- xPL Binding
- Yamahareceiver Binding
- Zibase Binding
- Z-Wave Binding
- Asterisk
- DoorBird
- FIND
- Foscam IP Cameras
- LG Hombot
- Worx Landroid
- Heatmiser PRT Thermostat
- Google Calendar
- Linux Media Players
- Osram Lightify
- Rainforest EAGLE Energy Access Gateway
- Roku Integration
- ROS Robot Operating System
- Slack
- Telldus Tellstick
- Zoneminder
- Wink Hub (rooted)
- Wink Monitoring
- openHAB Cloud Connector
- Google Calendar Scheduler
- Transformations
- XSLT
- JSON
- REST-API
- Security
- Service Discovery
- Voice Control
- BritishGasHive-Using-Ruby
- Dropbox Bundle
A good source of inspiration and tips from users gathered over the years. Be aware that things may have changed since they were written and some examples might not work correctly.
Please update the wiki if you do come across any out of date information.
- Rollershutter Bindings
- Squeezebox
- WAC Binding
- WebSolarLog
- Alarm Clock
- Convert Fahrenheit to Celsius
- The mother of all lighting rules
- Reusable Rules via Functions
- Combining different Items
- Items, Rules and more Examples of a SmartHome
- Google Map
- Controlling openHAB with Android
- Usecase examples
- B-Control Manager
- Spell checking for foreign languages
- Flic via Tasker
- Chromecast via castnow
- Speedtest.net integration