KLC2000v8_Client Manual revision 1.

KLC2000v8_Client
Manual

Revision 1.2

Kavit Electronics Industries Ltd.

May 02, 2023

1
 KLC2000v8_Client Manual revision 1.2

Copyright © 1992-2023 Kavit Electronics Industries Ltd. All Rights Reserved. No part of
this document may be reproduced, stored in a retrieval system, distributed or transmitted,
in any form, or by any means, electronic or otherwise, including photocopying, reprinting, or
recording, for any purpose, with the express prior written permission of Kavit Electronics
Industries Ltd.

TRADEMARKS Kavit and Kavit Logo are marks and registered trademarks of Kavit Electronics
Industries Ltd. in Israel and certain other countries. The use of these trademarks without
Kavit's prior written consent is strictly prohibited. Other third party trademarks referenced
are the property of their respective owners. Please note that the above list is not all-
inclusive, and the absence of any mark from this list does not mean that it is not Kavit
trademark.

DISCLAIMER The information in this document is provided "AS – IS", without warranty of any
kind, express or implied, including but not limited to a warranty if merchantability, fitness
for any particular purpose, title or non-infringement of third party rights, and Kavit
specifically disclaims all other warranties, conditions or representations. This document is
provided for informational purposes only, and should not be construed as a representation
or commitment on the part of Kavit. Information in this document is subject to change
without notice.

