WICE Wiki v2.95 - User contributions [en]

WICE RP How-To

2019-11-08T10:03:22Z

Max.h.petersson: /* Rapid Prototyping using Node.js */ added log file handling.

= Getting Started with WICE Rapid Prototyping =
To get started developing an RP component to be run on a WICE WCU you need the following:
* A toolchain for building executable programs on the target WCU platform
* A set of libraries providing APIs to the WCU hardware platform resources (e.g. CAN, diagnostics, logging, etc)
* WICE Portal access to configure the RP module for one or more WCUs

== Software Development Toolchain ==
The development toolchain is typically installed on a desktop Linux system and then executables are built by cross-compilation.
The following WCU platform architectures are supported:
* Host Mobility MX-4: ARM Cortex A9 or Cortex A5 processor, 32 bit
* Fältcom Committo: ARM 926EJ-S processor, 32 bit
* Actia Platform: MIPS processor, 32 bit

All toolchains are gcc-based.
The MX-4 toolchain is availble here: http://releases.linaro.org/13.09/components/toolchain/gcc-linaro/4.7

== WICE RP development API libraries ==
The following libraries are available:
* Canwrapper CAN library
* Debug logging library
* Timers and utilities library
* Tactalib Diagnostics library
* OBD II library

The development libraries are available here: http://www.alkit.se/rp/libs/

= Building and executing the RP program =

The binary file resulting from compiling the program for the target WCU platform is transferred to one or more in-vehicle WCUs using the WICE Portal. The binary will be executed
when the WCU boots, and will be terminated when the WCU shuts down.

When executed, an number of command line arguments are given to the RP binary, as follows:
<code>
-vin <VIN number> -settings <filename> -logfile <filename>
</code>

The <code>-vin</code> parameter supplies the Vehicle Identification Number of the vehicle the WCU is installed in.

The <code>-settings</code> parameter supplies the path to a configuration file the user can supply through the WICE portal.

The <code>-logfile</code> parameter supplies the path to a debug log file which will be uploaded to WICE portal when the RP module exits.

To get access to the information supplied on the command line at star-upt, the RP program must parse the command line.

= A simple example RP program =
The example code <code>rpex.c</code> illustrates how to write a small program that can be executed as an RP module on the WICE in-vehicle WCU platform.

The example shows how to read a configuration file supplied on the command line, to write a CAN diagnostic request on a CAN bus and read a diagnostic reply, and to log data to a log file that will be uploaded to the WICE Portal.

