Difference between revisions of "Quick Start"

From WICE Wiki v2.89
Jump to navigation Jump to search
(Created page with "This chapter takes you on a tour to quickly get acquainted with the WICE Portal to see how it works.<br> As the WICE Portal is a web based tool there is no need to install an...")
 
m (Removed protection from "Quick Start")
 
(93 intermediate revisions by 5 users not shown)
Line 1: Line 1:
This chapter takes you on a tour to quickly get acquainted with the WICE Portal to see how it works.<br>
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. <br>
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 measurement assignments are running, check each assignment's respective status, get result files from measurement tasks, and much more.
All you need is a web browser, such as Firefox, which has Javascript enabled.  
With the tool you can see which assignments are running in which car, their status, get result files from tasks and much more.
In this quick start you will first be introduced to the basic model of how it is supposed to work. Secondly,
a simple scenario will show how a task you have created is sent to a car and started. When that task has generated data for you, download that data to your computer for further analysis.


==Basic Conceptual Model==
In this quick start you will first be introduced to the basic model, and how it is supposed to work. Once the basics have been covered a simple scenario will be presented. This scenario will show how a task you have created is sent to a vehicle and then started. How to access the data generated by a task will also be covered.
To introduce to the concept of how it is supposed to work, see illustration 1 below. There are three parts involved here:
# You the user
# The WICE Portal
# A set of cars.
The user decides to add a task to a specific car when logged in into the portal. Each time the ignition is turned off the car contacts the portal to see if there is a new task to download and upload any result files to the portal. When the user later logs in he/she can see that the new task is running in the car as well as see that there are new result files for the task.
This is the basic model of how it works and what you can do. Next we will go through a scenario showing screen shots from the tool and updates on where we are in the conceptual model just shown.
To be precise, each car is configured with a Wireless Communication Unit (WCU) which handles the communication between the car and the portal. In reality, this is the device you “talk” to through the portal.


[[File:Illustration1.png]]
__TOC__


