Domoticz + Hikvision DS-2CD2142FWD-IS

[BakSeeDaa]

Hi there. This project is just started and I was thinking to share and discuss my ideas here with you.

I bought a couple of web cameras Hikvision DS-2CD2142FWD-IS on aliexpress and I'm very happy with them.

They can record onto my NAS without the need for an NVR or a PC running NVR software.

I've powered my cameras through PoE but I haven't connected the alarm-in or alarm-out connectors to anything. They will record automatically whenever they detect motion. I access the recordings through the built in GUI.

Now I'd like to integrate the cameras in my Domoticz Home Automation system.

I currently have 2 goals:

1. Domoticz want's to know whenever motion has been detected.
2. It would be great if the web camera can be instructed only to record under certain conditions, eg the Domoticz alarm status is "Armed Away".

By using the following command I can poll if output 1 is active (motion has been detected).

Code: Select all

curl --silent -u username:password http://<CAMERA_IP>/IO/outputs/1/status|grep '<ioState>active</ioState>'

There is a function to "Notify surveillance center" in the "Linkage section". It would be great if I can use that in any way to push a notification to Domoticz...

Here is a review of an older model that inspired me.

To be continued...

[Minglarn]

Hej or Hello! =)

I too have Hikvisions (they are really great low cost ipcams). I did mange to do a php script which enables or disables e-mail notifications from the Hikvisions. Never tried check for motion as it sends HTTP push and don't really know how to check for changes yet. =)

Here's a the script if you would like to alter to suit your setup... Remember to change the user and pass in the $url ...

Code: Select all

<?PHP
$ip = $_GET["ip"];
$email_onoff = $_GET["switch"];

$url = "http://user:[email protected].".$ip."/Event/triggers/1";

if ($email_onoff == "ON") {
	$xml_mail_set = '<?xml version="1.0" encoding="UTF-8"?>
	<EventTrigger version="1.0" xmlns="http://www.hikvision.com/ver10/XMLSchema">
	<id>1</id>
	<eventType>VMD</eventType>
	<eventDescription>VMD Event trigger Information</eventDescription>
	<EventTriggerNotificationList version="1.0" xmlns="http://www.hikvision.com/ver10/XMLSchema">
	<EventTriggerNotification>
	<id>1</id>
	<notificationMethod>email</notificationMethod>
	<notificationRecurrence>beginning</notificationRecurrence>
	</EventTriggerNotification>
	<EventTriggerNotification>
	<id>2</id>
	<notificationMethod>record</notificationMethod>
	<notificationRecurrence>beginning</notificationRecurrence>
	</EventTriggerNotification>
	<EventTriggerNotification>
	<id>3</id>
	<notificationMethod>HTTP</notificationMethod>
	<notificationRecurrence>beginning</notificationRecurrence>
	</EventTriggerNotification>
	</EventTriggerNotificationList>
	</EventTrigger>';
} else {
	$xml_mail_set ='<?xml version="1.0" encoding="UTF-8"?>
	<EventTrigger version="1.0" xmlns="http://www.hikvision.com/ver10/XMLSchema">
	<id>1</id>
	<eventType>VMD</eventType>
	<eventDescription>VMD Event trigger Information</eventDescription>
	<EventTriggerNotificationList version="1.0" xmlns="http://www.hikvision.com/ver10/XMLSchema">
	<EventTriggerNotification>
	<id>2</id>
	<notificationMethod>record</notificationMethod>
	<notificationRecurrence>beginning</notificationRecurrence>
	</EventTriggerNotification>
	<EventTriggerNotification>
	<id>3</id>
	<notificationMethod>HTTP</notificationMethod>
	<notificationRecurrence>beginning</notificationRecurrence>
	</EventTriggerNotification>
	</EventTriggerNotificationList>
	</EventTrigger>';
}
// Send using CURL
		$ch = curl_init($url);
		curl_setopt ($ch, CURLOPT_RETURNTRANSFER, true);
		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
		curl_setopt ($ch, CURLOPT_HTTPHEADER, Array("Content-Type: application/json"));
		curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
		curl_setopt($ch, CURLOPT_POSTFIELDS, $xml_mail_set);
		$result = curl_exec( $ch ); // runs the post
		curl_close($ch);
?>

Created switches where I can set e-mail notifications on / off

Skärmklipp.PNG (12.5 KiB) Viewed 10472 times

and the actions taken;

2Skärmklipp.PNG (7.35 KiB) Viewed 10472 times

The syntax is: hik_motion.php?ip="The last ip number for your cams"&switch="ON|OFF" ...
It's possible to set recording on or off if you send the correct XML to the cam but I never bothered to implement in my script as I have an NVR for 24/7 recordings.

