Difference between revisions of "Quick Start"

From WICE Wiki v2.89
Jump to navigation Jump to search
(Fixed acronym usage to be consistent and more correct. The page is now using the more common and accepted format Term (T))
Line 11: Line 11:
[[File:Illustration2.png|thumb|Figure 2: This figure shows how a task, assignment and WCU correlates. As you see the task is connected with an unspecified amount of WCUs where the task will execute. The task is also connected to one of the nine assignment as its that assignment that the task will be running.|277x277px]]The basic concept of the WICE portal functionality is to run and observe so called tasks. A task is an assignment (MCD-Hub, IDC, Canrecorder, SoH, SignalReader, SWDL, ETAS, Softhub or Blue piraT) to update or collect measurment from one or many cars. Tasks are run and observable when a user starts a task via the WICE portal on a set of Wireless Communication Units (WCUs) located in a set of cars. The portal then dowloads the tasks assignment to the WCUs when their cars ignition is turned off. Each WCU then runs the tasks assignment on its car. The user can then see the tasks result on each WCU as the tasks assignment will get different results depending on which WCU it ran on. This is because of that a task gives the same assignment to all WCUs but as different WCUs are located in different cars doing different stuff it will collect different data. To recap and illustrate how this works you can look at figure 1 and 2 explaining how this correlates.
[[File:Illustration2.png|thumb|Figure 2: This figure shows how a task, assignment and WCU correlates. As you see the task is connected with an unspecified amount of WCUs where the task will execute. The task is also connected to one of the nine assignment as its that assignment that the task will be running.|277x277px]]The basic concept of the WICE portal functionality is to run and observe so called tasks. A task is an assignment (MCD-Hub, IDC, Canrecorder, SoH, SignalReader, SWDL, ETAS, Softhub or Blue piraT) to update or collect measurment from one or many cars. Tasks are run and observable when a user starts a task via the WICE portal on a set of Wireless Communication Units (WCUs) located in a set of cars. The portal then dowloads the tasks assignment to the WCUs when their cars ignition is turned off. Each WCU then runs the tasks assignment on its car. The user can then see the tasks result on each WCU as the tasks assignment will get different results depending on which WCU it ran on. This is because of that a task gives the same assignment to all WCUs but as different WCUs are located in different cars doing different stuff it will collect different data. To recap and illustrate how this works you can look at figure 1 and 2 explaining how this correlates.
==A Simple Scenario==
==A Simple Scenario==
[[File:Illustration3.png|thumb|Figure 3: Login screen.]]
Now that we have gone through the concept of the WICE portal we will now give a more conrecte exampel. Lets say you want to create a task with a Statement of Health (SoH) assignment where you collect the cars voltage and mileage. To do this you need to log in to the WICE portal with your WICE login (username and password). You can see the login screen in figure 3 and if you have trouble logging in you can se The_Portal_User_View#Login.
Assume that you have a task you would like to be run in a car to collect interesting data to analyze. In short, the steps are:
#Log on to the WICE Portal
#Add a new assignment to a car
#Wait
#See how the assignment is doing
#Download result data generated from the assignment


When surfing to the portal you will see the screen in Figure 3. It is a simple screen with the possibility to enter a username and a password. Press the login button or enter to log in. If you have not yet received a user name and password, contact your local WICE portal administrator or responsible contact to get a user name and password.
Now that you are logged in you create a new task by clicking the "New Task" button at the bottom of the screen. When pressing the button a dialog will be shown with one tab for each assignment. To make the task a SoH task you click the SoH tab where the options for creating one will be shown. There you will at the top see six different checkboxes with different measurements SoH can collect. Check the boxes for voltage and mileage and scroll down to click "Add reasources". Here it will come up a window where we will search and add WCUs. You can search for a WCU by different criterea and when you have found the WCU(s) you wanted and have dragged them to the bottom box with the selected WCUs you press "Done". Now it should look like it does in figure x and you can now press ok to start the task. We dont need to fill the other boxes as we dont need a description, notification about status via email or schedule(sparsely used). That was a quick instruction on how to create a new task but you can read more detailed about how to create every sort of task at The_User_Portal_View#.


