How to manage cameras via DVR-IP, NetSurveillance, Sofia protocol (NETsurveillance ActiveX plugin XMeye SDK)

DVR-IP, NetSurveillance, Sofia

The NETSurveillance ActiveX plugin uses a TCP based protocol called just as the “Digital Video Recorder Interface Protocol” by the “Hangzhou male Mai Information Co”.

There is very little software or documentation that supports it other than the tools provided by the manufacturers of these cameras, making many of the configuration options unavailable.

Command and response codes can be found here: https://gist.github.com/ekwoodrich/a6d7b8db8f82adf107c3c366e61fd36f

Connections to this protocol are performed on ports TCP 34567 and UDP 34568.

An example of a program using this protocol is CMS. See also the article “Camera control software (watching video, downloading video to PC, task schedule)”.

python-dvr

python-dvr is a Python library for configuring a wide range of IP cameras which use the NETsurveillance ActiveX plugin XMeye SDK.

DeviceManager.py

DeviceManager.py is a standalone Tkinter and console interface program, just like the original DeviceManager.exe, it can run on both systems - if no TK is available - it runs with a console interface.

DeviceManager program (from python-dvr) can work with the following groups of surveillance cameras:

  • XM
  • Dahua
  • Fros
  • Wans
  • Beward

Most likely, this is not the manufacturer, but the type of camera detection system used on the LAN. That is, if your camera has a different manufacturer, DeviceManager can still find them.

To install and run DeviceManager, run the commands:

git clone https://github.com/NeiroNx/python-dvr
cd python-dvr
./DeviceManager.py

A graphical interface will open, there it is enough to click the Поиск (“Search”) button.

How to connect to DVR-IP, NetSurveillance, Sofia in command line

To connect on the command line, you can use an interactive Python session or create a small script.

In the python-dvr folder, create a camera.py file. The following code is used to connect:

Replace 192.168.0.167 with the IP of your camera, and the PASSWORD with the real password from it.

from dvrip import DVRIPCam
from time import sleep

host_ip = '192.168.0.167'

cam = DVRIPCam(host_ip, user='admin', password='PASSWORD')
if cam.login():
	print("Success! Connected to " + host_ip)
else:
	print("Failure. Could not connect.")

For example, this code will show the time on the camera:

from dvrip import DVRIPCam
from time import sleep

host_ip = '192.168.0.167'

cam = DVRIPCam(host_ip, user='admin', password='PASSWORD')
if cam.login():
	print("Success! Connected to " + host_ip)
else:
	print("Failure. Could not connect.")

print("Camera time:", cam.get_time())

Run like this:

python3 camera.py

It is clear that the lines of code for connection will be repeated in each script, so we will not duplicate them - just remember that they must be before the function that you have chosen:

Basic use

Reboot the camera:

cam.reboot()

Waiting for the camera to start:

sleep(60)

Login again

cam.login()

Synchronize camera time with PC time:

cam.set_time()

Disconnect:

cam.close()

Display special OSD text

info = cam.get_info("fVideo.OSDInfo")
info["OSDInfo"][0]["Info"] = ["Test:","Temp: 26 C","Hum: 21 %"] # 3 lines text
info["OSDInfo"][0]["OSDInfoWidget"]["EncodeBlend"] = True
info["OSDInfo"][0]["OSDInfoWidget"]["PreviewBlend"] = True
info["OSDInfo"][0]["OSDInfoWidget"]["BackColor"]= '0x80000000'
info["OSDInfo"][0]["OSDInfoWidget"]["FrontColor"]= '0xF0FFFF00'
info["OSDInfo"][0]["OSDInfoWidget"]["RelativePos"] = [6144,6144,8192,8192] # OSD block position
cam.set_info("fVideo.OSDInfo", info)

Camera settings

The code

params = cam.get_general_info()

returns general information about the camera (time zones, formats, auto reboot policy, security settings):

