Difference between revisions of "IVS Wiki:Configuring a Privacy Switch"
IVSWikiBlue (talk | contribs) |
IVSWikiBlue (talk | contribs) |
||
(36 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Article - Manual | content = | {{Article - Manual | content = | ||
+ | {{Aside | hue = 170 | content = This page uses {{img - tooltip | text = image examples | file = VALT_6.3_Manual-Home_00.png | width = 1000px}} }} | ||
+ | |||
<includeonly> | <includeonly> | ||
<h1>Introduction</h1> | <h1>Introduction</h1> | ||
Line 19: | Line 21: | ||
<ol> | <ol> | ||
− | <li>Go to <b>System</b> → <b>Accessories</b>.</li> | + | <li>Go to {{img - tooltip | text = <b>System</b> → <b>Accessories</b>| file = Privacy rules 12x 08.png}}.</li> |
− | <li>Ensure that Ports < | + | <li>Ensure that Ports <strong>1 & 3</strong> are set as <b>Input</b> and <strong>2 & 4</strong> are set as <b>Output</b>.</li> |
<center> | <center> | ||
<table class="wikitable" style="border:none"> | <table class="wikitable" style="border:none"> | ||
Line 47: | Line 49: | ||
}} | }} | ||
+ | |||
+ | {{Top of Page}} | ||
{{hr}} | {{hr}} | ||
Line 55: | Line 59: | ||
<ol> | <ol> | ||
<li>Pan/Tilt/Zoom your camera to the desired angle.</li> | <li>Pan/Tilt/Zoom your camera to the desired angle.</li> | ||
− | <li>Go to <b>PTZ</b> → <b>Preset Positions</b>.</li> | + | <li>Go to {{img - tooltip | text = <b>PTZ</b> → <b>Preset Positions</b> | file = Privacy rules 12x 05.png}}.</li> |
− | + | <li>Select {{img - tooltip | text = <b>Preset Positions</b> → <b>Create preset position</b> | file = Privacy rules 12x 13.png}}.</li> | |
− | <li>Select <b>Preset Positions</b> → <b>Create preset position</b>.</li> | ||
<ol> | <ol> | ||
− | <li><strong>Home | + | <li><strong>Home</strong></li> |
<ul> | <ul> | ||
<li>Set a typical angle that would capture the room normally.</li> | <li>Set a typical angle that would capture the room normally.</li> | ||
{{Aside | content = The <b>Home</b> preset may already exist. If this is the case, hit the <b>Edit</b> button on the existing Home preset instead of creating a new preset.}} | {{Aside | content = The <b>Home</b> preset may already exist. If this is the case, hit the <b>Edit</b> button on the existing Home preset instead of creating a new preset.}} | ||
− | <li>In the < | + | <li>In the <strong>Name</strong> field enter <b>Home</b>.</li> |
</ul> | </ul> | ||
− | <li><strong>Privacy | + | <li><strong>Privacy</strong></li> |
<ul> | <ul> | ||
<li>Typically, this involves having the PTZ face the wall.</li> | <li>Typically, this involves having the PTZ face the wall.</li> | ||
{{Aside | content = The exact position does not matter for functionality, but having the camera visibly face the wall can help to ensure visual privacy even if the mask is off.}} | {{Aside | content = The exact position does not matter for functionality, but having the camera visibly face the wall can help to ensure visual privacy even if the mask is off.}} | ||
− | <li>In the < | + | <li>In the <strong>Name</strong> field enter <b>Privacy</b>.</li> |
</ul> | </ul> | ||
</ol> | </ol> | ||
Line 83: | Line 86: | ||
While your camera is in the Privacy Position: | While your camera is in the Privacy Position: | ||
<ol> | <ol> | ||
− | <li><b>Video</b> → <b>Privacy Masks</b> → < | + | <li>{{img - tooltip | text = <b>Video</b> → <b>Privacy Masks</b> | file = Privacy rules 12x 03.png}} → <strong>Hit the plus (+) button</strong> to add a Mask.</li> |
<li>Have the mask cover the entire view.</li> | <li>Have the mask cover the entire view.</li> | ||
<li>Name the mask <b>Privacy</b>.</li> | <li>Name the mask <b>Privacy</b>.</li> | ||
− | + | :<em>Make sure this is the first/only mask.</em> | |
</ol> | </ol> | ||
}} | }} | ||
+ | |||
+ | {{Top of Page}} | ||
{{hr}} | {{hr}} | ||
<h1>Add Recipients</h1> | <h1>Add Recipients</h1> | ||
− | {{Manual lvl 2 | title = Add | + | The privacy switch is driven by custom rules/events created on the camera. These rules are sent to all cameras through Recipients. |
+ | |||
+ | {{Manual lvl 2 | title = Add Self | content = | ||
<ol> | <ol> | ||
− | <li>Go to <b>System</b> → <b>Events</b> → <b>Recipients</b>.</li> | + | <li>Go to {{img - tooltip | text = <b>System</b> → <b>Events</b> | file = Privacy rules 12x 04.png}} → {{img - tooltip | text = <b>Recipients</b> | file = Privacy rules 12x 07.png}}.</li> |
− | <li>Select < | + | <li>Select <strong>Add Recipient</strong>.</li> |
− | <li>In the < | + | <li>In the <strong>Name</strong> field, enter <b>Self</b> as the name of the camera.</li> |
− | + | <li>In the {{img - tooltip | text = <b>Type</b> | file = Privacy rules 12x 09.png}} field, select <b>HTTP</b>.</li> | |
− | <li>In the <b>Type</b> field, select <b>HTTP</b>.</li> | + | <li>The {{img - tooltip | text = <b>URL</b> |file = Privacy rules 12x 10.png}} of the recipient will be in the form:</li> |
− | |||
:<pre>http://CAMERA_IP/axis-cgi/param.cgi </pre> | :<pre>http://CAMERA_IP/axis-cgi/param.cgi </pre> | ||
</ol> | </ol> | ||
− | {{ | + | {{Section - Expand | title = Image Example | color = #f6c62a | content = <center>{{img - resize | file = Privacy rules 12x 00.png | width = 504px}}</center> }} |
}} | }} | ||
− | {{Manual lvl 3 | title = Remote PTZ | + | {{Top of Page}} |
+ | {{hr}} | ||
+ | |||
+ | {{Manual lvl 2 | title = Add Remote Cameras | content = If there is more than one camera in thme setup, be sure to add additional recipients. This will allow you to create additional rules later to tell thme remote cameras what to do when privacy is enabled/disabled.}} | ||
+ | |||
+ | |||
+ | {{Manual lvl 3 | title = All Remote Recipients | content = Repeart the steops from [[#Add Self|Add Self]], but change the <strong>Name</strong> to <b>Remote</b>.}} | ||
+ | |||
+ | {{Manual lvl 3 | title = Remote PTZ Recipients | content = | ||
For remote PTZ cameras, separate PTZ Control recipients need to be made alongside the standard recipient of the form: | For remote PTZ cameras, separate PTZ Control recipients need to be made alongside the standard recipient of the form: | ||
:<pre>http://CAMERA_IP/axis-cgi/com/ptz.cgi</pre> | :<pre>http://CAMERA_IP/axis-cgi/com/ptz.cgi</pre> | ||
− | {{Section - Expand | title = Image Example | color = #f6c62a | content = <center>{{img - resize | file = Privacy rules 12x | + | {{Section - Expand | title = Image Example | color = #f6c62a | content = <center>{{img - resize | file = Privacy rules 12x 11.png | width = 504px}}</center> }} |
<ol> | <ol> | ||
<li>Enter in the corresponding Username and Password for the recipient camera.</li> | <li>Enter in the corresponding Username and Password for the recipient camera.</li> | ||
Line 119: | Line 133: | ||
}} | }} | ||
+ | |||
+ | {{Top of Page}} | ||
{{hr}} | {{hr}} | ||
Line 124: | Line 140: | ||
{{Manual lvl 2 | title = Privacy Off | content = | {{Manual lvl 2 | title = Privacy Off | content = | ||
<ol> | <ol> | ||
− | <li>Go to <b>System</b> → <b>Events</b> → <b>Rules</b>.</li> | + | <li>Go to {{img - tooltip | text = <b>System</b> → <b>Events</b> | file = Privacy rules 12x 04.png}} → {{img - tooltip | text = <b>Rules</b> | file = Privacy rules 12x 06.png}}.</li> |
− | <li>Select < | + | <li>Select <strong>Add a rule</strong>.</li> |
− | <li>Set < | + | <li>Set <strong>Name</strong> to <b>Privacy Off</b>.</li> |
− | <li>Set < | + | <li>Set <strong>Condition</strong> to <b>Digital input is active</b> or <b>I/O → Digital input</b>. <em>(Firmware Dependent)</em></li> |
− | <li>In the < | + | <li>In the <strong>Port</strong> section, select the port the privacy switch trigger is connected to <em>(white wire)</em>.</li> |
− | <li>Set < | + | <li>Set <strong>Action</strong> to <b>Send notification through HTTP</b>.</li> |
<li>Set the Recipient.</li> | <li>Set the Recipient.</li> | ||
− | <li>The < | + | <li>The <strong>Query string suffix</strong> will be of the form <code>name=value</code> for each parameter <strong>name</strong> and <strong>value</strong>, with an ampersand (&) between each name/value pair.</li> |
</ol> | </ol> | ||
The suffix should be composed of the following pairs: | The suffix should be composed of the following pairs: | ||
Line 180: | Line 196: | ||
{{Manual lvl 2 | title = Privacy On | content = | {{Manual lvl 2 | title = Privacy On | content = | ||
<ol> | <ol> | ||
− | <li>Go to <b>System</b> → <b>Events</b> → <b>Rules</b>.</li> | + | <li>Go to {{img - tooltip | text = <b>System</b> → <b>Events</b> | file = Privacy rules 12x 04.png}} → {{img - tooltip | text = <b>Rules</b> | file = Privacy rules 12x 06.png}}.</li> |
− | <li>Select < | + | <li>Select <strong>Add a rule</strong>.</li> |
− | <li>Set < | + | <li>Set <strong>Name</strong> to <b>Privacy On</b>.</li> |
− | <li>Set < | + | <li>Set <strong>Condition</strong> to <b>Digital input is active</b> or <b>I/O → Digital input</b>. <em>(Firmware Dependent)</em></li> |
− | <li>In the < | + | <li>In the <strong>Port</strong> section, select the port the privacy switch trigger is connected to <em>(white wire)</em>.</li> |
− | <li>Set < | + | <li>Set <strong>Action</strong> to <b>Send notification through HTTP</b>.</li> |
<li>Set the Recipient.</li> | <li>Set the Recipient.</li> | ||
− | <li>The < | + | <li>The <strong>Query string suffix</strong> will be of the form <code>name=value</code> for each parameter <strong>name</strong> and <strong>value</strong>, with an ampersand (&) between each name/value pair.</li> |
</ol> | </ol> | ||
The suffix should be composed of the following pairs: | The suffix should be composed of the following pairs: | ||
Line 232: | Line 248: | ||
On the <b>Host Camera</b>: | On the <b>Host Camera</b>: | ||
<ol> | <ol> | ||
− | <li>Go to <b>System</b> → <b>Events</b> → <b>Rules</b>.</li> | + | <li>Go to {{img - tooltip | text = <b>System</b> → <b>Events</b> | file = Privacy rules 12x 04.png}} → {{img - tooltip | text = <b>Rules</b> | file = Privacy rules 12x 06.png}}.</li> |
− | <li>Select < | + | <li>Select <strong>Add a rule</strong>.</li> |
− | <li>Set < | + | <li>Set <strong>Name</strong> to <b>LED Toggle</b>.</li> |
− | <li>Set < | + | <li>Set <strong>Condition</strong> to <b>Digital input is active</b> or <b>I/O → Digital input</b>. <em>(Firmware Dependent)</em></li> |
− | <li>In the < | + | <li>In the <strong>Port</strong> section, select the port the privacy switch trigger is connected to <em>(white wire)</em>.</li> |
− | <li>Set < | + | <li>Set <strong>Action</strong> to <b>Toggle I/O while the rule is active</b>.</li> |
− | <li>Set the < | + | <li>Set the <strong>Action Port</strong> to the port the privacy switch LED is connected to <em>(black wire)</em>.</li> |
− | <li>Set the < | + | <li>Set the <strong>Action State</strong> to <b>Active</b>.</li> |
</ol> | </ol> | ||
+ | {{Section - Expand | title = Image Example | color = #f6c62a | content = <center>{{img - resize | file = Privacy rules 12x 12.png | width = 504px }}</center> }} | ||
}} | }} | ||
Line 249: | Line 266: | ||
{{Manual lvl 3 | title = PTZ Privacy | content = | {{Manual lvl 3 | title = PTZ Privacy | content = | ||
<ol> | <ol> | ||
− | <li>Go to <b>System</b> → <b>Events</b> → <b>Rules</b>.</li> | + | <li>Go to {{img - tooltip | text = <b>System</b> → <b>Events</b> | file = Privacy rules 12x 04.png}} → {{img - tooltip | text = <b>Rules</b> | file = Privacy rules 12x 06.png}}.</li> |
− | <li>Select < | + | <li>Select <strong>Add a rule</strong>.</li> |
− | <li>Set < | + | <li>Set <strong>Name</strong> to the camera name with <b>PTZ Privacy Position</b>.</li> |
− | <li>Set < | + | <li>Set <strong>Condition</strong> to <b>Digital input is active</b> or <b>I/O → Digital input</b>. <em>(Firmware Dependent)</em></li> |
− | <li>In the < | + | <li>In the <strong>Port</strong> section, select the port the privacy switch trigger is connected to <em>(white wire)</em>.</li> |
− | <li>Set < | + | <li>Set <strong>Action</strong> to <b>Send notification through HTTP</b>.</li> |
− | <li>Set the < | + | <li>Set the <strong>Recipient</strong> to be the proper <b>PTZ Controls Recipient</b>.</li> |
− | <li>The < | + | <li>The <strong>Query string suffix</strong> should be: <code>gotoserverpresetname=Privacy</code></li> |
</ol> | </ol> | ||
}} | }} | ||
Line 263: | Line 280: | ||
{{Manual lvl 3 | title = PTZ Home | content = | {{Manual lvl 3 | title = PTZ Home | content = | ||
<ol> | <ol> | ||
− | <li>Go to <b>System</b> → <b>Events</b> → <b>Rules</b>.</li> | + | <li>Go to {{img - tooltip | text = <b>System</b> → <b>Events</b> | file = Privacy rules 12x 04.png}} → {{img - tooltip | text = <b>Rules</b> | file = Privacy rules 12x 06.png}}.</li> |
− | <li>Select < | + | <li>Select <strong>Add a rule</strong>.</li> |
− | <li>Set < | + | <li>Set <strong>Name</strong> to the camera name with <b>PTZ Home Position</b>.</li> |
− | <li>Set < | + | <li>Set <strong>Condition</strong> to <b>Digital input is active</b> or <b>I/O → Digital input</b>. <em>(Firmware Dependent)</em></li> |
<li>Check the box <b>Invert this condition</b>.</li> | <li>Check the box <b>Invert this condition</b>.</li> | ||
− | <li>In the < | + | <li>In the <strong>Port</strong> section, select the port the privacy switch trigger is connected to <em>(white wire)</em>.</li> |
− | <li>Set < | + | <li>Set <strong>Action</strong> to <b>Send notification through HTTP</b>.</li> |
− | <li>Set the < | + | <li>Set the <strong>Recipient</strong> to be the proper <b>PTZ Controls Recipient</b>.</li> |
− | <li>The < | + | <li>The <strong>Query string suffix</strong> should be: <code>gotoserverpresetname=Home</code></li> |
</ol> | </ol> | ||
}} | }} | ||
− | |||
− | |||
− | |||
+ | {{Top of Page}} | ||
}} | }} |
Latest revision as of 15:33, 2 April 2025
Prepare all Cameras
On each camera in the room:
Set the I/O Ports
The Input/Output (I/O) ports will be wired to the Privacy Switch. These are used to determine which mode the camera should be in and outputs power to the Privacy Switch to light up the LED.
- Go to System → Accessories
🖼️.
- Ensure that Ports 1 & 3 are set as Input and 2 & 4 are set as Output.
Port 1 | Input | Port 2 | Output | |
---|---|---|---|---|
Port 3 | Input | Port 4 | Output |
✎Some cameras will only have ports 1 & 2.
Set the PTZ Presets
If there are any PTZ cameras in the room, you will need to set the preset positions on those cameras. These locations will help drive the camera to its Privacy Position and Home Position.
- Pan/Tilt/Zoom your camera to the desired angle.
- Go to PTZ → Preset Positions
🖼️.
- Select Preset Positions → Create preset position
🖼️.
- Home
- Set a typical angle that would capture the room normally.
- In the Name field enter Home.
- Privacy
- Typically, this involves having the PTZ face the wall.
- In the Name field enter Privacy.
✎The Home preset may already exist. If this is the case, hit the Edit button on the existing Home preset instead of creating a new preset.
✎The exact position does not matter for functionality, but having the camera visibly face the wall can help to ensure visual privacy even if the mask is off.
Set the Privacy Mask
The Privacy Mask will be used to block the view
While your camera is in the Privacy Position:
Add Recipients
The privacy switch is driven by custom rules/events created on the camera. These rules are sent to all cameras through Recipients.
Add Self
Add Remote Cameras
If there is more than one camera in thme setup, be sure to add additional recipients. This will allow you to create additional rules later to tell thme remote cameras what to do when privacy is enabled/disabled.
All Remote Recipients
Repeart the steops from Add Self, but change the Name to Remote.
Remote PTZ Recipients
For remote PTZ cameras, separate PTZ Control recipients need to be made alongside the standard recipient of the form:
http://CAMERA_IP/axis-cgi/com/ptz.cgi
- Enter in the corresponding Username and Password for the recipient camera.
- Hit the Test button.
- If the camera responds that everything is okay, hit the Save button to save your recipient.
⚠Repeat this process on all PTZ cameras in the room that the privacy switch would be activating.
Add Privacy Event Rules
Privacy Off
- Go to System → Events
🖼️ → Rules
🖼️.
- Select Add a rule.
- Set Name to Privacy Off.
- Set Condition to Digital input is active or I/O → Digital input. (Firmware Dependent)
- In the Port section, select the port the privacy switch trigger is connected to (white wire).
- Set Action to Send notification through HTTP.
- Set the Recipient.
- The Query string suffix will be of the form
name=value
for each parameter name and value, with an ampersand (&) between each name/value pair.
The suffix should be composed of the following pairs:
Name | Value |
---|---|
action | update |
Image.I0.Overlay.MaskWindows.M0.Enabled | no |
AudioSource.A0.InputGain | 0 |
PTZ.Various.V1.PanEnabled | true |
PTZ.Various.V1.TiltEnabled | true |
PTZ.Various.V1.ZoomEnabled | true |
autofocus | on |
The completed suffix should be (ignore word wrapping):
action=update&Image.I0.Overlay.MaskWindows.M0.Enabled=no& AudioSource.A0.InputGain=0&PTZ.Various.V1.PanEnabled=true& PTZ.Various.V1.TiltEnabled=true&TZ.Various.V1.ZoomEnabled=true
⚠Set AudioSource.A0.InputGain to the amount of gain necessary for the room. For example, if you gain would normally be set to 15 dB, you want to use the name/value pair to be AudioSource.A0.InputGan=15.
Privacy On
- Go to System → Events
🖼️ → Rules
🖼️.
- Select Add a rule.
- Set Name to Privacy On.
- Set Condition to Digital input is active or I/O → Digital input. (Firmware Dependent)
- In the Port section, select the port the privacy switch trigger is connected to (white wire).
- Set Action to Send notification through HTTP.
- Set the Recipient.
- The Query string suffix will be of the form
name=value
for each parameter name and value, with an ampersand (&) between each name/value pair.
The suffix should be composed of the following pairs:
Name | Value |
---|---|
action | update |
Image.I0.Overlay.MaskWindows.M0.Enabled | yes |
AudioSource.A0.InputGain | mute |
PTZ.Various.V1.PanEnabled | false |
PTZ.Various.V1.TiltEnabled | false |
PTZ.Various.V1.ZoomEnabled | false |
The completed suffix should be (ignore word wrapping):
action=update&Image.I0.Overlay.MaskWindows.M0.Enabled=yes& AudioSource.A0.InputGain=mute&PTZ.Various.V1.PanEnabled=false& PTZ.Various.V1.TiltEnabled=false&PTZ.Various.V1.ZoomEnabled=false
LED Toggle
On the Host Camera:
- Go to System → Events
🖼️ → Rules
🖼️.
- Select Add a rule.
- Set Name to LED Toggle.
- Set Condition to Digital input is active or I/O → Digital input. (Firmware Dependent)
- In the Port section, select the port the privacy switch trigger is connected to (white wire).
- Set Action to Toggle I/O while the rule is active.
- Set the Action Port to the port the privacy switch LED is connected to (black wire).
- Set the Action State to Active.
PTZ Rules
The following rules will be used to move the camera to a privacy location with privacy is enabled, and then move to a home location once the privacy is disabled.
PTZ Privacy
- Go to System → Events
🖼️ → Rules
🖼️.
- Select Add a rule.
- Set Name to the camera name with PTZ Privacy Position.
- Set Condition to Digital input is active or I/O → Digital input. (Firmware Dependent)
- In the Port section, select the port the privacy switch trigger is connected to (white wire).
- Set Action to Send notification through HTTP.
- Set the Recipient to be the proper PTZ Controls Recipient.
- The Query string suffix should be:
gotoserverpresetname=Privacy
PTZ Home
- Go to System → Events
🖼️ → Rules
🖼️.
- Select Add a rule.
- Set Name to the camera name with PTZ Home Position.
- Set Condition to Digital input is active or I/O → Digital input. (Firmware Dependent)
- Check the box Invert this condition.
- In the Port section, select the port the privacy switch trigger is connected to (white wire).
- Set Action to Send notification through HTTP.
- Set the Recipient to be the proper PTZ Controls Recipient.
- The Query string suffix should be:
gotoserverpresetname=Home