If turned on, you may have to enter a one time password when logging in. This enhances the security by providing something called two-factor authentication. The one time password is typically generated from an app in your smart phone. There is also a program for a desktop computer to generate the one time password. For Android, iPhone and Blackberry you can download an app called “Google Authenticator” to generate these one time passwords for you. An internet connection is not needed in order to generate the passwords. To log in to an account you need to enter your login, ordinary password and the current 6 digits generated by the app. A new 6 digit number is generated each 30 seconds.
When the task is done it will have generated results. You can see them searching the WCU(s) you used in the tasks tab (on the home screen). When you have found the WCU and your assignment you can select it and press the "Get Result Files" in the bottom left corner. then you will get a window where you can search among the resultfiles. Do note that this window shows all result files on the WCU so its not only your result files. When you have selected a file you will get the option to get(download), plot the rout for and view the file. Theres more information about the search tab and viewing results in The_User_Portal_View#Tasks_Tab
To simplify logins from the same computer, typically the one at work, you can tick the check box “Remember me”. If you tick this before you hit the login button when using the one time password, you will be remembered by the portal for the next 30 days. The next time you login from the computer you only have to enter your password. When the 30 days have passed you will once again have to enter a one time password to login. [[File:New_task_button.png|thumb|Figure 4: New task button]]
To create a new task, press the "New task" button which you can see in illustration "New task button". When pressing the button a dialog will be shown as depicted in Figure 5. There are nine tabs in this dialog:  MCD-Hub, Canrecorder, IDC, SoH, SignalReader, SWDL, ETAS, SoftHub and blue piraT. Figure 5 handles the MCD-Hub tab.
[[File:Illustration5.png|Figure 5: MCD-Hub|400x400px|thumb]]
 
===MCD-Hub===
MCD-Hub assignments are used to collect data using the MCD-Hub flight recorder. This assignment tab has seven areas (as shown in figure 7) with one funktion each that is used accordingly:
 
1. Selecting which MCD-Hub assignment file to use. Press "Bläddra"/"Browse" to bring up the file selection where you select the .hub file to use.
 
2. Choose which formats to convert to when result files are uploaded to the portal from a WCU.
 
3. Write a descriptive text for the assignment. (optional)
 
4. Choose if you want to be notified by email if the assignment fails to start. if you havnt filled in an email adress you will get oppurtunity when pressing ok. (optional)
 
5. Assign owner and the period of validity to the assignment. This is filled automatically and is optionally changed.
 
6. This option is under construction, do not use except for special cases
 
7. Start searching and selecting a WCU by pressing add resources at the bottom left of the screen. There you will get a pop up with 2 boxes, the upper one for searching cars and the bottom one for selected cars. In the top one you can search WCU units with ten different parameters by writing a value and pressing search or ENTER. to select a WCU you drag it from the top to the bottom box so that it appears in the bottom one.
 
After you press Ok and make the transfer there will be a pop-up telling you "Transfer ok!" if the transfer and checks went well, otherwise there will be a pop-up showing you an error cause.
 
===CAN-recorder===
[[File:Illustration6.png|thumb|Figure 6: Canrecorder]]
Canrecorder is a measurement module that allows CAN frames to be captured and logged. This assignment has 4 functions described in figure 6 and below:
 
1. Turning on or off CAN frame pass through filter. If you choose to have the filter on you must specify which CAN bus or CAN buses you wish to record. If you do not have the filter on you should not specify a CAN bus.
 
2. Choose if you want to record with the high speed CAN bus and/or the low speed can bus.
 
3. Specify which CAN buses you want to record by entering their ID and then pressing enter. This should only be done if the CAN frame passthrough filter is turned on.
 
4. Select how much time to record before and after the trigger.
 
===IDC===
Internal Diagnostic Client (IDC) is a measurement module that allows a sequence of diagnostic requests to be sent and responses recorded. The sequence of diagnostic requests are uploaded to the portal as a text file (usually ending with ".seq").
 