{
    "AppBindFlag": {
        "BeBinded": false
    },
    "AutoMaintain": {
        "AutoDeleteFilesDays": 0,
        "AutoRebootDay": "Tuesday",
        "AutoRebootHour": 3
    },
    "DSTState": {
        "InNormalState": true
    },
    "General": {
        "AutoLogout": 0,
        "FontSize": 24,
        "IranCalendarEnable": 0,
        "LocalNo": 0,
        "MachineName": "LocalHost",
        "OverWrite": "OverWrite",
        "ScreenAutoShutdown": 10,
        "ScreenSaveTime": 0,
        "VideoOutPut": "Auto"
    },
    "Location": {
        "DSTEnd": {
            "Day": 1,
            "Hour": 1,
            "Minute": 1,
            "Month": 10,
            "Week": 0,
            "Year": 2021
        },
        "DSTRule": "Off",
        "DSTStart": {
            "Day": 1,
            "Hour": 1,
            "Minute": 1,
            "Month": 5,
            "Week": 0,
            "Year": 2021
        },
        "DateFormat": "YYMMDD",
        "DateSeparator": "-",
        "IranCalendar": 0,
        "Language": "Russian",
        "TimeFormat": "24",
        "VideoFormat": "PAL",
        "Week": null,
        "WorkDay": 62
    },
    "OneKeyMaskVideo": null,
    "PwdSafety": {
        "PwdReset": [
            {
                "QuestionAnswer": "",
                "QuestionIndex": 0
            },
            {
                "QuestionAnswer": "",
                "QuestionIndex": 0
            },
            {
                "QuestionAnswer": "",
                "QuestionIndex": 0
            },
            {
                "QuestionAnswer": "",
                "QuestionIndex": 0
            }
        ],
        "SecurityEmail": "",
        "TipPageHide": false
    },
    "ResumePtzState": null,
    "TimingSleep": null
}

And this code:

params = cam.get_system_info()

returns hardware settings, camera serial number, current software version and firmware type:

{
    "AlarmInChannel": 2,
    "AlarmOutChannel": 1,
    "AudioInChannel": 1,
    "BuildTime": "2020-01-08 11:05:18",
    "CombineSwitch": 0,
    "DeviceModel": "HI3516EV300_85H50AI",
    "DeviceRunTime": "0x0001f532",
    "DigChannel": 0,
    "EncryptVersion": "Unknown",
    "ExtraChannel": 0,
    "HardWare": "HI3516EV300_85H50AI",
    "HardWareVersion": "Unknown",
    "SerialNo": "a166379674a3b447",
    "SoftWareVersion": "V5.00.R02.000529B2.10010.040600.0020000",
    "TalkInChannel": 1,
    "TalkOutChannel": 1,
    "UpdataTime": "",
    "UpdataType": "0x00000000",
    "VideoInChannel": 1,
    "VideoOutChannel": 1
}

This function:

params = cam.get_system_capabilities()

returns camera software capabilities (alarms and detections, communication protocols and hardware features):

{
    "AlarmFunction": {
        "AlarmConfig": true,
        "BlindDetect": true,
        "HumanDection": true,
        "HumanPedDetection": true,
        "LossDetect": true,
        "MotionDetect": true,
        "NetAbort": true,
        "NetAlarm": true,
        "NetIpConflict": true,
        "NewVideoAnalyze": false,
        "PEAInHumanPed": true,
        "StorageFailure": true,
        "StorageLowSpace": true,
        "StorageNotExist": true,
        "VideoAnalyze": false
    },
    "CommFunction": {
        "CommRS232": true,
        "CommRS485": true
    },
    "EncodeFunction": {
        "DoubleStream": true,
        "SmartH264": true,
        "SmartH264V2": false,
        "SnapStream": true
    },
    "NetServerFunction": {
        "IPAdaptive": true,
        "Net3G": false,
        "Net4GSignalLevel": false,
        "NetAlarmCenter": true,
        "NetDAS": false,
        "NetDDNS": false,
        "NetDHCP": true,
        "NetDNS": true,
        "NetEmail": true,
        "NetFTP": true,
        "NetIPFilter": true,
        "NetMutlicast": false,
        "NetNTP": true,
        "NetNat": true,
        "NetPMS": true,
        "NetPMSV2": true,
        "NetPPPoE": false,
        "NetRTSP": true,
        "NetSPVMN": false,
        "NetUPNP": true,
        "NetWifi": false,
        "OnvifPwdCheckout": true,
        "RTMP": false,
        "WifiModeSwitch": false,
        "WifiRouteSignalLevel": true
    },
    "OtherFunction": {
        "NOHDDRECORD": false,
        "NoSupportSafetyQuestion": false,
        "NotSupportAutoAndIntelligent": false,
        "SupportAdminContactInfo": true,
        "SupportAlarmRemoteCall": false,
        "SupportAlarmVoiceTipInterval": true,
        "SupportAlarmVoiceTips": true,
        "SupportAlarmVoiceTipsType": true,
        "SupportAppBindFlag": true,
        "SupportBT": true,
        "SupportBallTelescopic": false,
        "SupportBoxCameraBulb": false,
        "SupportCamareStyle": true,
        "SupportCameraWhiteLight": false,
        "SupportCfgCloudupgrade": true,
        "SupportChangeLanguageNoReboot": true,
        "SupportCloseVoiceTip": false,
        "SupportCloudUpgrade": true,
        "SupportCommDataUpload": true,
        "SupportCorridorMode": false,
        "SupportCustomizeLpRect": false,
        "SupportDNChangeByImage": false,
        "SupportDimenCode": true,
        "SupportDoubleLightBoxCamera": false,
        "SupportDoubleLightBulb": false,
        "SupportElectronicPTZ": false,
        "SupportFTPTest": true,
        "SupportFaceDetectV2": false,
        "SupportFaceRecognition": false,
        "SupportMailTest": true,
        "SupportMusicBulb433Pair": false,
        "SupportMusicLightBulb": false,
        "SupportNetWorkMode": false,
        "SupportOSDInfo": false,
        "SupportOneKeyMaskVideo": false,
        "SupportPCSetDoubleLight": true,
        "SupportPTZDirectionControl": false,
        "SupportPTZTour": false,
        "SupportPWDSafety": true,
        "SupportParkingGuide": false,
        "SupportPtz360Spin": false,
        "SupportRPSVideo": false,
        "SupportSetBrightness": false,
        "SupportSetDetectTrackWatchPoint": false,
        "SupportSetHardwareAbility": false,
        "SupportSetPTZPresetAttribute": false,
        "SupportSetVolume": true,
        "SupportShowH265X": true,
        "SupportSnapCfg": false,
        "SupportSnapV2Stream": true,
        "SupportSnapshotConfigV2": false,
        "SupportSoftPhotosensitive": true,
        "SupportStatusLed": false,
        "SupportTextPassword": true,
        "SupportTimeZone": true,
        "SupportTimingSleep": false,
        "SupportWebRTCModule": false,
        "SupportWriteLog": true,
        "SuppportChangeOnvifPort": true
    },
    "PreviewFunction": {
        "Talk": true,
        "Tour": false
    },
    "TipShow": {
        "NoBeepTipShow": true
    }
}