i know that it's not what you asked for but it could be a good start as the check for motion on alarm-out connectors is nearly the same.

[nayr]

I am working on a project implementing this, I dont actually have a Hikvision so I am working remotely on someone elses.. I have partial alarm support already functioning, I just need to finish it up.. works fine w/my dahuas but Hik's alarm system is funky and taking extra logic.

viewtopic.php?f=35&t=10604

the problem I have is the alarm stream dont send a stop when an event is done, it sends a videoloss=false report when everything returns to normal.. that made forking my dahua code not as easy as I hoped.

I was hoping to make more progress this weekend, sure would help if I had some people with cameras deployed to do actual testing/feedback.

[BakSeeDaa]

Thanks @Minglarn and @nayr !

It seems that I won't have to reinvent the wheel then which makes me very happy indeed!

I was hoping to make more progress this weekend, sure would help if I had some people with cameras deployed to do actual testing/feedback.

I'd be happy to participate for testing/feedback. Would You suggest that I try to install it immediately or should I wait?

[nayr]

for now just wait, I'll try to finish up the code I have and check it into my repo here soon.. if you want to watch for progress you can go here: https://github.com/nayrnet/node-hikvision-api as thats where all the work has to be finished, its not functional at this point.

luckily the stream types were the same I just have to handle the data off the streams differently.. I dont like the Hikvision API as much.

[G3rard]

Hej or Hello! =)

I too have Hikvisions (they are really great low cost ipcams). I did mange to do a php script which enables or disables e-mail notifications from the Hikvisions. Never tried check for motion as it sends HTTP push and don't really know how to check for changes yet. =)

Here's a the script if you would like to alter to suit your setup... Remember to change the user and pass in the $url ...
[...]

i know that it's not what you asked for but it could be a good start as the check for motion on alarm-out connectors is nearly the same.

Very nice!

I was already testing with motion detection on/off and used your code to add this to domoticz.
Here is the PHP code for putting motion detection on or off. Change user and password and it should work.

Code: Select all

<?PHP
$ip = $_GET["ip"];
$motion_onoff = $_GET["switch"];

$url = "http://user:[email protected].".$ip."/MotionDetection/1";

if ($motion_onoff == "ON") {
   $xml_mail_set = '<?xml version="1.0" encoding="UTF-8"?>
<MotionDetection version="1.0" xmlns="http://www.hikvision.com/ver10/XMLSchema">
<id>1</id>
<enabled>true</enabled>
<regionType>grid</regionType>
<Grid>
<rowGranularity>18</rowGranularity>
<columnGranularity>22</columnGranularity>
</Grid>
<MotionDetectionRegionList>
<sensitivityLevel>3</sensitivityLevel>
</MotionDetectionRegionList>
</MotionDetection>';
} else {
   $xml_mail_set ='<?xml version="1.0" encoding="UTF-8"?>
<MotionDetection version="1.0" xmlns="http://www.hikvision.com/ver10/XMLSchema">
<id>1</id>
<enabled>false</enabled>
<regionType>grid</regionType>
<Grid>
<rowGranularity>18</rowGranularity>
<columnGranularity>22</columnGranularity>
</Grid>
<MotionDetectionRegionList>
<sensitivityLevel>3</sensitivityLevel>
</MotionDetectionRegionList>
</MotionDetection>';
}
// Send using CURL
      $ch = curl_init($url);
      curl_setopt ($ch, CURLOPT_RETURNTRANSFER, true);
      curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
      curl_setopt ($ch, CURLOPT_HTTPHEADER, Array("Content-Type: application/json"));
      curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
      curl_setopt($ch, CURLOPT_POSTFIELDS, $xml_mail_set);
      $result = curl_exec( $ch ); // runs the post
      curl_close($ch);
	  echo "Hikvision motion detection";

?>

[BakSeeDaa]

Here is the PHP code for putting motion detection on or off. Change user and password and it should work.

Thank You very much @G3rard!

I don't have php running on my rpi so based on your and minglarns code I've come up withe the following solution.
One of my goals has been reached. Now Domoticz turns off motion detection on my living room web camera while I'm at home (E.g. alarm is not activated).

Below a LUA script that's watching my alarm system status. Whenever there is a change of the alarm system status a virtual switch gets toggled if needed.

Code: Select all

-- Switch the Motion detection virtual switch on or off (if needed) depending on alarm status
if (devicechanged["Z1 Alarm"]) then
	if (otherdevices_svalues["Z1 Alarm"] == DISARMED) then
		if (otherdevices["Living Room Motion Detection"] == "On") then
			commandArray["Living Room Motion Detection"] = "Off"	
		end
	else
		if (otherdevices["Living Room Motion Detection"] == "Off") then
			commandArray["Living Room Motion Detection"] = "On"	
		end
	end
