View source for Signal Reader Assignment Editor

The Signal Reader Assignment Editor, also known as '''haf creator''', can be found under the tab '''Assignment''' and allows the user to create new assignments for signal reader directly on the portal. This page will guide you through the basics of using the editor.

==Choosing a Signal Source==
First, you must select a signal source to base your new assignment on. Today, only custom vehicle types can be used for this, see Figure "Choosing a Signal Source". If you would like to edit the Custom Vehicle types or create a new one, this can be done by admins under the administration tab.

When you feel comfortable with which signal source you would like to use, double click it or select it and click '''Create new assignment'''.[[File:Choose Signal Source.png|thumb|Choosing a Signal Source|600x600px|none|link=https://wiki.alkit.se/wice264/index.php/File:Choose_Signal_Source.png]]In case the chosen Vehicle Profile has multiple A2L files per ECU a prompt will show up where it is possible to choose which A2L file to use per ECU. If no A2L file is chosen, that ECU is not used when creating the assignment.[[File:SignalReaderChooseA2LFilePerECU.png|none|thumb|Choose A2L File Per ECU Popup|link=https://wiki.alkit.se/wice264/index.php/File:SignalReaderChooseA2LFilePerECU.png]]
==Creating a new assignment==
Now that you have chosen a signal source, you can start creating the assignment. The first tab that you are presented with is the '''Assignment global settings''' tab where you can add information about the assignment so that you can easily keep track of what this assignment is about. Creator and creation date are both automatically filled in and cannot be changed because of consistency.[[File:MeasurementSetup2.png|thumb|600x600px|Measurement Setups|link=https://wiki.alkit.se/wice264/index.php/File:MeasurementSetup2.png]][[File:Edit-DAQ2.png|thumb|600x600px|Edit DAQ|link=https://wiki.alkit.se/wice264/index.php/File:Edit-DAQ2.png]]Under the '''Measurements''' tab, see Figure "Measurement Setups", you are presented to a table of Measurement Setups and an information window. These measurement setups are the core of a signal reader assignment. They contain '''Triggers''' that activate and deactivate on certain conditions provided by the user. Each trigger can contain a '''Recorder''' that contains a list of certain signals that will be measured when the start condition for the respective trigger is met. A trigger can also be used to act as a '''setup switch'''.

Measurement setups keep track of the signals that are present in them, as seen in Figure "Measurement Setups". If a CCP signal is present in the measurement setup it is possible to assign it to an individual '''DAQ list''' by pressing Edit DAQ. This brings up the window in Figure "Edit DAQ". Here you can drag and drop signals to the corresponding DAQ list that you which them to be in.

When you feel finished with the assignment you can simply click the '''Save assignment''' button in the lower right corner to save the assignment in its current state.
===Trigger===
To add a trigger to a measurement setup, click the '''Add trigger''' button for the respective measurement setup. This will create a new Trigger in the trigger table in the respective measurement setup and the information window will be filled with new settings for this trigger for you to add.

Fill out the '''start trigger''' '''condition''' for the trigger. This is easiest to do in the '''Edit expression''' window that you can get to by clicking one of the '''Edit''' buttons. To find a new signal to add a condition for, use the '''Add signal''' button. Here, you can browse all signals available for this assignment. Use the dropdown to browse signals from different can-busses and Wice generic internal signals. If you want to browse the signals currently in use in the assignment for the selected signal source, check the '''Search in assignment''' box. If you want more information about a signal, select it and click '''More info'''. When you have found the signal you want, double click it or select it and click '''Add signal'''. Now you can use the '''Operators''' list to add a condition for the signal, for example " > 0". When you are satisfied with the start condition, you will notice that the Validate button has a yellow warning symbol on it. This means that the expression is unvalidated, press the button to validate the expression. The buttons icon now either turns red (expression is unvalid) or green (expression is correct). See Figure "Validate Button States" for the different state of the validate button. Click Save to save the expression. The list of operators supported in trigger condition is available [[Signal Reader Trigger Expressions|here]].[[File:ValidateButtonStates.png|thumb|Validate Button States|link=https://wiki.alkit.se/wice264/index.php/File:ValidateButtonStates.png]]A '''stop trigger condition''' is not required, but can be supplied to determine when the recording should stop. If the stop condition is not supplied, the settings for the recorder will tell when the recording should stop.

You can use the '''trigger''' '''Setup switch''' to switch to/run a measurement setup when the start condition is met. Keep in mind though, that the setup switch will not run until all currently started recorders have at least fulfilled their '''minimum duration'''. A trigger with a recorder cannot have a setup switch, but the recorder can.
===Recorder===
There a two types of recorder, SREC (Signal recorder) and DREC (Diagnostics recorder). Choose which one you want with the radio button at the top of the Recorder tab.
=====Recorder - DREC=====
DREC (Diagnostics recorder) is used to ask diagnostic questions on the buses and record the answers. The questions to ask are determined by a sequence file that you are asked to upload.
====Recorder - SREC====
SREC (Signal recorder) is used to record signals on the busses.[[File:AddSignalsRecorder.png|thumb|600x600px|Add Signals for Recorder|link=https://wiki.alkit.se/wice264/index.php/File:AddSignalsRecorder.png]][[File:ImportSignalsText2.png|thumb|559x559px|Import signals from text|link=https://wiki.alkit.se/wice264/index.php/File:ImportSignalsText2.png]]
=====SREC - Signals=====
Click the '''Add Signal''' button to open a window to add signals for recording. This window is much like the window for adding signals for the trigger, only differing in the fact that you can select multiple signals in this window. The selected signals for this recorder are shown in the right table, see Figure "Add Signals for Recorder". To add new signals to this table, you can either:
*Double click the signal,
*Drag and drop the signal
*Select the signal and click the right pointing arrow
Click the red symbol to the right of each signal to remove it. When you are done, click Ok to add the signals.

It is also possible to '''import''' signals from a text file or directly from text as well as '''export''' signals as text. To do this, use the corresponding icon in the bottom right corner of the "Selected Symbols" list as senn in Figure "Add Signals for Recorder". The figure "Import signals from text" gives an example on how the text file and text is expected to be structured when importing signals. Each line is expected to be a signal, with or without the module name. If the signal does not have a module name it is expected to belong to the already selected signal source/module. When importing CCP signals it is here possible to select which DAQ list that all found CCP signals should be assigned to, using the drop down.

Now that you have added some signals, you can give them each a '''Skip factor''', default 1, which is an integer that determines how often the signal should be recorded/stored when supplied. For example, a skip factor of 1 will record the signal every time it is supplied and a skip factor of 3 will record the signal every third sample.
=====Recorder  - Properties=====
Under the recorder tab '''Properties''' you can select the properties for the recorder, see Figure "Recorder Properties".

'''Number of shots''' is an important factor for a recorder. A '''shot''' is the term used for a single recording and number of shots is therefore the number of times we should record. A shot is only started when the start trigger condition is met and will continue until any of these events occur:
*The recording fulfills the maximum duration.
*The recording fulfills the minimum duration and the '''stop trigger condition''' is met.
*The recording fulfills the minimum duration and a trigger start a '''setup switch'''.
*The recording fulfills the minimum duration and another recorder starts a '''setup switch'''.
*A setup switch is started manually.
*The assignment is stopped manually.
The '''recorder Setup switch''' is started when recorder has performed its number of shots and all other started recorders have at least fulfilled their minimum duration. It is, like the trigger setup switch, used to switch to/run a measurement setup.

You can also select the '''Pre trigg duration''' which determines the amount of data that will be saved in the flash before the start trigger condition is met. Range is 0 to 4294967295 (2<sup>32</sup>).

The '''Post trigg duration''' is much like the pre trigg duration and determines the amount of data that will be saved after the stop trigger condition is met. Range is 0 to 4294967295 (2<sup>32</sup>).

The '''Minimum duration''' determines the minimum amount of data that needs to be recorded before it becomes possible to cancel the recording through either a stop trigger or a setup swtich started by a trigger or another recorder.

The '''Maximum duration''' determines, as the name suggest, the maximum amount of data that should be recorded. Range is 0 to 4294967295 (2<sup>32</sup>).

The '''Unit''' for the four aforementioned durations can be set to seconds, samples or bytes. If you choose to set them to seconds, the device will use the timestamps of the incoming data to determine the four aforementioned durations.[[File:Recorder properties.png|thumb|600x600px|Recorder Properties|none|link=https://wiki.alkit.se/wice264/index.php/File:Recorder_properties.png]][[File:View assignments.png|thumb|600x600px|View Assignments|link=https://wiki.alkit.se/wice264/index.php/File:View_assignments.png]]
==Editing an assignment==
In order to edit an already created assignment navigate to the tab where you choose a signal source and click the '''View saved assignments''' button. This will display a window, see Figure "View Assignments", which lists all of the saved assignments created through the editor, by whom and when it was created. In order to edit an assignment, select it and click '''Edit''' and you will start editing it. Simply click '''Save assignment''' when you are done and the old version of the assignment will be updated.
==Copy an assignment==
It is possible to copy an assignment and at the same time let it use the latest version of the assigned vehicle profile. To do this, click the '''View saved assignments''' button, select the assignment you want to copy and click '''Copy to Latest'''. You will be prompted to enter a new name of the copied assignment, this must be a unique name. If the latest vehicle profile has multiple a2l description files per ECU, you will be prompted to select which one you want to use. If the assignment was first created using a specific description file for an ECU, that file will be pre-selected for that ECU so long as it still exists in the latest vehicle profile. Should signals in the original assignment not be found in the new signal sources for the copied assignment, these signals will be listed, prompting you if you still want to continue. If you choose to continue, these signals will be removed from the copied assignment.
==Using a portal assignment for a signal reader task==
In order to use a portal assignment. Select the WCUs in the Vehicle tab that you want to create the new signal reader assignment for and click new task. Navigate to the Signal reader tab and click the '''Browse saved assignments''' button and select the assignment you want to use and click '''Ok'''. This assignment will now be used to create the .haf file required by the WCUs to perform the signal reader task.