Camera video settings/modes

params = cam.get_info("Camera")

Will return approximately the following data:

{'ClearFog': [{'enable': 0, 'level': 50}], 'DistortionCorrect': {'Lenstype': 0, 'Version': 0},
'FishLensParam': [{'CenterOffsetX': 300, 'CenterOffsetY': 300, 'ImageHeight': 720,
'ImageWidth': 1280, 'LensType': 0, 'PCMac': '000000000000', 'Radius': 300, 'Version': 1,
'ViewAngle': 0, 'ViewMode': 0, 'Zoom': 100}], 'FishViCut': [{'ImgHeight': 0, 'ImgWidth': 0,
'Xoffset': 0, 'Yoffset': 0}], 'Param': [{'AeSensitivity': 5, 'ApertureMode': '0x00000000',
'BLCMode': '0x00000000', 'DayNightColor': '0x00000000', 'Day_nfLevel': 3, 'DncThr': 30,
'ElecLevel': 50, 'EsShutter': '0x00000002', 'ExposureParam': {'LeastTime': '0x00000100',
'Level': 0, 'MostTime': '0x00010000'}, 'GainParam': {'AutoGain': 1, 'Gain': 50},
'IRCUTMode': 0, 'IrcutSwap': 0, 'Night_nfLevel': 3, 'PictureFlip': '0x00000000',
'PictureMirror': '0x00000000', 'RejectFlicker': '0x00000000', 'WhiteBalance': '0x00000000'}],
'ParamEx': [{'AutomaticAdjustment': 3, 'BroadTrends': {'AutoGain': 0, 'Gain': 50},
'CorridorMode': 0, 'ExposureTime': '0x100', 'LightRestrainLevel': 16, 'LowLuxMode': 0,
'PreventOverExpo': 0, 'SoftPhotosensitivecontrol': 0, 'Style': 'type1'}], 'WhiteLight':
{'MoveTrigLight': {'Duration': 60, 'Level': 3}, 'WorkMode': 'Auto', 'WorkPeriod':
{'EHour': 6, 'EMinute': 0, 'Enable': 1, 'SHour': 18, 'SMinute': 0}}}

To get the current encoding settings

enc_info = cam.get_info("Simplify.Encode")

The last command will return approximately the following data:

[{'ExtraFormat': {'AudioEnable': False, 'Video': {'BitRate': 552, 'BitRateControl': 'VBR',
'Compression': 'H.265', 'FPS': 20, 'GOP': 2, 'Quality': 3, 'Resolution': 'D1'},
'VideoEnable': True}, 'MainFormat': {'AudioEnable': False, 'Video': {'BitRate': 2662,
'BitRateControl': 'VBR', 'Compression': 'H.265', 'FPS': 25, 'GOP': 2, 'Quality': 4,
'Resolution': '1080P'}, 'VideoEnable': True}}]

