Cynical SecuritySpy Plugin
BenSoftware makes a Macintosh application called SecuritySpy, useful to manage local and network cameras. It can record them, play them back, trigger recording based on visual motion detection or various schedules, and do pretty much whatever you'd like your typical surveillance camera application to do. I've been using it in my house for many years, and am a fairly satisfied customer.
Indigo and SecuritySpy have obvious shared interests. They both are often used to track movement through space and time, and they both have a concept of events and how to respond to them. Cynical SecuritySpy brings them together.
You will need SecuritySpy version 2.1.1 or later for this plugin to work. The plugin will work with versions 3 and 4 as well. Be sure to use the latest released update for whatever version you paid for; earlier versions may have bugs that interfere with Cynical SecuritySpy.
Install and configure SecuritySpy normally. Then create a Server device to represent each SecuritySpy installation, and one Camera device for each camera of interest. Use Indigo plugin actions to manipulate those cameras, and use Events to respond to changes.
Cynical SecuritySpy tracks changes in SecuritySpy's state and reflects them in the state of the server and camera devices, as well as through Camera Motion events. When your Indigo scripts cause changes in SecuritySpy, they will be reflected as Indigo device changes only when SecuritySpy reports them. This means that Cynical SecuritySpy provides you with closed-loop supervision over SecuritySpy servers - what you see in Indigo state and events is what actually happened on the server, not just what you said you wanted to happen.
To supplement SecuritySpy's motion sensing, use Indigo Trigger Recording actions, for example in response to an Indigo motion sensor. To respond to motion detected by SecuritySpy, write triggers for Camera Motion events.
To arrange for Indigo to directly control recording in SecuritySpy, configure the camera in SecuritySpy for continuous recording, and then use the Arm Camera action in Indigo to enable and disable continuous recording as desired. This requires SecuritySpy 4 or later.
To work with a SecuritySpy server, you must first tell Indigo about it by creating a Server device. This tells Indigo where the server is and how to talk to it. The server must have its web server component enabled, and the port number you enter is that of the web server (not the SecuritySpy server itself). The web server must allow http connections, not just https (secure) ones, though it's okay to allow both.
Cynical SecuritySpy talks to SecuritySpy exclusively through its web interface. There is no need for Indigo and SecuritySpy to run on the same computer, though they certainly can.
If the web server is Password protected, you must also enter a name and password that can perform whatever actions you want Indigo to take. At minimum, that user must have Allow access to general settings checked, as well as View live images for all cameras you want Indigo to work with. If you want Indigo to make changes to SecuritySpy, additional checkboxes will be needed. Do note that the password will be stored in cleartext in the plugin's configuration file. You may wish to create a specific username/password pair just for Indigo and use that.
Similarly, if the web server has Access control enabled, the computer running Indigo must be granted access to it. If they are both running on the same computer, use localhost (address 127.0.0.1).
This is one camera configured on a SecuritySpy server. Pick from the popup list that shows all cameras on all SecuritySpy servers for which you have created devices in Indigo (and which are responding at the moment).
You can name your Indigo Camera device anything you like, quite independent from the name SecuritySpy uses for it. Cynical SecuritySpy remembers SecuritySpy cameras by their camera number, which is meant to be stable and will survive renaming. In practice, it is probably a good idea to keep those names similar to avoid confusing you. Camera devices have a state state that reflects the current status of the camera:
The motion, continuous, and actions states represent the arming states of the camera. They directly correspond to the SecuritySpy settings for this camera. You can use the Arm Camera action to set them from Indigo, and you can set triggers on these states to detect changes, regardless of source.
If motion is on, the camera detects motion and starts recording according to its configuration; in earlier versions of SecuritySpy this was called the "active" state. If motion is off, the camera will not detect motion.
The continuous switch, when on, enables any continuous recording configured for the camera. If it is off, continuous recording is disabled.
The actions switch determines whether SecuritySpy's configured actions for the camera are executed when their conditions apply. If actions is off, then SecuritySpy actions for this camera are ignored. This has no effect on any actions you may have programmed into Indigo; motion triggers will still fire in Indigo as long as the motion state for the camera is on.
Arm Camera Action
This action can change any of a camera's arming states. From the pop-up menus, choose the camera, which arming state to change, and whether you want to turn it on, off, or toggle it.
For SecuritySpy versions 3 or earlier, the only arming state you can set is the motion state.
Make Active Action
This is an old way to set the motion state of a camera to true.
Make Passive Action
This is an older way to set the motion state of a camera to false.
Toggle Active Action
This is an older way to toggle the motion state of a camera - make it true if it was false, or vice versa.
Trigger Recording Action
This action tells SecuritySpy to pretend that it has seen motion on the designated camera. If you have a motion sensor in the general area covered by a camera, that's what you want to do. All the usual consequences follow; in particular, any motion-triggered recording commences. SecuritySpy's usual rules apply; the camera must be active and configured appropriately.
This action is the complement to the Camera Motion event. Together, they link Indigo's and SecuritySpy's event systems together. In fact, if everything is hooked up right, a Trigger Recording action will cause Camera Motion triggers to fire, as SecuritySpy faithfully reports the (simulated) motion back to Indigo.
Set Overlay Action
This changes the text overlay that SecuritySpy can place onto a video camera's image. This text becomes part of the video stream, so that it is displayed and recorded along with it. Note that it also irreversibly obscures what's behind it.
Note: This action neither sets nor clears the Camera Setup checkbox that enables overlays. If that checkbox is off, no overlays will ever be placed on the camera image. If you want to dynamically turn overlays off for a camera, leave that checkbox on and simply set the message text to empty.
Set Motion Sensitivity Action
This action lets you change the sensitivity of a camera's motion detection. It controls the same SecuritySpy parameter as the sensitivity slider in the Camera Setup window. The higher the number, the smaller the amount of motion needed to trigger an event. This is an integer value between 0 and 100.
The current sensitivity setting of a camera can be read as a camera state value. Any state change trigger set on this will fire when the camera's sensitivity is changed, whether that is done through SecuritySpy's user interface, its web interface, or through an Indigo action.
Move Camera Action
This action allows you to control a PTZ (Point-Tilt-Zoom) capable camera - the kind that can be told to move around. Only cameras recognized by SecuritySpy as able to move will be shown in the camera selection menu. Modern SecuritySpy versions also have checkboxes to control this. But if you ask Indigo to move a camera that is in fact securely bolted to the ground, nothing bad will happen.
Position Preset Action
This action tells a PTZ-capable camera to move to one of its preset positions. Even fewer types of cameras support presets, and only those cameras will be shown in the camera selection menu.
Run Script Action
Ask SecuritySpy to execute one of the scripts in its Scripts folder. Pick the desired script from the popup list.
Play Sound Action
Ask SecuritySpy to play one of the sounds available on the server. Loud siren sounds are particularly amusing. Pick the desired sound from the popup list.
Camera Motion Event
This event triggers when SecuritySpy reports motion on a particular camera. This is based on SecuritySpy's motion detection logic as set in the camera's Camera Setup panel. It requires the camera to be active (its motion state to be on) and have motion detection enabled.
This motion notification is controlled by Indigo, and is totally independent from any of the settings in the Actions tab of SecuritySpy. Turning actions off will not affect motion detection in Indigo. Turning motion off will, since it disables motion detection altogether.
The Maximum Rate configuration parameter determines how often continuing motion is reported - it is never triggered more often than every so many seconds. Under no circumstances will motion be reported more than once per second.