==Terminology==
==Basic Conceptual Model==
In order to bring some order to everything, the terminology used will be discussed in this section. It is important that you understand the distinctions not to get confused when using the portal.
[[File:Illustration1.png|alt=|thumb|Figure 1: This image shows how you the user, the WICE portal and the vehicles in the field are connected. As you see here you as the user access the WCUs and their vehicles through the portal.]][[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 functionality of the WICE portal is to manage so called ''tasks''. A task is an assignment to perform a specific action, typically collect measurement data from one or more vehicles. Tasks are created in the WICE portal and connected to a number of Wireless Communication Units (WCUs), which are in-vehicle units connected to the vehicles' internal communication buses. After a task has been created, the assignment is downloaded by each of the defined vehicles when ignition is turned on. Each WCU then runs the task's assignment, typically producing output in the shape of measurement data files, which are uploaded to the WICE portal. The user can then see the task's result on each WCU as the task's assignment will get different results depending on which WCU it ran on. To recap and illustrate how this works you can look at figure 1 and 2 explaining how this correlates.
Basically, on the top level there is a task. A task has a single user attached to it, which is the user that created the task and this cannot be changed. Also, each task is associated with only one assignment of each type (MCD-Hub, IDC, Canrecorder, SOH, SignalReader). However, a task can be associated with any number of WCUs. A WCU (Wireless Communication Unit) is the actual hardware that is installed into each car. The rationale behind this is that each WCU runs the same assignment for a task. Fortunately, each WCU running an assignment can be manipulated individually. This is quite natural as the progression for the assignment depends on each WCU or car.<br>
[[File:A Simple Scenario.png|thumb|Figure 3: This is how a task can look when it is ready to be created.]]
If you find this confusing, try Illustration 2 below.<br>
[[File:Illustration2.png]]
 
In the middle is the task which is the connecting entity. Below are the set if different assignment programs available. To the left there is a set of WCUs where the assignment program is downloaded to each WCU. The progression of the assignment program is probably different for each WCU and are therefore treated individually.


==A Simple Scenario==
==A Simple Scenario==
Assume that you have a task you would like to be run in a car to collect interesting data to analyze. This scenario shows just this. The steps are:
Now that we have gone through the concept of the WICE portal we will give a more concrete example. Let's say you want to create a task with a State of Health (SoH) assignment where you collect the mileage and battery voltage of a connected vehicle. To do this you need to [[The Portal User View#Login|log in]] to the WICE portal with your WICE login (username and password).
[[File:Illustration3.png|thumb|frame|Illustration 3: Login screen.]]
#Log on to the WICE Portal
#Add a new assignment to a car
#Log out of the portal
#Log in again and see how the assignment is doing
#Download result data generated from the assignment
 
When surfing to the portal you will see the screen in Illustration 3. It is a simple screen with the possibility to enter a user name and 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.
 
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.
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. <br>


In the next screen you are presented with your tasks, their status and more, see Illustration 4. For an elaborate explanation of the information presented, turn to chapter 3.2.2 on page 17. Press the “New Task” button to transfer a new task to the car. The car will try to start the new task the next time it connects to the portal.
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 type of 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 data items that SoH can collect. Check the boxes for voltage and mileage and scroll down to click "Add resources". A window will appear where we can 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 3 and you can now press "OK" to start the task. We don't need to fill the other boxes as we don't need a description, notification about status via email or schedule. 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 Portal User View#Creating a Task|Creating a Task]].


[[File:Illustration4.png|thumb|frame|Illustration 4: The screen showing a user's tasks.]]
When the task is done it will have generated results. You can find them by searching for 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. This will open a panel where you can search among the result files. When you have selected a file you gain access to multiple options. You can download the files (get files), plot the GPS data of the vehicle (plot route), preview the data files, or study the log files. There is more information about the Tasks tab and viewing results in [[The Portal User View#Tasks Tab|Tasks Tab]].
When pressing the button the “New Task” dialog will be shown as depicted in Illustration 5. There are five tabs in this dialog which are  “MCD-Hub”, “Canrecorder”, “IDC”, “SoH” and “SignalReader”. Illustration 5 deals with the MCD-Hub tab. The tab is composed of four different areas basically, with some differences depending on the type of the assignment. Those are:
[[File:Illustration5.png|thumb|frame|Illustration 5: The New Task dialog.]]
#Choose which MCD-Hub assignment file. Press the button “Bläddra”/”Browse” to bring up the file selection dialog.
#Choose which formats to convert to when result files are uploaded to the portal from a WCU.
#Write a descriptive text for the assignment. This is optional.
#To select which WCUs should receive the assignment, write the name of the WCU in the box above the “unselected resource” column text. When you type, the WCUs matching your text will automatically appear in the table. To select a WCU drag it from the unselected table to the selected table or press the right arrow between the two tables. To deselect a WCU, simply do the opposite.

Latest revision as of 13:31, 17 May 2022

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 measurement assignments are running, check each assignment's respective status, get result files from measurement 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 have been covered a simple scenario will be presented. This scenario will show how a task you have created is sent to a vehicle and then started. How to access the data generated by a task will also be covered.

Basic Conceptual Model

Figure 1: This image shows how you the user, the WICE portal and the vehicles in the field are connected. As you see here you as the user access the WCUs and their vehicles 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 functionality of the WICE portal is to manage so called tasks. A task is an assignment to perform a specific action, typically collect measurement data from one or more vehicles. Tasks are created in the WICE portal and connected to a number of Wireless Communication Units (WCUs), which are in-vehicle units connected to the vehicles' internal communication buses. After a task has been created, the assignment is downloaded by each of the defined vehicles when ignition is turned on. Each WCU then runs the task's assignment, typically producing output in the shape of measurement data files, which are uploaded to the WICE portal. The user can then see the task's result on each WCU as the task's assignment will get different results depending on which WCU it ran on. To recap and illustrate how this works you can look at figure 1 and 2 explaining how this correlates.

Figure 3: This is how a task can look when it is ready to be created.

A Simple Scenario

Now that we have gone through the concept of the WICE portal we will give a more concrete example. Let's say you want to create a task with a State of Health (SoH) assignment where you collect the mileage and battery voltage of a connected vehicle. To do this you need to log in to the WICE portal with your WICE login (username 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 type of 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 data items that SoH can collect. Check the boxes for voltage and mileage and scroll down to click "Add resources". A window will appear where we can 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 3 and you can now press "OK" to start the task. We don't need to fill the other boxes as we don't need a description, notification about status via email or schedule. 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 Creating a Task.

When the task is done it will have generated results. You can find them by searching for 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. This will open a panel where you can search among the result files. When you have selected a file you gain access to multiple options. You can download the files (get files), plot the GPS data of the vehicle (plot route), preview the data files, or study the log files. There is more information about the Tasks tab and viewing results in Tasks Tab.

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