Webcamviewer_XH - a CMSimple_XH Plugin

Webcamviewer_XH facilitates displaying an image, that will be refreshed after some customizable interval. Its intended use is to display the current snapshot of a webcam, which places the most recent image in the same place. If Javascript is disabled in the user's browser, Webcamviewer_XH degrades gracefully by displaying the image without refreshing it.

Please do read this documentation! Support might not be given otherwise. It's generally a good idea to read the documentation, before you encounter any problems!

Important Notice

Webcamviewer_XH couldn't be tested so far in various environments. It is a so called BETA version. Use with caution!

Requirements

Webcamviewer_XH is a plugin for CMSimple_XH. It requires a UTF-8 encoded version and jQuery4CMSimple.

Installation

The installation is done as with many other CMSimple_XH plugins. See the CMSimple_XH wiki for further details.

  1. Backup the data on your server.
  2. Unzip the distribution on your computer.
  3. Upload the whole directory webcamviewer/ to your server to CMSimple_XH's plugins directory.
  4. Set write permissions to the subdirectories config/, css/ and languages/.
  5. Switch to "Webcamviewer" in the back-end to check if all requirements are fulfilled.

Settings

The plugin's configuration is done as with many other CMSimple_XH plugins in the website's back-end. Select "Webcamviewer" from "Plugins".

You can change the default settings of Webcamviewer_XH in "Plugin Config". Hints for the options will be displayed when hovering over the help icon with your mouse.

Localization is done in "Plugin Language". You can translate the character strings to your own language, or customize them according to your needs.

The look of Webcamviewer_XH can be customized in "Plugin Stylesheet".

Usage

To enable Webcamviewer_XH you have to set "autoload" to 1, or if you want to save some resources, enable it individually for each page where it's needed, by calling:

{{{PLUGIN:webcamviewer();}}}

This will cause every image with class="webcamviewer" to be refreshed periodically after the configured "interval". It's mandatory that the image is placed directly in the configured "folder images". This is done for security reasons, as the images are served by a PHP script to disable the caching of the images in the browser. But this PHP script won't recognize any access protections for HTTP access to files, so a malicious user could access other images on the server.

License

Webcamviewer_XH is licensed under GPLv3.

© 2012 Christoph M. Becker

Credits

Webcamviewer was inspired by wolfgang_58.

The plugin icon is designed by Alessandro Rei. Many thanks for publishing this icon under GPL.

This plugin uses free applications icons from Aha-Soft. Many thanks for making these icons freely available.

And last but not least many thanks to Peter Harteg, the father of CMSimple, and all developers of CMSimple_XH without whom this amazing CMS wouldn't exist.