Bitrate change

NewBitrate = 7000
enc_info[0]['MainFormat']['Video']['BitRate'] = NewBitrate
cam.set_info("Simplify.Encode", enc_info)

Getting color parameters of a video channel

colors = cam.get_info("AVEnc.VideoColor.[0]")

The last command will return approximately the following data:

[{'Enable': True, 'TimeSection': '0 00:00:00-24:00:00', 'VideoColorParam': {'Acutance': 3848,
'Brightness': 50, 'Contrast': 50, 'Gain': 0, 'Hue': 50, 'Saturation': 50, 'Whitebalance': 128}},
{'Enable': False, 'TimeSection': '0 00:00:00-24:00:00', 'VideoColorParam': {'Acutance': 3848,
'Brightness': 50, 'Contrast': 50, 'Gain': 0, 'Hue': 50, 'Saturation': 50, 'Whitebalance': 128}}]

Change IR cut

cam.set_info("Camera.Param.[0]", { "IrcutSwap" : 0 })

Change WDR settings

WDR_mode = True
cam.set_info("Camera.ParamEx.[0]", { "BroadTrends" : { "AutoGain" : int(WDR_mode) } })

Getting network settings

net = cam.get_info("NetWork.NetCommon")

Enabling Adaptive IP Mode

cam.set_info("NetWork.IPAdaptive", { "IPAdaptive": True })

Set camera hostname

cam.set_info("NetWork.NetCommon.HostName", "IVG-85HG50PYA-S")

Selecting DHCP mode (enabled in this example)

dhcpst = cam.get_info("NetWork.NetDHCP")
dhcpst[0]['Enable'] = True
cam.set_info("NetWork.NetDHCP", dhcpst)

Add User and Change Password

User "test2" with password "123123"

cam.addUser("test2","123123")

Password change

cam.changePasswd("321321",cam.sofia_hash("123123"),"test2")

Delete user "test2"

if cam.delUser("test2"):
    print("User deleted")
else:
    print("Can not delete it")

System user cannot be deleted

if cam.delUser("admin"):
    print("You do it! How?")
else:
    print("It system reserved user")

Taking a JPEG snapshot

with open("snap.jpg", "wb") as f:
    f.write(cam.snapshot())

Receiving audio/video stream

Only the video is recorded to the file (using a simple lambda):

with open("datastream.h265", "wb") as f:
    cam.start_monitor(lambda frame, meta, user: f.write(frame))

Data stream recording with additional filtering (capturing the first 100 frames):

class State:
    def __init__(self):
        self.counter = 0

    def count(self):
        return self.counter

    def inc(self):
        self.counter += 1

with open("datastream.h265", "wb") as f:
    state = State()
    def receiver(frame, meta, state):
        if 'frame' in meta:
            f.write(frame)
            state.inc()
            print(state.count())
            if state.count() == 100:
                cam.stop_monitor()

    cam.start_monitor(receiver, state)

Camera Title Setting

An easy way to change the title of a picture:

cam.channel_title(["Backyard"])

Use Unicode font from host to generate bitmap for header from PIL import Image, ImageDraw, ImageFont

w_disp   = 128
h_disp   =  64
fontsize =  32
text     =  "Туалет"

imageRGB = Image.new('RGB', (w_disp, h_disp))
draw  = ImageDraw.Draw(imageRGB)
font  = ImageFont.truetype("/Library/Fonts/Arial Unicode.ttf", fontsize)
w, h  = draw.textsize(text, font=font)
draw.text(((w_disp - w)/2, (h_disp - h)/2), text, font=font)
image1bit = imageRGB.convert("1")
data = image1bit.tobytes()
cam.channel_bitmap(w_disp, h_disp, data)

Use your own logo in the picture

img = Image.open('vixand.png')
width, height = img.size
data = img.convert("1").tobytes()
cam.channel_bitmap(width, height, data)

Show current temperature, speed, GPS coordinates, etc.

Use the same method to draw text to a bitmap and send it to the camera, but consider placing the internal bitmap storage in RAM:

mount -t tmpfs -o size=100k tmpfs /mnt/mtd/tmpfs
ln -sf /mnt/mtd/tmpfs/0.dot /mnt/mtd/Config/Dot/0.dot

Camera firmware update

Optional: get information about update options

print(cam.get_upgrade_info())

Performing an update

cam.upgrade("General_HZXM_IPC_HI3516CV300_50H20L_AE_S38_V4.03.R12.Nat.OnvifS.HIK.20181126_ALL.bin")

Recommended for you:

Leave a Reply

Your email address will not be published.