The full source code of rpex is available [http://www.alkit.se/rp/example here].

The first thing the example program does is to parse the command line parameters:
<code>ret = parse_options(argc, argv);
if (ret != 1) {
return EXIT_FAILURE;
}</code>
The <code>parse_options</code> function sets the variables <code>settings_filename</code>, <code>log_filename</code> and <code>vin</code> to the strings supplied on the command line.

Next, debug output is enabled, and the output filename is set to <code>log_filename</code>, as specified on the command line. This ensures that the log file will be uploaded to the WICE Portal when rpex exits.
The <code>debug_enable</code> and <code>debug_msg</code> functions are defined in the <code>alkit-debug</code> development library.

<code>if (log_filename != NULL ) {
debug_enable(log_filename);
}
debug_msg(1, "rpex version is %s\n", RPEX_VERSION_STRING);</code>

Then, after some more log output, the settings file is read:

<code> if(settings_filename)
read_settings(settings_filename);</code>
The settings file is the main way (except for the command line parameters) to provide input to the RP program. It can contain any type of input data needed by the program. In the example, rpex only reads text from the settings file and prints it to the output logfile.

The program is now ready to do its main work,in this case to send a diagnostic request on a CAN bus, and read a response. This is done using the <code>alkit-canwrapper</code> library.
The following code block shows how to set up the CAN interface, prepare a CAN frame for transmission, set up a CAN filter matching the expected response, and then send the CAN frame.

<code> // Initialize CAN interface
ret = init_can(canbus, DEFAULT_CAN_DEVICE);
can_device_fd = get_can_fd(canbus);
 
// Set up CAN filter
install_CAN_filter(canbus, 0, CAN_FILTER_TYPE_PASS, can_filter_id, can_filter_mask);
 
// Prepare CAN frame for request
memset(&req_frame, 0, sizeof(candata_t));
req_frame.id = ecu_id;
req_frame.bus_nr = canbus;
req_frame.frame_type = CAN_FRAME_11_BIT;
memset(req_frame.databytes, 0, 8);
req_frame.databytes[0] = 0x02; // SingleFrame, length = 2
req_frame.databytes[1] = 0x10; // Service 10
req_frame.databytes[2] = 0x01; // Default Diagnostic Session
req_frame.databyte_count = 8; // With padding
 
// Send CAN frame
debug_msg(1, "Sending diagnostic request on CAN bus %d...\n", canbus);
n = write_can(canbus, &req_frame, &t);
if(n<0) {
debug_msg(1, "Error writing CAN frame\n");
return -1;
}</code>

The following code block shows how to read a response CAN frame.

<code>// Read CAN response
FD_ZERO(&readfds);
FD_SET(can_device_fd, &readfds);
timeout.tv_sec = 0;
timeout.tv_usec = 200000; // 200 ms
 
ready = select(FD_SETSIZE, &readfds, NULL, NULL, &timeout);
if (ready > 0) {
ret = read_can(canbus, &resp_frame);
if (ret == CAN_STATUS_OK) {
// Read successful
handle_can_frame(&resp_frame);
} else {
debug_msg(1, "Error reading CAN frame\n");
}
} else {
debug_msg(1, "No response.\n");
}</code>

The function <code>handle_can_frame</code>which is called when a frame is read simply logs the CAN identifier and payload to the logfile.

= Using the high-level API for reading in-vehicle signals =
To avoid the intricacies of reading CAN or FlexRay signals directly from the device, having to parse and interpret the signals, there is a high-level socket based API for reading in-vehicle and WICE-internal signals. The API is based on a publish/subscribe model, wherein the RP client subscribes to signals by name, and periodically gets signal values for the selected set of signals. The communication between the RP client and the WICE signal broker component is done over a socket.

The example code <code>rpex-pubsub.c</code> illustrates how to use the publish/subscribe API. The full source code is available [http://www.alkit.se/rp/example here].

To set up the communication between the RP module and the signal broker, the example program calls a function called <code>setup_pubsub_connection()</code> after parsing the command line parameters:
<code>pubsub_socket = setup_pubsub_connection(ip_addr, port_num);
if(pubsub_socket<0) {
debug_msg(1, "Pubsub connection failed\n");
exit(-1);
}</code>
The <code>setup_pubsub_connection()</code> function sets up a TCP socket to use for the communication.

To this socket, a subscribe command is sent with a list of names of the signals to subscribe to. The syntax of the subscribe command is as follows:
<code>subscribe <signal name 1> <signal name 2> ...<signal name n><CRLF></code>

Note that the separator character has to be space, and the line terminated with Carriage Return + Line Feed (or optionally only Line Feed).
<code>sprintf(str, "subscribe %s %s\n", RPEX_SIGNAL1, RPEX_SIGNAL2);
n = send(pubsub_socket, str, strlen(str), 0);
if(n <= 0) {
debug_msg(1, "Error subscribing to signals\n");
exit(-1);
}
</code>
Once the signals have been subscribed, the signal broker will send the signal values on the socket, to be read by the RP program, with the following syntax:
<code><signal name> <value><CRLF></code>
Again, the separator character between signal name and value is space.

The following code segment show an example of how to read signals as the bcome available on the socket using the <code>select()</code> system call.
<code>while(count < 100) {
FD_ZERO(&readfds);
FD_SET(pubsub_socket, &readfds);
timeout.tv_sec = 1;
timeout.tv_usec = 0;
ready = select(FD_SETSIZE, &readfds, NULL, NULL, &timeout);
if (ready > 0) {
n = read_line(pubsub_socket, &buf);
if (n > 0) {
// Read successful
handle_signal(buf);
free(buf);
count++;
} else {
debug_msg(1, "Error reading signal\n");
break;
}
}
}</code>

The <code>read_line()</code> helper function handles the actual reading of characters from the socket, and then the <code>handle_signal()</code> function parses the signal names and values, as follows.
<code>void handle_signal(char *str) {
char name[1000];
float value;
sscanf(str, "%s %f", name, &value);
if(strcmp(name, RPEX_SIGNAL1)==0)
debug_msg(1, "The value of signal 1 is %f\n", value);
if(strcmp(name, RPEX_SIGNAL2)==0)
debug_msg(1, "The value of signal 2 is %f\n", value);
}</code>
The RP program can at any time unsubscribe to signals using the <code>unsubscribe</code> command, which has the same syntax as the <code>subscribe</code> command.
<code>unsubscribe <signal name 1> <signal name 2> ...<signal name n><CRLF></code>
After unsubscribing to a (subset) of the subscribed signals, those signals' values will no longer be transmitted on the socket. (This is not shown in the example.)

The final part of the example shows how to terminate the subscription using the <code>quit</code> command.
<code>send(pubsub_socket, "quit", 4, 0);
close(pubsub_socket);</code>

You can find more information about the signal broker API in [[WICE Signal Broker API]] section.

= Rapid Prototyping using Node.js =
To develop Rapid Prototyping applications with graphical user interfaces, the [https://nodejs.org Node.js] framework can be used. Node.js is a cross-platform JavaScript run-time environment that executes JavaScript code on the server side. In the WICE RP concept, a Node.js application can be downloaded to a WCU where it is executed. The user interface developed can be accessed from a web browser connected to the WCU through Ethernet or WiFi. The setup described here is built with Node.js Express. However, other frameworks can be utilized using the same methodology, with small modifications.

All written to consol.log() will be in a log-file called rp-webapp-<date>.log and uploaded and accessible in the WICE back end.

The following example demonstrates how to access vehicle signals from a Node.js application running on a WCU.

In the Node.js application server set-up script, add the following code segment to include the Express framework and <code>socket.io</code> handling socket communication.

<code>// Setup server environment
const express = require('express');
const app = express();
const server = require('http').createServer(app);
const io = require('socket.io')(server);

// Run internal util
require('/path/to/script/socketHandler.js')(io)</code>

The <code>socketHandler.js</code> script contains the code that handles the socket communication, both with the web-client and with the WICE Signal Broker. The function waits for a client to connect, by accessing the web page. It then connects to the Signal Broker and subscribes to the desired signals (in this example Engine Speed and Vehicle Speed on the MS CAN bus). The application then listens for incoming messages on the connected socket and processes the data, i.e. signal names and values. The data is then transferred to the client by <code>socket.io</code> communication in order to present the information in the web-browser. An example <code>socketHandler.js</code> script is outlined here:

<code>const net = require('net');
const PORT = 31415;

module.exports = function(io) {
io.on('connection', function(client) { // Await client connection
console.log('Client connected...');

// Setup TCP socket to Signal Broker.
var tcpSocket = new net.Socket();
tcpSocket.connect(PORT, 'localhost', function () {
console.log('Connected to signal broker... ');

// Get a list of available signals (optional)
tcpSocket.write('list\n');

// Subscribe to desired signals.
tcpSocket.write('subscribe CAN_MS.EngineSpeed CAN_MS.VehicleSpeed\n');
});

// Listener triggered by messages from sigread.
tcpSocket.on('data', function(message) {
console.log(message.toString());
// Handle received messages here...
});

// Triggered if the tcpSocket is closed.
tcpSocket.on('close', function () {
console.log('TCP connection closed!');
});

// Triggered upon error events.
tcpSocket.on('error', function(error) {
console.log('TCP error: %s', error);
});

// Triggered if the client refreshes or closes the page
client.on('disconnect', function (){
console.log("Client disconnected");
tcpSocket.destroy(); // Disconnect from Signal Broker
});
});
}</code>

Each received message is a newline-terminated text line consisting of signal name followed by signal value, separated by a space character (see [[#Using the high-level API for reading in-vehicle signals|Signal Broker]] section above). The message is transferred to the client through socket communication established in the first part of the script above.

Send data to client:
<code>client.emit('speed', speed);</code>

Receive data in HTML-embedded client script:
<code>// Setup client socket.
var socket = io.connect('/'); // url path for the current page
socket.on('connect', function (data) {
console.log("Client connected to server");
});

// Triggered by ‘speed’ tagged messages from server.
socket.on('speed', function (value) {
console.log(value);
});</code>

To transfer a Node web-app to one or more WCUs, it should be put in a zip file and uploaded to the WICE Portal as an RP module.
The zip file must have a top level directory called <code>rp</code>, and in this directory a Node application entry point file called <code>server.js</code>.

A complete example of a Node web-application RP zip-file, including source code, is available for download [http://www.alkit.se/rp/node-example here].

The Portal Administrator View

2017-09-13T07:20:10Z

Max.h.petersson: /* Modules for the WCU */ RFE till RP

An administrator can do everything a user can do and more. In addition to the user, an administrator can create and modify users and stop assignments for any task.
These new functions will be explained in the next 3 chapters.

We will start with the search tab where two more buttons are visible. Next is the vehicles tab.
Lastly is the administration tab with 5 sub tabs consisting of: the connect tab, the archives tab the
GDS/SDDB files tab, the resource groups tab and the users tab.

==The Search Tab==
[[File:Admin stop assigment.png|thumb|200x200px|Illustration 32a: Stop running assignment]]
[[File:Admin force stop assignment.png|thumb|200x200px|Illustration 32b: Force stop assignment]]
In addition to the functionality for an ordinary user, an administrator have one more button present. An administrator can send a force stop command to any WCU.

Illustration 32a shows the "Stop assigment" button. This button is the same as for the ordinary user and is used to stop a running assignment. When a running assignment is stopped, it changes state to "Stop pending". This means that the portal is waiting for a stop message from the WCU before the state is changed to "Stopped" in the portal view. The administrator view exclusive "Force Stop Assignment" button, which can be seen in illustration 32b, forces a "Stop pending" assignment into "Stopped" state without waiting for the stop signal from the WCU.

Also, the administrator can search and view any user's task.

==The Vehicles Tab==
An administrator can do quite a many things in this view. Illustration 33 shows an example of this view. The table header along with the buttons “Edit Description” and “Get Log Files” are explained in the page for '''[[Vehicles]]'''.

At the bottom you have a set of buttons to aid in handling the WCUs. To add a new WCU to the portal, the “New” buttons opens up a dialog for that. The “Get Log Files” button fetches log files for the selected WCU from the portal.

[[File:42vehiclestab.png|none|left|frame|Illustration 33: The administrator's view in the WCUs tab.]]

===The New WCU Dialog===
[[File:Illustration34.png|frame|Illustration 34: The Add New WCU Dialog.]]
There are two ways that a WCU can enter the portal. The first is if you click the “New WCU” button and the second is the first time a WCU connects to the portal it registers itself. Ideally you will never have to add a WCU to the portal but just as a safety step you have the opportunity to add it yourself. When clicking the “New WCU” button the dialog in Illustration 34 opens up. You must enter the ID of the WCU as this is a unique identifier and you will be notified if the ID is already present on the portal. The description is optional but may be handy to remember which WCU it is.

===Edit the WCU Configuration===
[[File:Wcu config1.png|150px|thumb|frame|Illustration: Modules.]]
[[File:Wcu config2.png|150px|thumb|frame|Illustration: Connection.]]
[[File:Wcu config3.png|150px|thumb|frame|Illustration: WCU.]]
[[File:Wcu config4.png|150px|thumb|frame|Illustration: Power management.]]
[[File:Wcu_config_wake_on_can.png|150px|thumb|frame|Illustration: Wake On CAN]]
[[File:Wcu config5.png|150px|thumb|frame|Illustration: Upload.]]
You can edit the configuration of the WCU from the portal. Simply click on '''Edit Configuration''' to open up the window in "Illustration: WCU Configuration: Modules". The WCU configuration window is divided into five tabs where each tab is described below.

====Modules====
The set of check boxes for the different modules that are present is nine and are at the top. Check or uncheck these to tell the WCU if they are present or not. Doing so will speed up the boot process.

To edit "Car type", click on the field where the car type is the displayed to open the "Edit car" dialog. This dialog is described in section [[The_Portal_Administrator_View#The_Edit_Car_Dialog]]

The last three check boxes, "Run IDC at boot", "Run IDC at ignition off" and "Enable VIN reader" is self-explanatory.

====Connection====
This tab can be seen in "Illustration: Connection" and the tab content is described in the table below.
{| class="wikitable"
| style="font-weight: bold;" | Internet Service Provider (ISP)
| Which ISP to use when multiple SIM cards are installed
|-
| style="font-weight: bold;" | WICE portal address
| The server that the WCU should use for fetching new assignments etc.
|-
| style="font-weight: bold;" | DRO Server
| The server to connect to when doing a DRO.
|}

====WCU====
This tab can be seen in "Illustration: WCU" and the tab content is described in the table below.
{| class="wikitable"
| style="font-weight: bold;" | Unit ID:
| The ID cannot be changed from the portal. It can only be changed by logging on to the WCU.
|-
| style="font-weight: bold;" | Platform type:
| The WCU platform type.
|-
| style="font-weight: bold;" | Platform subtype:
| The WCU platform subtype.
|-
| style="font-weight: bold;" | WCU software version:
| This is the currenly used WCU software version.
|-
| style="font-weight: bold;" | Preferred WCU software:
| This is the new preferred WCU software version to be installed.
|-
| style="font-weight: bold;" | Perform reset on update:
| Removes all data on the WCU when installing a new WCU software.
|-
| style="font-weight: bold;" | MX4 firmware version:
| The currently used MX4 firmware version.
|-
| style="font-weight: bold;" | Preferred MX4 firmware:
| The new preferred MX4 firmware.
|}

From version 2.40 of the WCU software, all WCUs report its platform type. The platform type determines, among other things, the number of available CAN buses in the IO tab. (see [[I/O configurations]]) Since a resource group is a collection of WCUs it has no platform type of its own to report. From version 2.41 of the portal the user has the option to set a fictive platform type for a resource group. This is also a prerequisite to also set the [[I/O configurations]] for a resource group. The platform type (and eventual subtype) is set in the WCU tab. If the resource group has members with other platform type(s) than the type that is about to be set, the user will get a warning.

If the platform type of the resource group differs from the platform type of its members the I/O tab will be disabled. This is also the case when the platform type of the resource group and one member is the same but another member has another platform type.

From version 2.42 it is possible to update the WCU root password. To update the password, write the new password in "Set root password" and save the configuration.

====Power Management====
[[File:Periodic wake up time.png|thumb|frame|Illustration: Perodic wake-up]]
This tab can be seen in "Illustration: Power management " and the tab content is described below.

“Power mode” has two settings, Sleep and cut-off. In cut-off the MCD-Hub is not powered up on boot, nor is the WCU woken up at regular intervals to report battery voltage, GPS position etc.

In the other mode, sleep, some more settings are visible as shown in "Illustration: Wake On Can".
You can select the WCU to remain unpowered by selecting "External cut-off". In addition, you may enable the WCus wake-up functionality. This function is simply made up of a cycle time called “Periodic wake-up time” and the corresponding “Periodic run-time”. The “Periodic run-time” determines how long time the WCU should be awake before going back to sleep. The “Periodic wake-up time” indicates the time for each new wake up cycle.

From version 2.43 it is also possible to set power mode to "deep sleep" for WCUs running on platform MX4 T20/T30 and MX4 V61. The configuration is the same as for mode "sleep".

'''Example: '''
A periodic run-time of 600 seconds means that the WCU will be alive for 600 seconds (10 minutes). A periodic wake-up time of 3600 seconds means that the WCU will start a new run-time (600 seconds in this case) every new hour. (3600 seconds = 60 min). The sleep time in each cycle is, for the general case, the wake-up time minus the run-time and in this example 3600 minus 600 = 3000 seconds (50 min).
This example is illustrated in illustration "Perodic wake-up.



====Upload====
This tab can be seen in "Illustration: Upload" and the tab content is described in the table below.
{| class="wikitable"
| style="font-weight: bold;" | Mobile upload limit
| Defines the maximum data size that should be transferred via the mobile network. If the data size is larger than that the WCU will wait until a connection to a local network can be established. The size is in Mbytes.
|-
| style="font-weight: bold;" | Post run grace timeout
| The number of seconds to wait before communicating with the MCD-Hub and portal, if the ignition is turned off.
|-
| style="font-weight: bold;" | Upload timeout
| The maximum number of seconds the WCU should upload data before stopping.
|-
| style="font-weight: bold;" | Erase error code
| If turned on the error codes in the car will be reset.
|-
| style="font-weight: bold;" | Upload data at boot
| Uploads data when the WCU boots up
|-
| style="font-weight: bold;" | Upload data at ignition off
| Uploads data when the car is turned off
|}
<gallery widths="150px" mode="nolines">
File:Wcu config1.png|Illustration: Modules.
File:Wcu config2.png|Illustration: Connection.
File:Wcu config3.png|Illustration: WCU.
File:Wcu config4.png|Illustration: Power Management.
File:Wcu_config_wake_on_can.png|Illustration: Wake On CAN
File:Wcu config5.png|Illustration: Upload.
</gallery>
Version >= 2.41 of the portal has a new tab named I/O. You can read more about in [[I/O_configurations]].

===The Edit Car Dialog===
[[File:Illustration37.png|frame|Illustration 37: Edit Car]]

To edit the information about a car, press the “Edit Car” button. The dialog in Illustration 37 opens up.
The entry you can not edit is the VIN entry. If you need to edit that you must instead create a new car.
In order for the portal to be able to translate error codes into a human readable format, you must choose a diagnostic DB file to be used. It is important to select the correct one as the diagnostic error codes read out might be translated incorrectly or more probable, not at all. It is also important to select the right type of car using “Car type”. This controls the number of CAN buses and speeds and the number of Ethernet networks, if any, in the car. The “Active” check box controls whether the car should show up in tables and searches in general concerning cars. A car can never be removed as it has probably been involved in measurements but to recall an inactivated car you must actively select to view inactivated cars.

It is possible to update several cars at once by selecting multiple cars and then press the “Edit Car” button. By doing this you can selectively make changes to attributes of all the selected cars at once. To do this, the dialog is extended as one can be seen in Illustration 38 below.

[[File:Illustration38.png|frame|Illustration 38: Edit Car|center]]

===Upload a Car Import File===
It is possible to import a file that describes a set of cars. It can consist of both new cars and cars already in the database but that might need to be updated with new information.
A car import file consists of a comma separated file where each line describes a car. The first line of the file must look as follows: 
'''VIN,regNr,description,project,protoNumber,tsu,series'''

There are seven attributes currently. When uploading the file you have a choice of modifying existing cars on the portal. If you do not check this box and there are cars that already exists, the import will fail.

=== Show or export SIM card ID ===
The SIM card ID for a single WCU can be seen when right-clicking on a WCU in the Vehicles tab and selecting "Show info".

SIM card ID's for one or multiple WCUs can also be exported as a csv file. Select the WCUs you are interested in (in the Vehicles tab) and press the button "Export SIM card info" located in the bottom row below the Vehicles grid. The downloaded file will contain five columns: WCU ID, WCU Name, RegNr (Plate nr), VIN and SIM Card ID.

=== Upload WCU file ===
The WCU attributes 'WCU Name' and 'WCU Comment' can from version 2.43 of the portal be updated for multiple WCUs via a comma separated txt/xls/xlsx file. Click the "Upload WCU File" button to open up the import file to upload dialog.

The uploaded file has the following requirements:
* The file must have two mandatory columns with the names 'WCU ID' and 'WCU Name'.
* Furthermore, an optional column named 'Comments' can be added.
* The columns should be in said order.
* The amount of columns on each row must match the amount of columns in the header.
* The columns should be separated by using tab or by a comma.
If there is a 'Comment' column and a blank comment on a row then the old comment, if any, for the specific WCU will be kept.

To remove a comment from a WCU simply check the checkbox for erasing comments. Doing so will result in that empty comments in the uploaded file will erase current comments.

==Resource Groups==
As described above in [[Vehicles#Resource Groups]], you can define a set of resource groups in order to easily handle large groups of resources collectively. An example is if you have 100
WCUs in such a resource group and you would like to edit the configuration for all WCUs. Instead of having to open the configuration for each individual WCU, you simply open the configuration for the resource group, do your edits and when you press save, the configuration
will be saved to all WCUs in one go. The resource groups are created in another panel which
will be described later.

[[File:Illustration39.png|frame|Illustration 39: Adding resources to a group.|left]]
To add resources to a resource group you start by selecting the resources you are interested to add to a resource group. Resources already added to a resource group will render the corresponding add button disabled.

When you are satisfied with your selection you press either the button “Add WCU(s) to resource group” or “Add car(s) to resource group”. Pressing any of those buttons will show the dialog to the left. The group box will list the available groups. If you know the name of the resource group you can type the name and as you type the box will show names that fit what you type.

The three check boxes requires a deeper discussion of what the mean. Assume you have a resource group that has been used for some time. A new WCU enters the portal and you would like to add that WCU to your group. A common situation is that you would like that WCU to be configured that same way as the rest of the WCUs in the resource group. This is accomplished by checking “Update WCU configuration”. If this requires an update of the WCUs software it will automatically be taken care of. Also, a WCU comes configured with a set of modules. Usually you will probably want to update the module configurations as well but in case you wish not to, simply uncheck that check box. There are also situations where there are no module configurations for some modules and if you press “Add” you will be prompted about that. If you for some reason do care about that you can check the “Ignore non existent tools and configurations” check box.

==Modules for the WCU==
A WCU can have a number of modules attached. This makes it possible to add new peripherals to the WCU for handling various tasks in acquiring measured data from a car. The nine types of modules are:
# MCD-Hub
# Canrecorder
# GPS
# IDC (Internal Diagnostic Client)
# Uptime
# State of Health
# Signal Reader
# RP (Rapid Prototyping)
# Blue piraT

To deal with each tool's configuration a new view is presented below. To open this view, press the button “Modules” as shown in Illustration 33 on [[#The Vehicles Tab]].
In the illustration above there are a set of tools present. Each type is grouped on the left side using a stack panel. Select the connected MCD-Hubs by selecting the MCD-Hub stack and select (click) the Canrecorder stack to see the canrecorders connected a so fourth.

[[File:Illustration40.png|frame|Illustration 40: View for handling tool configurations.|center]]
Each tool has its own entry in each of the stacks. In Illustration 40 above there is only one MCD-Hub present and it is “0”. Each tool is recognized with a tool ID which is set by the WCU. This ID is usually not descriptive and therefore you have the possibility to set a name of your likings. Change the name by pressing the button “Edit name”. You can also add a description to the tool that shows up as a “tool tip” when hovering over the name of the selected tool. Analogously, change the description by pressing the button “Edit tool description”. To reload the set of available tools for both MCD-Hub and Canrecorder, press the “Reload tools” button.

===Configure the MCD-Hub Module===
The configuration for the MCD-Hub has only two settings. The first is the MCD-Hubs IP address and the second is the preferred firmware version. The other two configuration settings shown in Illustration 40 is “MCD-Hub firmware version” which shows the current version used by the hub and the second is “Last configuration update date” which states when the MCD-Hubs current configuration was brought into action.
When you are done with your configuration you save it by pressing the “Save” button. If you for any reason need to reload the configuration, press the “Reload” button.

===Configure the Canrecorder Module===
The configuration for the Canrecorder is shown in Illustration 41 below. There are four fields of which two are editable. In order for the canrecorder to work you need to set the high- and low speed CAN bus. The update date says when the last configuration was enabled and the canrecorder version says which version of the canrecorder software is used.
[[File:Illustration41.png|frame|Illustration 41: Configuration options for Canrecorder.|center]]

===Configure the GPS Module===
There are four settings involved:

# Enable GPS. Sets whether the GPS should be enabled or not. If you disable the GPS all the other settings will also be disabled.
# GPS sampling interval. Sets the position sampling interval in seconds.
# GPS monitor enabled. If this setting is enabled the WCU will continuously send its GPS position to the portal enabling real-time monitoring of the whereabouts of the WCU.
# GPS monitor interval. Set how often the position will be updated. The interval is in seconds.

===Configure the IDC Module===
[[File:Illustration42.png|frame|Illustration 42: Settings for the Internal Diagnostic Client (IDC).|center]]
The IDC can be configured with which bus to communicate on given its assignment. You can actually even choose both where it will first try the Ethernet network (ETH), if it exists, and the CAN bus. If the car type in question does not have an Ethernet network, only the CAN option will appear.

===Configure the Up-time Module===
[[File:Illustration43.png|frame|Illustration 43: Settings for the Up-time module.|right]]
The module is used to report how much and how long the WCU is running. First of all you can enable/disable the functionality all together with the “Enabled” check box. Next is how often the up-time should be logged in seconds. The second check box, “Monitor enabled” is used when you would like the module to report its up-time in real-time and the interval for that, also in seconds.

===Configure the State of Health Module===
The state of health model has the same settings as the IDC module above.

===Configure the Signal Reader Module===
As of version 2.33 of the WCU software it is possible to monitor signals in real time.
For this to happen you must enable the feature by checking the box “Enable monitor”. It is currently set at an update rate of once every second.

===Configure the RP Module===
From version 2.35 of the portal there is a possibility to upload up to three files to configure the RP module. The three files are:
# Configuration file
# Certificate file
# Binary file

[[File:Illustration44.png|frame|Illustration 44: Settings for the RP module.|center]]

=== Configure the Blue piraT Module ===
As of version 2.44 of the WICE portal it is possible to create blue piraT assignments. The blue piraT tool only has one configuration, the debug level, which determines the level of logging during the execution of the blue piraT assignments.

==The Administration Tab==
This tab is a collection of the administrative tasks available in the portal. These are “Connect car to WCU”, “Archives”, “GDS/SDDB file”, “Resource Groups” and “Users”.

===Connect Car to WCU tab===
To archive which car a specific WCU was in at the time an assignment was run can be done by connecting a car to a WCU in this tab. This is usually done automatically but in some situations it is necessary to do this manually

The area is divided into two tables, one for searching WCUs, the left one, and one for searching cars, the right one. When you start typing the name of the WCU you are looking for in the upper left corner just above the table, matching WCUs appear in the left table. To find the car you are looking for, you do the same in the right table but here you have the option of using either the VIN or plate number.

To connect a WCU with a car you drag the WCU you would like to connect onto the car in the right table. When you drop it onto a car a small icon will show signifying that the WCU and car are connected.

From version 2.42 it is also possible to select a WCU and a Car and then click on the new "Connect" button located between the two grids.

To disconnect a WCU and car you simply press the icon for wither of the WCU or car.
See Illustration 45 below for an example.

The connection is a sort of instantaneous carbon copy of the situation at the time that a task was created. If you later change the connection, already running/run tasks will not be affected.

[[File:Illustration45.png|frame|Illustration 45: The connect Car to WCU tab.|center]]

===The User Administration Tab===
The basic layout of the areas is just the same here as before. At the top you have a search area, in the middle is a result are and at the bottom are a set of buttons. The tab with a set of example users is in Illustration 46 below.
The eight columns are:
[[File:Illustration46.png|frame|none|left|Illustration 46: The user administration tab.]]

* '''User ID'''. The unique ID that the user must enter when logging in.
* '''Name'''. The name of the user.
* '''Roles'''. Depending on which roles the user has to, he/she have different privileges. The roles are non-overlapping, i.e. being an “Admin” does not necessarily mean that you can do everything a “User” can do.
* '''Enabled'''. Tells whether the account is enabled or not.
* '''Email Address'''. By registering an email address a user can receive notifications via email from a WCU when certain event occurs.
* '''Last login date'''. The date when the user last logged in.
* '''Two factor auth'''. Whether the two-factor authentication is turned on for a particular user.
* '''Logged in'''. You can see if the user is currently logged in.

At the bottom there are eight buttons. They are:
# The “New” button brings up the “New User” dialog which adds a new user to the portal
# The “Edit” button brings up the “Edit User” dialog
# The “Change Password” button brings up a dialog to change a user's password.
# The “Create new secret” button. Pressing this generates a new cryptographic salt to be used when generating one-time passwords. If you do this for a user without enabling the possibility to see the secret on the next login, renders the user unable to login to the portal. No dialog is opened, simply a message saying that a new one has been generated is shown.
# The “Show secret” button. Shows a dialog with the cryptographic salt shown in clear text as well as the QR-code, more on this later.
# Edit roles and permissions
# The “Save headers” button. Saves the headers and their order to be used as default on later logins.
# Video. Start a video conversations with another user of the portal. You must have the software “Confero” installed for this to work.

====The New User Dialog====
[[File:Illustration47.png|frame|Illustration 47: The New User Dialog]]
By pressing the “New User” button the dialog in Illustration 47 below appears. Mandatory fields are User ID and the two password fields. Remember that the User ID must be unique and you will be notified if it is not. Click the “Add” button to add the user or change you mind by clicking “Cancel”.

====The Edit User Dialog====
You can at any time modify a user by pressing the “Modify” button to bring up the dialog in Illustration 48 below. The User ID cannot be changed. A disabled account can not be used for logging onto the portal even if the correct user name and password are given. To modify the user roles, select or deselect a role by using the check boxes. To turn on two-factor authentication for a user, check the appropriate box. When you are satisfied with your modifications, press the “Save” button to make them permanent on the portal or press the “Cancel” button if you change your mind.

[[File:Illustration48.png|thumb|frame|Illustration 48: The modify user dialog.]]

To enable two factor authentication, tick the check box “Enable two factor authentication”. This will force the user to add another special one time password in addition to the account password when logging into the portal. The one time password is generated by a program on either your computer or if you want to you can install it on your smart phone which is probably the best solution. The program that generates one time password is based on a cryptographic salt and the current time. The cryptographic salt is randomly generated by the portal and is individual for each user. A secret can at any time be regenerated for a user which will render the user unable to login if you do not tick the check box “Show the secret to the user on their next login”.

====The Change Password Dialog====
[[File:Illustration49.png|thumb|frame|Illustration 49: The change password dialog.]]
To change a user's password, press the “Change Password” button and the dialog in X Y will appear. It is pretty straight forward as you type in the new password in the “New password” entry and you need to confirm it by typing it again in the entry below it. If you are satisfied, click the “Change” button or the “Cancel” button if you decide not to change the password.

====The Show Secret Window====
[[File:Illustration50.png|thumb|frame|Illustration 50: The QR-code window]]
A QR-code is shown that can be transferred to a smart phone by simply starting the authenticator app, point it at the screen and let the phone read the QR-code. An example of such a QR-code can be seen in Illustration 50. If the application that is to be used as a password generator do not support QR codes, the secret is shown in clear text at the top.

{{: Roles and permissions}}
===The GDS/SDDB File Tab===
In order for the portal to be able to translate error codes into a human readable format, a GDS or SDDB file must be selected for a vehicle. The set of GDS/SDDB files to choose from is administered in this tab, see Illustration 56 below.
[[File:Illustration53.png|left|frame|Illustration 56: The GDS/SDDB file view.]]
 
To upload a new GDS/SDDB file, press upload new file and you will be presented with dialog where you select the file, sets an optional name (if no name is entered, the file name is used) and an optional comment. To upload a new file for an existing entry, press the edit file button and you will be presented with a dialog where you can upload a new file. To edit the comment or the name that should show up when select which GDS/SDDB file to use for a vehicle, simply double click the cell and edit directly in the table.

===The Resource Groups Tab===
This tab is used to administer some parts of the creation and destruction of resource groups and more. The panel for administering the resource groups is depicted in Illustration 57, below.
[[File:Illustration54.png|left|frame|Illustration 57: The resource groups panel.]]
 
At the top is a search field to search for resource groups. Next are two tables, side by side. The left table lists the resource groups found depending on your search criteria. When a resource group is selected, the resources that are part of the resource group are shown in the right table. Next, the functionality of the buttons will be covered.

====Add and Remove Resource Groups====
[[File:Illustration55.png|thumb|Illustration 58: Add resource group dialog.]]
To add a resource group you simply press the “New resource group” button and the following window will show. Type the name for the new resource and press “Create”. If you change your mind, press the “Cancel” button. Resource groups are global and writable and that means that names must be unique. The reason for this is that a resource group name takes on the form as both the resources car and WCU and those must be unique and therefore the resource groups must also be unique. One can, however, imagine situations where this must not be enforced but at the moment this is the case.

To remove a resource group, press the “Remove resource group” button. Be aware that no warning is given if there are resources in the group when removing it.

====Manipulating Resources in a Resource Group====
In the right hand table in Illustration 59 below, you see a set of resources for a resource group.
[[File:Illustration56.png|left|frame|Illustration 59: Manipulating resources in a resource group.]]
 
Here are both WCUs and cars part of the group. In addition to the type there is a column named “Synchronized”. That column only applies to WCUs. The use of this column is as follows. Assume you have a resource group consisting of 50 WCUs. Further, lets make a configuration change to that resource group. Depending on where the WCUs geographically are and how they are used the WCUs will be updated at different times. How do you you know when all WCUs are up to date in the resource group? You could check them individually in the “Vehicles” panel but that is not very elegant and time saving. Instead, just watch the “Synchronized” column for the WCUs. When a WCU is up to date with respect to the group configuration the column will read “true”. The value is updated each 30 seconds.

You can remove individual resources from a group by selecting the resource and then press the “Remove resource” button.

Yet another button remains and it is the button “Base Group on Resource”. When you add a WCU to a resource group in the “Vehicles” panel you have the option of not updating the WCU configuration to match the one of the resource group's, see Illustration 39 in [[#Resource Groups]]. Using this function it is possible to base the whole group on a WCU's configuration rather than the group's configuration.

===The WCU Status Tab===
This view is supposed to be used as for supervising a set of vehicles. The supervision done in real time and the values for the set of vehicles are updated as soon as they arrive on the server from the different vehicles.

The set of status information collected comprises three parts:

'''General information:'''
* Alive, a heart beat signal
* Connectivity, what data rates are currently available to the vehicle.
** 3G
** 2G
** none
* Cell Signal Quality (CSQ). Indicates the signal strength of the mobile modem. The values are between 0 – 31, the higher the value the better. The special value of 99 is designated an unknown or not even detectable signal.
* GPS, simply a binary indicator of fix or no fix for the GPS.

'''Data Storage Usage:''' 
This set of data informs how much collected data resides in the WCU for each type of data collector (module). Total data indicates how much of the total amount of data storage available is used. After that, each type of data collector is lined up.

'''Data Collection Status:''' 
When modules collect data they go through a set of states when triggers starts, stops and other events occur. Currently, only such events for the signal reader module is available. An optional message accompanying the current state is shown in parenthesis.

The screen is divided in two parts, on the left hand side is a table with search functionality for finding the vehicles of interest and on the right hand side is the monitored vehicles. To monitor a vehicles you search for it in the table and then drag and drop the vehicle on the right hand panel.

A view of the panel is depicted in Illustration 60 below.
[[File:Illustration57.png|left|frame|Illustration 60: The WCU Status tab.]]

The Portal Administrator View

2017-09-11T14:32:14Z

Max.h.petersson: /* Configure the RFE Module */ Changed to RP Module

An administrator can do everything a user can do and more. In addition to the user, an administrator can create and modify users and stop assignments for any task.
These new functions will be explained in the next 3 chapters.

We will start with the search tab where two more buttons are visible. Next is the vehicles tab.
Lastly is the administration tab with 5 sub tabs consisting of: the connect tab, the archives tab the
GDS/SDDB files tab, the resource groups tab and the users tab.

==The Search Tab==
[[File:Admin stop assigment.png|thumb|200x200px|Illustration 32a: Stop running assignment]]
[[File:Admin force stop assignment.png|thumb|200x200px|Illustration 32b: Force stop assignment]]
In addition to the functionality for an ordinary user, an administrator have one more button present. An administrator can send a force stop command to any WCU.

Illustration 32a shows the "Stop assigment" button. This button is the same as for the ordinary user and is used to stop a running assignment. When a running assignment is stopped, it changes state to "Stop pending". This means that the portal is waiting for a stop message from the WCU before the state is changed to "Stopped" in the portal view. The administrator view exclusive "Force Stop Assignment" button, which can be seen in illustration 32b, forces a "Stop pending" assignment into "Stopped" state without waiting for the stop signal from the WCU.

Also, the administrator can search and view any user's task.

==The Vehicles Tab==
An administrator can do quite a many things in this view. Illustration 33 shows an example of this view. The table header along with the buttons “Edit Description” and “Get Log Files” are explained in the page for '''[[Vehicles]]'''.

At the bottom you have a set of buttons to aid in handling the WCUs. To add a new WCU to the portal, the “New” buttons opens up a dialog for that. The “Get Log Files” button fetches log files for the selected WCU from the portal.

[[File:42vehiclestab.png|none|left|frame|Illustration 33: The administrator's view in the WCUs tab.]]

===The New WCU Dialog===
[[File:Illustration34.png|frame|Illustration 34: The Add New WCU Dialog.]]
There are two ways that a WCU can enter the portal. The first is if you click the “New WCU” button and the second is the first time a WCU connects to the portal it registers itself. Ideally you will never have to add a WCU to the portal but just as a safety step you have the opportunity to add it yourself. When clicking the “New WCU” button the dialog in Illustration 34 opens up. You must enter the ID of the WCU as this is a unique identifier and you will be notified if the ID is already present on the portal. The description is optional but may be handy to remember which WCU it is.

===Edit the WCU Configuration===
[[File:Wcu config1.png|150px|thumb|frame|Illustration: Modules.]]
[[File:Wcu config2.png|150px|thumb|frame|Illustration: Connection.]]
[[File:Wcu config3.png|150px|thumb|frame|Illustration: WCU.]]
[[File:Wcu config4.png|150px|thumb|frame|Illustration: Power management.]]
[[File:Wcu_config_wake_on_can.png|150px|thumb|frame|Illustration: Wake On CAN]]
[[File:Wcu config5.png|150px|thumb|frame|Illustration: Upload.]]
You can edit the configuration of the WCU from the portal. Simply click on '''Edit Configuration''' to open up the window in "Illustration: WCU Configuration: Modules". The WCU configuration window is divided into five tabs where each tab is described below.

====Modules====
The set of check boxes for the different modules that are present is nine and are at the top. Check or uncheck these to tell the WCU if they are present or not. Doing so will speed up the boot process.

To edit "Car type", click on the field where the car type is the displayed to open the "Edit car" dialog. This dialog is described in section [[The_Portal_Administrator_View#The_Edit_Car_Dialog]]

The last three check boxes, "Run IDC at boot", "Run IDC at ignition off" and "Enable VIN reader" is self-explanatory.

====Connection====
This tab can be seen in "Illustration: Connection" and the tab content is described in the table below.
{| class="wikitable"
| style="font-weight: bold;" | Internet Service Provider (ISP)
| Which ISP to use when multiple SIM cards are installed
|-
| style="font-weight: bold;" | WICE portal address
| The server that the WCU should use for fetching new assignments etc.
|-
| style="font-weight: bold;" | DRO Server
| The server to connect to when doing a DRO.
|}

====WCU====
This tab can be seen in "Illustration: WCU" and the tab content is described in the table below.
{| class="wikitable"
| style="font-weight: bold;" | Unit ID:
| The ID cannot be changed from the portal. It can only be changed by logging on to the WCU.
|-
| style="font-weight: bold;" | Platform type:
| The WCU platform type.
|-
| style="font-weight: bold;" | Platform subtype:
| The WCU platform subtype.
|-
| style="font-weight: bold;" | WCU software version:
| This is the currenly used WCU software version.
|-
| style="font-weight: bold;" | Preferred WCU software:
| This is the new preferred WCU software version to be installed.
|-
| style="font-weight: bold;" | Perform reset on update:
| Removes all data on the WCU when installing a new WCU software.
|-
| style="font-weight: bold;" | MX4 firmware version:
| The currently used MX4 firmware version.
|-
| style="font-weight: bold;" | Preferred MX4 firmware:
| The new preferred MX4 firmware.
|}

From version 2.40 of the WCU software, all WCUs report its platform type. The platform type determines, among other things, the number of available CAN buses in the IO tab. (see [[I/O configurations]]) Since a resource group is a collection of WCUs it has no platform type of its own to report. From version 2.41 of the portal the user has the option to set a fictive platform type for a resource group. This is also a prerequisite to also set the [[I/O configurations]] for a resource group. The platform type (and eventual subtype) is set in the WCU tab. If the resource group has members with other platform type(s) than the type that is about to be set, the user will get a warning.

If the platform type of the resource group differs from the platform type of its members the I/O tab will be disabled. This is also the case when the platform type of the resource group and one member is the same but another member has another platform type.

From version 2.42 it is possible to update the WCU root password. To update the password, write the new password in "Set root password" and save the configuration.

====Power Management====
[[File:Periodic wake up time.png|thumb|frame|Illustration: Perodic wake-up]]
This tab can be seen in "Illustration: Power management " and the tab content is described below.

“Power mode” has two settings, Sleep and cut-off. In cut-off the MCD-Hub is not powered up on boot, nor is the WCU woken up at regular intervals to report battery voltage, GPS position etc.

In the other mode, sleep, some more settings are visible as shown in "Illustration: Wake On Can".
You can select the WCU to remain unpowered by selecting "External cut-off". In addition, you may enable the WCus wake-up functionality. This function is simply made up of a cycle time called “Periodic wake-up time” and the corresponding “Periodic run-time”. The “Periodic run-time” determines how long time the WCU should be awake before going back to sleep. The “Periodic wake-up time” indicates the time for each new wake up cycle.

From version 2.43 it is also possible to set power mode to "deep sleep" for WCUs running on platform MX4 T20/T30 and MX4 V61. The configuration is the same as for mode "sleep".

'''Example: '''
A periodic run-time of 600 seconds means that the WCU will be alive for 600 seconds (10 minutes). A periodic wake-up time of 3600 seconds means that the WCU will start a new run-time (600 seconds in this case) every new hour. (3600 seconds = 60 min). The sleep time in each cycle is, for the general case, the wake-up time minus the run-time and in this example 3600 minus 600 = 3000 seconds (50 min).
This example is illustrated in illustration "Perodic wake-up.



====Upload====
This tab can be seen in "Illustration: Upload" and the tab content is described in the table below.
{| class="wikitable"
| style="font-weight: bold;" | Mobile upload limit
| Defines the maximum data size that should be transferred via the mobile network. If the data size is larger than that the WCU will wait until a connection to a local network can be established. The size is in Mbytes.
|-
| style="font-weight: bold;" | Post run grace timeout
| The number of seconds to wait before communicating with the MCD-Hub and portal, if the ignition is turned off.
|-
| style="font-weight: bold;" | Upload timeout
| The maximum number of seconds the WCU should upload data before stopping.
|-
| style="font-weight: bold;" | Erase error code
| If turned on the error codes in the car will be reset.
|-
| style="font-weight: bold;" | Upload data at boot
| Uploads data when the WCU boots up
|-
| style="font-weight: bold;" | Upload data at ignition off
| Uploads data when the car is turned off
|}
<gallery widths="150px" mode="nolines">
File:Wcu config1.png|Illustration: Modules.
File:Wcu config2.png|Illustration: Connection.
File:Wcu config3.png|Illustration: WCU.
File:Wcu config4.png|Illustration: Power Management.
File:Wcu_config_wake_on_can.png|Illustration: Wake On CAN
File:Wcu config5.png|Illustration: Upload.
</gallery>
Version >= 2.41 of the portal has a new tab named I/O. You can read more about in [[I/O_configurations]].

===The Edit Car Dialog===
[[File:Illustration37.png|frame|Illustration 37: Edit Car]]

To edit the information about a car, press the “Edit Car” button. The dialog in Illustration 37 opens up.
The entry you can not edit is the VIN entry. If you need to edit that you must instead create a new car.
In order for the portal to be able to translate error codes into a human readable format, you must choose a diagnostic DB file to be used. It is important to select the correct one as the diagnostic error codes read out might be translated incorrectly or more probable, not at all. It is also important to select the right type of car using “Car type”. This controls the number of CAN buses and speeds and the number of Ethernet networks, if any, in the car. The “Active” check box controls whether the car should show up in tables and searches in general concerning cars. A car can never be removed as it has probably been involved in measurements but to recall an inactivated car you must actively select to view inactivated cars.

It is possible to update several cars at once by selecting multiple cars and then press the “Edit Car” button. By doing this you can selectively make changes to attributes of all the selected cars at once. To do this, the dialog is extended as one can be seen in Illustration 38 below.

[[File:Illustration38.png|frame|Illustration 38: Edit Car|center]]

===Upload a Car Import File===
It is possible to import a file that describes a set of cars. It can consist of both new cars and cars already in the database but that might need to be updated with new information.
A car import file consists of a comma separated file where each line describes a car. The first line of the file must look as follows: 
'''VIN,regNr,description,project,protoNumber,tsu,series'''

There are seven attributes currently. When uploading the file you have a choice of modifying existing cars on the portal. If you do not check this box and there are cars that already exists, the import will fail.

=== Show or export SIM card ID ===
The SIM card ID for a single WCU can be seen when right-clicking on a WCU in the Vehicles tab and selecting "Show info".

SIM card ID's for one or multiple WCUs can also be exported as a csv file. Select the WCUs you are interested in (in the Vehicles tab) and press the button "Export SIM card info" located in the bottom row below the Vehicles grid. The downloaded file will contain five columns: WCU ID, WCU Name, RegNr (Plate nr), VIN and SIM Card ID.

=== Upload WCU file ===
The WCU attributes 'WCU Name' and 'WCU Comment' can from version 2.43 of the portal be updated for multiple WCUs via a comma separated txt/xls/xlsx file. Click the "Upload WCU File" button to open up the import file to upload dialog.

The uploaded file has the following requirements:
* The file must have two mandatory columns with the names 'WCU ID' and 'WCU Name'.
* Furthermore, an optional column named 'Comments' can be added.
* The columns should be in said order.
* The amount of columns on each row must match the amount of columns in the header.
* The columns should be separated by using tab or by a comma.
If there is a 'Comment' column and a blank comment on a row then the old comment, if any, for the specific WCU will be kept.

To remove a comment from a WCU simply check the checkbox for erasing comments. Doing so will result in that empty comments in the uploaded file will erase current comments.

==Resource Groups==
As described above in [[Vehicles#Resource Groups]], you can define a set of resource groups in order to easily handle large groups of resources collectively. An example is if you have 100
WCUs in such a resource group and you would like to edit the configuration for all WCUs. Instead of having to open the configuration for each individual WCU, you simply open the configuration for the resource group, do your edits and when you press save, the configuration
will be saved to all WCUs in one go. The resource groups are created in another panel which
will be described later.

[[File:Illustration39.png|frame|Illustration 39: Adding resources to a group.|left]]
To add resources to a resource group you start by selecting the resources you are interested to add to a resource group. Resources already added to a resource group will render the corresponding add button disabled.

When you are satisfied with your selection you press either the button “Add WCU(s) to resource group” or “Add car(s) to resource group”. Pressing any of those buttons will show the dialog to the left. The group box will list the available groups. If you know the name of the resource group you can type the name and as you type the box will show names that fit what you type.

The three check boxes requires a deeper discussion of what the mean. Assume you have a resource group that has been used for some time. A new WCU enters the portal and you would like to add that WCU to your group. A common situation is that you would like that WCU to be configured that same way as the rest of the WCUs in the resource group. This is accomplished by checking “Update WCU configuration”. If this requires an update of the WCUs software it will automatically be taken care of. Also, a WCU comes configured with a set of modules. Usually you will probably want to update the module configurations as well but in case you wish not to, simply uncheck that check box. There are also situations where there are no module configurations for some modules and if you press “Add” you will be prompted about that. If you for some reason do care about that you can check the “Ignore non existent tools and configurations” check box.

==Modules for the WCU==
A WCU can have a number of modules attached. This makes it possible to add new peripherals to the WCU for handling various tasks in acquiring measured data from a car. The nine types of modules are:
# MCD-Hub
# Canrecorder
# GPS
# IDC (Internal Diagnostic Client)
# Uptime
# State of Health
# Signal Reader
# RFE (Road Friction Estimation)
# Blue piraT

To deal with each tool's configuration a new view is presented below. To open this view, press the button “Modules” as shown in Illustration 33 on [[#The Vehicles Tab]].
In the illustration above there are a set of tools present. Each type is grouped on the left side using a stack panel. Select the connected MCD-Hubs by selecting the MCD-Hub stack and select (click) the Canrecorder stack to see the canrecorders connected a so fourth.

[[File:Illustration40.png|frame|Illustration 40: View for handling tool configurations.|center]]
Each tool has its own entry in each of the stacks. In Illustration 40 above there is only one MCD-Hub present and it is “0”. Each tool is recognized with a tool ID which is set by the WCU. This ID is usually not descriptive and therefore you have the possibility to set a name of your likings. Change the name by pressing the button “Edit name”. You can also add a description to the tool that shows up as a “tool tip” when hovering over the name of the selected tool. Analogously, change the description by pressing the button “Edit tool description”. To reload the set of available tools for both MCD-Hub and Canrecorder, press the “Reload tools” button.

===Configure the MCD-Hub Module===
The configuration for the MCD-Hub has only two settings. The first is the MCD-Hubs IP address and the second is the preferred firmware version. The other two configuration settings shown in Illustration 40 is “MCD-Hub firmware version” which shows the current version used by the hub and the second is “Last configuration update date” which states when the MCD-Hubs current configuration was brought into action.
When you are done with your configuration you save it by pressing the “Save” button. If you for any reason need to reload the configuration, press the “Reload” button.

===Configure the Canrecorder Module===
The configuration for the Canrecorder is shown in Illustration 41 below. There are four fields of which two are editable. In order for the canrecorder to work you need to set the high- and low speed CAN bus. The update date says when the last configuration was enabled and the canrecorder version says which version of the canrecorder software is used.
[[File:Illustration41.png|frame|Illustration 41: Configuration options for Canrecorder.|center]]

===Configure the GPS Module===
There are four settings involved:

# Enable GPS. Sets whether the GPS should be enabled or not. If you disable the GPS all the other settings will also be disabled.
# GPS sampling interval. Sets the position sampling interval in seconds.
# GPS monitor enabled. If this setting is enabled the WCU will continuously send its GPS position to the portal enabling real-time monitoring of the whereabouts of the WCU.
# GPS monitor interval. Set how often the position will be updated. The interval is in seconds.

===Configure the IDC Module===
[[File:Illustration42.png|frame|Illustration 42: Settings for the Internal Diagnostic Client (IDC).|center]]
The IDC can be configured with which bus to communicate on given its assignment. You can actually even choose both where it will first try the Ethernet network (ETH), if it exists, and the CAN bus. If the car type in question does not have an Ethernet network, only the CAN option will appear.

===Configure the Up-time Module===
[[File:Illustration43.png|frame|Illustration 43: Settings for the Up-time module.|right]]
The module is used to report how much and how long the WCU is running. First of all you can enable/disable the functionality all together with the “Enabled” check box. Next is how often the up-time should be logged in seconds. The second check box, “Monitor enabled” is used when you would like the module to report its up-time in real-time and the interval for that, also in seconds.

===Configure the State of Health Module===
The state of health model has the same settings as the IDC module above.

===Configure the Signal Reader Module===
As of version 2.33 of the WCU software it is possible to monitor signals in real time.
For this to happen you must enable the feature by checking the box “Enable monitor”. It is currently set at an update rate of once every second.

===Configure the RP Module===
From version 2.35 of the portal there is a possibility to upload up to three files to configure the RP module. The three files are:
# Configuration file
# Certificate file
# Binary file

[[File:Illustration44.png|frame|Illustration 44: Settings for the RP module.|center]]

=== Configure the Blue piraT Module ===
As of version 2.44 of the WICE portal it is possible to create blue piraT assignments. The blue piraT tool only has one configuration, the debug level, which determines the level of logging during the execution of the blue piraT assignments.

==The Administration Tab==
This tab is a collection of the administrative tasks available in the portal. These are “Connect car to WCU”, “Archives”, “GDS/SDDB file”, “Resource Groups” and “Users”.

===Connect Car to WCU tab===
To archive which car a specific WCU was in at the time an assignment was run can be done by connecting a car to a WCU in this tab. This is usually done automatically but in some situations it is necessary to do this manually

The area is divided into two tables, one for searching WCUs, the left one, and one for searching cars, the right one. When you start typing the name of the WCU you are looking for in the upper left corner just above the table, matching WCUs appear in the left table. To find the car you are looking for, you do the same in the right table but here you have the option of using either the VIN or plate number.

To connect a WCU with a car you drag the WCU you would like to connect onto the car in the right table. When you drop it onto a car a small icon will show signifying that the WCU and car are connected.

From version 2.42 it is also possible to select a WCU and a Car and then click on the new "Connect" button located between the two grids.

To disconnect a WCU and car you simply press the icon for wither of the WCU or car.
See Illustration 45 below for an example.

The connection is a sort of instantaneous carbon copy of the situation at the time that a task was created. If you later change the connection, already running/run tasks will not be affected.

[[File:Illustration45.png|frame|Illustration 45: The connect Car to WCU tab.|center]]

===The User Administration Tab===
The basic layout of the areas is just the same here as before. At the top you have a search area, in the middle is a result are and at the bottom are a set of buttons. The tab with a set of example users is in Illustration 46 below.
The eight columns are:
[[File:Illustration46.png|frame|none|left|Illustration 46: The user administration tab.]]

* '''User ID'''. The unique ID that the user must enter when logging in.
* '''Name'''. The name of the user.
* '''Roles'''. Depending on which roles the user has to, he/she have different privileges. The roles are non-overlapping, i.e. being an “Admin” does not necessarily mean that you can do everything a “User” can do.
* '''Enabled'''. Tells whether the account is enabled or not.
* '''Email Address'''. By registering an email address a user can receive notifications via email from a WCU when certain event occurs.
* '''Last login date'''. The date when the user last logged in.
* '''Two factor auth'''. Whether the two-factor authentication is turned on for a particular user.
* '''Logged in'''. You can see if the user is currently logged in.

At the bottom there are eight buttons. They are:
# The “New” button brings up the “New User” dialog which adds a new user to the portal
# The “Edit” button brings up the “Edit User” dialog
# The “Change Password” button brings up a dialog to change a user's password.
# The “Create new secret” button. Pressing this generates a new cryptographic salt to be used when generating one-time passwords. If you do this for a user without enabling the possibility to see the secret on the next login, renders the user unable to login to the portal. No dialog is opened, simply a message saying that a new one has been generated is shown.
# The “Show secret” button. Shows a dialog with the cryptographic salt shown in clear text as well as the QR-code, more on this later.
# Edit roles and permissions
# The “Save headers” button. Saves the headers and their order to be used as default on later logins.
# Video. Start a video conversations with another user of the portal. You must have the software “Confero” installed for this to work.

====The New User Dialog====
[[File:Illustration47.png|frame|Illustration 47: The New User Dialog]]
By pressing the “New User” button the dialog in Illustration 47 below appears. Mandatory fields are User ID and the two password fields. Remember that the User ID must be unique and you will be notified if it is not. Click the “Add” button to add the user or change you mind by clicking “Cancel”.

====The Edit User Dialog====
You can at any time modify a user by pressing the “Modify” button to bring up the dialog in Illustration 48 below. The User ID cannot be changed. A disabled account can not be used for logging onto the portal even if the correct user name and password are given. To modify the user roles, select or deselect a role by using the check boxes. To turn on two-factor authentication for a user, check the appropriate box. When you are satisfied with your modifications, press the “Save” button to make them permanent on the portal or press the “Cancel” button if you change your mind.

[[File:Illustration48.png|thumb|frame|Illustration 48: The modify user dialog.]]

To enable two factor authentication, tick the check box “Enable two factor authentication”. This will force the user to add another special one time password in addition to the account password when logging into the portal. The one time password is generated by a program on either your computer or if you want to you can install it on your smart phone which is probably the best solution. The program that generates one time password is based on a cryptographic salt and the current time. The cryptographic salt is randomly generated by the portal and is individual for each user. A secret can at any time be regenerated for a user which will render the user unable to login if you do not tick the check box “Show the secret to the user on their next login”.

====The Change Password Dialog====
[[File:Illustration49.png|thumb|frame|Illustration 49: The change password dialog.]]
To change a user's password, press the “Change Password” button and the dialog in X Y will appear. It is pretty straight forward as you type in the new password in the “New password” entry and you need to confirm it by typing it again in the entry below it. If you are satisfied, click the “Change” button or the “Cancel” button if you decide not to change the password.

====The Show Secret Window====
[[File:Illustration50.png|thumb|frame|Illustration 50: The QR-code window]]
A QR-code is shown that can be transferred to a smart phone by simply starting the authenticator app, point it at the screen and let the phone read the QR-code. An example of such a QR-code can be seen in Illustration 50. If the application that is to be used as a password generator do not support QR codes, the secret is shown in clear text at the top.

{{: Roles and permissions}}
===The GDS/SDDB File Tab===
In order for the portal to be able to translate error codes into a human readable format, a GDS or SDDB file must be selected for a vehicle. The set of GDS/SDDB files to choose from is administered in this tab, see Illustration 56 below.
[[File:Illustration53.png|left|frame|Illustration 56: The GDS/SDDB file view.]]
 
To upload a new GDS/SDDB file, press upload new file and you will be presented with dialog where you select the file, sets an optional name (if no name is entered, the file name is used) and an optional comment. To upload a new file for an existing entry, press the edit file button and you will be presented with a dialog where you can upload a new file. To edit the comment or the name that should show up when select which GDS/SDDB file to use for a vehicle, simply double click the cell and edit directly in the table.

===The Resource Groups Tab===
This tab is used to administer some parts of the creation and destruction of resource groups and more. The panel for administering the resource groups is depicted in Illustration 57, below.
[[File:Illustration54.png|left|frame|Illustration 57: The resource groups panel.]]
 
At the top is a search field to search for resource groups. Next are two tables, side by side. The left table lists the resource groups found depending on your search criteria. When a resource group is selected, the resources that are part of the resource group are shown in the right table. Next, the functionality of the buttons will be covered.

====Add and Remove Resource Groups====
[[File:Illustration55.png|thumb|Illustration 58: Add resource group dialog.]]
To add a resource group you simply press the “New resource group” button and the following window will show. Type the name for the new resource and press “Create”. If you change your mind, press the “Cancel” button. Resource groups are global and writable and that means that names must be unique. The reason for this is that a resource group name takes on the form as both the resources car and WCU and those must be unique and therefore the resource groups must also be unique. One can, however, imagine situations where this must not be enforced but at the moment this is the case.

To remove a resource group, press the “Remove resource group” button. Be aware that no warning is given if there are resources in the group when removing it.

====Manipulating Resources in a Resource Group====
In the right hand table in Illustration 59 below, you see a set of resources for a resource group.
[[File:Illustration56.png|left|frame|Illustration 59: Manipulating resources in a resource group.]]
 
Here are both WCUs and cars part of the group. In addition to the type there is a column named “Synchronized”. That column only applies to WCUs. The use of this column is as follows. Assume you have a resource group consisting of 50 WCUs. Further, lets make a configuration change to that resource group. Depending on where the WCUs geographically are and how they are used the WCUs will be updated at different times. How do you you know when all WCUs are up to date in the resource group? You could check them individually in the “Vehicles” panel but that is not very elegant and time saving. Instead, just watch the “Synchronized” column for the WCUs. When a WCU is up to date with respect to the group configuration the column will read “true”. The value is updated each 30 seconds.

You can remove individual resources from a group by selecting the resource and then press the “Remove resource” button.

Yet another button remains and it is the button “Base Group on Resource”. When you add a WCU to a resource group in the “Vehicles” panel you have the option of not updating the WCU configuration to match the one of the resource group's, see Illustration 39 in [[#Resource Groups]]. Using this function it is possible to base the whole group on a WCU's configuration rather than the group's configuration.

===The WCU Status Tab===
This view is supposed to be used as for supervising a set of vehicles. The supervision done in real time and the values for the set of vehicles are updated as soon as they arrive on the server from the different vehicles.

The set of status information collected comprises three parts:

'''General information:'''
* Alive, a heart beat signal
* Connectivity, what data rates are currently available to the vehicle.
** 3G
** 2G
** none
* Cell Signal Quality (CSQ). Indicates the signal strength of the mobile modem. The values are between 0 – 31, the higher the value the better. The special value of 99 is designated an unknown or not even detectable signal.
* GPS, simply a binary indicator of fix or no fix for the GPS.

'''Data Storage Usage:''' 
This set of data informs how much collected data resides in the WCU for each type of data collector (module). Total data indicates how much of the total amount of data storage available is used. After that, each type of data collector is lined up.

'''Data Collection Status:''' 
When modules collect data they go through a set of states when triggers starts, stops and other events occur. Currently, only such events for the signal reader module is available. An optional message accompanying the current state is shown in parenthesis.

The screen is divided in two parts, on the left hand side is a table with search functionality for finding the vehicles of interest and on the right hand side is the monitored vehicles. To monitor a vehicles you search for it in the table and then drag and drop the vehicle on the right hand panel.

A view of the panel is depicted in Illustration 60 below.
[[File:Illustration57.png|left|frame|Illustration 60: The WCU Status tab.]]

Vehicles

2017-06-22T08:39:13Z

Max.h.petersson:

<includeonly>=Vehicles Tab=</includeonly>
This view is used to handle the various vehicles that are assigned to you. A figure of this view
is presented below in Illustration 26. At the top, the red section, is a search area where you
type in the criteria to be used for fetching the vehicles you are interested in. As you enter your
criteria a row count is presented in the upper right area to show how many potential matches
there are. The entries are also fetched as you type but only as many rows as fit your current
view are fetched. As you scroll down more results will be fetched.

[[File:Illustration26.png]]

The number of possible columns to show is quite large, 24. The columns shown below are in
default order. You will have to account for any changes you have made your self. The columns
are:

{| class="wikitable"
| style="font-weight: bold;" | WCU ID
| The ID of the WCU. An example is MM-320:1
|-
| style="font-weight: bold;" | WCU Description
| A textual comment attached to the WCU.
|-
| style="font-weight: bold;" | Last DRO
| Says when the DRO log file was last transferred to the portal.
|-
| style="font-weight: bold;" | Last log
| Shows when the last log file was transferred to the portal.
|-
| style="font-weight: bold;" | Upload size
| Says what the size, in k bytes, of the last data upload was.
|-
| style="font-weight: bold;" | Upload date
| Contains which date the last upload was done
|-
| style="font-weight: bold;" | Upload
| This column says how much data has been transferred from the WCU to the portal the last week.
|-
| style="font-weight: bold;" | UploadCar
| The plate number of the car where the WCU is mounted.
|-
| style="font-weight: bold;" | UploadVIN
| Shows the VIN of the car where WCU is mounted.
|-
| style="font-weight: bold;" | UploadVoltage
| The column shows the latest known battery voltage as reported by the CEM.
|-
| style="font-weight: bold;" | Mileage
| The column shows the mileage of the car.
|-
| style="font-weight: bold;" | Up-time
| Shows how many hours the WCU been running the last week.
|-
| style="font-weight: bold;" | Distance
| Shows how long the car has been driven the last week.
|-
| style="font-weight: bold;" | Project Id
| Shows the project ID.
|-
| style="font-weight: bold;" | Proto number
| Shows the proto number.
|-
| style="font-weight: bold;" | TSU
| Shows the TSU ID.
|-
| style="font-weight: bold;" | WCU Version
| Shows which version the current WCU software has.
|-
| style="font-weight: bold;" | Connected
| Shows how many minutes have passed since the WCU made a connection to the WICE portal.
|-
| style="font-weight: bold;" | GDS/SDDB
| The name of the GDS/SDDB file used when parsing SoH assignment data.
|-
| style="font-weight: bold;" | WCU voltage
| Shows the voltage as measured by the WCU.
|-
| style="font-weight: bold;" | WCU storage usage
| Shows the amount of storage available to store data on the WCU.
|-
| style="font-weight: bold;" | Series
| Shows the series attribute.
|-
|'''WCU name'''
|Shows the name of the WCU
|-
|'''Resource group'''
|The resource group (if any) the WCU is part of.
|-
|'''Platform type'''
|Only from v2.44: Search WCU by platform type.
|}

Now, as there are so many columns present you have the option of selecting which ones you would like to see by right-clicking on the table header. If you would like your selection to be remembered between sessions, click the “Save headers” button after you have selected your columns.

There is a concept called “resource groups” you should be aware of in this panel. A resource group is simply a way to refer to a group of resources (WCU, Car) collectively. An example is when creating assignments you can select a resource group instead of the individual WCU:s to start a new assignment. Also, when showing the positions on a map, you select a resource group and press “Show position”, all WCU:s in that resource group will show. To see which resources are in a resource group you press the triangle to the left of the row and the row
opens up to show the individual members. To show the members in the view you can rightclick the entry and select the option “find members” from the menu.

When selecting a row in the table the selected row changes to a blue shade. You can modify
the description of the WCU by clicking in the “Edit Description” button and enter a new description. You can search among the vehicles log files by clicking the “Get log files” button.

==Show the WCU Position==
To see the last reported position of a vehicle, click the “Show Position” button which opens up a map view of where the vehicle was last known to be. You can view several vehicles simultaneously by ctrl- or shift-clicking the vehicles you are interested in. An example of the view is shown in Illustration 27 below.

[[File:Illustration27.png|none|left|frame|Illustration 27: An example vehicle map view.]]

To the right of the map view is a list of all the vehicles. Each vehicle is labeled with the license plate number and if you click on a vehicle entry on the right, an information pop-up will show for the vehicle. If you click on the marker of a vehicle, a new tab is opened in the browser that shows what Google Maps has to offer on that position.
Also, just moving the mouse pointer over a marker will make the pop-up show.

Each vehicle is labeled with the license plate number and if you click on a vehicle entry on the right, an information pop-up will show for the vehicle.
If you click on the marker of a vehicle, a new tab is opened in the browser that shows what Google Maps has to offer on that position.
Also, just moving the mouse pointer over a marker will make the pop-up show.

==View ECU software==
It is possible to see which ECUs are in the vehicle along with each ECUs software number.
Press the button “ECU SW” after you have selected one vehicle. The following view will be
shown. As you can see in Illustration 29 each ECUs software number is shown along with
when it was read. You can download the list as a tab-separated text file if you press “Download”.

==View Trouble Codes==
If an SoH assignment has been enabled to do trouble code read-outs, you can view the trouble codes by selecting the vehicle you are interested in and push the button “View DTCs”. In Illustration 28 below you can see an example of trouble codes. There are three columns in the table. To the left is the ECU name, next when the trouble code was committed to the portal and lastly, the actual trouble code.
If you click in the column for the actual trouble code, a dialog opens with that particular trouble codes. You can extend the size of the dialog in order to examine the trouble codes in more detail.
You can also search the trouble codes as you can see at the top of Illustration 28.

[[File:Illustration28.png|none|left|frame|Illustration 28: Viewing trouble codes.]]

[[File:Illustration29.png|none|left|frame|Illustration 29: ECU Software Versions.]]

==Get WCU Up-time==
[[File:Wcu_uptime.png|frame|Illustration 30: WCU up-time dialog.]]
This function is used to get a compilation of the up-time of a set of vehicles during a particular time span. Select the WCUs you are interested in and the click the “Get WCU uptime” button. This brings up the dialog to the right.

Choose the dates you are interested by choosing a start and end date. Next you have the option of downloading a CSV file, or excel file. The up-time in that file is listed as hours up-time per day per WCU.
The other option is to compile the up-time in a chart shown on screen. The up-time is averaged over the WCUs selected for each day. WCUs having no up-time at all are excluded from the compilation.

From version 2.42 there is a new feature to display the WCUs uptime based on the data sent from statusd. More info in [[WCU Uptime]].

==Export SoH Data==
[[File:Soh data export.png|frame|Illustration 31: The SoH data export panel.]]
You can export data from SoH assignments to your local computer by using the function
“Export SoH data”. Select the cars you are interested in as you can export for more than
one car in one export.
You select the dates you are interested in getting the data from. Check each item you are interested in. Currently you can select mileage, WCU voltage, ECU software versions, battery voltage and storage usage.
The file can be exported in CSV format (suitable for Excel and other spread sheet applications) och XML format.

==Resource Groups==
WCUs and cars can collectively be referred to as resources. As such they can be grouped
together and be handled collectively in order to ease the administration of a set of similar individuals. A resource group can consist of both cars and WCUs but usually only
one type of resource is in a resource group.

You identify a resource group by a gray arrow like icon to the left in the table row. If you
click the icon the entry opens up and makes room for showing which resources are part
of the resource group.

From version 2.42 the showing of the resource group's resources has been improved. More info can be found in [[Resource group's resources]].

When a new task is created any resource groups assigned to you will show up in addition to individual WCUs. There is, however, no indication as to the particular entry is a
resource group or not. If you select a resource group, the new assignment will be downloaded to all the WCUs that are part of the resource group.
As a regular user you can not create and remove resource groups, only an administrator
of the portal can do this.

From version 2.42 of the portal it is easier to search out members of resource groups using the "Resource group" column. When searching in this column one will get results that either matches the name of a resource group WCU or WCUs that are part of a resource group that matches the search criteria. In other words, if we search for "ABCD" we will get the resource group "ABCD" together with all WCUs that are part of the "ABCD" group.

This column can also be used to list all WCUs that are not part of any resource group. To perform this search, put "^$" in the "Resource group" column.

==Modules==
If you have the right permission you might be able to view a WCU:s modules or even
edit them. A module is a functionality of the WCU. Currently the functionalities are:
* MCD-Hub
* Canrecorder
* GPS
* IDC
* Uptime
* State of Health
* Signal Reader
* ETAS
* SoftHub
* Rapid Prototyping (RP)
* Blue piraT

Search Tab

2017-06-22T08:38:36Z

Max.h.petersson:

<includeonly>= Search Tab=</includeonly>
[[File:New search 1.png|thumb|The new Search tab]]
The 'Search' tab makes it possible to search and download result files and log files without first search for a specific assignment. The tab is split into three portlets where each portlet can be expanded or minimized to make more space for the other windows.

The portlets are Search, Results and Selected downloads where each one has its own section on this page.

== Search ==
The search portlet is where constraints are added to the search query.

=== Filename: ===
Filename can be full filename like "ABC_123.dat" or some regular expression that matches a part of a filename.

=== Measurement date: ===
By default '''to''' is set to today's date and the time when the page last was refreshed and '''from '''is set to ('''to '''- 7 days).

=== WCUs: ===
This widget allows the user to filter WCUs on various search criteria. The default search criteria is 'WCU ID matches expression .*' which means that we will search on every WCU the current logged in user has access to. If the current user is an admin, we will search for all WCUs in the system. If the current user is a restricted user with access to only 10 WCUs, we will search for only those 10 WCUs.

The currently available WCU attributes to filter on is: WCU ID, Software version, Description and WCU Name

==== Operators: ====
Each search criteria has at least two operators; 'matches expression' and 'equals'.

===== Matches expression: =====
'Matches expression' means that the inserted value will be treated as a regular expression.

===== Equals: =====
'Equals means that the chosen attribute has to exactly match the inserted value.

===== Is one of: =====
For the attributes 'WCU ID' and 'WCU Name' there is an additional operator 'is one of'. When choosing this operator, the value text field is replaced by a combined search and drop down list which is populated be either all WCU IDs or WCU Names the currently logged in user has access to. One can use this operator to conveniently filter out a few WCUs where it's a non trivial task to write a regular expression that only matches the wanted wcus.

==== Advanced filter: ====
[[File:New search advanced search 1.png|thumb|Advanced filter]]
The WCUs widget allows the user build advanced nestled filters which is illustrated in in 'Advanced filter'.

In this example we filter "all wcus that matches expression '8' " AND "software version equals '2.43.0' " AND "description matches expression 'T20' or 'T30' ".

=== Cars: ===
This widget is very similar to the WCUs widget. Default search criteria is "Plate number matches expression .*" which basically means that we don't put any constraints on cars.

The currently available Car attributes to filter on is: Description, Plate number, Project, Proto number, Series, TSU and VIN.
[[File:New search filetypes.png|thumb|Enable file types]]

=== File types: ===
The file types widget decides which file types we want to include in the search result. A file type is included in the result if the file type button in the window is toggled.

The file types 'MDF', 'TEXT' and 'VECTOR' has sub types. When toggling a button with sub types, this will enable/disable all sub types for that file type. If one only want to include a subset of the sub types, one can expand the file type and only choose the wanted sub type. If only a subset of the file sub types are selected, the file type button will be in the disabled state. If all file sub types for a file type is enabled, the file type will change to enabled state. An example can be seen in "Enable file types".

=== Aggregate results by: ===
This widget allows the user how the search results will be aggregated. Available choices are 'Day', 'Week'. 'Month' or 'Year', where 'Day' is the default option.[[File:New search 1.png|thumb|Example search]]
== Results ==
If the search query yielded any results these results are presented as a chart in the Results portlet. In illustration "Example search" we show the results of a search query where have searched for all result files during August, 2016.

The X-axis depends on the chosen "Aggregate results by" in the Search portlet and the Y-axis shows the number of result files for each aggregation. The result files types that were found in the query are displayed in the legend below the chart. In the example we can see that we searched for 8 result file types but result contains 5 of them.
[[File:New search add to download.png|thumb|Add to download]]
If one clicks on any result bar in the chart a new window, "Add to download" will popup which can be seen in illustration "Add to download". This window shows the date for the aggregation, which can be a day, a week, a month or a year, the file type (MDF in this case), the total number of files and the total size of all the files in the aggregation. The window also has a grid that shows if the aggregation consists of subsets of file sub types. In this example we only have the sub type "MDF_WITHOUT_MODULE_NAMES". When clicking the button "Add to download", this aggregation will be added to the "Selected downloads" portlet.

It is also possible to click the label of the X-axis to add all the file types for this date to "Selected downloads". In the same way it's doable to click the legend to add all found results of a particular file type to the "Selected downloads".

== Selected downloads ==
[[File:New search selected downloads.png|thumb|Selected downloads]]
Selected downloads shows the all aggregations added from the Results chart. An example can be seen in "Selected downloads". The columns shows basically the same information as the "Add to download" window displays before the aggregations are added for download.

Clicking "Download" starts the compilation and the user is notified when the compilation is ready for download. The compilation can take quite some time if the total file size is > 100 mb.

== Save, apply and reset search criteria ==
[[File:New search save as template.png|thumb|Save current search critieria]]
In the same way as for the 'Tasks' tab and the 'Vehicles' tab, search criteria can be saved as templates. To save the current search criteria as a template, use the middle of the three buttons to the right of the Search and Cancel buttons in the Search portlets. An example can be seen in "Save current search criteria".

The leftmost button applies previously saved criteria and the rightmost buttons resets the search criteria to default.

Tasks Tab

2017-06-22T08:37:53Z

Max.h.petersson:

<includeonly>= Tasks Tab=</includeonly>
<div class="keywords"> Regexp, regex, reg ex, regual expression </div>
[[File:Illustration14.png|thumb|frame|Illustration 14a: The search panel for finding tasks.]]
[[File:User stop assignment.png|thumb|172x172px|Illustration 14b: Stop running assigment]]
You can easily search among all tasks on the portal by selecting this tab. There are two sections in this panel. The top one deals with various search criteria while the bottom one shows
search results. 

Each search criteria affects what is indicated by the label associated with the text field. As an
example you have the label “Task ID:” which searches the field for task IDs to find matching
tasks to display. In version 2.40 and above you can use regular expressions in all search fields. To designate an "all" search you enter a period (".") for that particular field. All searches are treated with the letters as wild-cards. An example is if you intend to search for tasks containing the word “bear” simply enter “bear” in the text field. Now, if there are tasks with the names “bear”, “polar bear”and “unbearable” all of these will match as they
contain the word “bear” somewhere.
If you enter characters in more than one text field, they will be treated with a logical AND between each field when searching.

To search for a range of WCUs, assume the WCUs MM-810:1 – MM-823:1, you enter the query <code>8[1][0-9]|8[2][0-3]</code>. This is a regular expression where the first expression, 8[1][0-9], means that we want our search to start with an '8' followed by a '1' and then any digit in range 0-9.
The second part, 8[2][0-3], means an '8' followed by a '2' and then any digit in range 0-3. The two expressions are combined with a pipe characater ("|") which means logical OR.
In other words we are looking for range 810-819 OR 820-823.

'''Note!''' If your WCU/resource group you are searching for has special characters (like '(' or '/') in its name you may need to escape these characters in order to get the desired result. Escape means putting a '\' before the special character. For example if you want to enter (and search for) the resource group name 'ABC(Alpha_Bravo_Charlie)' you need to write 'ABC$Alpha\_Bravo\_Charlie$'.
Another example is when you want to list a WCU that contains "07-51" in its name. In this case you need to type "07\-51", otherwise the "-" character will make the searcher to search for a range of numbers.

For more info how to use regular expressions, see [https://en.wikipedia.org/wiki/Regular_expression#Standards Regular Expressions]

The search tab shows all assignments the current logged in user has read access to. If the user also has write access to the assignments it is possible to stop a running assignment. To stop a running assignment, select the assigment and click the "Stop assignment" button located in the bottom right corner of the search tab. This button is marked with read in illustration 14b.

==The Search Fields Section==
Above most columns of the table there is a field that can be used to enter search criteria
to find assignments. Most of the fields are straight forward in where they apply. However some of them needs some more explaining.
Fields where you need to supply a date can be done in two ways. By clicking on the
small calendar picture to the right of the field brings up calendar where you can select a
date. When selecting a date this way, the time portion is always set to 12:00:00. Edit this
afterwards to fit your needs. You can also enter a date by in the field and the accepted
form is: yyyy-MM-dd HH:mm:ss.

The “Assignment status” field is made up of check boxes. If you leave all unchecked, it
is implied that you do not care which status the assignment is in and therefore all statuses are included in the search. As soon as you check one or more of these a logical or
is applied to the selection of statuses.
The “Last update from” and to option relates to when the assignment changed its status,
i.e. any of the status from the check boxes.
There is an option to filter by the type of assignment using the check boxes to the right
of “Assignment type:”.
In the “Current hit count” you can see how many hits you will receive if you decide to
get the search results. This is a good indicator to see if you should narrow your search
criteria.
To sort the table you click the column header either by clicking the arrow to the right of
each header to select ordering, each click on the header somewhere else will toggle ascending/descending sorting or you can right click on the header to call up the header
menu where you can select sorting order or which columns you would like to see.

==The Results Section==
[[File:Illustration15.png|thumb|frame|Illustration 15: Coloring of assignments that are in state "Error" or "Running".]]
The results are fetched when you press Enter or when you press the "Search" button to the right in the Search tab.

In order to view a result you simply select the assignment in the table that you are interested in. Depending on the assignment different buttons will be enabled. If there are results available the “Get Result Files” button will be enabled.
Multiple rows in the table can be selected by holding down the shift key in order to select a range of rows or by holding down the ctrl-key to select individual rows.

[[File:Illustration16.png|thumb|frame|Illustration 16: Drop down menu of the table header.]]

If you right-click an entry you will be presented with a pop-up with a range of possibilities. Firstly, all the functionality of the buttons above the search result table is there along with a few more that are related to getting information. There is also some context awareness of this pop-up. An example of that is if you right-click in the WCU column, the option of showing the WCU information will be visible. If you instead right-click “Car” column, showing the cars information is visible. The reason for this is to keep the number of options to a minimum in order not to clobber your view. The “Task ID” column has an extra entry saying “Get result files” that brings up a dialog to download result files for a task. An explanation of this functionality can be found at the end of [[Active Tasks Tab#General Tab Layout]].

There is an option to save which columns you are interested in to see. By clicking on the button “Save headers” the currently shown columns are saved and restored when you log in the next time. Right-clicking in the header will bring up menu where you can among other things select which columns should be visible in the table of results. The order of the columns can also be change by simply dragging a column to a new position. When saving the set of columns, the order of them is also saved on the server.
The drop down menu of the table header is in Illustration 16. The current table can be exported to an excel sheet by selecting “Export to excel”.

==The Result Files and Logs Dialog==
[[File:Illustration17.png|thumb|frame|Illustration 17: The search for result files dialog.]]
An assignment can generate in principle an infinite number of result files. To be able to work with the files, a search window will open when you press the “Get Result Files” button or the “Get Log Files” button. There is only a minor difference in that when you hit the “Get Log Files” button not all search terms are available. See Illustration 17 below.

At the top we have some information regarding the task such as the ID and description. Next is a field to hide the search field to make room for the table with the list of files. There are 4 different kinds of search criteria you use to filter out the result files you are interested in: the date, file name, the size of the file and the type of file. As you type your different criteria in the search fields, the “Available files:” entry reflects the number of files that would be listed if you hit the “Search Files” button.
Depending on the type of assignment you will be presented with a potentially differing set of buttons and controls. In the illustration above an MCD-Hub assignment was selected.
To choose the subtype for a file, use the radio buttons for each of the types MDF, Vector and Text. The subtype selection is only enabled if the corresponding file type is checked.

[[File:Illustration18.png|thumb|frame|Illustration 18: List of files to download.]]

The check box “Compile by upload date” groups together all results from each result upload from the WCU. This is very useful as one upload can contain thousands of files and you are mostly interested in all of them to gather statistics or analyzing the result.
When you are satisfied with your search criteria, hit the Search Files button to view the list of files. An example of such a list is in Illustration 18 below. To select a file, click the row with the file you are interested in and it will be selected. By holding the shift-key down when you click an entry, all entries between the previous click and this one will be selected. To select a set of individual files, hold down the ctrl-key while selecting entries. When you push the Get File(s) button, a save file dialog opens where you can save the zip-file with your selected files zipped together.

On the right you have a set or four buttons. The top one has already been described and is straight forward as it downloads result files to your computer. The next “Save header” saves which columns your are interested in seeing. The third button is used to get a plot of where the car has been during the collection of data for the selected file. If the data series is long, the last 24 hours are used to plot the route. The fourth button, “View file” is also only used for text files (and log files) which opens up a simple text area window where you can view the contents of the file. You can also double click a text file entry to view the contents of a file. The fifth button is only visible for MCD-Hub assignments and it is used to convert files in MDF format to text format.
When you are done, just hit the Back button and the window will disappear.

From version 2.42 it is also possible to include gpx-files together with the downloaded result files by having the "Include gpx files" checkbox checked. Currently this is set by default.

For each included result file, there will be a corresponding gpx file with the same filename as the result file. The gpx file will contain the route when the assignment was executed. Note that not all assignments have an end date, so in this case, the end date is set to 24h from the start date.

===Downloading Files===
Depending on the number of files and sizes of the result files, it can take a considerable time to zip the files together before they are ready for download. Therefore, files are zipped and getting ready in the background on the server and when they are ready for download you will be notified with a toast message at the top next to the download dialog icon. The icon can be found in the tool strip at the top depicted in Illustration 19 below.

[[File:Illustration19.png|frame|left|Illustration 19: Tool strip with the download icon.]]
 
When you press the “Get files(s)” button you will have the option of adding a description to the download which you can later see in the “My downloads” dialog for identification. Here you can also choose to insert VIN and plate number in all downloaded files. You can read more about hit here: [[Filenames when downloading]]. It is optional and you don't have to do that.

The following toast will be shown when the preparation begins.

[[File:Illustration20.png|frame|left|Illustration 20: Toast shown when file preparation begins.]]
 
When the preparation is done and your files are ready for download, the following toast will be shown in conjunction with the download icon in the tool strip.

[[File:Illustration21.png|frame|Illustration 21: Toast shown when file preparation is done.]]
To see what preparations are ready for download, click the download icon in the tool strip, a dialog called “My Downloads” will open. If a download is being prepared, the progress bar in the column “Progress” will fill gradually fill with green until it is ready. If you are downloading a file, the progress bar Download progress will gradually fill with green until it is done. If you entered a description for your preparation, it will show in the column “Description”.
To download a file click the icon with a down pointing arrow. You will be prompted for an optional name of the downloaded file. Whatever you type there will automatically get the file extension “.zip”. To close the dialog, click the cross in the upper right corner of the dialog.

{{:My downloads}}

==The New Results Panel==
In an effort to somewhat abstract the notion that the MCD-Hub generates files, this panel has been introduced. You enter this panel by pressing the button “Use new panel” which you at the top as depicted in Illustration 17 in [[#The Result Files and Logs Dialog]]. In this panel you deal with meta data of a measurement. As an example, consider a measurement made using the assignment with the name “312H_PP_1_7_5_4_CHARGE_M2810.hub”. When the data is converted it is converted into a number of different formats, however some parts of the file name are consistent over the different formats. A result file from this assignment could be named “312H_PP_1_7_5_4_CHARGE_M2810_MS_LOG_SREC_DRV_shot0001_20141124_092157.dat”. Depending on file type it will end with .dat, .txt or .asc. In this panel the “set” of different files will be represented with only one entry namely “MS_LOG_SREC_DRV_shot0001” and a column with when the measurement was triggered. See Illustration 23 for an example. Here you can filter the result based on time and a string that matches part of the filename.
Select the measurements you are interested in and press the “Get file(s)” button. You will now be presented with a selection window of which file types you are interested in. You can select as many file types as you which to download.

[[File:Illustration23.png|thumb|frame|Illustration 23: The new results panel]]
[[File:Illustration24.png|thumb|frame|Illustration 24: File type selection dialog]]

The file type selection dialog is as depicted in Illustration 24. In this dialog the MDF type of file is selected with the subtype without module names. After each subtype for the text and MDF type it says (converted). This means that this data is accessible right away with any need to convert the raw data into any of the formats, except for the Vector type which does not have the (converted) text for any of the subtypes. In case the file type you are interested in is not currently converted on the portal you will be given the option to start a conversion when you press the Ok button. Depending on the file type and amount of data in the measurement it can take a long time but when it is done you will get a message saying “Conversion done”.

==Plot Route Dialog==
If you are interested in seeing where the car was driven while making measurements you can use the “Plot route” function by either using the button or the right-click menu. Doing this will open a dialog which by default plots the last 24 hour GPS positions (maximum of 100 positions) or, if there are not any during the last 24 hours, the last 100 registered positions. The dialog is depicted in Illustration 25 below. Just above the map are two dates present, from and to. These show the time interval that is shown on the map. You can change the dates and press the “Update map” button to view a new set a GPS positions during a measurement. You can zoom in and out of the map by pressing the plus or minus signs. By pressing the left mouse button and then drag the map you can freely move the map around. To zoom in on a particular area, hold down the left shift key and the left mouse button while dragging and a red rectangle will appear showing which area will be magnified. Release the mouse button to zoom in on the area.
You can download the set of positions in a file by pressing the button “Get GPS-data”. This downloads the GPS data to your computer in the gpx format to be used elsewhere.

[[File:Illustration25.png|left|frame|Illustration 25: Plotting the route for a car during an assignment.]]

The Portal User View

2017-06-22T08:35:45Z

Max.h.petersson:

This section will explain all panels and dialog in depth. Both regarding how you use it but also the limitations and some reasons to why it looks like it does. Section 3.1 will describe the meaning of the top level panels. In section 3.2 through 3.5 each top level panel will be described in detail.

==Top level tabs==
On the top level there are four different tabs to choose from. From left to right they are:
#'''Tasks''' Manages your tasks, search among tasks and create new tasks.
#'''Search''' In this tab you search and download result files.
#'''Vehicles''' Manages your vehicles. As vehicles belong to users of the system, you need to assign a vehicle to yourself before you initiate tasks running on it. You can also deassign vehicles when you are finished with them.
#'''Administration''' In this tab you can administer your name, email-address, password and a few other things.

With these three tabs you can do all the work that is needed to start, stop and handle data to and from vehicles. A figure of the tabs is presented in Illustration 11 below.
[[File:Illustration11 v240.png|frame|left|Illustration 11: The four tabs shown to a user.]]

 
{{:Tasks Tab}}
 
{{:Search Tab}}
 

{{:Vehicles}}