= Foscam IP Camera Plugin =

This plugin offers support for pan, tilt, patrol, presets and motion detection.

__Note__: Presets are supported starting with MiOS firmware version 1.5.390.

'''__Note__: The motion detection part of the plugin works only with the Foscam cameras.'''

== Installation ==

=== UI5 ===
1. Go to ''Apps'' >> ''Install Apps'' and install the plugin. Alternatively, you can install it from http://apps.mios.com.
2. In the camera's ''Advanced'' tab enter ''I_FoscamPTZ.xml'' in the '''impl_file''' field.
3. Save.
4. '''Motion detection is disabled by default'''. To enable it open the ''Advanced'' tab of the camera device and scroll down to the ''ConfiguredMD'' field. ''-1'' means that it's disabled. To enable it set it to ''0''.

=== UI4 ===
1. Download these files:
 * [http://code.mios.com/trac/mios_foscam-camera/export/17/tags/2.5/I_FoscamPTZ.xml I_FoscamPTZ.xml]
 * [http://code.mios.com/trac/mios_foscam-camera/raw-attachment/wiki/WikiStart/D_DigitalSecurityCamera1.xml D_DigitalSecurityCamera1.xml]
2. Upload both files on Vera:
 * On the Vera UI, in the ''Toolbox'' section, open ''MiOS Developers'' >> ''Luup Files''.
 * Upload the files.
 * Uncheck ''Restart Luup after upload''.
 * Click ''GO''. 
3. Set the camera to use the I_FoscamPTZ.xml file as the implementation file:
 * On the Vera UI open the camera's control panel (click on the wrench).
 * On the ''Advanced'' tab, in the ''impl_file'' field enter ''I_FoscamPTZ.xml''
 * Close the control panel. 
4. Save.
5. '''Motion detection is disabled by default'''. To enable it open the ''Advanced'' tab of the camera device and scroll down to the ''ConfiguredMD'' field. ''-1'' means that it's disabled. To enable it set it to ''0''. 

== Setting up motion detection ==

The plugin needs to know a couple of things to setup motion detection:
1. The camera's IP address and port or URL (e.g. ''192.168.81.123:8001'' or ''camera.myserver.com'')
2. The camera's username and password
3. The Vera IP address or URL (e.g. ''192.168.81.1'' or ''vera.myserver.com'')

The plugin will attempt to find the Vera's IP address automatically based on the camera's IP address. This attempt will be successful only if the camera is on the same network as Vera. In all other cases the Vera's IP address (or URL) must be specified by the user.

{{{
#!html
<p style="font-weight:bold; color:red">
WARNING: the plugin will overwrite the alarm notification URL!
</p>
}}}

=== To disable the motion detection feature of the plugin ===

1. Open the ''Advanced'' tab of the camera's control panel.
2. Scroll to the bottom to find the ''ConfiguredMD'' field.
3. Set this field to ''-1''.
4. Save.

== Configurable parameters ==

* These parameters can be modified in the '''camera''''s control panel, in the ''Advanced'' tab:
||'''!StepSize'''||How much the camera will rotate when you send a ''pan'' or ''tilt'' command. Must be a natural number greater than 0.||
||'''!ReverseControls'''||When this parameter is ''1'' the camera controls will be reversed. Useful when you have the camera upside down. Can be ''0'' or ''1''.||
||'''!VeraAddress'''||Enter here the IP address or URL of the Vera.||
[[Image(camera_params.png)]]
----
* These parameters can be modified in the '''motion sensor''''s control panel, in the ''Advanced'' tab:
||'''!OnTime'''||The number of seconds the plugin hasn't received any notification from the camera after which the device will become ''Untripped''. The default is 1200 seconds (20 minutes).||
||'''embedded'''||By default this checkbox is ''checked'', which means that moving the camera to a different room will also move the motion sensor, so the motion sensor will always be in the same room as the camera. To prevent this from happening uncheck this checkbox and save.||
[[Image(sensor_params.png)]]

== Getting presets support in post 1.5.390 firmwares ==

All the Foscam camera devices created in pre 1.5.390 firmwares use the device file ''D_DigitalSecurityCamera1.xml'', which doesn't support presets. In firmware 1.5.390 another device file for the camera has been added: ''D_DigitalSecurityCamera2.xml''. To set your camera to use this device file instead of the old one:
1. Open the camera's control panel, ''Advanced'' tab.
2. Find the ''device_file'' field and change it from ''D_DigitalSecurityCamera'''1'''.xml'' to ''D_DigitalSecurityCamera'''2'''.xml''.
3. Save.

{{{
#!html
<p style="font-weight:bold; color:red">
WARNING: Do not change the device file for the camera if your MiOS firmware version is older than 1.5.390!
</p>
}}}

If everything worked OK, the Camera control tab should look like this (the number of preset buttons may vary from firmware to firmware):

[[Image(camera_control.png)]]