end

-- Acting upon the change of the Motion detection virtual swith
if (devicechanged["Living Room Motion Detection"]) then
	local scriptfile = "/bin/bash /home/pi/domoticz/scripts/sh/webcam1_md_disable.sh &"
	if (devicechanged["Living Room Motion Detection"] == "On") then
		scriptfile = "/bin/bash /home/pi/domoticz/scripts/sh/webcam1_md_enable.sh &"
	end
	print("Running scriptfile: " .. scriptfile)
	local stdout = io.popen(scriptfile)
	local result = stdout:read("*a")
	stdout:close()
end

2 bash scripts, one for enabling and one for disabling motion detection:

Code: Select all

#!/bin/bash
# Enable Vardagsrum WebCam Motion Detection
# To find out what the XML shall look like, check the following URL:
# http://username:password@detectorhostname/MotionDetection/1

curl -k -s -H "Content-Type: application/json" -X PUT -d '<?xml version="1.0" encoding="UTF-8"?>
<MotionDetection version="1.0" xmlns="http://www.hikvision.com/ver10/XMLSchema">
<id>1</id>
<enabled>true</enabled>
<regionType>grid</regionType>
<Grid>
<rowGranularity>18</rowGranularity>
<columnGranularity>22</columnGranularity>
</Grid>
<MotionDetectionRegionList>
<sensitivityLevel>4</sensitivityLevel>
<MotionDetectionRegion version="1.0" xmlns="http://www.hikvision.com/ver10/XMLSchema">
<id>1</id>
<enabled>true</enabled>
<maskEnabled>false</maskEnabled>
<RegionCoordinatesList>
<RegionCoordinates>
<positionX>0</positionX>
<positionY>0</positionY>
</RegionCoordinates>
<RegionCoordinates>
<positionX>0</positionX>
<positionY>18</positionY>
</RegionCoordinates>
<RegionCoordinates>
<positionX>22</positionX>
<positionY>18</positionY>
</RegionCoordinates>
<RegionCoordinates>
<positionX>22</positionX>
<positionY>0</positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</MotionDetectionRegion>
</MotionDetectionRegionList>
</MotionDetection>' http://username:password@detectorhostname/MotionDetection/1

Code: Select all

#!/bin/bash
# Disable Vardagsrum WebCam Motion Detection
# To find out what the XML shall look like, check the following URL:
# http://username:password@detectorhostname/MotionDetection/1

curl -k -s -H "Content-Type: application/json" -X PUT -d '<?xml version="1.0" encoding="UTF-8"?>
<MotionDetection version="1.0" xmlns="http://www.hikvision.com/ver10/XMLSchema">
<id>1</id>
<enabled>false</enabled>
<regionType>grid</regionType>
<Grid>
<rowGranularity>18</rowGranularity>
<columnGranularity>22</columnGranularity>
</Grid>
<MotionDetectionRegionList>
<sensitivityLevel>4</sensitivityLevel>
<MotionDetectionRegion version="1.0" xmlns="http://www.hikvision.com/ver10/XMLSchema">
<id>1</id>
<enabled>true</enabled>
<maskEnabled>false</maskEnabled>
<RegionCoordinatesList>
<RegionCoordinates>
<positionX>0</positionX>
<positionY>0</positionY>
</RegionCoordinates>
<RegionCoordinates>
<positionX>0</positionX>
<positionY>18</positionY>
</RegionCoordinates>
<RegionCoordinates>
<positionX>22</positionX>
<positionY>18</positionY>
</RegionCoordinates>
<RegionCoordinates>
<positionX>22</positionX>
<positionY>0</positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</MotionDetectionRegion>
</MotionDetectionRegionList>
</MotionDetection>' http://username:password@detectorhostname/MotionDetection/1

Note that the XML-data that You post (PUT) may differ depending on your HikVision web camera device model and software version. Check first what nodes you need by opening the URL http://username:password@detectorhostna ... etection/1 in your browser

[kmccor]

for now just wait, I'll try to finish up the code I have and check it into my repo here soon.. if you want to watch for progress you can go here: https://github.com/nayrnet/node-hikvision-api as thats where all the work has to be finished, its not functional at this point.

luckily the stream types were the same I just have to handle the data off the streams differently.. I dont like the Hikvision API as much.

Hi, did you manage to make progress on the Hikvision alarm? I've got a couple of Hikvision cameras and this functionality is exactly what I want so I can use Domoticz as the hub for all of my security alerting. I've read the couple of associated threads there are on this but I'm unclear whether anyone managed to implement it.

Thanks

[BakSeeDaa]

