MC-Config - Modas · 3 Functionality and operation of the MC-Config program After being started the...

12
MC-Config Program Version: 2.0.1.18 Manual MC-Config Version 2.0.1.18 1 / 12

Transcript of MC-Config - Modas · 3 Functionality and operation of the MC-Config program After being started the...

MC-Config

Program Version: 2.0.1.18

Manual

MC-Config Version 2.0.1.18 1 / 12

Content1 Functional description............................................................................................................................................32 Initial start-up.........................................................................................................................................................33 Functionality and operation of the MC-Config program.......................................................................................4

3.1 Functions of the control keys..........................................................................................................................43.1.1 Information on list items..........................................................................................................................53.1.2 Settings for the recording of messages.....................................................................................................5

3.2 Settings and functions using the Main Menu..................................................................................................63.2.1 File Menu.................................................................................................................................................63.2.2 View Menu...............................................................................................................................................63.2.3 Configure Menu:......................................................................................................................................63.2.4 Device Menue..........................................................................................................................................7

4 Config function......................................................................................................................................................75 Firmware Updates..................................................................................................................................................96 Configuration and monitoring of WLAN-clients in local or remote networks......................................................9

6.1 Recording Debug Messages..........................................................................................................................107 Command line parameters....................................................................................................................................12

FiguresFigure 1: Setup for the initial operation of a WLAN-client......................................................................................3Figure 2: Functionality and operation of the MC-Config program...........................................................................4Figure 3: Config Dialog............................................................................................................................................8Figure 4: Setting the IP-ranges..................................................................................................................................9Figure 5: Recording of debug messages.................................................................................................................10Figure 6: Logging settings.......................................................................................................................................11

MC-Config Version 2.0.1.18 2 / 12

1 Functional description

The MC-Config Program can perform the following functions in a system with one or several MCx - WLAN-clients:

Locating the WLAN-clients in the network (via LAN or WLAN) Configuring the WLAN-client parameter including saving and loading of configurations via files Transfer of firmware files to WLAN-clients Restart WLAN-clients (reboot) Reset of WLAN-client parameters to default settings (Factory Default) Display of current connection parameters of the WLAN-clients in the network

2 Initial start-up

For the initial start-up WLAN-clients can communicate only using the LAN connection, because usuallythere is no wireless network with a matching SSID.

The WLAN-client is connected to a computer that has an Ethernet port. The MC-Config program is started on the computer.

To be checked:- The connected computer (notebook) should have a fixed IP-address (no DHCP) on the LAN

interface.- The LAN interface on the computer must be identified by the operating system as

"connected". Check the LAN interface by entering the command “ipconfig“ in the command line window.

- An active firewall on the computer could prevent the communication with the WLAN-client.

MC-Config Version 2.0.1.18 3 / 12

Figure 1: Setup for the initial operation of a WLAN-client

3 Functionality and operation of the MC-Config programAfter being started the MC-Config program first detects all network interfaces that are currently active on the computer. Via these interfaces queries are then sent out per Broadcast UDP/IP that will be answered by WLAN-clients. The responding devices are registered and displayed in a list.

Below the list there is a field for messages from the MC-Config program. Here are also displayed debug messages from WLAN-clients, provided that this function has been activated at the WLAN-client before. By double-clicking this field all messages saved so far are opened in a text editor.

3.1 Functions of the control keys

Number Name Function

1 Refresh Restarts a scan for existing WLAN-clients. The scan ranges are set under Configure -> IP-Ranges. 6

2 Config Opens the configuration dialog for the selected WLAN-client. At first the configuration file of the WLAN-client is downloaded. As soon as the configuration is completely received a window opens and displays the configurable parameters of the WLAN-client. All these parameter shown here are defined on the basis of the configuration file received from the WLAN-client. If there are additional parameters defined by a certain WLAN-client firmware, the MC-Config program can process these parameters without changes.

3 Upgrade Can be used to transfer a firmware file to the WLAN-client.

4 Web Opens the website of the selected WLAN-client in a browser window.

5 Reboot Restarts the selected WLAN-client.

6 Default Resets the configuration of the selected WLAN-client to the factory default setting. Subsequently, a restart of the device is carried out.

7 Close Closes the application.

8 User / Password

This information must be entered, if the configuration of a WLAN-client is protected by thedefinition of User+Password.

MC-Config Version 2.0.1.18 4 / 12

Figure 2: Functionality and operation of the MC-Config program

3.1.1 Information on list itemsColumn Name Function

a No. These number is assigned consecutively in the order of registration of the WLAN-clients by the MC-Config program.

b Name Shows the device name as given in the configuration of the WLAN-client.

c SN Serial number of the WLAN-client

d Vers. Firmware version of the WLAN-client

e IP-Address IP adress of the WLAN-client on the interface (LAN or WLAN) the client is connected to by the MC-Config program. Depending on the set bridge mode there might be a different IP address for the LAN and WLAN port. Text colour and background colour of this field provide information about the typeof connection between the MC-Config program and the WLAN-client.

