SDM2 Device Manager Readme
Date: Mon 04-Dec-2017
Welcome to the SDM2 Device Manager tool. With this tool you can detect your devices on the network, and configure the principal settings on each of these devices.
This program replaces the Siqura Device Manager tool, version 1.x. You can still download this application from our website https://www.tkhsecurity.com/support/software . This SDM2 tool is also available from this link.
Use the SDM2 Device Manager to
- Detect your devices on the network
- Change the network settings on your device
- Inspect/Modify parameters on your device
- Log selected device parameters
- Video live video from those devices that support (MPEG) video
- Backup and restore the configuration of your devices (XSNet excluded at this time)
- Update the firmware for your devices (XSNet excluded at this time)
As of version 2.1.0, the tool supports a driver mechanism. In comparison with the previous version 2.0.4, the only driver supported was SPI. This is still the preferred driver in the Auto driver detect mechanism, for backwards compatibility reasons.
The SDM2 Device Manager tool is a 32-bit portable tool. You should be able to run it on your customer's machine without installing anything on it. Many customer forbid installation of your software on their machines. This tool should run fine from a USB stick.
No settings are written to the Windows Registry. All settings are kept in the tool's settings file (SDM2.xml).
You need write access on the tool's folder.
Several options are available to let you detect the devices on your network. Typically, you just start the tool and it will use UPnP device detection to auto discover the TKH Security Solutions devices. But you can also run a scan over a given IP range to find out directly which devices exist in this range.
If you are out there in the field and find yourself frequently testing out which devices are there in your customer's network, then you can benefit from the Document feature. The device list is stored in the document you save to disk, then later on when you reopen this file, the device list is immediately available again.
To maintain the device list, following functions are available:
- Auto detection using UPnP
- Manual scan over a given IP range
- Manually add a device with a given IP address
- Save and open your device list
Note on UPnP device detection: this standard protocol requires multicast for good operation. If multicast is not working correctly on your network, then the device detection will either be slow on the discovery of the devices, or not work at all. Also, your Firewall application might interfere with the UPnP discovery.
It is for this reason that the Manual scan function is also available in the tool.
Auto detection using UPnP
Typically, auto detection is Enabled when you start the tool, so the detected devices will drop in automatically. But when you open a previously saved device list, auto detection will be Disabled.
With Edit > Auto detect new devices, you can turn auto detection on and off.
You can check the status bar to see if auto detection is enabled or not. Also, when enabled, you will see a checkmark next to the menu option.
Note: UPnP detection works over all found network adapters on your machine. You do not need to select a network adapter.
Tip: UPnP detection is a continuous process that runs in the background of the application. If you want to be sure that the process starts by sending out a new request over the network, you can Disable and then Enable the device detection.
As of version 2.1.0, the tool will show a message box when no devices are auto detected for about 30 seconds.
Manual scan over a given IP range
Choose Edit > Manual scan for devices from the menu bar (or hit Ctrl+M on the keyboard) to show the manual scan dialog.
Note: the manual scan function will take the IP range you entered as input and automatically determine the network adapter to which this IP range applies. The dialog shows you the list of networks on your machine to help you find out which IP ranges are typically accessible. But you can specify any IP range.
Manually add a device with a given IP address
Choose Edit > Add device from the menu bar (or hit INS on the keyboard) to show the Add device dialog.
Note: you need to enter the device credentials correctly, or the connection with the device will not be possible. The tool will remember the credentials per device and save these to its settings file (password is encrypted). By doing so, you can clear the list, redetect all devices, and the tool will already fill in the right credentials. This saves you a lot of work.
Of course, you can also save the device list to a file, and the credentials will also be stored in that file.
Device list file
You can save the currently shown device list to a file.
For each device, the tool will then write the device information to this file.
By default, an XML file is written. If you want to use this device information in other applications (like Excel), then make sure you save the file as a CSV file. This will write a comma separated file.
Note: the device's credentials are stored in the file without encryption! Make sure that the file you write is saved in a proper location, so that it will not fall into the wrong hands.
As of version 2.1.0, you can now choose a driver per device in the Edit Device dialog.
Normally, the device driver used will be AutoDetect.
You can manually change the selected driver, after which the tool will reconnect to the device using this different driver. Depending on the device's capabilities, the connection will work or not.
Depending on the driver selected for the device, the list of parameters shown will vary.
Currently, the following drivers are supported:
- SPI preferred driver, works with
- C/S-50/60/620 series video encoders
- 620/840 series cameras
- 810/820/860 series cameras
- 1000/1100 series cameras
- MAPI works with
- C/S-50/60/620 series video encoders
- 620/840 series cameras
- XSNet preliminary (limited) access, works with
- XSNet switchesDevice connection Change network settings on your deviceIn case you are unsure whether the new IP address you want to assign to the device is currently free, click on the Test button. This will run a PING for the new IP address and let you know if the new IP address is available (i.e. can be used for the new device). Since version 2.2.0, you can back up the configuration of your devices. Select one or more devices from the device list, then from the context menu, select Backup. You will then select the base folder in which the backup(s) should be written.When you want to restore a previously saved backup, select the device(s) you want to restore the configuration for, and from the context menu, select Restore. You will then select either the base folder for the backup, or the specific backup folder inside the backup base folder. In case you select the base folder, SDM2 will look up the appropriate device backup by searching for the device MAC address. In case you selected a specific device backup folder directly, SDM2 will check this backup against the selected device for compatibility. You can only restore backups to identical device models, and even then there is a change that the device will refuse to proceed with the backup; this happens if the device has a different version firmware which is no longer compatible with the stored configuration backup. Not to worry: the device will check the file by itself and only proceeds with the restore if it can indeed use the given backup. As of version 2.2.0, you can now upgrade the device firmware. Select the devices you want to upgrade the firmware for, then from the context menu, select Update Firmware. Then select the firmware file you want to use. You will get a confirmation box before the upgrade actually takes place. With the Edit > Find devices function, you can select one or more devices in the device list, based on the search text you enter. You can select which column to search in, or just search over all columns. To speed up the find function, you can also hit Ctrl+F on the keyboard to show the Find dialog.Show video Since the SDM2 tool is a portable tool, this Video control installation is a separate process. You can decide whether or not to use the live video capability of the tool. Do note that installing the Video control to the host machine will mark traces on the host machine. Even if you uninstall the Video control (which can be done with the same installer), traces of the installation may be left on the machine. If you are running the tool on a customer’s machine, please make sure that this is allowed! Under Tools > Options, you can modify the tool's options. Options are:- Show third party devices. This will effectively turn off the filter function for UPnP detection. By default, this option is disabled, and only devices from TKH Security Solutions are shown. You can show the system log by selecting View > System log.- Enable auto detection at application startup. Normally, this is turned on. If you prefer the auto detection to run under manual control, you can uncheck this option. You can then manually start and stop the auto detection from the menu bar. - Reopen last used document. When this option is checked, then the tool will re-open the file you last used. - Enable auto detection after file opened. Controls the auto detection mechanism after opening a file.- Set document Modified flag on auto detected devices. If you select this, the document will be marked Modified when new devices are auto detected. This is the same behaviour as was seen on the previous version 2.0.4 of the tool. If you do not want to be annoyed by the Save question when only auto detections were seen, uncheck this option. Note that when you manually modify any device in the list, the Modified flag will work as before. For this version (found on top of this readme), following issues are known:
- If you wish to see the full revisions list, please check out the Version info in the About box.
- - (none).
- Known issues
- - System logging. The tool logs information to its private system log. Depending on the logging level you select here, the tool will log more or less information.
- - Browser selection. By default, the tool will use the default browser on your machine, to open the device web page. Since some equipment still heavily relies on plugins or other older mechanisms, you can only correctly show these devices' web pages by using an older browser, like Internet Explorer. By changing the browser here, you can overcome this issue.
- - Show driver in status. With this checkbox checked, the device status will display the used srived next to the Online status for the device.
- - Show serial number column. With this checkbox checked, the device serial number will show up in the device list view. Note that the serial number shown is retrieved from the device software configuration. Under certain circumstances you may find different serial number information on the sticker of the device.
- When running a manual scan on the network, you will always get a new device list entry for each detected device.
- Note that to be able to show live video, the SDM2 tool requires the Video control installed on your host machine. Normally, this is not the case, and then you need to install this Video control first. To do this, choose menu option Tools > Run Video control installer. This installation wizard will guide you through the installation process for the Video control.
- If the video device supports PTZ, you can use the mouse cursor on the video panel to move around, and the mouse wheel to control zoom.
- As of version 2.1.0, you can now show live video from those devices that support MPEG video. To show video, select the device you want to show the video from, then choose menu option Tools > Show video (or use the same options from the device context menu).
- Find device
- For the 810/820-series cameras, the firmware upgrade procedure is a time consuming operation that includes multiple reboots on the device side. Please be patient, this operation may take up to 10 minutes per camera!
- You can upgrade firmware for multiple devices in one operation, but then the devices need to be the same model. If this is not the case, then the context menu option is disabled and cannot be selected.
- Firmware upgrade
- If you restore the configuration of a device, this might include changing the IP address of that device. If that is the case, then SDM2 will change the IP address for the device list entry as well to reflect the new situation after restoring the configuration completes.
- The backup folder structure is two levels: 1) dated base folder, and 2) device backup folder containing the backup for one device.
- Backup and restore your device(s) configuration
- After changing the device network settings, the tool will attempt to reboot it. This normally works, but some devices do not support remote reboot. So after changing the network settings for one or more devices, do check the device Status column in the main window; the device should come back Online under the new IP addres.
- To change the network settings on your device, you select the Change network settings option from the device right-click menu. From the dialog you then see, you can change the network settings for each selected device, then hit Apply.
- Setting the device to Forced Offline is handy if you know that the device is not there at this time.
- For each device in the device list, the tool will maintain a logical connection. In the device list table you can find the Status column. This column shows you the current status for the device connection. Typically, your device will either be Online (i.e. connection is OK and you can work with it), or Forced Offline (you configured the device to be Offline in the Edit device dialog).