for now just wait, I'll try to finish up the code I have and check it into my repo here soon.. if you want to watch for progress you can go here: https://github.com/nayrnet/node-hikvision-api as thats where all the work has to be finished, its not functional at this point.

luckily the stream types were the same I just have to handle the data off the streams differently.. I dont like the Hikvision API as much.

I've set up the NodeJS Module for communication with Hikvision IP Cameras today on a fresh Raspbian Jessie Lite image.

Initially I encountered various problems when running npm install.

After reading this, the solution was to install the latest version of Node at the moment which is Node 7.2.0.

To install I issued the following commands:

Code: Select all

cd
curl -sL https://deb.nodesource.com/setup_7.x | sudo -E bash -
sudo apt-get install nodejs git
npm install https://github.com/nayrnet/node-hikvision-api
npm install request

I modified the provided example script to suit my needs which is to set a virtual switch "MD Main Entrance" to on/off. Later today I will make sure that the script starts automatically for every IP camera I've got. Thanks @nayr for the code and the work You've put into this, it's really appreciated.

[juppiejo]

Ok, quite a Newb question maybe. But using nayr's method, how do I setup the Hik IP-cam to 'publish' its status (eg motion detected) to MQTT? Probably there's a simple answer to my question, but I can't find any setting on the Hik's to specify this link.

[philchillbill]

Dunno if this is of any use to you as it uses Perl instead of PHP but it does get the PIR status into Domoticz. I have no experience with MQTT (yet) but that part should be easy if the PIR is reporting. Check:

http://www.domoticz.com/forum/viewtopic ... ir#p107550

[Shyam]

for now just wait, I'll try to finish up the code I have and check it into my repo here soon.. if you want to watch for progress you can go here: https://github.com/nayrnet/node-hikvision-api as thats where all the work has to be finished, its not functional at this point.

luckily the stream types were the same I just have to handle the data off the streams differently.. I dont like the Hikvision API as much.

I've set up the NodeJS Module for communication with Hikvision IP Cameras today on a fresh Raspbian Jessie Lite image.

Initially I encountered various problems when running npm install.

After reading this, the solution was to install the latest version of Node at the moment which is Node 7.2.0.

To install I issued the following commands:

Code: Select all

cd
curl -sL https://deb.nodesource.com/setup_7.x | sudo -E bash -
sudo apt-get install nodejs git
npm install https://github.com/nayrnet/node-hikvision-api
npm install request

I modified the provided example script to suit my needs which is to set a virtual switch "MD Main Entrance" to on/off. Later today I will make sure that the script starts automatically for every IP camera I've got. Thanks @nayr for the code and the work You've put into this, it's really appreciated.

Sorry to bring up a old thread, would you be able to give step by step instructions? I've installed the api, not sure where to go after that

[BakSeeDaa]

Sorry to bring up a old thread, would you be able to give step by step instructions? I've installed the api, not sure where to go after that

I believe then you are going to set up the example script. I've replaced those Hikvision for Dahua ones because I think they are better. The script is not made by me so you'd need to ask the author for help.

[Shyam]

Sorry to bring up a old thread, would you be able to give step by step instructions? I've installed the api, not sure where to go after that

I believe then you are going to set up the example script. I've replaced those Hikvision for Dahua ones because I think they are better. The script is not made by me so you'd need to ask the author for help.

Thanks!

I've got the sample script "working", well it errors, but atleast it connects.

How did you configure it so that the scripts executes by pressing a switch?

[BakSeeDaa]

Sorry to bring up a old thread, would you be able to give step by step instructions? I've installed the api, not sure where to go after that

I believe then you are going to set up the example script. I've replaced those Hikvision for Dahua ones because I think they are better. The script is not made by me so you'd need to ask the author for help.

Thanks!

I've got the sample script "working", well it errors, but atleast it connects.

How did you configure it so that the scripts executes by pressing a switch?

If I recall correctly, you'd need to make the nodejs script communicate with Domoticz on various events.You can also set up Domoticz to send commands to the cameras by opening their URLs. I'm sorry I can't help you further with this. I don't have my old scripts anymore.

[Shyam]

I believe then you are going to set up the example script. I've replaced those Hikvision for Dahua ones because I think they are better. The script is not made by me so you'd need to ask the author for help.

Thanks!

I've got the sample script "working", well it errors, but atleast it connects.

How did you configure it so that the scripts executes by pressing a switch?

If I recall correctly, you'd need to make the nodejs script communicate with Domoticz on various events.You can also set up Domoticz to send commands to the cameras by opening their URLs. I'm sorry I can't help you further with this. I don't have my old scripts anymore.

No probs at all! It seems Hikvision have changed their firmware and the way described earlier on in the thread does not work any more