OPEN SOURCE This software uses the OpenSSL which requires mentioning the following
acknowledgments:
This product includes software developed by the OpenSSL Project for use in the OpenSSL
Toolkit (http://www.openssl.org/).
This product includes software written by Tim Hudson ([email protected])

2
 KLC2000v8_Client Manual revision 1.2

Revision History:

Revision Date of issue Author Scope

1.0 December 16, 2017 Kobi de-Trenewan Document creation
1.1 March 28, 2018 Kobi de-Trenewan - Updated number of observers
- "Too low back power" indication
support

1.2 May 2, 2023 Kobi de-Trenewan - Online device fields were fixed
and updated

3
 KLC2000v8_Client Manual revision 1.2

Introduction
The KLC2000v8_Server combined with KLC2000v8_Client applications allow multiple users to
either fully or partially monitor and control a collection of KJ2000v8 jammers through an
Ethernet network.

The following picture describes how the system parts are connected to each other:

The KLC2000v8_Client application can connect to a single KLC2000v8_Server. Single instance

of the KLC2000v8_Client is controlled by a single operator in any given moment.

Every operator is identified by the combined information of: entity, user name, access level
and password. The list of the operators' identification information is stored only in the
KLC2000v8_Server database.

There are 4 supported access levels: administrator, supervisor, technician and observer. Up
to a single administrator, up to a single technician, up to a single supervisor and up to 50
observers can be simultaneous connected (from up to 53 instances of KLC2000v8_Client) to
a single KLC2000v8_Server.

Different access levels provide different capabilities that are available to the operators:

Administrator and technician access level provide theirs operators a full access to all the
features supported by the KLC2000v8_Client (The difference between them is that only
administrator can locally login the KLC2000v_Server). These features are: generating report
on the jammers, detailed jammer status, read and modify each channel activation state and
output power, change parameters of the KJ2000v8 controller, start firmware upgrade of the

4
 KLC2000v8_Client Manual revision 1.2

KJ2000v8 controller, change factory parameters of each channel (including firmware

upgrade of the software in each channel's microcontroller). A detailed explanation of each
these features will be given later.

Supervisor operator can watch the detailed jammer status, generating report on the
jammers and also to read and modify each channel activation state and output power.

Observer operator can only watch the detailed jammer status but change nothing.

The KLC2000v8_Client jobs are:

1. Remotely login to the KLC2000v8_Server.

2. Support Unicode with UTF-16 format.
3. Collect information from/to KJ2000s jammers in the system.
4. Collect information on the connection status with the KJ2000v8_Server.
5. Show the overall status of all the KJ2000s jammers in the system as colored icons.
6. Allow logically separation of the KJ2000 jammers into sites, sub-sites etc.
7. Allow to focus on a single KJ2000 jammer, in order to get its detailed status as well
as graphically commanding it to do operations as allowed by the operator's access
level.
8. Store and load windows, sites and jammers icons graphical properties.
9. Keep log files in CSV format. The log files are kept in the same folder as the
KLC2000v8_Client.exe is. The log file name format is "KLC2000_Client_YYYY-MM-
DD.log" when YYYY is the year, MM is the month ("01" to "12") and DD is the day in
month ("01" to "31"). Every midnight, the old log file is closed and new one with a
new name is created. If the KLC2000v8_Client starts its execution when a log file
which fits the executing date already exists, then it adds the logs to the end of the
log file.
10. Show the current log file upon user request.
11. Show the history of the log files upon user request.
12. Executing the KLC2000v8_Client requires a running and properly configured
KLC2000v8_Server, so the remote login the KLC2000v8_Client does can succeed.
13. Generating report for all the jammers icons upon request.

5
 KLC2000v8_Client Manual revision 1.2

“Login” window
The login window is opened in one of the 3 scenarios:
1. Upon start executing the KLC2000v8_Client application.
2. If the "login…" option is selected in the main window main menu. In this case any
other opened windows of the KLC2000v8_Client are closed.
3. If the "login…" option is selected in the tray icon popup menu.

Once this window is opened, the communication to the KLC2000v8_Server is automatically

closed.
The login window requires both transport parameters and operator identification
information, to be compatible with the ones defined in the KLC2000v8_Server application in
order to be able to successfully complete the remote login with it.
Transport parameters:
- "IP address" is the IP address on which the KLC2000v8_Server listens to incoming
connections from operators. Both IPv4 and IPv6 are supported.
- "TCP/IP port" is the port number on which the KLC2000v8_Server listens to incoming
connections from operators.
- "TLS" should be checked if a secure Ethernet transport should be used.
- "Communication timeout" - the number of seconds pass with no TCP packets arrival,
to detect that the TCP link with the KLC2000v8_Server is broken.
- "Reconnect period" - in case of a failure connection attempt, or broken TCP link is
identified, it is the number of seconds until a new connection attempt will be made.
Operator identification information:
- "Access level" can be one of the following: Administrator, Supervisor, Technician and
Observer. Each has different control capabilities on the KJ2000s.

6
 KLC2000v8_Client Manual revision 1.2

- "Entity" is the name of the entity (e.g. agency or company) the operator
represents. It contains 1 to 32 characters.
- "User name" is an operator nick name (Entity can have more than a single operator).
It contains 1 to 32 characters.
- "Password" is a password that is assigned to the triplet of Entity/User name/Access
level. It contains up to 32 characters with the following constrains:
o It contains minimum of 10 characters.
o No more than 2 consecutive characters.
o Characters must be taken from at least 3 groups from the following:
▪ Upper case Latin letters: A-Z
▪ Lower case Latin letters: a-z
▪ Digits: 0-9
▪ Symbols: ` ~ ! @ # $ % ^ & * ( ) _ + - = { } | [ ] \ : " ; ' < > ? , . /
▪ Other characters not appear in previous groups.
Passwords expiry dates are no longer than 365 days from the date they are
configured. Email notification can be sent by the KLC2000v8_Server application
before it expires, to inform the operator (and possibly the administrator) about the
need in providing a new password. A notification is also sent once the password
expired.

Only the administrator can change entity/user name/access level/passwords. It is

locally done in the KLC2000v8_Server application by the administrator.

Clicking the "Ok" button starts the connection and authentication procedure with the
KLC2000v8_Server application. If the connection and authentication succeeds then the login
window is automatically closed. If it fails, then more attempts are automatically done with a
period of time of "Reconnect period" after each failure.
Closing the login window or clicking the "Cancel" button exits the KLC2000v8_Client
application.
Clicking the "Stop connection" stops the connection attempts.

7
 KLC2000v8_Client Manual revision 1.2

“About” window
Once a successful first time login is done, or if the “About…” option is selected from the tray
icon popup menu, then the following window is opened:

In case the about window is opened immediately after first successful login, then closing the
about window results in automatically opening of the main window.

8
 KLC2000v8_Client Manual revision 1.2

“Main” window
The main window serves 2 purposes:
1. KLC2000v8_Client application main window, so closing it also terminates the
application. In addition it also contains the main menu which allows the operator to
do application level operations, and a status bar which reports the TCP status
connection with the KLC2000v8_Server, as well as the entity, user name and its
access level of the last operator that successfully logged in.
2. It is the root site, so it is the ultimate origin of all the device icons, and of all of the
other site windows (if there are more).

The main window allows the user to:

1. Activate the options that are allowed by the KLC2000v8_Client application via the
main menu.
2. Watch in real time the connection status of the operator to the KLC2000v8_Server
application.
3. Watch in real time the overall error of the jammers that their icons are located in
this window.
4. Watch in real time the most severe overall error that is propagated to the site icons
that are located in this window.

9
 KLC2000v8_Client Manual revision 1.2

5. Edit/add/delete/delete all/move icons on it.

6. Edit the main window title ("Edit root site name…" from the popup menu).
7. Hide/show/move the legend which provides the color code of the overall error.
8. Load/clear background picture.
9. Fit the window size to the loaded background picture size.

The main menu options are:

Menu Description
Edit menu: "Online devices…" - allows watching the
KJ2000v8 jammers that are connected to the
system, and dragging them into a site
window in case they are not already
mapped.
"Login…" - closes the TCP connection with
the KLC2000v8_Server, and allows to
remotely login to it again, as the same or
different operator.
"Log out" - closes all the open windows and
shows an icon of the KLC2000v8_Client in
the system tray.
"Exit" - terminates the KLC2000v8_Client
application.
Configuration menu: "Load configuration" - Loads the
configuration which is saved in
"KLC2000v8_Client.ws" file. This file includes
the graphical configuration (windows state,
size and positions) of the main window, any
other site window (legend visible and
position, all icons names and positions,
background pictures), log window, logs
history window and the online devices
window.
The logs history window configuration also
includes the default folder where it looks for
log files.
"Save configuration" - Saves the current
windows configuration in
"KLC2000v8_Client.ws" file. See "Load
configuration…" for details of what
configuration is saved.
"Default windows configuration" - changes
the configuration of the system to a default
empty one.
Log menu: "Show log…" - open the KLC2000v8_Client
log window.
"Show logs history…" - open the logs history
window from which user can display any log
file, from any date.
"Report devices…" - open the report devices
window from which the user can generate

10
 KLC2000v8_Client Manual revision 1.2

report on the existing jammers.

Windows menu: "Edit root site name…" - allow the operator
to change the title of the main window,
which also serves as the root site.
"Show all sites" - make all the opened sites
visible.
"Close all sites" - close all the site windows,
except of the main window.
"Cascade" - Display all the open site
windows in a cascaded manner.
Help menu: "About KLC2000 Client…" - open the about
window.

Many graphical features of the main window can be changed:

- The window size, position and state.

- The legend visibility and position.
- The icons position and names.
- The window title.
- The background picture, if any.

These graphical changes can only be stored by the “Save configuration” option, and they
trigger no message suggesting to save them upon exit.

In addition to the main menu, 4 different popup menus are available to the user, depending
on the exact location the mouse' right button is clicked:

1. On the legend:

2. On a site icon:

3. On a device icon:

4. On any other remaining area which does not include: the window title, the main
menu or the status bar:

11
 KLC2000v8_Client Manual revision 1.2

Please notice, the "Edit root site name…" option will only be enabled in the main
window.

12
 KLC2000v8_Client Manual revision 1.2

"site" windows

Site windows are decedents of the main window directly or indirectly via a tree like
structure, whose root is the main window, and it splits via the site icons that can be put on
the main window or on any other site window.

The difference between the main window and any other site window are:

1. Only the main window must always exist as it serves as the KLC2000v8_Client
application central window.
2. Only the main window contains the application main menu bar and a status bar.
3. The caption of any site window is the same as the caption of its parent’s icon. The
exception is the main window which has no parent icon, so its caption can only be
changed using the “Edit root site name…” option.
4. There is only a single instance of the main window. Other sites windows instances
are limited only by the PC resources.

Each site window allows to group site and jammers icons that have logical relation between
them (usually it is based on being in the same geographical area/institute).

The color of each site icon is determined by the color of the most severe problem in the
icons of its window (weather this site window is open or closed). The problem priorities is as
shown in the legend (that can be configured to be visible or hidden in each site window),
when “No communication” is the most severe problem, and “Device is Ok” indicates that
there are no detectable errors. If there are no icons inside the site window, then its parent
icon color will reflect that that there are no detectable errors. In this way, only a relatively
small number of site icons are needed to be supervised.

Clicking on a site icon opens a site window. Both site and device icons can be dragged from
one to other site window, with the exception that no site icon can be dragged into a
decedent site window of itself.

Clicking on a device icon opens a KJ2000v8 jammer window, with capabilities that are
determined by the operator access level.

13
 KLC2000v8_Client Manual revision 1.2

"KJ2000v8 jammer" windows

KJ2000v8 jammer windows are opened once a jammer icon in any of the site windows is
clicked. They allow the operators (that have the right access level) to:

1. Get a coarse and detailed status report on each channel in the jammer, including the
time the last report was gotten.
2. Get information if the jammer is simultaneously controlled by other machines.
3. Get tempers alerts, if any.
4. Enable/disable the transmission of each channel.
5. Change each channel output power.
6. Change the parameters of the KJ2000v8 control circuit (e.g. network parameters,
device name).
7. Start a firmware update operation of the KJ2000v8 control circuit.
8. Make a firmware update and firmware verify to the software in the microcontroller
of each channel.
9. Program factory parameters in the microcontroller of each channel.

The caption of this window is determined by the name of its parent icon. The parent icon
name is automatically determined, when dragging a line in the “online devices” window to a
site window, as identical to the device name parameter (it is one of the parameters that are
needed to be configured in the KJ2000v8 jammer) but it can also be changed when the
operator modify the parent icon name with the “Edit device icon…” option.

Any of these windows has up to 5 tabsheets: “Status”, “Channels”, “Parameters”,

“Firmware”, “Channels factory parameters”.

14
 KLC2000v8_Client Manual revision 1.2

As explained in the introduction: only operators with access level of administrator and
technician can access all of these tabsheets. Observer operator can only access the “Status”
tabsheet (without the “Setup connection” button), and supervisor operator can only access
the “Status” and the “Channels” tabsheets.

The visibility state and the position of each KJ2000v8 jammer window is saved by the “Save
configuration” option, and restored by the “Load configuration” option.

Any text that was typed in any of this window’s fields is neither stored in the configuration
file, nor it is stored after closing the window.

For detailed information about the options available in this window, please refer to the
“Manual for KLC2000USBv8”, the manual that describes the KLC2000USBv8 application -
which uses an identical window to manage a single KJ2000v8 jammer via a USB interface.

15
 KLC2000v8_Client Manual revision 1.2

"Online devices" windows

Online devices window shows the current jammers that are connected to the
KLC2000v8_Client application via the KLC2000v8_Server application.

This information includes the following:

1. The jammer unique ID - it is an 8 hexadecimal digits number, which uniquely identify

the jammer. The list is ordered by the unique IDs.
2. Device name - an arbitrary name of up to 32 characters that is given to the jammer
during its configuration. It serves as a default name when dragging a line to a site
window.
3. Device type - it should always be “KJ2000v8”.
4. Connection time - the time the device was connected to the KLC2000v8_Server.
5. Mapped - this field is checked if there is already an icon in a site window (no matter
if the site window is open or closed) that represents this jammer (the match is based
on the jammer “unique ID” parameter). In case the jammer is not mapped, then the
operator is able to drag this line into any opened site icon. Once a successful drop is
made, then a device icon is created with a default name identical to the jammer
“device name”.
6. Site - this field is not empty only when the device is mapped. It indicates the title of
the site window into which the device is mapped.

In the bottom line, a summary of the number of connected devices and the connected and
mapped devices appears.

16
 KLC2000v8_Client Manual revision 1.2

“Log” window

The log window allows the user to trace both the KLC2000v8_Client application level
problems and KJ2000v8 jammers level problems in real time. The displayed events should
always appear sorted in chronological order (unless the system date/time was messed by
the user). Every midnight, the list disappears and a new list with a new log file begins. Every
time a new event is recorded then:

1. New line is added to the bottom of the list.

2. The index of the displayed top level item in the list is automatically increased by one,
if possible. This feature allows the user to always watch the last events without any
need of scrolling the list down.
3. In case of a new incoming jammer device level alert, the KLC2000v8_Client first
checks if the device state is changed due to this new alert. If yes, then it is recorded
as a new event in the log. If the device state was not changed, then this new alert is
discarded.

The window title shows the created CSV file name (its file extension is “.log”). The table
columns are the same as the CSV file columns and they contain the following information:

- “Time” - the time the recorded event is identified by the system.

- “Severity” - it categorizes the severity of the recorded event to one of the following:
o For application level alerts: “Information”, “Error”, “Warning”, and “Alert”.
o For KJ2000v8 jammer device level alerts: "No communication", "Over
temperature", "High back power", "Too low back power", "Channel is in
bootloader state", "Tamper alert", "Communication is Ok" and "Device is
Ok".

Each severity within a group is displayed with a different background color.

- “Device ID” - in case an event that is related to a KJ2000v8 jammer device is

recorded, then an 8 characters string of the device unique ID (hexadecimal format)
appears here.
- “Operator/Device name” - In case of an application level alert then the "full"
operator name (entity/user name/access level) is displayed. In case of a jammer
device alert, then the jammer configured name is displayed.

17
 KLC2000v8_Client Manual revision 1.2

- “Description” - a textual description of the recorded event.

Except of the “Time” field, all the other fields in the CSV file have an identical content as the
one that appears in this window. In case of the “Time” field, the CSV file stores a UNIX
format date and time information about the event (UNIX format is an integer number of
seconds that passed since the midnight of 1970 January 1st). The CSV file is stored in UTF-8
format.

The log window size, position and state can be modified, as well the width of each header
control section (the width of each column). These graphical changes can only be stored by
the “Save configuration” option, and they trigger no message suggesting to save them upon
exit.

18
 KLC2000v8_Client Manual revision 1.2

“Logs history” window

The logs history window allows the user to watch the content of any previously
KLC2000v8_Server made log files (including the current one, all the events since it was
created until the file was selected for display in the logs history window). This window is
divided into 3 parts:

1. Select and load folder - Here the user can type a folder name or select it graphically
by clicking the button. The default folder is the one the KLC2000v8_Server.exe
is located. After selecting the folder which contains the log files, the user can force
the window to show the log files by clicking on the “Load folder logs” button.
2. List of log files dates that has been found in the folder - double clicking on one of the
dates in this list, loads the stored events to the list.
3. List of stored events (for detailed description please see the “Log window”)

The window position, size and state, as well as the position of the splitter (that separates the
log dates list and the events list), and the width of each header control section (the width of
the events columns) can all be modified by the user. These graphical changes as well as the
last folder, from which the log files are read, can only be stored by the “Save configuration”
option, and they trigger no message suggesting to save them upon exit.

19
 KLC2000v8_Client Manual revision 1.2

“Devices report” window

The devices report window allows the user generate a report on all the mapped devices in
the system.

The user can select which channels (1-16) will be reported.

The "Channels detect" button checks all the changes the "channels" check list box so only
channels that are connected (at least in a single KJ2000 device) in the system are checked.

"Create CSV report" checkbox should be checked if a CSV format file should be generated
(this file has a ".txt" extension).

"Key column" radio group allows the user to decide whether the devices will be sorted by
their unique IDs or by the device icons titles names.

"Generate report" button triggers the generations of a RTF (Rich Text Format) file, as well as
the content identical CSV file (if the user chose this option). The results are stored in a folder
which is called "report", which is located in the folder where the application is. The created
file names (without the extension) have the format of "KLC2000v8_Client_report_YYYY-MM-
DD_HH-MM-SS" (YYYY-MM-DD is the date, and HH-MM-SS is the time in 24 hours format).

For each connected device and channel, the report includes both the measured back power
[dBm] and the measured temperature [°C], if they are reported by the channel.

The cells are filled with colors to graphically reflect various scenarios:

Not connected
"No back power report" or "No temperature report"
Disabled
Disabled but expected to be enabled
Bootloader
High temperature
High back power
Too low back power

20
 KLC2000v8_Client Manual revision 1.2

In case no proper device is connected then "No communication" is reported.

These colors are identical to the colors used to show the status of the icons in the site
windows, whenever it is applicable.

The generated RTF file is identical to the content of the window.

The generated TXT (CSV format) file is different:

Its top 2 lines are comments which display the date and time when the report was
generated and the reported channels numbers.

The following lines include the following fields:

Unique ID Icon title

Status of 1st Back power of 1st … Status of the last Back power of the
channel channel channel last channel
Status of 1st Temperature of 1st … Status of last Temperature of last
channel channel channel channel

In case of no communication the following line is generated:

Unique ID Icon title No communication

The channels possible statuses are the same as appears in the colors table.

21