When assigning an IDC assignment its identical to a MCD-Hub assignment except the file you select must be a .seq file and you can not choose conversion format.
 
===SoH===
[[File:Illustration7.png|353x353px|Figure 7: SoH tab|thumb]]
The State of Health (SoH) assignment collects specific status information from vechiles. You select which information you want the assignment to collect by filling in one or more of the six boxes shown in figre 7. In order for SoH data to be correctly interpreted, relevant description files (SDDB/GDS) for the vehicles executing the SoH assignment must have been defined. To add a SDDB/GDS file to a vehicle, see [[The_Portal_Administrator_View#The_Edit_Car_Dialog]].The six different options are:
* Mileage
* Voltage
* Read ECU software numbers
* Read ECU DTC:s
* Read OBD-II PIDs
* App Diagnotstic Db Part Num
 
===Signal Reader===
[[File:Illustration8.png|thumb|Figure 8: Signal reader assignment.]]
Signal Reader is a measurement module that allows monitoring and logging of CAN-bus signals, as well as diagnostics data. Signal Reader performs more or less the same kind of measurements as the MCD-Hub but it has other functions at its disposal. Those other functions are described below and shown in figure 8:
 
1. You select the file you want. It must be a .haf file which is a text version of .hub a file.
 
2. When you have selected a file and WCU units the buses defined in the file and the WCU will be mapped but if they can not it will come a pop-up. In the pop-up window you will have to map the different buses to eachother manually. You can always map the buses manually by selecting to and then pressing mappings at the top. Read more about this in [[I/O configurations]] and [[Mappings]].
 
3. With a Signal Reader assignment you can follow WCU signals live by selecting monitor signals. When selected it will come up two boxes under the task description. In the left one you search for signals and drag them over to the right one where the monitored signals are. You can later se the monitored signals through the vehicles tab. It is also possible to copy the signals text in the bottom right corner of the right box. Next to the copy text button you can also paste signals as text where the pasted signal names will be matched against the list of unselected signals
 
4. You can choose if you want the signals to have their source modules names as a prefix.
 
===SWDL===
A Software Download (SWDL) task updates the ECU software in one or more ECUs in one or more vehicles. A number of Versatile Binary Format (VBF) files containing the ECU software need to be supplied, along with PIN codes to allow security access to re-program the ECUs.
 
===ETAS===
 
Through an ETAS task, an ETAS ES720 Drive Recorder system can be configured, and measurement data offloaded, and accessed through the WICE Portal.
 
===SoftHub===
 
The SoftHub is a more recent version of the MCD-Hub measurement system, and a SoftHub task is created much in the same way an MCD-Hub task is.
 
===Blue piraT===
 
The blue PiraT is a measurement system from Telemotive AG that can be configured with measurement set-ups, and data accessed through the WICE Portal. Note that to use the blue PiraT module, the WCUs to be used need to be preconfigured with a special software package. Contact Alkit Communications in order to set this up.


=== Get result files ===
=== Get result files ===

Revision as of 13:59, 3 July 2017

This chapter takes you on a tour to quickly get acquainted with the WICE Portal to see how it works.

As the WICE Portal is a web based tool there is no need to install any software on your computer. All you need is a web browser, such as Internet Explorer, which has Javascript enabled. Using the WICE Portal you can for example: See which assignments are running in which car. Check up on each assignment's respective status. Get result files from tasks. And much more.

In this quick start you will first be introduced to the basic model, and how it is supposed to work. Once the basics has been covered a simple scenario will be presented. This scenario will show how a task you have created is sent to a car and then started. How to download the data generated by a task for further analysis will also be covered.

Basic Conceptual Model

Figure 1: This image shows how you the user, the WICE portal and the cars in the field are connected. As you see here you as the user access the WCUs and their cars through the portal.
Figure 2: This figure shows how a task, assignment and WCU correlates. As you see the task is connected with an unspecified amount of WCUs where the task will execute. The task is also connected to one of the nine assignment as its that assignment that the task will be running.

The basic concept of the WICE portal functionality is to run and observe so called tasks. A task is an assignment (MCD-Hub, IDC, Canrecorder, SoH, SignalReader, SWDL, ETAS, Softhub or Blue piraT) to update or collect measurment from one or many cars. Tasks are run and observable when a user starts a task via the WICE portal on a set of Wireless Communication Units (WCUs) located in a set of cars. The portal then dowloads the tasks assignment to the WCUs when their cars ignition is turned off. Each WCU then runs the tasks assignment on its car. The user can then see the tasks result on each WCU as the tasks assignment will get different results depending on which WCU it ran on. This is because of that a task gives the same assignment to all WCUs but as different WCUs are located in different cars doing different stuff it will collect different data. To recap and illustrate how this works you can look at figure 1 and 2 explaining how this correlates.

A Simple Scenario

Now that we have gone through the concept of the WICE portal we will now give a more conrecte exampel. Lets say you want to create a task with a Statement of Health (SoH) assignment where you collect the cars voltage and mileage. To do this you need to log in to the WICE portal with your WICE login (username and password). You can see the login screen in figure 3 and if you have trouble logging in you can se The_Portal_User_View#Login.

Now that you are logged in you create a new task by clicking the "New Task" button at the bottom of the screen. When pressing the button a dialog will be shown with one tab for each assignment. To make the task a SoH task you click the SoH tab where the options for creating one will be shown. There you will at the top see six different checkboxes with different measurements SoH can collect. Check the boxes for voltage and mileage and scroll down to click "Add reasources". Here it will come up a window where we will search and add WCUs. You can search for a WCU by different criterea and when you have found the WCU(s) you wanted and have dragged them to the bottom box with the selected WCUs you press "Done". Now it should look like it does in figure x and you can now press ok to start the task. We dont need to fill the other boxes as we dont need a description, notification about status via email or schedule(sparsely used). That was a quick instruction on how to create a new task but you can read more detailed about how to create every sort of task at The_User_Portal_View#.

When the task is done it will have generated results. You can see them searching the WCU(s) you used in the tasks tab (on the home screen). When you have found the WCU and your assignment you can select it and press the "Get Result Files" in the bottom left corner. then you will get a window where you can search among the resultfiles. Do note that this window shows all result files on the WCU so its not only your result files. When you have selected a file you will get the option to get(download), plot the rout for and view the file. Theres more information about the search tab and viewing results in The_User_Portal_View#Tasks_Tab

Get result files

Figure 9: The Get result files dialog.

When there is any result data generated from an assignment the “Get Result Files” button will be enabled. When clicking that button a dialog will appear. What you get here is basically a set of search terms to use to search through your result files on the portal for this particular task and WCU. When hovering the pointer over the search area you will get the number of files that match your search terms as a tool tip.

By pressing the “List Files” button you will get an opportunity to download result files to your local computer. See Figure 10 below. By default the “Compile by upload date” check box is checked. The idea behind this is that each set of results is grouped into sets of files which corresponds to a particular upload of result files. Each such upload can be huge with several thousands of files. Picking individual files is tedious and mostly you are interested with all of the files of a particular type that was uploaded. The “Compile by upload date” then simply means that one row in the table means one such upload of files. To download result files, select the files you are interested in and click “Get File(s)”. After that a file save dialog will open and you can choose where to save the file. All the files you have selected will be downloaded as a zip-file.

If the file you have selected is of a human readable type, the button “View file” will be enabled. By clicking that button the file is opened in your browser and you can look through it. Another way to open the file is to double click on the file entry. When your program has collected enough data for you you can stop it by clicking the “Stop Assignment” button. A message will be sent to the WCU telling it that the current assignment should be stopped. This concludes this section where we have walked through a simple and rather basic scenario where a task was created and a hub assignment program generated some data that could be later retrieved.

In the The Portal User View section a thorough explanation of the user's view will be presented.

Retrieved from "https://wiki.alkit.se/wice289/index.php?title=Quick_Start&oldid=711"