black characters --> Unicast connection (direct IP connection, connection to website is possible) red characters --> Broadcast connection (connection to website is not possible)green background --> connection via LAN interface of the WLAN-cllientpink background --> connection via WLAN connection of the WLAN-client

f System-MAC MAC address of the WLAN-client. The LAN interface sends out data using another Mac address than the WLAN interface.

g SSID Gives the WLAN name (Service Set Identifier ), that the WLAN-client wants to connect to.

h AP-MAC / Name When the WLAN-client is connected to a WLAN, the Mac address of the connected access point is displayed here. Some access points send out a devicename that the WLAN-client shows here instead of the MAC address.

i Signal (SNR) Strength of the signal received by the access point (AP). The signal-to-noise ratiois given in dBmSignal >= 40 very good connectionSignal >= 30 good connectionSignal >= 20 sufficient connection, WLAN-client starts to search for a better AP Signal < 20 limited connection, the bit rate will be reduced during data transfer

j Bitrate Bitrate for receiving data from AP. The data rate is given in MBit/s and is in the range of 1 to 300 MBit/s

k Key When the WLAN-client is connected to an AP, here the encryption type used to establish the connection is given.

l Ch. Channel number for the connection of the WLAN-client with the AP. The channelnumber is defined by the AP.

m Status Information on the transfer state of data between the MC-Config program and the WLAN-Client.

n Uptime Run time of the WLAN-client since power up or last reset.

3.1.2 Settings for the recording of messages

Field Name Function

o This field displays the system messages of the MC-Config program. With the debug-logging-function being switched on at a WLAN-client the display changes and shows the messages of the selected WLAN-client.

p Log file The messages of the MC-Config program are written to the file given here.

q Selection of how detailed the messages should be, that the MC-Config program will output, can be made here.

r This key opens a dialog used to define the log file. (see 'p')

MC-Config Version 2.0.1.18 5 / 12

3.2 Settings and functions using the Main Menu Using the main menu you can initiate already mentioned actions as well as carry out advanced settings for the MC-Config program.

3.2.1 File Menu

Can be used to call functions of keys above the list.

3.2.2 View Menu

Menu item Function

Select Visible Column This function is used to define the list view by activating and deactivating the individual columns.

Copy list This function is used to copy the text part of the list view including the information of the WLAN-clients to the clipboard. With a text editor this information can be further processed.

Autosize columns This function sets the width of all visible columns automatically to a certain measure so that all information is visible. This action can also be set off when you click on the list view and press the keys Cntl+V.

3.2.3 Configure Menu:

Menu item Funktion

IP Ranges Particularly in a situation, when the MC-Config program is expected to connect with the WLAN-clients per WLAN and the WLAN-system does not forward the UDP broadcast packages, that the MC-Config program sends out in the search for the WLAN-client, it is necessary to scan selectively certain IP address ranges. In this menu item the parameters for the scan are defined. see --> 9

Interfaces If the computer used to run the MC-Config program has several IP network interfaces, via this menu item one can - if necessary - select, which interfaces shall (can) be used for the connection to the WLAN-clients. The user should apply these settings in order to avoid the distribution of an unnecessary big number of broadcastqueries via the different interfaces.

Basic settings In this menu item you find settings that influence the functionality of the MC-Config program. For now there is only one setting option that activates “Hotkeys” for the list view.

MC-Config Version 2.0.1.18 6 / 12

Once this option is activated the list view reacts to the following inputs:Key Function

's' Set selected item to “static“

'S' Reset “static“ state

ESC Cancel data transfer in process

'c' Call Config-function

'u' Call Upgrade-function

3.2.4 Device Menue

Basis Settings

Select all Select all list items.

Delete Delete selected list items from the table. This can also be done by pressing the keys 'Cntl + del'

Abort transfer Abort all running data transfer.

Debug logging Activate or deactivate the logging of debug messages for all selected WLAN-clients

Signal logging Activate or deactivate the logging of WLAN connection data for all selected WLAN-clients.

Download system log Download and save the debug messages of the selected WLAN-clients.

4 Config function By pressing the Config key all data, that define the setting of a WLAN-Client will be transferred to the MC-Config program. The setting consists of all parameters that are defined by there:

• name• type• help text• actual value• default value

MC-Config Version 2.0.1.18 7 / 12

That means, all the parameters to be set are dynamic for the config program, and they are exclusively defined by the firmware of the WLAN-client. It is thus not necessary to generate a new config program,when for example a parameter is added to the function of the WLAN-client.

When a complete setting from the WLAN-client is received, the following window opens:

The window shows the following sectors:1. Main menu ( 1 + 2 )2. Config structure with search function (3 + 4)3. Parameter definition ( 5 )4. Field for notes and help regarding the individual parameters ( 6 )5. Keys to save, load and allocate the configuration data ( 7-11 )

In order to show or edit certain parameters the user shall at first select from the config structure the segment where the parameter is defined. By using the search function (3) a parameter can be located in the config structure. Config structure items with a match are shown in blue.Possible settings for the selected segment are displayed in the parameter field (5). The user can applychanges. Changed parameters are shown in bold. Additionally the changed config structure item gets red. Thus the user can keep an overview about where alterations are done. Using the key combination„Cntl - R“ you can undo changes. Pressing the key combination „Cntl - D“ all values are being reset to the delivery state (Factory Default).

After all alterations are done, the configuration is sent back to the WLAN-client by pressing the “Apply”key (8). The client will accept the parameters and carry out a reboot depending on the changed parameters. The config dialog is then closed.

The keys of the config dialog have the following functions:

Nr. key Function

7 Break Closes the Config dialog without transferring the changes to the WLAN-client

8 Apply Starts the transfer of the parameter set to the WLAN-client. The Config dialog is closed.

9 Save to File Saves the current parameter set in a file.

10 Load from File Loads a parameter set from a file.

11 Check Transfer of the parameter set to the WLAN-client for verification. The result of the verification is shown in the status bar at the bottom (12).

MC-Config Version 2.0.1.18 8 / 12

Figure 3: Config Dialog

5 Firmware UpdatesPressing the Upgrade key the user is led to a dialog, where a firmware file can be selected. Firmware files for WLAN-clients are of the type „bin“. The selected file is subsequently transferred to the WLAN-client and there stored in the flash memory. The existing configuration of the WLAN-client is being accepted by the new firmware.

6 Configuration and monitoring of WLAN-clients in local or remote networks The following conditions might be the reason that the MC-Config program cannot establish a connection to WLAN-clients:

The WLAN-clients are in another network. The WLAN-clients are connected via a WLAN infrastructure that does not forward the broadcast

queries of the MC-Config program.

In order to reach these WLAN-clients you can define IP ranges hat are scanned with the start of the MC-Config program or after pressing the “Refresh” key.

Here you can open the dialog for the definition of the ranges:

By selecting 1 - 4 different ways to set a scan range can be defined: 1) Freely definable IP range with start and end IP2) Definition of an IP range with network address and subnet mask

MC-Config Version 2.0.1.18 9 / 12

Figure 4: Setting the IP-ranges

3) Definition of an IP range with network address and bit mask4) Single IP address information

Clicking „Add“ (6) the selected and edited information will be added to the range (5). With „Save to File“ (7) the information can be saved to a file and with “Load from File” (8) loaded from a file. With the “delete”-Key a selected IP range item in (5) can be removed.After leaving the dialog the defined and activated ranges are scanned.

6.1 Recording Debug MessagesThe MC-Config program provides the possibility to receive debug messages from WLAN-clients and to save these messages in a file. You can send this file to the manufacturer of the WLAN-client, who will evaluate it andpresent an error diagnosis.

To start the recording right-click the relevant entry in the device list and select „Debug logging“ --> „Start“ (1). After subsequently the log file has been defined, all messages are written to this file. If there is an active debug recording for the active device in the table, the messages are also displayed in the field (2).

Depending on the particular problem that is to be inspected, you can set the „intensity“ of the debug messages for individual parts of the program of the MC1 firmware using the configuration (--> Logging).Additionally you can generate protocol records of the data traffic on the WLAN- as well as LAN- interface.

MC-Config Version 2.0.1.18 10 / 12

Figure 5: Recording of debug messages

1) Call of the logging parameters2) Setting of the location where messages are saved

a) RAMb) Internal FLASHc) USB (not implemented yet)In order to have the messages available at the WLAN-client after a restart, it is recommended to select “Internal FLASH“

3) Here it is specified, which information every line of a debug message contains.

MC-Config Version 2.0.1.18 11 / 12

Figure 6: Logging settings

4) Using „Dump Wireless“ the wireless card is set into a special mode that allows to save all data packages sent and received via WLAN in the file. Later this file can be inspected using the analysis program “Wireshark“.

5) The same function as under (4) is available for the LAN interface using the option “Dump LAN“.

6) Here you can carry out settings for the individual software modules regarding the intensity of generating debug messages. If you for example identify a problem in the serial interface, you can change the setting "DebugSerial“ from „Default“ to„Detailed“ in order to get more detailed information about the course of communication.

7 Command line parameters

When starting the program certain parameters can be defined.

Parameter Function Examplelport With lport the local UDP port can be defined. The MC-Config

program sends requests alwaays to the UDP port 17784. The source port number is usually undefined and is selected by the operating system. If you want to determine this port number, because in the WLAN system for instance only certain port numbers shall be allowed to use, you can set the local UDP port this way.

lport=17788

user

password

In a system where the access to the configuration of the WLAN-clients is protected by the definition of “user” and “password”, you can preassign the input fields for that parameter during the startup.

user=admin

password=12345

For the definition of these parameters you generate a shortcut to the MCConfig.exe file. You can set these parameters in the properties of this shortcut under "destination".For example: c\...\MCConfig.exe.user=admin password=12345 lport=17788

MC-Config Version 2.0.1.18 12 / 12