WICE Wiki v2.95 - User contributions [en]

Main Page

2025-08-14T07:46:13Z

Mathias:

'''Welcome to the WICE Wiki!''' Here you can find information about the WICE System and how-to guides of all the features in the WICE Portal.

The WICE system is a powerful and flexible data collection and fleet management system developed by Alkit Communications AB. The WICE Portal is the user interface of the WICE system.

Feel free to suggest improvements and add pages if you feel that some information is missing.

To see the addtions/changes of the previous version of the WICE portal, see [[New features in v2.94|New features in v2.94.]] (Also available from the sidebar to the left.)

For full release history see [[https://wice-sysdoc.alkit.se/index.php/Release_notes WICE Release history]].

Main Page

2025-08-14T07:42:58Z

Mathias:

'''Welcome to the WICE Wiki!''' Here you can find information about the WICE System and how-to guides of all the features in the WICE Portal.

Feel free to suggest improvements and add pages if you feel that some information is missing.

To see the addtions/changes of the previous version of the WICE portal, see [[New features in v2.94|New features in v2.94.]] (Also available from the sidebar to the left.)

For full release history see [[https://wice-sysdoc.alkit.se/index.php/Release_notes WICE Release history]].

New features in v2.94

2025-06-16T07:19:44Z

Mathias: /* Support for admins to download description files. */

== Support for labels in vehicle templates ==
As of version 2.94.0, the Vehicle Template panel supports adding labels to vehicle templates. Read more about it [https://wiki.alkit.se/wice294/index.php/Vehicle_templates here].

== Extend WCU history to account for more changes ==
Two new columns have been added to the WCU history: '''"Type of Change"''' and '''"State"'''.

* '''Type of Change''' indicates whether the update involved a configuration change, a tools change, or a label change.
* '''State''' reflects the WCU’s status at the time of the change, such as "In Operation".

You can read more about these updates [https://wiki.alkit.se/wice294/index.php/Vehicles#Right_click_context_menu here].

== Configurable tester address for signal reader, IDC, SoH and vinreader ==
The SignalReader, IDC, State of Health, and VINReader modules have all been updated to include a new field called 'Tester Address.' In the VINReader module, this field is visible only when the ID reader method is set to SPA 29. Additionally, the Tester Address field is available only with WCU version 2.94.0 or later. Read more about it [https://wiki.alkit.se/wice294/index.php/The_Portal_Administrator_View#Configure_the_Vinreader_Module here]

== Fetch PINs from PIE ==
[[File:Fetch PINs button.png|thumb|Button to fetch PINs from PIE]]
As of version 2.94.0 for portals with Vehicle Communication Forwarder (VCF) enabled, it will now be possible to get PINs from PIE for the WCUs in a group via ''Administration''->''Resource groups''. This will save any found PINs that can then be applied to the VCF's configuration for each WCU in the group. Read more about configuring VCF [[Vehicle Communication Forwarder|here]].

== New column for WCU state in Vehicles Tab ==
A new column has been introduced to the Vehicles tab that will show the current state of the WCU.

== Support for SOVD IP Address in the WCU configuration ==
As of version 2.94.0, you can enter either an IPv4 address or a physical ID in the 'SOVD IP Address' field located under the Connection tab in the WCU configuration settings. This field is only visible when the WCU is running version 2.94.0 or later. This is only enabled for customers needing support for the function.

== Support to update a subset of WCU configuration variables ==
[[File:UpdateSubSetOfWCUConfigruationVariable.png|thumb|Update a subset of WCU configuration variables window]]
You can now edit the configuration of multiple WCUs simultaneously. When doing so, the same configuration editor will appear, but with a few new additions. A new '''"Show Changed Settings"''' button allows you to easily track any modifications you've made. Additionally, a new dropdown menu labeled '''"Settings from WCU"''' lets you select which WCU’s configuration you want to edit from. More importantly, only the configuration settings changed will be applied to the WCUs, all other configuration settings will be untouched.

== Support for new platform Kvaser Edge ==
There is support for a new WCU platform called Kvaser Edge.

== Support for admins to download description files ==
[[File:New-dowload-desc-files.png|thumb|Download description file|200x200px|none]]
If you are an admin and the function is turned on, you have the opportunity to download the vehicle description files found in the Administration->Vehicle Profiles panel.

== New alarm when a shelved WCU tries to connect with a vehicle ==
An alarm is raised when a WCU is in any of its shelved states and tries to connect with a vehicle. The category is 'wcu::state::shelved::connect'.

== Support for show signal info for all signals in assignment editor ==

== Frame names in add signals for assignment editor ==
You can now view the frame name for both CAN and LIN signals directly within the "Add Signal" dialog for a recorder. Additionally, you can also bring out frame names for signals in the recorder by simple right clicks and select the column “Frame name”.

== Improved assignment editor permission ==
We've upgraded the assignment permission settings to give more control.

Previously, assignments could only be marked as private or public. Now, you can assign user-specific permissions to allowing selected users to access private, public, or both types of assignments. Read more [[Assignment Editor#Assignment permissions|here]].

== Improved handling of copy assignment ==
We’ve improved the Signal Reader Assignment copy functionality in the Assignment Creator.

The new version ensures a more reliable experience when duplicating assignments and preventing the process from getting stuck.

== Support to see when a label was associated with a resource ==
[[File:New label viewer.png|thumb|101x101px|New label viewer]]
There is now support to see at what time a specific label was associated with a resource.

== Support to search for empty values in label columns ==
You can now search for the absence of values in your label columns in various places.

== Cybersecurity settings ==
For the WCU a bunch of cybersecurity settings are available.

* Disable USB ethernet interfaces
* Lock Signal Reader's Signal Broker communication to localhost
* Disable the SSH daemon
* Root password checks to prevent too weak passwords
* Software firewall on the WCU

== Instant downloads of multiple files ==
From version 2.94 the previous background zipping of files described in [[Downloading Files]] is no longer needed. Instead the downloading starts immediately when clicking the "Get all files" button in [[Tasks Tab]] or the "Download" button in the [[Search Tab]].
== Improved CAN frame logging in Signal Reader ==
The CAN frame logging has been improved to support CANFD frame logging and to support finalization of MF4 frame logs in recovery mode.

New features in v2.94

2025-06-16T07:19:02Z

Mathias:

== Support for labels in vehicle templates ==
As of version 2.94.0, the Vehicle Template panel supports adding labels to vehicle templates. Read more about it [https://wiki.alkit.se/wice294/index.php/Vehicle_templates here].

== Extend WCU history to account for more changes ==
Two new columns have been added to the WCU history: '''"Type of Change"''' and '''"State"'''.

* '''Type of Change''' indicates whether the update involved a configuration change, a tools change, or a label change.
* '''State''' reflects the WCU’s status at the time of the change, such as "In Operation".

You can read more about these updates [https://wiki.alkit.se/wice294/index.php/Vehicles#Right_click_context_menu here].

== Configurable tester address for signal reader, IDC, SoH and vinreader ==
The SignalReader, IDC, State of Health, and VINReader modules have all been updated to include a new field called 'Tester Address.' In the VINReader module, this field is visible only when the ID reader method is set to SPA 29. Additionally, the Tester Address field is available only with WCU version 2.94.0 or later. Read more about it [https://wiki.alkit.se/wice294/index.php/The_Portal_Administrator_View#Configure_the_Vinreader_Module here]

== Fetch PINs from PIE ==
[[File:Fetch PINs button.png|thumb|Button to fetch PINs from PIE]]
As of version 2.94.0 for portals with Vehicle Communication Forwarder (VCF) enabled, it will now be possible to get PINs from PIE for the WCUs in a group via ''Administration''->''Resource groups''. This will save any found PINs that can then be applied to the VCF's configuration for each WCU in the group. Read more about configuring VCF [[Vehicle Communication Forwarder|here]].

== New column for WCU state in Vehicles Tab ==
A new column has been introduced to the Vehicles tab that will show the current state of the WCU.

== Support for SOVD IP Address in the WCU configuration ==
As of version 2.94.0, you can enter either an IPv4 address or a physical ID in the 'SOVD IP Address' field located under the Connection tab in the WCU configuration settings. This field is only visible when the WCU is running version 2.94.0 or later. This is only enabled for customers needing support for the function.

== Support to update a subset of WCU configuration variables ==
[[File:UpdateSubSetOfWCUConfigruationVariable.png|thumb|Update a subset of WCU configuration variables window]]
You can now edit the configuration of multiple WCUs simultaneously. When doing so, the same configuration editor will appear, but with a few new additions. A new '''"Show Changed Settings"''' button allows you to easily track any modifications you've made. Additionally, a new dropdown menu labeled '''"Settings from WCU"''' lets you select which WCU’s configuration you want to edit from. More importantly, only the configuration settings changed will be applied to the WCUs, all other configuration settings will be untouched.

== Support for new platform Kvaser Edge ==
There is support for a new WCU platform called Kvaser Edge.

== Support for admins to download description files. ==
[[File:New-dowload-desc-files.png|thumb|Download description file|200x200px|none]]
If you are an admin and the function is turned on, you have the opportunity to download the vehicle description files found in the Administration->Vehicle Profiles panel.

== New alarm when a shelved WCU tries to connect with a vehicle ==
An alarm is raised when a WCU is in any of its shelved states and tries to connect with a vehicle. The category is 'wcu::state::shelved::connect'.

== Support for show signal info for all signals in assignment editor ==

== Frame names in add signals for assignment editor ==
You can now view the frame name for both CAN and LIN signals directly within the "Add Signal" dialog for a recorder. Additionally, you can also bring out frame names for signals in the recorder by simple right clicks and select the column “Frame name”.

== Improved assignment editor permission ==
We've upgraded the assignment permission settings to give more control.

Previously, assignments could only be marked as private or public. Now, you can assign user-specific permissions to allowing selected users to access private, public, or both types of assignments. Read more [[Assignment Editor#Assignment permissions|here]].

== Improved handling of copy assignment ==
We’ve improved the Signal Reader Assignment copy functionality in the Assignment Creator.

The new version ensures a more reliable experience when duplicating assignments and preventing the process from getting stuck.

== Support to see when a label was associated with a resource ==
[[File:New label viewer.png|thumb|101x101px|New label viewer]]
There is now support to see at what time a specific label was associated with a resource.

== Support to search for empty values in label columns ==
You can now search for the absence of values in your label columns in various places.

== Cybersecurity settings ==
For the WCU a bunch of cybersecurity settings are available.

* Disable USB ethernet interfaces
* Lock Signal Reader's Signal Broker communication to localhost
* Disable the SSH daemon
* Root password checks to prevent too weak passwords
* Software firewall on the WCU

== Instant downloads of multiple files ==
From version 2.94 the previous background zipping of files described in [[Downloading Files]] is no longer needed. Instead the downloading starts immediately when clicking the "Get all files" button in [[Tasks Tab]] or the "Download" button in the [[Search Tab]].
== Improved CAN frame logging in Signal Reader ==
The CAN frame logging has been improved to support CANFD frame logging and to support finalization of MF4 frame logs in recovery mode.

New features in v2.94

2025-06-16T07:15:18Z

Mathias: /* Cybersecurity settings */

== Support for labels in vehicle templates ==
As of version 2.94.0, the Vehicle Template panel supports adding labels to vehicle templates. Read more about it [https://wiki.alkit.se/wice294/index.php/Vehicle_templates here].

== Extend WCU history to account for more changes ==
Two new columns have been added to the WCU history: '''"Type of Change"''' and '''"State"'''.

* '''Type of Change''' indicates whether the update involved a configuration change, a tools change, or a label change.
* '''State''' reflects the WCU’s status at the time of the change, such as "In Operation".

You can read more about these updates [https://wiki.alkit.se/wice294/index.php/Vehicles#Right_click_context_menu here].

== Configurable tester address for signal reader, IDC, SoH and vinreader ==
The SignalReader, IDC, State of Health, and VINReader modules have all been updated to include a new field called 'Tester Address.' In the VINReader module, this field is visible only when the ID reader method is set to SPA 29. Additionally, the Tester Address field is available only with WCU version 2.94.0 or later. Read more about it [https://wiki.alkit.se/wice294/index.php/The_Portal_Administrator_View#Configure_the_Vinreader_Module here]

== Fetch PINs from PIE ==
[[File:Fetch PINs button.png|thumb|Button to fetch PINs from PIE]]
As of version 2.94.0 for portals with Vehicle Communication Forwarder (VCF) enabled, it will now be possible to get PINs from PIE for the WCUs in a group via ''Administration''->''Resource groups''. This will save any found PINs that can then be applied to the VCF's configuration for each WCU in the group. Read more about configuring VCF [[Vehicle Communication Forwarder|here]].

== New column for WCU state in Vehicles Tab ==
A new column has been introduced to the Vehicles tab that will show the current state of the WCU.

== Support for SOVD IP Address in the WCU configuration ==
As of version 2.94.0, you can enter either an IPv4 address or a physical ID in the 'SOVD IP Address' field located under the Connection tab in the WCU configuration settings. This field is only visible when the WCU is running version 2.94.0 or later. This is only enabled for customers needing support for the function.

== Support to update a subset of WCU configuration variables ==
[[File:UpdateSubSetOfWCUConfigruationVariable.png|thumb|Update a subset of WCU configuration variables window]]
You can now edit the configuration of multiple WCUs simultaneously. When doing so, the same configuration editor will appear, but with a few new additions. A new '''"Show Changed Settings"''' button allows you to easily track any modifications you've made. Additionally, a new dropdown menu labeled '''"Settings from WCU"''' lets you select which WCU’s configuration you want to edit from. More importantly, only the configuration settings changed will be applied to the WCUs, all other configuration settings will be untouched.

== Support for new platform Kvaser Edge ==
There is support for a new WCU platform called Kvaser Edge.

== Support for admins to download description files. ==
[[File:New-dowload-desc-files.png|thumb|Download description file|200x200px|none]]
If you are an admin and the function is turned on, you have the opportunity to download the vehicle description files found in the Administration->Vehicle Profiles panel.

== New alarm when a shelved WCU tries to connect with a vehicle ==
An alarm is raised when a WCU is in any of its shelved states and tries to connect with a vehicle. The category is 'wcu::state::shelved::connect'.

== Support for show signal info for all signals in assignment editor ==

== Frame names in add signals for assignment editor ==
You can now view the frame name for both CAN and LIN signals directly within the "Add Signal" dialog for a recorder. Additionally, you can also bring out frame names for signals in the recorder by simple right clicks and select the column “Frame name”.

== Improved assignment editor permission ==
We've upgraded the assignment permission settings to give more control.

Previously, assignments could only be marked as private or public. Now, you can assign user-specific permissions to allowing selected users to access private, public, or both types of assignments. Read more [[Assignment Editor#Assignment permissions|here]].

== Improved handling of copy assignment ==
We’ve improved the Signal Reader Assignment copy functionality in the Assignment Creator.

The new version ensures a more reliable experience when duplicating assignments and preventing the process from getting stuck.

== Support to see when a label was associated with a resource ==
[[File:New label viewer.png|thumb|101x101px|New label viewer]]
There is now support to see at what time a specific label was associated with a resource.

== Support to search for empty values in label columns ==
You can now search for the absence of values in your label columns in various places.

== Cybersecurity settings ==
For the WCU a bunch of cybersecurity settings are available.

* Disable USB ethernet interfaces
* Lock Signal Reader's Signal Broker communication to localhost
* Disable the SSH daemon
* Root password checks to prevent too weak passwords
* Software firewall on the WCU

== Instant downloads of multiple files ==
From version 2.94 the previous background zipping of files described in [[Downloading Files]] is no longer needed. Instead the downloading starts immediately when clicking the "Get all files" button in [[Tasks Tab]] or the "Download" button in the [[Search Tab]].

New features in v2.94

2025-06-16T07:11:07Z

Mathias: /* Cyber security settings */

== Support for labels in vehicle templates ==
As of version 2.94.0, the Vehicle Template panel supports adding labels to vehicle templates. Read more about it [https://wiki.alkit.se/wice294/index.php/Vehicle_templates here].

== Extend WCU history to account for more changes ==
Two new columns have been added to the WCU history: '''"Type of Change"''' and '''"State"'''.

* '''Type of Change''' indicates whether the update involved a configuration change, a tools change, or a label change.
* '''State''' reflects the WCU’s status at the time of the change, such as "In Operation".

You can read more about these updates [https://wiki.alkit.se/wice294/index.php/Vehicles#Right_click_context_menu here].

== Configurable tester address for signal reader, IDC, SoH and vinreader ==
The SignalReader, IDC, State of Health, and VINReader modules have all been updated to include a new field called 'Tester Address.' In the VINReader module, this field is visible only when the ID reader method is set to SPA 29. Additionally, the Tester Address field is available only with WCU version 2.94.0 or later. Read more about it [https://wiki.alkit.se/wice294/index.php/The_Portal_Administrator_View#Configure_the_Vinreader_Module here]

== Fetch PINs from PIE ==
[[File:Fetch PINs button.png|thumb|Button to fetch PINs from PIE]]
As of version 2.94.0 for portals with Vehicle Communication Forwarder (VCF) enabled, it will now be possible to get PINs from PIE for the WCUs in a group via ''Administration''->''Resource groups''. This will save any found PINs that can then be applied to the VCF's configuration for each WCU in the group. Read more about configuring VCF [[Vehicle Communication Forwarder|here]].

== New column for WCU state in Vehicles Tab ==
A new column has been introduced to the Vehicles tab that will show the current state of the WCU.

== Support for SOVD IP Address in the WCU configuration ==
As of version 2.94.0, you can enter either an IPv4 address or a physical ID in the 'SOVD IP Address' field located under the Connection tab in the WCU configuration settings. This field is only visible when the WCU is running version 2.94.0 or later. This is only enabled for customers needing support for the function.

== Support to update a subset of WCU configuration variables ==
[[File:UpdateSubSetOfWCUConfigruationVariable.png|thumb|Update a subset of WCU configuration variables window]]
You can now edit the configuration of multiple WCUs simultaneously. When doing so, the same configuration editor will appear, but with a few new additions. A new '''"Show Changed Settings"''' button allows you to easily track any modifications you've made. Additionally, a new dropdown menu labeled '''"Settings from WCU"''' lets you select which WCU’s configuration you want to edit from. More importantly, only the configuration settings changed will be applied to the WCUs, all other configuration settings will be untouched.

== Support for new platform Kvaser Edge ==
There is support for a new WCU platform called Kvaser Edge.

== Support for admins to download description files. ==
[[File:New-dowload-desc-files.png|thumb|Download description file|200x200px|none]]
If you are an admin and the function is turned on, you have the opportunity to download the vehicle description files found in the Administration->Vehicle Profiles panel.

== New alarm when a shelved WCU tries to connect with a vehicle ==
An alarm is raised when a WCU is in any of its shelved states and tries to connect with a vehicle. The category is 'wcu::state::shelved::connect'.

== Support for show signal info for all signals in assignment editor ==

== Frame names in add signals for assignment editor ==
You can now view the frame name for both CAN and LIN signals directly within the "Add Signal" dialog for a recorder. Additionally, you can also bring out frame names for signals in the recorder by simple right clicks and select the column “Frame name”.

== Improved assignment editor permission ==
We've upgraded the assignment permission settings to give more control.

Previously, assignments could only be marked as private or public. Now, you can assign user-specific permissions to allowing selected users to access private, public, or both types of assignments. Read more [[Assignment Editor#Assignment permissions|here]].

== Improved handling of copy assignment ==
We’ve improved the Signal Reader Assignment copy functionality in the Assignment Creator.

The new version ensures a more reliable experience when duplicating assignments and preventing the process from getting stuck.

== Support to see when a label was associated with a resource ==
[[File:New label viewer.png|thumb|101x101px|New label viewer]]
There is now support to see at what time a specific label was associated with a resource.

== Support to search for empty values in label columns ==
You can now search for the absence of values in your label columns in various places.

== Cybersecurity settings ==
For the WCU a bunch of cybersecurity settings are available.

* Disable USB ethernet interfaces
* Lock signal reader pub/sub communication to localhost
* Disable the SSH daemon
* Root password checks to prevent too weak passwords

== Instant downloads of multiple files ==
From version 2.94 the previous background zipping of files described in [[Downloading Files]] is no longer needed. Instead the downloading starts immediately when clicking the "Get all files" button in [[Tasks Tab]] or the "Download" button in the [[Search Tab]].

New features in v2.94

2025-06-16T07:10:44Z

Mathias: /* Support for new platform Kvaser Edge */

== Support for labels in vehicle templates ==
As of version 2.94.0, the Vehicle Template panel supports adding labels to vehicle templates. Read more about it [https://wiki.alkit.se/wice294/index.php/Vehicle_templates here].

== Extend WCU history to account for more changes ==
Two new columns have been added to the WCU history: '''"Type of Change"''' and '''"State"'''.

* '''Type of Change''' indicates whether the update involved a configuration change, a tools change, or a label change.
* '''State''' reflects the WCU’s status at the time of the change, such as "In Operation".

You can read more about these updates [https://wiki.alkit.se/wice294/index.php/Vehicles#Right_click_context_menu here].

== Configurable tester address for signal reader, IDC, SoH and vinreader ==
The SignalReader, IDC, State of Health, and VINReader modules have all been updated to include a new field called 'Tester Address.' In the VINReader module, this field is visible only when the ID reader method is set to SPA 29. Additionally, the Tester Address field is available only with WCU version 2.94.0 or later. Read more about it [https://wiki.alkit.se/wice294/index.php/The_Portal_Administrator_View#Configure_the_Vinreader_Module here]

== Fetch PINs from PIE ==
[[File:Fetch PINs button.png|thumb|Button to fetch PINs from PIE]]
As of version 2.94.0 for portals with Vehicle Communication Forwarder (VCF) enabled, it will now be possible to get PINs from PIE for the WCUs in a group via ''Administration''->''Resource groups''. This will save any found PINs that can then be applied to the VCF's configuration for each WCU in the group. Read more about configuring VCF [[Vehicle Communication Forwarder|here]].

== New column for WCU state in Vehicles Tab ==
A new column has been introduced to the Vehicles tab that will show the current state of the WCU.

== Support for SOVD IP Address in the WCU configuration ==
As of version 2.94.0, you can enter either an IPv4 address or a physical ID in the 'SOVD IP Address' field located under the Connection tab in the WCU configuration settings. This field is only visible when the WCU is running version 2.94.0 or later. This is only enabled for customers needing support for the function.

== Support to update a subset of WCU configuration variables ==
[[File:UpdateSubSetOfWCUConfigruationVariable.png|thumb|Update a subset of WCU configuration variables window]]
You can now edit the configuration of multiple WCUs simultaneously. When doing so, the same configuration editor will appear, but with a few new additions. A new '''"Show Changed Settings"''' button allows you to easily track any modifications you've made. Additionally, a new dropdown menu labeled '''"Settings from WCU"''' lets you select which WCU’s configuration you want to edit from. More importantly, only the configuration settings changed will be applied to the WCUs, all other configuration settings will be untouched.

== Support for new platform Kvaser Edge ==
There is support for a new WCU platform called Kvaser Edge.

== Support for admins to download description files. ==
[[File:New-dowload-desc-files.png|thumb|Download description file|200x200px|none]]
If you are an admin and the function is turned on, you have the opportunity to download the vehicle description files found in the Administration->Vehicle Profiles panel.

== New alarm when a shelved WCU tries to connect with a vehicle ==
An alarm is raised when a WCU is in any of its shelved states and tries to connect with a vehicle. The category is 'wcu::state::shelved::connect'.

== Support for show signal info for all signals in assignment editor ==

== Frame names in add signals for assignment editor ==
You can now view the frame name for both CAN and LIN signals directly within the "Add Signal" dialog for a recorder. Additionally, you can also bring out frame names for signals in the recorder by simple right clicks and select the column “Frame name”.

== Improved assignment editor permission ==
We've upgraded the assignment permission settings to give more control.

Previously, assignments could only be marked as private or public. Now, you can assign user-specific permissions to allowing selected users to access private, public, or both types of assignments. Read more [[Assignment Editor#Assignment permissions|here]].

== Improved handling of copy assignment ==
We’ve improved the Signal Reader Assignment copy functionality in the Assignment Creator.

The new version ensures a more reliable experience when duplicating assignments and preventing the process from getting stuck.

== Support to see when a label was associated with a resource ==
[[File:New label viewer.png|thumb|101x101px|New label viewer]]
There is now support to see at what time a specific label was associated with a resource.

== Support to search for empty values in label columns ==
You can now search for the absence of values in your label columns in various places.

== Cyber security settings ==
For the WCU a bunch of cyber security settings are available.

* Disable USB ethernet interfaces
* Lock signal reader pub/sub communication to localhost
* Disable the SSH daemon
* Root password checks to prevent too weak passwords

== Instant downloads of multiple files ==
From version 2.94 the previous background zipping of files described in [[Downloading Files]] is no longer needed. Instead the downloading starts immediately when clicking the "Get all files" button in [[Tasks Tab]] or the "Download" button in the [[Search Tab]].

WCU platform

2025-04-25T07:56:23Z

Mathias: /* WCU Hardware Platform */

The Wireless Communication Unit (WCU) is the in-vehicle unit running the WICE WCU software and communicating with the vehicle and the WICE back-end.

WCU:s are identified by a unique text string, which by convention is the MAC address of (one of) the ethernet interfaces in the unit. The WCU id is configured on each WCU (automatically from the MAC address) and is a search parameter available in the WICE Portal web-GUI.

=== WCU Hardware Platform ===
The following hardware platforms are supported for the WICE WCU:

* Host Mobility MX-4 (T20, T30, T30FR and V61)
* SETEK HMX
* Raspberry Pi
* Nvidia Jetson Xavier

Depending on the specific hardware platform, the WCU supports a number of communication interfaces, such as CAN, LIN, FlexRay and Ethernet and that be configured in different ways using the WICE Portal.

The WCU has the following communication interfaces (some of which are optional):

* a point-to-point (ppp) interface using a 2G/3G/4G mobile data modem
* optionally, a WiFi wireless LAN interface
* one to four wired ethernet interfaces.
* two to six Controller Area Network (CAN) interfaces
* optionally a FlexRay interface
* optionally, one or more LIN interfaces
* one to two USB interfaces.

The unit has the following storage mechanisms:

* internal flash memory for persistent storage
* removable SD card for temporary storage

The unit has the following power modes:

* running (full functionality available)
* sleep (suspended state)
* deep sleep (low-power suspended state)

The WCU platform can also support some limited user-interaction through light-emitting diodes (LED) on the side of the unit. A description of the LEDs is available [[WCU LEDs|here]].

=== WCU Firmware ===
The WCU firmware is the operating system, device drivers and basic packages required to run the system. The WCU units are delivered with the firmware installed. It can be remotely upgraded from the WICE Portal in a similar way as the WCU Software (see below).

=== WCU Software ===
The WCU software is delivered as a self-extracting application installation package, which can be run on the WCU:s manually from a command prompt, using a suitably prepared USB stick, or updated remotely using the WICE Portal mechanism for remote software upgrades.

The WICE solution for remote update of the WCU software works as follows: The Alkit staff member responsible for the WCU software deployment publishes installation packages for supported versions of the WCU software at the WICE Portal, in the WICE back-end server infrastructure. WICE administrators can then select which version of the available WCU software versions should be run on each of the WCUs that are registered in the system (see [[The Portal Administrator View#Edit the WCU Configuration|Edit WCU Configuration]]). This is done by choosing a particular version in a drop-down menu in the WICE Portal in the WCU configuration view. Many WCUs can be configured at the same time.
Then, whenever a WCU connects to the back-end, a check is made to see whether a different WCU software version (higher or lower version) than the currently installed version for the WCU in question is configured. If so, the installation package is downloaded to the WCU’s solid-state storage over the secure TLS connection that was established when the WCU connected. When the download is finished, the WCU software package will be installed on the WCU. After the installation has finished, the WCU will report back to the WICE back-end infrastructure with the new version of the WCU, so that WICE administrators can keep track of the currently installed software version, as well as the history of software changes.
A similar process is performed to update the WCU firmware and operating system. When new firmware is installed, the partition where the certificate and configuration files reside is left unaltered.

The WCU software release history is available [[https://wice-sysdoc.alkit.se/index.php/WICE_WCU_Software_Revision_History here]].

==== Extra Bundles ====
Some WICE software packages, referred to as 'extra bundles' are not installed by default. The user needs to select which, if any, extra bundles should be installed on a particular WCU. This is done in the WICE Portal, Edit Configuration. [[Extra bundles|For more information about Extra bundles, click here]].

=== WCU Modules ===
The WCU Modules are the software components of the WCU producing
measurement data. They are configured through the Configuration Manager, which communicates with the WICE Portal, where the user can access and change the overall WCU configuration and the per-module configurations.

The data capture behavior of the WCU modules is described by a measurement task, downloaded from the WICE Portal by the Task Manager component, which sets up the modules.

The available WCU modules are:
* Arcos
* Area5
* Audio
* Blue piraT
* Canrecorder
* DLT
* DoIP
* ETAS
* Ethernet capture
* File fetcher
* GPS
* IDC
* IPEmotion RT
* LPD
* M-Log
* MQTT
* Rapid Prototyping
* Signal Reader
* State-of-Health
* SWDL
* Video
* WCU internals and status

==== Arcos module ====
The Arcos module makes it possible to use an Arcos data logger (from Ipetronik) connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the Arcos and data can be offloaded and uploaded to the portal.

==== Area5 module ====
The Area5 module is used to read out ECU memory segments using CCP or XCP. The binary data of the memory segments are uploaded to the back-end where they are translated into parameter sets and signals.

==== Audio module ====
The audio module makes it possible to record sound clips from microphones connected to the audio devices of WCUs. Audio can also be streamed in real time from WCUs for live audio monitoring purposes.
The recording of audio can be triggered by a push button connected to the WCU, or from the Signal Reader module by specifying a recorder name or a trigger expression. In the latter case, when the corresponding Signal Reader recorder is started or when the trigger condition is fulfilled the audio recording starts, and when the recorder stops, the audio recording does as well. Pre-trig buffering is supported.
Audio sample rate, number of channels (mono or stereo) and compression format can be specified in the module configuration.

==== Blue piraT Module ====
The Blue piraT module makes it possible to use a Blue piraT logger connected to the WCU through an Ethernet port.
Measurement configuration can be downloaded to the logger and measurement data can be offloaded and uploaded to the WICE Portal.

==== CAN Recorder Module ====
The CAN Recorder Module supports frame logging on the CAN-buses the WCU is connected to. Filters for the ECU identifiers to log can be
defined in the WICE Portal interface when creating a CAN Recorder measurement task.

==== DLT module ====
The DLT module supports read-out of Diagnostic Log Trace files. The read-out can be done either using an in-vehicle DLT daemon, or using UDS Service 38 file transfer. See [[DLT Module|DLT module]].

==== DoIP module ====
The DoIP module makes it possible to establish a tunnel over the Internet to a WCU for synchronous communication using the DoIP protocol.
In the WCU, the remote DoIP functionality is based on the DoIP daemon '''doipd''', which relays DoIP communication between vehicle and the back-end.
It also takes care of waking up the vehicle when communication requests are pending. For more information see [[Remote Diagnostics over IP (DoIP)|Remote Diagnostics over IP (DoIP)]].

==== Ethernet Capture Module ====
The Ethernet Capture module supports logging of ethernet frames on one of the WCU's ethernet interfaces. Filters can be set (in tcpdump format) for selecting which frames to capture. The result is logged in a pcap file, which is uploaded to the WICE Portal.

==== ETAS Module ====
The ETAS module makes it possible to use an ETAS ES720 measurement system connected to the WCU through an Ethernet port.
Measurement tasks can be downloaded to the ES720 and measurement data can be offloaded and uploaded to the WICE Portal.

==== File Fetcher Module ====
The File Fetcher module supports uploading of files collected from a unit connected to the WCU.

==== GPS Module ====
The GPS Module reads the position of a WCU at regular intervals and
reports to the WICE Portal, to support map-based localization of vehicles for the fleet-management service and for the "Plot Route" function of the metrology service.

==== IDC module ====
The IDC module allows a sequence of diagnostic requests to be sent on the
in-vehicle network (either CAN or Ethernet), and the responses are collected in a result file. IDC can also read OBD-II PIDs and interpret the responses.
IDC supports diagnostics over CAN using ISO15765-2 and over IP/Ethernet using ISO13400. Both physical and functional ECU addressing is supported.
An IDC sequence file can in addition to diagnostic requests also contain commands, as described in [[IDC sequence file commands]].

==== IPEmotion RT ====
The IPEmotion RT module makes it possible to use an IPEmotion RT data logger (from Ipetronik) connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the logger and data can be offloaded and uploaded to the portal.

==== LPD module ====
The LPD module supports long term driveline testing using a custom built Android app that connects to the WICE WCU.

==== M-Log module ====
The M-log module makes it possible to use an M-Log data logger connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the M-Log and data can be offloaded and uploaded to the portal.

==== MQTT module ====
The MQTT module makes it possible to collect data from another system using an MQTT broker and specifying MQTT topics.

==== Rapid Prototyping module ====
With the Rapid Prototyping (RP) module, custom software components can be run on the WCU for proof-of-concept testing of new in-vehicle functionality. A Signal Broker API (provided by the Signal Reader module, see below) can be used to easily access in-vehicle signals and parameters. Output data from the RP module is uploaded to the WICE back-end where it is made available in the WICE Portal. The RP module supports both native applications, compiled for the WCU processor architecture, and Node.js applications written in Javascript. The latter is particularly useful for providing in-vehicle GUI functionality.

For more information see [[WICE_RP_How-To]].

==== Signal Reader Module ====
The Signal Reader module executes a measurement task, monitors and logs time-series signal data and stores the data in an MDF file (Measurement Data
Format). Signals can be recorded from the vehicle's internal communication buses (e.g. CAN, LIN, FlexRay). A number of signals internal to the WCU are also available: [[WICE Internal Signals|WICE Internal Signals]]

Signal Reader also supports logging of signals using CCP, XCP and UDS diagnostics. This is sometimes referred to as Active signals.

Triggers are supported, switching between measurement set-ups and starting and stopping recorders. Trigger expression syntax is described [[Signal Reader Trigger Expressions|here]]. Pre- and post-trig recording can be specified, which results in signal data being recorded prior to or subsequent to a trigger condition respectively. Minimum and maximum shot lengths of recorders can also be specified.

==== State of Health Module ====
The State-of-Health (SoH) module is used to read out a limited data set
from test vehicles to monitor their operational status. The specific data to be read is configurable from the WICE portal and includes
position, mileage (odometer), battery voltage, ECU software numbers, Diagnostic Trouble Codes and uptime. The SoH module uses the IDC module to
service a sequence of diagnostic requests, created by the WICE Portal
based on which data is requested and the diagnostic database of the vehicle type. Position is accessed from the GPS Module (see below)
and uptime is accessed from the WCU internal module (see below).

==== SWDL module ====
The Software Download (SWDL) module makes it possible to download ECU software to connected vehicles for re-programming. The input to the SWDL module is a number of VBF (Versatile Binary Format) files containing the ECU software, and PIN codes for the ECUs to be reprogrammed. Sequence files can also be supplied for pre- and post-programming diagnostics.

==== Video module ====
The video module makes it possible to record video clips from cameras connected to the WCU. Video can also be streamed in real time from WCUs for live video monitoring purposes.
The recording of video can be triggered by a push-button connected to the WCU, or from the Signal Reader module by specifying a recorder name or a trigger expression. In the latter case, when the corresponding Signal Reader recorder is started (i.e. when a trigger condition is fulfilled) the video recording starts, and when the recorder stops, the video recording does as well. Pre-trig buffering is supported.
Video resolution, frame rate and compression format can be specified in the module configuration.

==== WCU internals Module ====
The WCU internals Module logs useful information about a WCU, including
uptime, battery voltage (on the WCU power input), and memory usage.

==== WCU Status Module ====
The WCU status Daemon, statusd,
monitors the status of the WCU, including all the modules, and
reports to the WICE Portal. The daemon also provides a common i/o API
for all modules, including GPS and digital i/o.

=== Power Management ===
The Power Management settings of the WCU determines how and when the unit is started and shut down. What Power Management mechanisms are available depends on the WCU hardware platform. The following refers to the MX4 platform.
The MX4 unit can be started and stopped based on the ''ignition'' input pin or on the availability or absence of CAN traffic on any of the CAN interfaces. The WCU can also be configured to start after a specific time interval from shut-down. The configuration is done in the [[The Portal Administrator View#Power Management| WCU Configuration]] in the WICE Portal.
Note that the behaviour of the ignition pin depends on the setting of the START switch on the back of the WCU. If the switch is set to INT the pin will always be active, so that if the WCU is set to''Wake on ignition'' it will be always on. If the switch is set to EXT, the pin will reflect the current state of the ignition of the vehicle (providing it is correctly installed).

New features in v2.93

2025-03-06T11:48:22Z

Mathias:

== Support for using labels to control permissions ==
It is now possible to select resources by labels as an alternative to select resources manually when selecting resources for a permission in [[Roles and permissions]].
[[File:Labels in permissions1.png|thumb]]
[[File:Permission label2.png|thumb|Select resources by labels]]
When a label is selected as in the screenshot to the right, the WCUs which are currently associated with the label are added to the set of selected resources. Multiple labels can also be used to either collect more resources or narrow down the resources depending on the chosen relation between the labels.

After the permission has been saved, any additional resources which get associated with the labels used in the permission will automatically be added to the permission. Since these labels now controls one or many permissions, only the users with the role admin can add or remove the labels from resources as long as they are part of any permission.

== Support for impersonating another user ==
[[File:Impersonate user.png|thumb|Impersonate user]]
An admin user can impersonate another user by selecting a user in the [[The Portal Administrator View#The_User_Tab]] and click the new button "Impersonate" as can be seen in the screenshot "Impersonate user".
[[File:Impersonating user.png|thumb|Impersonating user]]
When the button has been clicked, the portal will be reloaded and once logged in again you are now impersonating the selected user. See screenshot "Impersonating user".

To stop impersonating, one can either click the new "Stop impersonating user" icon next to the red text "Impersonating user" or click the logout icon in the upper right corner of the portal.

== Platform types in WMUs ==
[[File:Selected platform for new WMU.png|thumb|Select platform for new WMU]]
When adding a new WMU via the portal GUI it is now mandatory to select the platform for the new WMU as can be seen in the screenshot "Select platform for new WMU".

If the WMU is running WMU version 3.0.0 or above it will also report its platform back to the portal. In the case the reported platform does not match the selected platform a warning will be shown and the selected platform must be changed to the reported before the WCU configuration can be saved.
[[File:Reported WMU platform does not match selected2.png|thumb|Reported WMU platform does not match selected]]
See screenshot "Reported WMU platform does not match selected.

== Support for moving a vehicle to a resource group when applying a vehicle template ==
It is now possible to move a vehicle into a resource group with the help of vehicle templates. For more detailed information on how to use this feature, you can read more [https://wiki.alkit.se/wice293/index.php/Vehicle_templates here].

== Support for MDF file recovery after a WCU crash ==
[[File:ApplyFileToAllVehicles.png|thumb|Apply File To all Vehicles]]
From version 2.93, the WCU can recover Signal Reader measurement data after a crash or similar unexpected shut-down. To enable this, there is a new checkbox called 'Recover MDF files after unexpected shutdowns' in theSignal Reader module settings. If the checkbox is checked and the WCU crashes, MDF signal data will be recovered from the temporary signal data storage on the WCU the next time the WCU is started. The recovered MDF file is uploaded to the WICE back-end. Pre-trig logging is not possible to recover.

WCU platform

2025-03-06T11:34:51Z

Mathias: /* DLT module */

The Wireless Communication Unit (WCU) is the in-vehicle unit running the WICE WCU software and communicating with the vehicle and the WICE back-end.

WCU:s are identified by a unique text string, which by convention is the MAC address of (one of) the ethernet interfaces in the unit. The WCU id is configured on each WCU (automatically from the MAC address) and is a search parameter available in the WICE Portal web-GUI.

=== WCU Hardware Platform ===
The following hardware platforms are supported for the WICE WCU:

* Host Mobility MX-4 (T20, T30, T30FR and V61)
* Fältcom MIIPS Committo
* Raspberry Pi
* Nvidia Jetson Xavier

Depending on the specific hardware platform, the WCU supports a number of communication interfaces, such as CAN, LIN, FlexRay and Ethernet and that be configured in different ways using the WICE Portal.

The WCU has the following communication interfaces (some of which are optional):

* a point-to-point (ppp) interface using a 2G/3G/4G mobile data modem
* optionally, a WiFi wireless LAN interface
* one to four wired ethernet interfaces.
* two to six Controller Area Network (CAN) interfaces
* optionally a FlexRay interface
* optionally, one or more LIN interfaces
* one to two USB interfaces.

The unit has the following storage mechanisms:

* internal flash memory for persistent storage
* removable SD card for temporary storage

The unit has the following power modes:

* running (full functionality available)
* sleep (suspended state)
* deep sleep (low-power suspended state)

The WCU platform can also support some limited user-interaction through light-emitting diodes (LED) on the side of the unit. A description of the LEDs is available [[WCU LEDs|here]].

=== WCU Firmware ===
The WCU firmware is the operating system, device drivers and basic packages required to run the system. The WCU units are delivered with the firmware installed. It can be remotely upgraded from the WICE Portal in a similar way as the WCU Software (see below).

=== WCU Software ===
The WCU software is delivered as a self-extracting application installation package, which can be run on the WCU:s manually from a command prompt, using a suitably prepared USB stick, or updated remotely using the WICE Portal mechanism for remote software upgrades.

The WICE solution for remote update of the WCU software works as follows: The Alkit staff member responsible for the WCU software deployment publishes installation packages for supported versions of the WCU software at the WICE Portal, in the WICE back-end server infrastructure. WICE administrators can then select which version of the available WCU software versions should be run on each of the WCUs that are registered in the system (see [[The Portal Administrator View#Edit the WCU Configuration|Edit WCU Configuration]]). This is done by choosing a particular version in a drop-down menu in the WICE Portal in the WCU configuration view. Many WCUs can be configured at the same time.
Then, whenever a WCU connects to the back-end, a check is made to see whether a different WCU software version (higher or lower version) than the currently installed version for the WCU in question is configured. If so, the installation package is downloaded to the WCU’s solid-state storage over the secure TLS connection that was established when the WCU connected. When the download is finished, the WCU software package will be installed on the WCU. After the installation has finished, the WCU will report back to the WICE back-end infrastructure with the new version of the WCU, so that WICE administrators can keep track of the currently installed software version, as well as the history of software changes.
A similar process is performed to update the WCU firmware and operating system. When new firmware is installed, the partition where the certificate and configuration files reside is left unaltered.

The WCU software release history is available [[https://wice-sysdoc.alkit.se/index.php/WICE_WCU_Software_Revision_History here]].

==== Extra Bundles ====
Some WICE software packages, referred to as 'extra bundles' are not installed by default. The user needs to select which, if any, extra bundles should be installed on a particular WCU. This is done in the WICE Portal, Edit Configuration. [[Extra bundles|For more information about Extra bundles, click here]].

=== WCU Modules ===
The WCU Modules are the software components of the WCU producing
measurement data. They are configured through the Configuration Manager, which communicates with the WICE Portal, where the user can access and change the overall WCU configuration and the per-module configurations.

The data capture behavior of the WCU modules is described by a measurement task, downloaded from the WICE Portal by the Task Manager component, which sets up the modules.

The available WCU modules are:
* Arcos
* Area5
* Audio
* Blue piraT
* Canrecorder
* DLT
* DoIP
* ETAS
* Ethernet capture
* File fetcher
* GPS
* IDC
* IPEmotion RT
* LPD
* M-Log
* MQTT
* Rapid Prototyping
* Signal Reader
* State-of-Health
* SWDL
* Video
* WCU internals and status

==== Arcos module ====
The Arcos module makes it possible to use an Arcos data logger (from Ipetronik) connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the Arcos and data can be offloaded and uploaded to the portal.

==== Area5 module ====
The Area5 module is used to read out ECU memory segments using CCP or XCP. The binary data of the memory segments are uploaded to the back-end where they are translated into parameter sets and signals.

==== Audio module ====
The audio module makes it possible to record sound clips from microphones connected to the audio devices of WCUs. Audio can also be streamed in real time from WCUs for live audio monitoring purposes.
The recording of audio can be triggered by a push button connected to the WCU, or from the Signal Reader module by specifying a recorder name or a trigger expression. In the latter case, when the corresponding Signal Reader recorder is started or when the trigger condition is fulfilled the audio recording starts, and when the recorder stops, the audio recording does as well. Pre-trig buffering is supported.
Audio sample rate, number of channels (mono or stereo) and compression format can be specified in the module configuration.

==== Blue piraT Module ====
The Blue piraT module makes it possible to use a Blue piraT logger connected to the WCU through an Ethernet port.
Measurement configuration can be downloaded to the logger and measurement data can be offloaded and uploaded to the WICE Portal.

==== CAN Recorder Module ====
The CAN Recorder Module supports frame logging on the CAN-buses the WCU is connected to. Filters for the ECU identifiers to log can be
defined in the WICE Portal interface when creating a CAN Recorder measurement task.

==== DLT module ====
The DLT module supports read-out of Diagnostic Log Trace files. The read-out can be done either using an in-vehicle DLT daemon, or using UDS Service 38 file transfer. See [[DLT Module|DLT module]].

==== DoIP module ====
The DoIP module makes it possible to establish a tunnel over the Internet to a WCU for synchronous communication using the DoIP protocol.
In the WCU, the remote DoIP functionality is based on the DoIP daemon '''doipd''', which relays DoIP communication between vehicle and the back-end.
It also takes care of waking up the vehicle when communication requests are pending. For more information see [[Remote Diagnostics over IP (DoIP)|Remote Diagnostics over IP (DoIP)]].

==== Ethernet Capture Module ====
The Ethernet Capture module supports logging of ethernet frames on one of the WCU's ethernet interfaces. Filters can be set (in tcpdump format) for selecting which frames to capture. The result is logged in a pcap file, which is uploaded to the WICE Portal.

==== ETAS Module ====
The ETAS module makes it possible to use an ETAS ES720 measurement system connected to the WCU through an Ethernet port.
Measurement tasks can be downloaded to the ES720 and measurement data can be offloaded and uploaded to the WICE Portal.

==== File Fetcher Module ====
The File Fetcher module supports uploading of files collected from a unit connected to the WCU.

==== GPS Module ====
The GPS Module reads the position of a WCU at regular intervals and
reports to the WICE Portal, to support map-based localization of vehicles for the fleet-management service and for the "Plot Route" function of the metrology service.

==== IDC module ====
The IDC module allows a sequence of diagnostic requests to be sent on the
in-vehicle network (either CAN or Ethernet), and the responses are collected in a result file. IDC can also read OBD-II PIDs and interpret the responses.
IDC supports diagnostics over CAN using ISO15765-2 and over IP/Ethernet using ISO13400. Both physical and functional ECU addressing is supported.
An IDC sequence file can in addition to diagnostic requests also contain commands, as described in [[IDC sequence file commands]].

==== IPEmotion RT ====
The IPEmotion RT module makes it possible to use an IPEmotion RT data logger (from Ipetronik) connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the logger and data can be offloaded and uploaded to the portal.

==== LPD module ====
The LPD module supports long term driveline testing using a custom built Android app that connects to the WICE WCU.

==== M-Log module ====
The M-log module makes it possible to use an M-Log data logger connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the M-Log and data can be offloaded and uploaded to the portal.

==== MQTT module ====
The MQTT module makes it possible to collect data from another system using an MQTT broker and specifying MQTT topics.

==== Rapid Prototyping module ====
With the Rapid Prototyping (RP) module, custom software components can be run on the WCU for proof-of-concept testing of new in-vehicle functionality. A Signal Broker API (provided by the Signal Reader module, see below) can be used to easily access in-vehicle signals and parameters. Output data from the RP module is uploaded to the WICE back-end where it is made available in the WICE Portal. The RP module supports both native applications, compiled for the WCU processor architecture, and Node.js applications written in Javascript. The latter is particularly useful for providing in-vehicle GUI functionality.

For more information see [[WICE_RP_How-To]].

==== Signal Reader Module ====
The Signal Reader module executes a measurement task, monitors and logs time-series signal data and stores the data in an MDF file (Measurement Data
Format). Signals can be recorded from the vehicle's internal communication buses (e.g. CAN, LIN, FlexRay). A number of signals internal to the WCU are also available: [[WICE Internal Signals|WICE Internal Signals]]

Signal Reader also supports logging of signals using CCP, XCP and UDS diagnostics. This is sometimes referred to as Active signals.

Triggers are supported, switching between measurement set-ups and starting and stopping recorders. Trigger expression syntax is described [[Signal Reader Trigger Expressions|here]]. Pre- and post-trig recording can be specified, which results in signal data being recorded prior to or subsequent to a trigger condition respectively. Minimum and maximum shot lengths of recorders can also be specified.

==== State of Health Module ====
The State-of-Health (SoH) module is used to read out a limited data set
from test vehicles to monitor their operational status. The specific data to be read is configurable from the WICE portal and includes
position, mileage (odometer), battery voltage, ECU software numbers, Diagnostic Trouble Codes and uptime. The SoH module uses the IDC module to
service a sequence of diagnostic requests, created by the WICE Portal
based on which data is requested and the diagnostic database of the vehicle type. Position is accessed from the GPS Module (see below)
and uptime is accessed from the WCU internal module (see below).

==== SWDL module ====
The Software Download (SWDL) module makes it possible to download ECU software to connected vehicles for re-programming. The input to the SWDL module is a number of VBF (Versatile Binary Format) files containing the ECU software, and PIN codes for the ECUs to be reprogrammed. Sequence files can also be supplied for pre- and post-programming diagnostics.

==== Video module ====
The video module makes it possible to record video clips from cameras connected to the WCU. Video can also be streamed in real time from WCUs for live video monitoring purposes.
The recording of video can be triggered by a push-button connected to the WCU, or from the Signal Reader module by specifying a recorder name or a trigger expression. In the latter case, when the corresponding Signal Reader recorder is started (i.e. when a trigger condition is fulfilled) the video recording starts, and when the recorder stops, the video recording does as well. Pre-trig buffering is supported.
Video resolution, frame rate and compression format can be specified in the module configuration.

==== WCU internals Module ====
The WCU internals Module logs useful information about a WCU, including
uptime, battery voltage (on the WCU power input), and memory usage.

==== WCU Status Module ====
The WCU status Daemon, statusd,
monitors the status of the WCU, including all the modules, and
reports to the WICE Portal. The daemon also provides a common i/o API
for all modules, including GPS and digital i/o.

=== Power Management ===
The Power Management settings of the WCU determines how and when the unit is started and shut down. What Power Management mechanisms are available depends on the WCU hardware platform. The following refers to the MX4 platform.
The MX4 unit can be started and stopped based on the ''ignition'' input pin or on the availability or absence of CAN traffic on any of the CAN interfaces. The WCU can also be configured to start after a specific time interval from shut-down. The configuration is done in the [[The Portal Administrator View#Power Management| WCU Configuration]] in the WICE Portal.
Note that the behaviour of the ignition pin depends on the setting of the START switch on the back of the WCU. If the switch is set to INT the pin will always be active, so that if the WCU is set to''Wake on ignition'' it will be always on. If the switch is set to EXT, the pin will reflect the current state of the ignition of the vehicle (providing it is correctly installed).

WCU platform

2025-03-06T11:33:56Z

Mathias:

The Wireless Communication Unit (WCU) is the in-vehicle unit running the WICE WCU software and communicating with the vehicle and the WICE back-end.

WCU:s are identified by a unique text string, which by convention is the MAC address of (one of) the ethernet interfaces in the unit. The WCU id is configured on each WCU (automatically from the MAC address) and is a search parameter available in the WICE Portal web-GUI.

=== WCU Hardware Platform ===
The following hardware platforms are supported for the WICE WCU:

* Host Mobility MX-4 (T20, T30, T30FR and V61)
* Fältcom MIIPS Committo
* Raspberry Pi
* Nvidia Jetson Xavier

Depending on the specific hardware platform, the WCU supports a number of communication interfaces, such as CAN, LIN, FlexRay and Ethernet and that be configured in different ways using the WICE Portal.

The WCU has the following communication interfaces (some of which are optional):

* a point-to-point (ppp) interface using a 2G/3G/4G mobile data modem
* optionally, a WiFi wireless LAN interface
* one to four wired ethernet interfaces.
* two to six Controller Area Network (CAN) interfaces
* optionally a FlexRay interface
* optionally, one or more LIN interfaces
* one to two USB interfaces.

The unit has the following storage mechanisms:

* internal flash memory for persistent storage
* removable SD card for temporary storage

The unit has the following power modes:

* running (full functionality available)
* sleep (suspended state)
* deep sleep (low-power suspended state)

The WCU platform can also support some limited user-interaction through light-emitting diodes (LED) on the side of the unit. A description of the LEDs is available [[WCU LEDs|here]].

=== WCU Firmware ===
The WCU firmware is the operating system, device drivers and basic packages required to run the system. The WCU units are delivered with the firmware installed. It can be remotely upgraded from the WICE Portal in a similar way as the WCU Software (see below).

=== WCU Software ===
The WCU software is delivered as a self-extracting application installation package, which can be run on the WCU:s manually from a command prompt, using a suitably prepared USB stick, or updated remotely using the WICE Portal mechanism for remote software upgrades.

The WICE solution for remote update of the WCU software works as follows: The Alkit staff member responsible for the WCU software deployment publishes installation packages for supported versions of the WCU software at the WICE Portal, in the WICE back-end server infrastructure. WICE administrators can then select which version of the available WCU software versions should be run on each of the WCUs that are registered in the system (see [[The Portal Administrator View#Edit the WCU Configuration|Edit WCU Configuration]]). This is done by choosing a particular version in a drop-down menu in the WICE Portal in the WCU configuration view. Many WCUs can be configured at the same time.
Then, whenever a WCU connects to the back-end, a check is made to see whether a different WCU software version (higher or lower version) than the currently installed version for the WCU in question is configured. If so, the installation package is downloaded to the WCU’s solid-state storage over the secure TLS connection that was established when the WCU connected. When the download is finished, the WCU software package will be installed on the WCU. After the installation has finished, the WCU will report back to the WICE back-end infrastructure with the new version of the WCU, so that WICE administrators can keep track of the currently installed software version, as well as the history of software changes.
A similar process is performed to update the WCU firmware and operating system. When new firmware is installed, the partition where the certificate and configuration files reside is left unaltered.

The WCU software release history is available [[https://wice-sysdoc.alkit.se/index.php/WICE_WCU_Software_Revision_History here]].

==== Extra Bundles ====
Some WICE software packages, referred to as 'extra bundles' are not installed by default. The user needs to select which, if any, extra bundles should be installed on a particular WCU. This is done in the WICE Portal, Edit Configuration. [[Extra bundles|For more information about Extra bundles, click here]].

=== WCU Modules ===
The WCU Modules are the software components of the WCU producing
measurement data. They are configured through the Configuration Manager, which communicates with the WICE Portal, where the user can access and change the overall WCU configuration and the per-module configurations.

The data capture behavior of the WCU modules is described by a measurement task, downloaded from the WICE Portal by the Task Manager component, which sets up the modules.

The available WCU modules are:
* Arcos
* Area5
* Audio
* Blue piraT
* Canrecorder
* DLT
* DoIP
* ETAS
* Ethernet capture
* File fetcher
* GPS
* IDC
* IPEmotion RT
* LPD
* M-Log
* MQTT
* Rapid Prototyping
* Signal Reader
* State-of-Health
* SWDL
* Video
* WCU internals and status

==== Arcos module ====
The Arcos module makes it possible to use an Arcos data logger (from Ipetronik) connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the Arcos and data can be offloaded and uploaded to the portal.

==== Area5 module ====
The Area5 module is used to read out ECU memory segments using CCP or XCP. The binary data of the memory segments are uploaded to the back-end where they are translated into parameter sets and signals.

==== Audio module ====
The audio module makes it possible to record sound clips from microphones connected to the audio devices of WCUs. Audio can also be streamed in real time from WCUs for live audio monitoring purposes.
The recording of audio can be triggered by a push button connected to the WCU, or from the Signal Reader module by specifying a recorder name or a trigger expression. In the latter case, when the corresponding Signal Reader recorder is started or when the trigger condition is fulfilled the audio recording starts, and when the recorder stops, the audio recording does as well. Pre-trig buffering is supported.
Audio sample rate, number of channels (mono or stereo) and compression format can be specified in the module configuration.

==== Blue piraT Module ====
The Blue piraT module makes it possible to use a Blue piraT logger connected to the WCU through an Ethernet port.
Measurement configuration can be downloaded to the logger and measurement data can be offloaded and uploaded to the WICE Portal.

==== CAN Recorder Module ====
The CAN Recorder Module supports frame logging on the CAN-buses the WCU is connected to. Filters for the ECU identifiers to log can be
defined in the WICE Portal interface when creating a CAN Recorder measurement task.

==== DLT module ====
The DLT module supports read-out of Diagnostic Log Trace files. See [[DLT Module|DLT module]].

==== DoIP module ====
The DoIP module makes it possible to establish a tunnel over the Internet to a WCU for synchronous communication using the DoIP protocol.
In the WCU, the remote DoIP functionality is based on the DoIP daemon '''doipd''', which relays DoIP communication between vehicle and the back-end.
It also takes care of waking up the vehicle when communication requests are pending. For more information see [[Remote Diagnostics over IP (DoIP)|Remote Diagnostics over IP (DoIP)]].

==== Ethernet Capture Module ====
The Ethernet Capture module supports logging of ethernet frames on one of the WCU's ethernet interfaces. Filters can be set (in tcpdump format) for selecting which frames to capture. The result is logged in a pcap file, which is uploaded to the WICE Portal.

==== ETAS Module ====
The ETAS module makes it possible to use an ETAS ES720 measurement system connected to the WCU through an Ethernet port.
Measurement tasks can be downloaded to the ES720 and measurement data can be offloaded and uploaded to the WICE Portal.

==== File Fetcher Module ====
The File Fetcher module supports uploading of files collected from a unit connected to the WCU.

==== GPS Module ====
The GPS Module reads the position of a WCU at regular intervals and
reports to the WICE Portal, to support map-based localization of vehicles for the fleet-management service and for the "Plot Route" function of the metrology service.

==== IDC module ====
The IDC module allows a sequence of diagnostic requests to be sent on the
in-vehicle network (either CAN or Ethernet), and the responses are collected in a result file. IDC can also read OBD-II PIDs and interpret the responses.
IDC supports diagnostics over CAN using ISO15765-2 and over IP/Ethernet using ISO13400. Both physical and functional ECU addressing is supported.
An IDC sequence file can in addition to diagnostic requests also contain commands, as described in [[IDC sequence file commands]].

==== IPEmotion RT ====
The IPEmotion RT module makes it possible to use an IPEmotion RT data logger (from Ipetronik) connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the logger and data can be offloaded and uploaded to the portal.

==== LPD module ====
The LPD module supports long term driveline testing using a custom built Android app that connects to the WICE WCU.

==== M-Log module ====
The M-log module makes it possible to use an M-Log data logger connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the M-Log and data can be offloaded and uploaded to the portal.

==== MQTT module ====
The MQTT module makes it possible to collect data from another system using an MQTT broker and specifying MQTT topics.

==== Rapid Prototyping module ====
With the Rapid Prototyping (RP) module, custom software components can be run on the WCU for proof-of-concept testing of new in-vehicle functionality. A Signal Broker API (provided by the Signal Reader module, see below) can be used to easily access in-vehicle signals and parameters. Output data from the RP module is uploaded to the WICE back-end where it is made available in the WICE Portal. The RP module supports both native applications, compiled for the WCU processor architecture, and Node.js applications written in Javascript. The latter is particularly useful for providing in-vehicle GUI functionality.

For more information see [[WICE_RP_How-To]].

==== Signal Reader Module ====
The Signal Reader module executes a measurement task, monitors and logs time-series signal data and stores the data in an MDF file (Measurement Data
Format). Signals can be recorded from the vehicle's internal communication buses (e.g. CAN, LIN, FlexRay). A number of signals internal to the WCU are also available: [[WICE Internal Signals|WICE Internal Signals]]

Signal Reader also supports logging of signals using CCP, XCP and UDS diagnostics. This is sometimes referred to as Active signals.

Triggers are supported, switching between measurement set-ups and starting and stopping recorders. Trigger expression syntax is described [[Signal Reader Trigger Expressions|here]]. Pre- and post-trig recording can be specified, which results in signal data being recorded prior to or subsequent to a trigger condition respectively. Minimum and maximum shot lengths of recorders can also be specified.

==== State of Health Module ====
The State-of-Health (SoH) module is used to read out a limited data set
from test vehicles to monitor their operational status. The specific data to be read is configurable from the WICE portal and includes
position, mileage (odometer), battery voltage, ECU software numbers, Diagnostic Trouble Codes and uptime. The SoH module uses the IDC module to
service a sequence of diagnostic requests, created by the WICE Portal
based on which data is requested and the diagnostic database of the vehicle type. Position is accessed from the GPS Module (see below)
and uptime is accessed from the WCU internal module (see below).

==== SWDL module ====
The Software Download (SWDL) module makes it possible to download ECU software to connected vehicles for re-programming. The input to the SWDL module is a number of VBF (Versatile Binary Format) files containing the ECU software, and PIN codes for the ECUs to be reprogrammed. Sequence files can also be supplied for pre- and post-programming diagnostics.

==== Video module ====
The video module makes it possible to record video clips from cameras connected to the WCU. Video can also be streamed in real time from WCUs for live video monitoring purposes.
The recording of video can be triggered by a push-button connected to the WCU, or from the Signal Reader module by specifying a recorder name or a trigger expression. In the latter case, when the corresponding Signal Reader recorder is started (i.e. when a trigger condition is fulfilled) the video recording starts, and when the recorder stops, the video recording does as well. Pre-trig buffering is supported.
Video resolution, frame rate and compression format can be specified in the module configuration.

==== WCU internals Module ====
The WCU internals Module logs useful information about a WCU, including
uptime, battery voltage (on the WCU power input), and memory usage.

==== WCU Status Module ====
The WCU status Daemon, statusd,
monitors the status of the WCU, including all the modules, and
reports to the WICE Portal. The daemon also provides a common i/o API
for all modules, including GPS and digital i/o.

=== Power Management ===
The Power Management settings of the WCU determines how and when the unit is started and shut down. What Power Management mechanisms are available depends on the WCU hardware platform. The following refers to the MX4 platform.
The MX4 unit can be started and stopped based on the ''ignition'' input pin or on the availability or absence of CAN traffic on any of the CAN interfaces. The WCU can also be configured to start after a specific time interval from shut-down. The configuration is done in the [[The Portal Administrator View#Power Management| WCU Configuration]] in the WICE Portal.
Note that the behaviour of the ignition pin depends on the setting of the START switch on the back of the WCU. If the switch is set to INT the pin will always be active, so that if the WCU is set to''Wake on ignition'' it will be always on. If the switch is set to EXT, the pin will reflect the current state of the ignition of the vehicle (providing it is correctly installed).

WICE Cybersecurity

2025-02-19T11:38:58Z

Mathias: Created page with "WICE has a large number of cybersecurity mechanisms implemented in response to threats. Threats are identified in a TARA procedure and potential weaknesses in WICE are addressed. Alkit maintains a publicly accessible Vulnerability disclosure programme that allows for the disclosure of Vulnerabilities discovered by researchers and other external actors or entities. Contact [https://www.alkit.se/index.php/contacts Alkit Communications] to receive information required to u..."

WICE has a large number of cybersecurity mechanisms implemented in response to threats. Threats are identified in a TARA procedure and potential weaknesses in WICE are addressed.

Alkit maintains a publicly accessible Vulnerability disclosure programme that allows for the disclosure of Vulnerabilities discovered by researchers and other external actors or entities. Contact [https://www.alkit.se/index.php/contacts Alkit Communications] to receive information required to utilise the disclosure programme.

=== WICE Cybersecurity Approach ===
The high level approach is to secure the back-end and the WCUs and provide a secure channel between them to ensure confidentiality and integrity of the system.

=== Access control mechanism ===
The WICE system has a comprehensive Access Control framework (configured in the WICE Portal) to control which user has access to which WCU.

=== Secure communication mechanism ===
The WICE system relies on a secure communication mechanism based on TLS 1.3 and a PKI for communication between WCUs and the WICE back-end.

The WCU communicates with the WICE-back-end using the secure TLS-based tunnel, allowing configurations of the WCUs. The access control of the PKI solution is based on X.509 certificates identifying the endpoints of communication (WCU and WICE back-end). Only WCUs with a valid certificate can connect to the WICE back-end and is therefore an access control mechanism that ensures only authorised WICE users can access a WCU.

=== Authentication mechanism ===
The WICE system authenticates all users when logging in to the WICE Portal front-end user interface. A role-based access control framework is used to configure which WICE user has access to different resources, including WCUs. A specific user that has been assigned credentials to a specific WCU can then access the WCU by means of the secure TLS-based connection between the WCU and the back-end, provided the WCU is properly configured and authenticated through the PKI.

=== Secure update mechanism ===
The WICE system supports remote updates of the WCU software, including firmware. The software update mechanism allows an authenticated WICE user with the proper access rights to select a new software version to be installed on one or more WCUs through the WICE Portal user interface. The selected software will be downloaded to the WCU(s) over a secure channel (TLS tunnel), verified for integrity, and installed on the WCU.

=== Resilience mechanism ===
The WICE system uses resilience mechanisms to mitigate the effects of Denial of Service (DoS) Attacks on the network interfaces of the WCU and return the WCU to a defined state after the attack.

=== Input validation ===
The WICE system validates all input received via external interfaces if the input has potential impact on security assets and/or network assets.

=== Vulnerability Monitoring ===
Alkit maintains a publicly accessible Vulnerability disclosure programme that allows for the disclosure of Vulnerabilities discovered by researchers and other external actors or entities. Contact [https://www.alkit.se/index.php/contacts Alkit Communications] to receive information required to utilise the disclosure programme.

WCU authentication token

2024-11-29T13:11:53Z

Mathias:

{| class="wikitable" style="float:right; margin-left: 10px;"
| '''WCU version'''
|-
| 2.46 and later
|}

The WCU configuration (reached via the [[Vehicles|Vehicles panel]]) contains the possibility to administer the WCU authentication token used for USB sticks on the WCU.

Press the '''New UUID''' button, shown in the Figure "WCU Configuration: Authentication Token", to generate such an authentication token. Remember to click '''Save''' to save the generated token.

To use the generated token for data offload to a USB stick, put the token in a file called wice-access-token.txt i a directory called /wice/wcu_id, for instance

<code>/wice/04-1B-94-00-1D-2A/wice-access-token.txt</code>

When a USB stick thus prepared is inserted in a WCU with the corresponding id, data will be offloaded to the USB stick.
[[File:WcuConfigAuthToken.png|left|thumb|WCU Configuration: Authentication Token]]

WCU platform

2024-09-05T11:53:30Z

Mathias: /* WCU Modules */

The Wireless Communication Unit (WCU) is the in-vehicle unit running the WICE WCU software and communicating with the vehicle and the WICE back-end.

WCU:s are identified by a unique text string, which by convention is the MAC address of (one of) the ethernet interfaces in the unit. The WCU id is configured on each WCU (automatically from the MAC address) and is a search parameter available in the WICE Portal web-GUI.

=== WCU Hardware Platform ===
The following hardware platforms are supported for the WICE WCU:

* Host Mobility MX-4 (T20, T30, T30FR and V61)
* Fältcom MIIPS Committo
* Raspberry Pi
* Nvidia Jetson Xavier

Depending on the specific hardware platform, the WCU supports a number of communication interfaces, such as CAN, LIN, FlexRay and Ethernet and that be configured in different ways using the WICE Portal.

The WCU platform can also support some limited user-interaction through light-emitting diodes (LED) on the side of the unit. A description of the LEDs is available [[WCU LEDs|here]].

=== WCU Firmware ===
The WCU firmware is the operating system, device drivers and basic packages required to run the system. The WCU units are delivered with the firmware installed. It can be remotely upgraded from the WICE Portal in a similar way as the WCU Software (see below).

=== WCU Software ===
The WCU software is delivered as a self-extracting application installation package, which can be run on the WCU:s manually from a command prompt, using a suitably prepared USB stick, or updated remotely using the WICE Portal mechanism for remote software upgrades.

The WICE solution for remote update of the WCU software works as follows: The Alkit staff member responsible for the WCU software deployment publishes installation packages for supported versions of the WCU software at the WICE Portal, in the WICE back-end server infrastructure. WICE administrators can then select which version of the available WCU software versions should be run on each of the WCUs that are registered in the system (see [[The Portal Administrator View#Edit the WCU Configuration|Edit WCU Configuration]]). This is done by choosing a particular version in a drop-down menu in the WICE Portal in the WCU configuration view. Many WCUs can be configured at the same time.
Then, whenever a WCU connects to the back-end, a check is made to see whether a different WCU software version (higher or lower version) than the currently installed version for the WCU in question is configured. If so, the installation package is downloaded to the WCU’s solid-state storage over the secure TLS connection that was established when the WCU connected. When the download is finished, the WCU software package will be installed on the WCU. After the installation has finished, the WCU will report back to the WICE back-end infrastructure with the new version of the WCU, so that WICE administrators can keep track of the currently installed software version, as well as the history of software changes.
A similar process is performed to update the WCU firmware and operating system. When new firmware is installed, the partition where the certificate and configuration files reside is left unaltered.

The WCU software release history is available [[https://wice-sysdoc.alkit.se/index.php/WICE_WCU_Software_Revision_History here]].

==== Extra Bundles ====
Some WICE software packages, referred to as 'extra bundles' are not installed by default. The user needs to select which, if any, extra bundles should be installed on a particular WCU. This is done in the WICE Portal, Edit Configuration. [[Extra bundles|For more information about Extra bundles, click here]].

=== WCU Modules ===
The WCU Modules are the software components of the WCU producing
measurement data. They are configured through the Configuration Manager, which communicates with the WICE Portal, where the user can access and change the overall WCU configuration and the per-module configurations.

The data capture behavior of the WCU modules is described by a measurement task, downloaded from the WICE Portal by the Task Manager component, which sets up the modules.

The available WCU modules are:
* Arcos
* Area5
* Audio
* Blue piraT
* Canrecorder
* DLT
* DoIP
* ETAS
* Ethernet capture
* File fetcher
* GPS
* IDC
* IPEmotion RT
* LPD
* M-Log
* MQTT
* Rapid Prototyping
* Signal Reader
* State-of-Health
* SWDL
* Video
* WCU internals and status

==== Arcos module ====
The Arcos module makes it possible to use an Arcos data logger (from Ipetronik) connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the Arcos and data can be offloaded and uploaded to the portal.

==== Area5 module ====
The Area5 module is used to read out ECU memory segments using CCP or XCP. The binary data of the memory segments are uploaded to the back-end where they are translated into parameter sets and signals.

==== Audio module ====
The audio module makes it possible to record sound clips from microphones connected to the audio devices of WCUs. Audio can also be streamed in real time from WCUs for live audio monitoring purposes.
The recording of audio can be triggered by a push button connected to the WCU, or from the Signal Reader module by specifying a recorder name or a trigger expression. In the latter case, when the corresponding Signal Reader recorder is started or when the trigger condition is fulfilled the audio recording starts, and when the recorder stops, the audio recording does as well. Pre-trig buffering is supported.
Audio sample rate, number of channels (mono or stereo) and compression format can be specified in the module configuration.

==== Blue piraT Module ====
The Blue piraT module makes it possible to use a Blue piraT logger connected to the WCU through an Ethernet port.
Measurement configuration can be downloaded to the logger and measurement data can be offloaded and uploaded to the WICE Portal.

==== CAN Recorder Module ====
The CAN Recorder Module supports frame logging on the CAN-buses the WCU is connected to. Filters for the ECU identifiers to log can be
defined in the WICE Portal interface when creating a CAN Recorder measurement task.

==== DLT module ====
The DLT module supports read-out of Diagnostic Log Trace files. See [[DLT Module|DLT module]].

==== DoIP module ====
The DoIP module makes it possible to establish a tunnel over the Internet to a WCU for synchronous communication using the DoIP protocol.
In the WCU, the remote DoIP functionality is based on the DoIP daemon '''doipd''', which relays DoIP communication between vehicle and the back-end.
It also takes care of waking up the vehicle when communication requests are pending. For more information see [[Remote Diagnostics over IP (DoIP)|Remote Diagnostics over IP (DoIP)]].

==== Ethernet Capture Module ====
The Ethernet Capture module supports logging of ethernet frames on one of the WCU's ethernet interfaces. Filters can be set (in tcpdump format) for selecting which frames to capture. The result is logged in a pcap file, which is uploaded to the WICE Portal.

==== ETAS Module ====
The ETAS module makes it possible to use an ETAS ES720 measurement system connected to the WCU through an Ethernet port.
Measurement tasks can be downloaded to the ES720 and measurement data can be offloaded and uploaded to the WICE Portal.

==== File Fetcher Module ====
The File Fetcher module supports uploading of files collected from a unit connected to the WCU.

==== GPS Module ====
The GPS Module reads the position of a WCU at regular intervals and
reports to the WICE Portal, to support map-based localization of vehicles for the fleet-management service and for the "Plot Route" function of the metrology service.

==== IDC module ====
The IDC module allows a sequence of diagnostic requests to be sent on the
in-vehicle network (either CAN or Ethernet), and the responses are collected in a result file. IDC can also read OBD-II PIDs and interpret the responses.
IDC supports diagnostics over CAN using ISO15765-2 and over IP/Ethernet using ISO13400. Both physical and functional ECU addressing is supported.
An IDC sequence file can in addition to diagnostic requests also contain commands, as described in [[IDC sequence file commands]].

==== IPEmotion RT ====
The IPEmotion RT module makes it possible to use an IPEmotion RT data logger (from Ipetronik) connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the logger and data can be offloaded and uploaded to the portal.

==== LPD module ====
The LPD module supports long term driveline testing using a custom built Android app that connects to the WICE WCU.

==== M-Log module ====
The M-log module makes it possible to use an M-Log data logger connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the M-Log and data can be offloaded and uploaded to the portal.

==== MQTT module ====
The MQTT module makes it possible to collect data from another system using an MQTT broker and specifying MQTT topics.

==== Rapid Prototyping module ====
With the Rapid Prototyping (RP) module, custom software components can be run on the WCU for proof-of-concept testing of new in-vehicle functionality. A Signal Broker API (provided by the Signal Reader module, see below) can be used to easily access in-vehicle signals and parameters. Output data from the RP module is uploaded to the WICE back-end where it is made available in the WICE Portal. The RP module supports both native applications, compiled for the WCU processor architecture, and Node.js applications written in Javascript. The latter is particularly useful for providing in-vehicle GUI functionality.

For more information see [[WICE_RP_How-To]].

==== Signal Reader Module ====
The Signal Reader module executes a measurement task, monitors and logs time-series signal data and stores the data in an MDF file (Measurement Data
Format). Signals can be recorded from the vehicle's internal communication buses (e.g. CAN, LIN, FlexRay). A number of signals internal to the WCU are also available: [[WICE Internal Signals|WICE Internal Signals]]

Signal Reader also supports logging of signals using CCP, XCP and UDS diagnostics. This is sometimes referred to as Active signals.

Triggers are supported, switching between measurement set-ups and starting and stopping recorders. Trigger expression syntax is described [[Signal Reader Trigger Expressions|here]]. Pre- and post-trig recording can be specified, which results in signal data being recorded prior to or subsequent to a trigger condition respectively. Minimum and maximum shot lengths of recorders can also be specified.

==== State of Health Module ====
The State-of-Health (SoH) module is used to read out a limited data set
from test vehicles to monitor their operational status. The specific data to be read is configurable from the WICE portal and includes
position, mileage (odometer), battery voltage, ECU software numbers, Diagnostic Trouble Codes and uptime. The SoH module uses the IDC module to
service a sequence of diagnostic requests, created by the WICE Portal
based on which data is requested and the diagnostic database of the vehicle type. Position is accessed from the GPS Module (see below)
and uptime is accessed from the WCU internal module (see below).

==== SWDL module ====
The Software Download (SWDL) module makes it possible to download ECU software to connected vehicles for re-programming. The input to the SWDL module is a number of VBF (Versatile Binary Format) files containing the ECU software, and PIN codes for the ECUs to be reprogrammed. Sequence files can also be supplied for pre- and post-programming diagnostics.

==== Video module ====
The video module makes it possible to record video clips from cameras connected to the WCU. Video can also be streamed in real time from WCUs for live video monitoring purposes.
The recording of video can be triggered by a push-button connected to the WCU, or from the Signal Reader module by specifying a recorder name or a trigger expression. In the latter case, when the corresponding Signal Reader recorder is started (i.e. when a trigger condition is fulfilled) the video recording starts, and when the recorder stops, the video recording does as well. Pre-trig buffering is supported.
Video resolution, frame rate and compression format can be specified in the module configuration.

==== WCU internals Module ====
The WCU internals Module logs useful information about a WCU, including
uptime, battery voltage (on the WCU power input), and memory usage.

==== WCU Status Module ====
The WCU status Daemon, statusd,
monitors the status of the WCU, including all the modules, and
reports to the WICE Portal. The daemon also provides a common i/o API
for all modules, including GPS and digital i/o.

=== Power Management ===
The Power Management settings of the WCU determines how and when the unit is started and shut down. What Power Management mechanisms are available depends on the WCU hardware platform. The following refers to the MX4 platform.
The MX4 unit can be started and stopped based on the ''ignition'' input pin or on the availability or absence of CAN traffic on any of the CAN interfaces. The WCU can also be configured to start after a specific time interval from shut-down. The configuration is done in the [[The Portal Administrator View#Power Management| WCU Configuration]] in the WICE Portal.
Note that the behaviour of the ignition pin depends on the setting of the START switch on the back of the WCU. If the switch is set to INT the pin will always be active, so that if the WCU is set to''Wake on ignition'' it will be always on. If the switch is set to EXT, the pin will reflect the current state of the ignition of the vehicle (providing it is correctly installed).

Signal Reader Trigger Expressions

2024-08-28T06:43:07Z

Mathias:

Trigger conditions are expressions evaluated by the Signal Reader module to control when recorders are started and stopped and when measurement set-up switches are performed.
Trigger conditions are boolean expressions, evaluated to either true or false. A number of operators can be combined to form the trigger expression. The allowed operators in trigger expressions are shown in the table below.

{| class="wikitable"
!=
|Tests for equality. Syntax: expression = expression
|-
!!=
|Tests for inequality. Syntax: expression != expression
|-
!<
|Tests for left side of expression being less than right side. Syntax: expression < expression
|-
!>
|Tests for left side of expression being greater than right side. Syntax: expression > expression
|-
!<=
|Tests for left side of expression being less or equal to right side. Syntax: expression <= expression
|-
!>=
|Tests for left side of expression being greater or equal to right side. Syntax: expression >= expression
|-
!AND
|Logical conjunction between left and right side boolean expressions. Syntax: boolean expression AND boolean expression
|-
!OR
|Logical disjunction between left and right side boolean expressions. Syntax: boolean expression OR boolean expression
|-
!NOT
|Logical negation of boolean expression. Syntax: NOT(boolean expression)
|-
!CHANGE
|True when the specified signal changes value by at least the specified amount. Syntax: CHANGE(Signal, amount)
|-
!CHANGE_UP
|True when the specified signal increases its value with at least the specified amount. Syntax: CHANGE_UP(Signal, amount)
|-
!CHANGE_DOWN
|True when the specified signal decreases its value with at least the specified amount. Syntax: CHANGE_DOWN(Signal, amount)
|-
!CHANGE_BY
|True when the specified signal changes value by exactly the specified amount. Syntax: CHANGE_BY(Signal, amount)
|-
!CHANGE_UP_BY
|True when the specified signal increases its value by exactly the specified amount. Syntax: CHANGE_UP_BY(Signal, amount)
|-
!CHANGE_DOWN_BY
|True when the specified signal decreases its value by exactly the specified amount. Syntax: CHANGE_DOWN_BY(Signal, amount)
|-
!CHANGE_FROM_TO
|True when the specified signal changes from the specified value to the other specified value. Syntax: CHANGE_FROM_TO(Signal, value, value)
|-
!TIMER
|Effects a delay in seconds from that the specified signal is greater than zero. Syntax: TIMER(signal, time)
|-
!EXPR_TIMER
|Effects a delay in seconds from that the condition is fulfilled. Syntax: EXPR_TIMER(expression, time)
|-
!TIME_COUNTER
|Counts the time elapsed while the supplied boolean expression has been true. You can optionally supply an expression resetting the time counter to zero. Syntax: TIME_COUNTER(expression) or TIME_COUNTER(expression, expression)
|-
!SAMPLE_COUNTER
|Counts the number of samples received while the boolean expression is true. You can optionally supply an expression resetting the time counter to zero. Syntax: SAMPLE_COUNTER(expression) or SAMPLE_COUNTER(expression, expression)
|-
!EVERY
|Repeatedly becomes true after a time interval, specified in seconds, has elapsed. Syntax: EVERY(time)
|-
!MOVAV
|Calculates a moving average over the specified signal. Syntax: MOVAV(Signal)
|-
!ABS
|Calculates the absolute value of the specified expression. Syntax: ABS(expression)
|-
!MIN
|Calculates the minimum value of two expressions. Syntax: MIN(expression, expression)
|-
!MAX
|Calculates the maximum value of two expressions. Syntax: MAX(expression, expression)
|-
!MEAN
|Calculates the mean value of two expressions. Syntax: MEAN(expression, expression)
|-
!LOSS_OF_SIGNAL
|True when the specified signal disappears for the specified number of seconds. Syntax: LOSS_OF_SIGNAL(Signal, seconds)
|}

New features in v2.87

2024-01-03T14:16:05Z

Mathias: /* Initial Support for MDF Version 4.1 */

== Support for Vehicle Communication Forwarder ==
If enabled in the Portal, it is now possible to add and configure a Vehicle Communication Forwarder to a WCU from Edit Configuration under the [[I/O configurations#Add CAN channels|I/O Configuration tab]]. If both WMUs and Vehicle Communication Forwarder are enabled in the portal, only Vehicle Communication Forwarder will be shown. Read more about Vehicle Communication Forwarder [[Vehicle Communication Forwarder|here]].

== Assignment Review Support ==
When having assignments that are delicate in the sense that those will be run on many vehicles or of other reasons, there is now support to appoint one or several reviewers of the assignment. Those reviewers can then approve or reject the assignment for the original editor to fix any problems. In addition to the review process of assignments, there is support to require that only reviewed assignments can be added to resource groups or WCU:s. Read more about the review process [[Review assignment process|here]] and how to enforce that reviewed assignments on resources for WCUs [https://wiki.alkit.se/wice287/index.php/The_Portal_Administrator_View#The_Edit_WCU_Dialog here] and resource groups [[The Portal Administrator View#Approved Assignments|here]].

== Initial Support for MDF Version 4.1 ==
There is support to search and download MDF files for version 4.1 in the result files panel. Support to preview such files will come later. In the WCU software, there is support for generating MDF files of version 4.1.1, in addition to the previously available 3.x versions. The MDF version is selected in the module settings for Signal Reader.

== Improved Handling of Default Resource Group Labels ==
Possible to select if default label should remove from the WCU or/and Vehicle when disconnecting from the group. Also possible to default labels will affect current resources in the resource group. Read more [[Edit default labels window|here]].

== Support for Assignment Validation ==
When creating a signal reader assignment in the editor it is possible to make some common mistake that can affect the vehicle's behavior. If the user tries to save an assignment with this type of mistake the user will be informed and then take action after it. Read more about signal reader editor [[Signal Reader Assignment Editor|here]].

== Record Result Files Announced to Third Parties ==
A column named 'Announced On' has been added in the result files panel to track when the result file was announced. Additionally, two labels have been introduced on the task to monitor the number of announced files called 'announced_files' and the date of the last announcement called 'announced_on". These labels are visible in the tasks panel. Read more about it [https://wiki.alkit.se/wice287/index.php/Creating_a_Task#Announce_result_file_availability here].

== Support to Edit Values on Labels on Tasks ==
When an assignment is generated with associated labels, it is now possible to modify the values of these labels in the View Task window. Read more about it [https://wiki.alkit.se/wice287/index.php/Tasks_Tab#Task_Options here].

== WCU Connected Column in Vehicles Panel has Better Mixed Time Format ==
The column 'Connected' in the Vehicles panel has an improved time format presentation. Earlier, it simply showed the number of minutes since a WCU last connected to the portal. This quickly became difficult to use and you had to move the pointer over the cell in order to get a hover message saying the actual date. Now, a mixed format based on how long the WCU connected with the portal is used. Up to a month since the last connected time is shown as, e.g. '7d3h11m'. When the time exceeds a month, the date is shown. Also, filtering is made using the format '7d3h11m'. Read more about this here.

== Support for New Permission to Create Vehicles ==
There is now a Vehicle Create Permission, which enables non-admin users to create vehicles in the vehicles tab. Additionally, vehicles without a WCU connected will now show up in the vehicles tab for users with this permission.

Read more about creating vehicles [[The Portal Administrator View#Add Vehicle Dialog|here]].

== Support for New Permission to Connect/Disconnect WCU:s and Vehicles in the Portal ==
There is now a WCU Connect Permission, which enables non-admin users to connect WCUs to vehicles. Read more about connecting WCUs to vehicles [[The Portal Administrator View#The Administration Tab|here]].

== Improved Task Search Performance ==
Under some circumstances the search i the tasks panel could be lagging for a few seconds and this is now improved.

== CAN-FD Support ==
The assignment editor now has support for CAN-FD.

== Signal Reader New Type of Triggers are Introduced ==
A trigger in signal reader can now run the following events: Recorder (old), Setup switch (old), Pause diagnostics, Start/Stop CCP/XCP DAQ, Upload. Read more about triggers [[Signal Reader Assignment Editor|here]].

== Improved Resource Groups Table under the Administration Tab ==
Resource group table has been extended with new columns that control if Require approved assignments and shows the number of resources and labels. It is also possible to filter on strict and nonstrict and a counter has been added in the header.

WICE Internal Signals

2023-08-24T08:15:03Z

Mathias:

The following WICE-internal signals are supported by Signal Reader:

{| class="wikitable"
!'''Signal name'''
!Description
|-
|Accelerometer_X
|The value of the X direction of the WCU's built-in accelerometer. (See [[WICE Accelerometer]].)
|-
|Accelerometer_Y
|The value of the Y direction of the WCU's built-in accelerometer. (See [[WICE Accelerometer]].)
|-
|Accelerometer_Z
|The value of the Z direction of the WCU's built-in accelerometer. (See [[WICE Accelerometer]].)
|-
|Audio_Device_1
|The status of audio device 1 (1=recording, 0 = not recording). When present in a recorder, the audio module will record sound from the device.
|-
|Audio_Device_2
|The status of audio device 2 (1=recording, 0 = not recording). When present in a recorder, the audio module will record sound from the device.
|-
|Busload_CAN_<n>
|The bus load on CAN bus <n>
|-
|Connectivity
|The current connectivity of the WCU (0 = unknown, 1 = none, 2 = 2G, 3 = 3G, 4 = 4G, 5=5G, 6=WiFi, 7=ethernet)
|-
|CSQ
|The built-in modem's CSQ value (Signal Quality)
|-
|Date_Year
|The year of the current date.
|-
|Date_Month
|The month (1-12) of the current date.
|-
|Date_Day
|The day of the month (1-31) of the current date.
|-
|Date_Weekday
|The day of the week (1-7, where 1 is Sunday).
|-
|Date_Hour
|The hour of the day (0-23).
|-
|Date_Minute
|The minute of the hour (0-59).
|-
|Date_Second
|The second of the minute (0-59).
|-
|Dynamic_<n>
|Special signals with values assignable from external software components (typically used for Rapid Prototyping).
|-
|IO__AI_<n>
|Analog input number <n>
|-
|IO__DI_<n>
|Digital input number <n>
|-
|IO__DO_<n>
|Digital output number <n>
|-
|Log_All_Frames_CAN_<n>
|Log all CAN frames on CAN bus <n>
|-
|Log_All_Frames_FlexRay_<n>
|Log all CAN frames on Flexray bus <n>
|-
|Latitude
|The GPS latitude
|-
|Longitude
|The GPS longitude
|-
|Network_Receive_Rate_eth0
|The rate i kilobilts per second of receiving data on the eth0 interface
|-
|Network_Receive_Rate_eth1
|The rate i kilobilts per second of receiving data on the eth1 interface
|-
|Network_Receive_Rate_ppp0
|The rate i kilobilts per second of receiving data on the ppp0 (i.e. mobile data communication) interface
|-
|Network_Transmit_Rate_eth0
|The rate i kilobilts per second of transmitting data on the eth0 interface
|-
|Network_Transmit_Rate_eth1
|The rate i kilobilts per second of transmitting data on the eth1 interface
|-
|Network_Transmit_Rate_ppp0
|The rate i kilobilts per second of transmitting data on the ppp0 (i.e. mobile data communication) interface
|-
|Power_Mode
|The power mode of the WCU
|-
|Random
|A random number generator
|-
|Random_Start
|A random number generator updated once, at program start
|-
|Random_Setup_Switch
|A random number generator updated at each measurement set-up switch
|-
|Start_Signal
|The start signal of the WCU
|-
|Start_Signal_Voltage
|The voltage of the start signal of the WCU, in millivolts
|-
|Speed
|The GPS speed
|-
|Start_Switch
|The start switch of the WCU
|-
|Tester_Present
|When present in a measurement set-up, a Tester Present diagnostic request (with suppress Positive Response bit set) will be sent periodically.
|-
|Time_Since_Epoch
|The time elapsed since the epoch (Jan 1, 1970, 00:00)
|-
|Time_Since_Start
|The time elapsed since the start of the task
|-
|Time_Since_Setup_Switch
|The time elapsed since the activation of the current measurement set-up
|-
|Trigger_Button
|The trigger button connected to the WCU
|-
|Usage_CPU
|The WCU CPU usage in percent
|-
|Usage_Memory
|The WCU memory usage in percent
|-
|Video_Camera_1
|The status of video camera 1 (1=connected, 0 = disconnected). When present in a recorder, the video module will record video from the camera.
|-
|Video_Camera_2
|The status of video camera 2 (1=connected, 0 = disconnected). When present in a recorder, the video module will record video from the camera.
|-
|WCU_Battery
|The WCU battery voltage in millivolts
|-
|WCU_Temp
|The WCU internal temperature in degrees Celsius
|-
|WCU_Storage
|The available storage on the WCU in percent
|-
|WCU_Voltage
|The WCU voltage in millivolts
|}

WICE Accelerometer

2023-08-24T08:13:06Z

Mathias: Created page with "The WICE-internal signals for the built-in accelerometer, WICE.Accelerometer_X, WICE.Accelerometer_X and WICE.Accelerometer_Z are oriented as in the below picture. Orientation of the axes of the built-in accelerometer"

The WICE-internal signals for the built-in accelerometer, WICE.Accelerometer_X, WICE.Accelerometer_X and WICE.Accelerometer_Z are oriented as in the below picture.
[[File:WICE Accelerometer.png|thumb|Orientation of the axes of the built-in accelerometer]]

File:WICE Accelerometer.png

2023-08-24T08:12:14Z

Mathias:

Orientation of the axes of the built-in accelerometer

WICE RP How-To

2023-08-21T12:11:47Z

Mathias:

= 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)
* A high-level, socket based, Signal Broker API simplifying access to in-vehicle signals.
* 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: https://www.alkit.se/pub/gcc-linaro-arm-linux-gnueabihf-2012.09-20120921_linux.tar.gz

== 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: https://www.alkit.se/rp/libs/

Note that you do not need these libraries when using the high-level Signal Broker API (the preferred approach), described below.

= 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 start-up, 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 [https://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 [https://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>
As another example, the following Python code illustrates how to set up a socket connection th the Signal Broker, list the available signals, and subscribe to them.
<code>
# Example showing how to read signals from WICE Signal Broker in Python

import socket

HOST = "127.0.0.1"
PORT = 31415

def read_line(sock):
"read a line from a socket"
chars = []
while True:
a = sock.recv(1)
chars.append(a)
if a == "\n" or a == "":
return "".join(chars)

def read_signals(sock):
"read available signals"
sigs = []
while True:
line = read_line(sock)
if line == "\n" or line == "\r\n" or line == "":
return sigs
sigs.append(dict(name = line.strip(), value = 0.0))

def parse_signal(str):
"parse string into signal name tuple"
x = str.split()
t = (x[0], x[1])
return t

print("Setting up socket connection to port %d..." % PORT)
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.connect((HOST, PORT))
# Get list of available signals
sock.send("list\n")
signals = read_signals(sock)

print("Available signals:")
print(signals)

# Subscribe to signals
for signal in signals:
sock.send("subscribe " + signal["name"] + "\n")

while True:
line = read_line(sock)
t = parse_signal(line)
for s in signals:
if s["name"] == t[0]:
s.update({"value": t[1]})
break
print("Signal " + s["name"] + ", value = " + str(s["value"]))
s.close()
</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 [https://www.alkit.se/rp/node-example/ here].

New features in v2.84

2023-06-29T07:38:52Z

Mathias: /* WCU information panel extended with certificate expire date */

== Context menu added for some plot options in the signal preview ==
A context menu has been added in the signal preview when right clicking the plot. The menu gives you the opportunity to toggle the visibility of the chart title, the y-axes titles and the y-axes themselves. It also gives you the option to toggle between having the file name or signal names as the plot title.
== Improved tooltip when hovering over the plot ==
The tooltip that appears when you hover over the plot in the signal preview now showcase the value of all signals and just not the one closest to the cursor.
== Functionality added to add more files to plot without loosing signal selection ==
When viewing signals in the signal preview you can now add more files without loosing the settings or the selections of your current plot. This is done by pressing the new "Add more files" button which takes you back where you can add new files in and also remove old files.
== Show/hide module button of signal preview improved ==
The show/hide module button in the signal preview now applies the module names to the signal list and the signal preview instead of only effecting the signal list.
== Allow more signals in signal preview ==
The maximum number of signals in a plot is now infinitely many signals in a single plot.
== WCU information panel extended with certificate expiry date ==
The WCU information panel now also shows the certificates expiry date. Hovering over the date will also show how many days left before the certificate expires.

== Support to have per-vehicle ECU PIN codes ==
For SWDL tasks there is now support to have ECU PIN codes per vehicle instead of just global ones for a task. See further in [[The Portal Administrator View#Upload a file describing ECU pin codes for a vehicle|ECU PIN codes for vehicles]] on how to prepare a vehicle with individual pin codes and on creating SWDL tasks [[Creating a Task#SWDL|here]].

== New Canrecorder ==
A new Canrecorder is introduced in 2.84 with design changes and some new settings like: trigger option and shot count. Read more [[Creating a Task#CAN-recorder|here.]]

== New WICE-internal signals in Signal Reader ==
Two new WICE-internal signals are introduced in introduced in 2.84: WICE.WCU_Storage, giving the available storage on the WCU in percent, and WICE.Connectivity, giving the current connectivity mode. Read more [[WICE_Internal_Signals|here.]]

New features in v2.84

2023-06-29T07:38:10Z

Mathias: /* Support to have per vehicle ECU pin codes */

== Context menu added for some plot options in the signal preview ==
A context menu has been added in the signal preview when right clicking the plot. The menu gives you the opportunity to toggle the visibility of the chart title, the y-axes titles and the y-axes themselves. It also gives you the option to toggle between having the file name or signal names as the plot title.
== Improved tooltip when hovering over the plot ==
The tooltip that appears when you hover over the plot in the signal preview now showcase the value of all signals and just not the one closest to the cursor.
== Functionality added to add more files to plot without loosing signal selection ==
When viewing signals in the signal preview you can now add more files without loosing the settings or the selections of your current plot. This is done by pressing the new "Add more files" button which takes you back where you can add new files in and also remove old files.
== Show/hide module button of signal preview improved ==
The show/hide module button in the signal preview now applies the module names to the signal list and the signal preview instead of only effecting the signal list.
== Allow more signals in signal preview ==
The maximum number of signals in a plot is now infinitely many signals in a single plot.
== WCU information panel extended with certificate expire date ==
The WCU information panel now also shows the certificates expiry date. Hovering over the date will also show how many days left before the certificate expires.

== Support to have per-vehicle ECU PIN codes ==
For SWDL tasks there is now support to have ECU PIN codes per vehicle instead of just global ones for a task. See further in [[The Portal Administrator View#Upload a file describing ECU pin codes for a vehicle|ECU PIN codes for vehicles]] on how to prepare a vehicle with individual pin codes and on creating SWDL tasks [[Creating a Task#SWDL|here]].

== New Canrecorder ==
A new Canrecorder is introduced in 2.84 with design changes and some new settings like: trigger option and shot count. Read more [[Creating a Task#CAN-recorder|here.]]

== New WICE-internal signals in Signal Reader ==
Two new WICE-internal signals are introduced in introduced in 2.84: WICE.WCU_Storage, giving the available storage on the WCU in percent, and WICE.Connectivity, giving the current connectivity mode. Read more [[WICE_Internal_Signals|here.]]

New features in v2.84

2023-06-29T07:37:26Z

Mathias:

== Context menu added for some plot options in the signal preview ==
A context menu has been added in the signal preview when right clicking the plot. The menu gives you the opportunity to toggle the visibility of the chart title, the y-axes titles and the y-axes themselves. It also gives you the option to toggle between having the file name or signal names as the plot title.
== Improved tooltip when hovering over the plot ==
The tooltip that appears when you hover over the plot in the signal preview now showcase the value of all signals and just not the one closest to the cursor.
== Functionality added to add more files to plot without loosing signal selection ==
When viewing signals in the signal preview you can now add more files without loosing the settings or the selections of your current plot. This is done by pressing the new "Add more files" button which takes you back where you can add new files in and also remove old files.
== Show/hide module button of signal preview improved ==
The show/hide module button in the signal preview now applies the module names to the signal list and the signal preview instead of only effecting the signal list.
== Allow more signals in signal preview ==
The maximum number of signals in a plot is now infinitely many signals in a single plot.
== WCU information panel extended with certificate expire date ==
The WCU information panel now also shows the certificates expiry date. Hovering over the date will also show how many days left before the certificate expires.

== Support to have per vehicle ECU pin codes ==
For SWDL tasks there is now support to have ECU pin codes per vehicle instead of just global ones for a task. See further in [[The Portal Administrator View#Upload a file describing ECU pin codes for a vehicle|ECU pin codes for vehicles]] on how to prepare a vehicle with individual pin codes and on creating SWDL tasks [[Creating a Task#SWDL|here]].

== New Canrecorder ==
A new Canrecorder is introduced in 2.84 with design changes and some new settings like: trigger option and shot count. Read more [[Creating a Task#CAN-recorder|here.]]

== New WICE-internal signals in Signal Reader ==
Two new WICE-internal signals are introduced in introduced in 2.84: WICE.WCU_Storage, giving the available storage on the WCU in percent, and WICE.Connectivity, giving the current connectivity mode. Read more [[WICE_Internal_Signals|here.]]

WICE Internal Signals

2023-06-29T07:31:41Z

Mathias:

The following WICE-internal signals are supported by Signal Reader:

{| class="wikitable"
!'''Signal name'''
!Description
|-
|Accelerometer_X
|The value of the X direction of the WCU's built-in accelerometer.
|-
|Accelerometer_Y
|The value of the Y direction of the WCU's built-in accelerometer.
|-
|Accelerometer_Z
|The value of the Z direction of the WCU's built-in accelerometer.
|-
|Audio_Device_1
|The status of audio device 1 (1=recording, 0 = not recording). When present in a recorder, the audio module will record sound from the device.
|-
|Audio_Device_2
|The status of audio device 2 (1=recording, 0 = not recording). When present in a recorder, the audio module will record sound from the device.
|-
|Busload_CAN_<n>
|The bus load on CAN bus <n>
|-
|Connectivity
|The current connectivity of the WCU (0 = unknown, 1 = none, 2 = 2G, 3 = 3G, 4 = 4G, 5=5G, 6=WiFi, 7=ethernet)
|-
|CSQ
|The built-in modem's CSQ value (Signal Quality)
|-
|Date_Year
|The year of the current date.
|-
|Date_Month
|The month (1-12) of the current date.
|-
|Date_Day
|The day of the month (1-31) of the current date.
|-
|Date_Weekday
|The day of the week (1-7, where 1 is Sunday).
|-
|Date_Hour
|The hour of the day (0-23).
|-
|Date_Minute
|The minute of the hour (0-59).
|-
|Date_Second
|The second of the minute (0-59).
|-
|Dynamic_<n>
|Special signals with values assignable from external software components (typically used for Rapid Prototyping).
|-
|IO__AI_<n>
|Analog input number <n>
|-
|IO__DI_<n>
|Digital input number <n>
|-
|IO__DO_<n>
|Digital output number <n>
|-
|Log_All_Frames_CAN_<n>
|Log all CAN frames on CAN bus <n>
|-
|Log_All_Frames_FlexRay_<n>
|Log all CAN frames on Flexray bus <n>
|-
|Latitude
|The GPS latitude
|-
|Longitude
|The GPS longitude
|-
|Network_Receive_Rate_eth0
|The rate i kilobilts per second of receiving data on the eth0 interface
|-
|Network_Receive_Rate_eth1
|The rate i kilobilts per second of receiving data on the eth1 interface
|-
|Network_Receive_Rate_ppp0
|The rate i kilobilts per second of receiving data on the ppp0 (i.e. mobile data communication) interface
|-
|Network_Transmit_Rate_eth0
|The rate i kilobilts per second of transmitting data on the eth0 interface
|-
|Network_Transmit_Rate_eth1
|The rate i kilobilts per second of transmitting data on the eth1 interface
|-
|Network_Transmit_Rate_ppp0
|The rate i kilobilts per second of transmitting data on the ppp0 (i.e. mobile data communication) interface
|-
|Power_Mode
|The power mode of the WCU
|-
|Random
|A random number generator
|-
|Random_Start
|A random number generator updated once, at program start
|-
|Random_Setup_Switch
|A random number generator updated at each measurement set-up switch
|-
|Start_Signal
|The start signal of the WCU
|-
|Start_Signal_Voltage
|The voltage of the start signal of the WCU, in millivolts
|-
|Speed
|The GPS speed
|-
|Start_Switch
|The start switch of the WCU
|-
|Tester_Present
|When present in a measurement set-up, a Tester Present diagnostic request (with suppress Positive Response bit set) will be sent periodically.
|-
|Time_Since_Epoch
|The time elapsed since the epoch (Jan 1, 1970, 00:00)
|-
|Time_Since_Start
|The time elapsed since the start of the task
|-
|Time_Since_Setup_Switch
|The time elapsed since the activation of the current measurement set-up
|-
|Trigger_Button
|The trigger button connected to the WCU
|-
|Usage_CPU
|The WCU CPU usage in percent
|-
|Usage_Memory
|The WCU memory usage in percent
|-
|Video_Camera_1
|The status of video camera 1 (1=connected, 0 = disconnected). When present in a recorder, the video module will record video from the camera.
|-
|Video_Camera_2
|The status of video camera 2 (1=connected, 0 = disconnected). When present in a recorder, the video module will record video from the camera.
|-
|WCU_Battery
|The WCU battery voltage in millivolts
|-
|WCU_Temp
|The WCU internal temperature in degrees Celsius
|-
|WCU_Storage
|The available storage on the WCU in percent
|-
|WCU_Voltage
|The WCU voltage in millivolts
|}

WCU platform

2022-12-22T14:51:38Z

Mathias: /* WCU Modules */

The Wireless Communication Unit (WCU) is the in-vehicle unit running the WICE WCU software and communicating with the vehicle and the WICE back-end.

WCU:s are identified by a unique text string, which by convention is the MAC address of (one of) the ethernet interfaces in the unit. The WCU id is configured on each WCU (automatically from the MAC address) and is a search parameter available in the WICE Portal web-GUI.

=== WCU Hardware Platform ===
The following hardware platforms are supported for the WICE WCU:

* Host Mobility MX-4 (T20, T30, T30FR and V61)
* Fältcom MIIPS Committo
* Raspberry Pi
* Nvidia Jetson Xavier

Depending on the specific hardware platform, the WCU supports a number of communication interfaces, such as CAN, LIN, FlexRay and Ethernet and that be configured in different ways using the WICE Portal.

The WCU platform can also support some limited user-interaction through light-emitting diodes (LED) on the side of the unit. A description of the LEDs is available [[WCU LEDs|here]].

=== WCU Firmware ===
The WCU firmware is the operating system, device drivers and basic packages required to run the system. The WCU units are delivered with the firmware installed. It can be remotely upgraded from the WICE Portal in a similar way as the WCU Software (see below).

=== WCU Software ===
The WCU software is delivered as a self-extracting application installation package, which can be run on the WCU:s manually from a command prompt, using a suitably prepared USB stick, or updated remotely using the WICE Portal mechanism for remote software upgrades.

The WICE solution for remote update of the WCU software works as follows: The Alkit staff member responsible for the WCU software deployment publishes installation packages for supported versions of the WCU software at the WICE Portal, in the WICE back-end server infrastructure. WICE administrators can then select which version of the available WCU software versions should be run on each of the WCUs that are registered in the system (see [[The Portal Administrator View#Edit the WCU Configuration|Edit WCU Configuration]]). This is done by choosing a particular version in a drop-down menu in the WICE Portal in the WCU configuration view. Many WCUs can be configured at the same time.
Then, whenever a WCU connects to the back-end, a check is made to see whether a different WCU software version (higher or lower version) than the currently installed version for the WCU in question is configured. If so, the installation package is downloaded to the WCU’s solid-state storage over the secure TLS connection that was established when the WCU connected. When the download is finished, the WCU software package will be installed on the WCU. After the installation has finished, the WCU will report back to the WICE back-end infrastructure with the new version of the WCU, so that WICE administrators can keep track of the currently installed software version, as well as the history of software changes.
A similar process is performed to update the WCU firmware and operating system. When new firmware is installed, the partition where the certificate and configuration files reside is left unaltered.

The WCU software release history is available [[https://wice-sysdoc.alkit.se/index.php/WICE_WCU_Software_Revision_History here]].

==== Extra Bundles ====
Some WICE software packages, referred to as 'extra bundles' are not installed by default. The user needs to select which, if any, extra bundles should be installed on a particular WCU. This is done in the WICE Portal, Edit Configuration. [[Extra bundles|For more information about Extra bundles, click here]].

=== WCU Modules ===
The WCU Modules are the software components of the WCU producing
measurement data. They are configured through the Configuration Manager, which communicates with the WICE Portal, where the user can access and change the overall WCU configuration and the per-module configurations.

The data capture behavior of the WCU modules is described by a measurement task, downloaded from the WICE Portal by the Task Manager component, which sets up the modules.

The available WCU modules are:
* Arcos
* Area5
* Audio
* Blue piraT
* Canrecorder
* DLT
* DoIP
* ETAS
* File fetcher
* Ethernet capture
* GPS
* IDC
* IPEmotion RT
* LPD
* M-Log
* Rapid Prototyping
* Signal Reader
* State-of-Health
* SWDL
* Video
* WCU internals and status

==== Arcos module ====
The Arcos module makes it possible to use an Arcos data logger (from Ipetronik) connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the Arcos and data can be offloaded and uploaded to the portal.

==== Area5 module ====
The Area5 module is used to read out ECU memory segments using CCP or XCP. The binary data of the memory segments are uploaded to the back-end where they are translated into parameter sets and signals.

==== Audio module ====
The audio module makes it possible to record sound clips from microphones connected to the audio devices of WCUs. Audio can also be streamed in real time from WCUs for live audio monitoring purposes.
The recording of audio can be triggered by a push button connected to the WCU, or from the Signal Reader module by specifying a recorder name or a trigger expression. In the latter case, when the corresponding Signal Reader recorder is started or when the trigger condition is fulfilled the audio recording starts, and when the recorder stops, the audio recording does as well. Pre-trig buffering is supported.
Audio sample rate, number of channels (mono or stereo) and compression format can be specified in the module configuration.

==== Blue piraT Module ====
The Blue piraT module makes it possible to use a Blue piraT logger connected to the WCU through an Ethernet port.
Measurement configuration can be downloaded to the logger and measurement data can be offloaded and uploaded to the WICE Portal.

==== CAN Recorder Module ====
The CAN Recorder Module supports frame logging on the CAN-buses the WCU is connected to. Filters for the ECU identifiers to log can be
defined in the WICE Portal interface when creating a CAN Recorder measurement task.

==== DLT module ====
The DLT module supports read-out of Diagnostic Log Trace files. See [[DLT Module|DLT module]].

==== DoIP module ====
The DoIP module makes it possible to establish a tunnel over the Internet to a WCU for synchronous communication using the DoIP protocol.
In the WCU, the remote DoIP functionality is based on the DoIP daemon '''doipd''', which relays DoIP communication between vehicle and the back-end.
It also takes care of waking up the vehicle when communication requests are pending. For more information see [[Remote Diagnostics over IP (DoIP)|Remote Diagnostics over IP (DoIP)]].

==== Ethernet Capture Module ====
The Ethernet Capture module supports logging of ethernet frames on one of the WCU's ethernet interfaces. Filters can be set (in tcpdump format) for selecting which frames to capture. The result is logged in a pcap file, which is uploaded to the WICE Portal.

==== ETAS Module ====
The ETAS module makes it possible to use an ETAS ES720 measurement system connected to the WCU through an Ethernet port.
Measurement tasks can be downloaded to the ES720 and measurement data can be offloaded and uploaded to the WICE Portal.

==== File Fetcher Module ====
The File Fetcher module supports uploading of files collected from a unit connected to the WCU.

==== GPS Module ====
The GPS Module reads the position of a WCU at regular intervals and
reports to the WICE Portal, to support map-based localization of vehicles for the fleet-management service and for the "Plot Route" function of the metrology service.

==== IDC module ====
The IDC module allows a sequence of diagnostic requests to be sent on the
in-vehicle network (either CAN or Ethernet), and the responses are collected in a result file. IDC can also read OBD-II PIDs and interpret the responses.
IDC supports diagnostics over CAN using ISO15765-2 and over IP/Ethernet using ISO13400. Both physical and functional ECU addressing is supported.
An IDC sequence file can in addition to diagnostic requests also contain commands, as described in [[IDC sequence file commands]].

==== IPEmotion RT ====
The IPEmotion RT module makes it possible to use an IPEmotion RT data logger (from Ipetronik) connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the logger and data can be offloaded and uploaded to the portal.

==== LPD module ====
The LPD module supports long term driveline testing using a custom built Android app that connects to the WICE WCU.

==== M-Log module ====
The M-log module makes it possible to use an M-Log data logger connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the M-Log and data can be offloaded and uploaded to the portal.

==== Rapid Prototyping module ====
With the Rapid Prototyping (RP) module, custom software components can be run on the WCU for proof-of-concept testing of new in-vehicle functionality. A Signal Broker API (provided by the Signal Reader module, see below) can be used to easily access in-vehicle signals and parameters. Output data from the RP module is uploaded to the WICE back-end where it is made available in the WICE Portal. The RP module supports both native applications, compiled for the WCU processor architecture, and Node.js applications written in Javascript. The latter is particularly useful for providing in-vehicle GUI functionality.

For more information see [[WICE_RP_How-To]].

==== Signal Reader Module ====
The Signal Reader module executes a measurement task, monitors and logs time-series signal data and stores the data in an MDF file (Measurement Data
Format). Signals can be recorded from the vehicle's internal communication buses (e.g. CAN, LIN, FlexRay). A number of signals internal to the WCU are also available: [[WICE Internal Signals|WICE Internal Signals]]

Signal Reader also supports logging of signals using CCP, XCP and UDS diagnostics. This is sometimes referred to as Active signals.

Triggers are supported, switching between measurement set-ups and starting and stopping recorders. Trigger expression syntax is described [[Signal Reader Trigger Expressions|here]]. Pre- and post-trig recording can be specified, which results in signal data being recorded prior to or subsequent to a trigger condition respectively. Minimum and maximum shot lengths of recorders can also be specified.

==== State of Health Module ====
The State-of-Health (SoH) module is used to read out a limited data set
from test vehicles to monitor their operational status. The specific data to be read is configurable from the WICE portal and includes
position, mileage (odometer), battery voltage, ECU software numbers, Diagnostic Trouble Codes and uptime. The SoH module uses the IDC module to
service a sequence of diagnostic requests, created by the WICE Portal
based on which data is requested and the diagnostic database of the vehicle type. Position is accessed from the GPS Module (see below)
and uptime is accessed from the WCU internal module (see below).

==== SWDL module ====
The Software Download (SWDL) module makes it possible to download ECU software to connected vehicles for re-programming. The input to the SWDL module is a number of VBF (Versatile Binary Format) files containing the ECU software, and PIN codes for the ECUs to be reprogrammed. Sequence files can also be supplied for pre- and post-programming diagnostics.

==== Video module ====
The video module makes it possible to record video clips from cameras connected to the WCU. Video can also be streamed in real time from WCUs for live video monitoring purposes.
The recording of video can be triggered by a push-button connected to the WCU, or from the Signal Reader module by specifying a recorder name or a trigger expression. In the latter case, when the corresponding Signal Reader recorder is started (i.e. when a trigger condition is fulfilled) the video recording starts, and when the recorder stops, the video recording does as well. Pre-trig buffering is supported.
Video resolution, frame rate and compression format can be specified in the module configuration.

==== WCU internals Module ====
The WCU internals Module logs useful information about a WCU, including
uptime, battery voltage (on the WCU power input), and memory usage.

==== WCU Status Module ====
The WCU status Daemon, statusd,
monitors the status of the WCU, including all the modules, and
reports to the WICE Portal. The daemon also provides a common i/o API
for all modules, including GPS and digital i/o.

=== Power Management ===
The Power Management settings of the WCU determines how and when the unit is started and shut down. What Power Management mechanisms are available depends on the WCU hardware platform. The following refers to the MX4 platform.
The MX4 unit can be started and stopped based on the ''ignition'' input pin or on the availability or absence of CAN traffic on any of the CAN interfaces. The WCU can also be configured to start after a specific time interval from shut-down. The configuration is done in the [[The Portal Administrator View#Power Management| WCU Configuration]] in the WICE Portal.
Note that the behaviour of the ignition pin depends on the setting of the START switch on the back of the WCU. If the switch is set to INT the pin will always be active, so that if the WCU is set to''Wake on ignition'' it will be always on. If the switch is set to EXT, the pin will reflect the current state of the ignition of the vehicle (providing it is correctly installed).

WCU platform

2022-12-22T14:47:43Z

Mathias: /* WCU Modules */

The Wireless Communication Unit (WCU) is the in-vehicle unit running the WICE WCU software and communicating with the vehicle and the WICE back-end.

WCU:s are identified by a unique text string, which by convention is the MAC address of (one of) the ethernet interfaces in the unit. The WCU id is configured on each WCU (automatically from the MAC address) and is a search parameter available in the WICE Portal web-GUI.

=== WCU Hardware Platform ===
The following hardware platforms are supported for the WICE WCU:

* Host Mobility MX-4 (T20, T30, T30FR and V61)
* Fältcom MIIPS Committo
* Raspberry Pi
* Nvidia Jetson Xavier

Depending on the specific hardware platform, the WCU supports a number of communication interfaces, such as CAN, LIN, FlexRay and Ethernet and that be configured in different ways using the WICE Portal.

The WCU platform can also support some limited user-interaction through light-emitting diodes (LED) on the side of the unit. A description of the LEDs is available [[WCU LEDs|here]].

=== WCU Firmware ===
The WCU firmware is the operating system, device drivers and basic packages required to run the system. The WCU units are delivered with the firmware installed. It can be remotely upgraded from the WICE Portal in a similar way as the WCU Software (see below).

=== WCU Software ===
The WCU software is delivered as a self-extracting application installation package, which can be run on the WCU:s manually from a command prompt, using a suitably prepared USB stick, or updated remotely using the WICE Portal mechanism for remote software upgrades.

The WICE solution for remote update of the WCU software works as follows: The Alkit staff member responsible for the WCU software deployment publishes installation packages for supported versions of the WCU software at the WICE Portal, in the WICE back-end server infrastructure. WICE administrators can then select which version of the available WCU software versions should be run on each of the WCUs that are registered in the system (see [[The Portal Administrator View#Edit the WCU Configuration|Edit WCU Configuration]]). This is done by choosing a particular version in a drop-down menu in the WICE Portal in the WCU configuration view. Many WCUs can be configured at the same time.
Then, whenever a WCU connects to the back-end, a check is made to see whether a different WCU software version (higher or lower version) than the currently installed version for the WCU in question is configured. If so, the installation package is downloaded to the WCU’s solid-state storage over the secure TLS connection that was established when the WCU connected. When the download is finished, the WCU software package will be installed on the WCU. After the installation has finished, the WCU will report back to the WICE back-end infrastructure with the new version of the WCU, so that WICE administrators can keep track of the currently installed software version, as well as the history of software changes.
A similar process is performed to update the WCU firmware and operating system. When new firmware is installed, the partition where the certificate and configuration files reside is left unaltered.

The WCU software release history is available [[https://wice-sysdoc.alkit.se/index.php/WICE_WCU_Software_Revision_History here]].

==== Extra Bundles ====
Some WICE software packages, referred to as 'extra bundles' are not installed by default. The user needs to select which, if any, extra bundles should be installed on a particular WCU. This is done in the WICE Portal, Edit Configuration. [[Extra bundles|For more information about Extra bundles, click here]].

=== WCU Modules ===
The WCU Modules are the software components of the WCU producing
measurement data. They are configured through the Configuration Manager, which communicates with the WICE Portal, where the user can access and change the overall WCU configuration and the per-module configurations.

The data capture behavior of the WCU modules is described by a measurement task, downloaded from the WICE Portal by the Task Manager component, which sets up the modules.

The available WCU modules are:
* Arcos
* Area5
* Audio
* Blue piraT
* Canrecorder
* DLT
* DoIP
* ETAS
* Ethernet capture
* GPS
* IDC
* LPD
* M-Log
* Rapid Prototyping
* Signal Reader
* State-of-Health
* SWDL
* Video
* WCU internals and status

==== Arcos module ====
The Arcos module makes it possible to use an Arcos data logger (from Ipetronik) connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the Arcos and data can be offloaded and uploaded to the portal.
==== Area5 module ====
The Area5 module is used to read out ECU memory segments using CCP or XCP. The binary data of the memory segments are uploaded to the back-end where they are translated into parameter sets and signals.

==== Audio module ====
The audio module makes it possible to record sound clips from microphones connected to the audio devices of WCUs. Audio can also be streamed in real time from WCUs for live audio monitoring purposes.
The recording of audio can be triggered by a push button connected to the WCU, or from the Signal Reader module by specifying a recorder name or a trigger expression. In the latter case, when the corresponding Signal Reader recorder is started or when the trigger condition is fulfilled the audio recording starts, and when the recorder stops, the audio recording does as well. Pre-trig buffering is supported.
Audio sample rate, number of channels (mono or stereo) and compression format can be specified in the module configuration.

==== Blue piraT Module ====
The Blue piraT module makes it possible to use a Blue piraT logger connected to the WCU through an Ethernet port.
Measurement configuration can be downloaded to the logger and measurement data can be offloaded and uploaded to the WICE Portal.

==== CAN Recorder Module ====
The CAN Recorder Module supports frame logging on the CAN-buses the WCU is connected to. Filters for the ECU identifiers to log can be
defined in the WICE Portal interface when creating a CAN Recorder measurement task.

==== DLT module ====
The DLT module supports read-out of Diagnostic Log Trace files. See [[DLT Module|DLT module]].

==== DoIP module ====
The DoIP module makes it possible to establish a tunnel over the Internet to a WCU for synchronous communication using the DoIP protocol.
In the WCU, the remote DoIP functionality is based on the DoIP daemon '''doipd''', which relays DoIP communication between vehicle and the back-end.
It also takes care of waking up the vehicle when communication requests are pending. For more information see [[Remote Diagnostics over IP (DoIP)|Remote Diagnostics over IP (DoIP)]].

==== Ethernet Capture Module ====
The Ethernet Capture module supports logging of ethernet frames on one of the WCU's ethernet interfaces. Filters can be set (in tcpdump format) for selecting which frames to capture. The result is logged in a pcap file, which is uploaded to the WICE Portal.

==== ETAS Module ====
The ETAS module makes it possible to use an ETAS ES720 measurement system connected to the WCU through an Ethernet port.
Measurement tasks can be downloaded to the ES720 and measurement data can be offloaded and uploaded to the WICE Portal.

==== File Fetcher Module ====
The only configuration in the File Fetcher Module is the debug level which specifies the amount of logging from the WCU regarding its handling of the File fetcher task.

==== GPS Module ====
The GPS Module reads the position of a WCU at regular intervals and
reports to the WICE Portal, to support map-based localization of vehicles for the fleet-management service and for the "Plot Route" function of the metrology service.

==== IDC module ====
The IDC module allows a sequence of diagnostic requests to be sent on the
in-vehicle network (either CAN or Ethernet), and the responses are collected in a result file. IDC can also read OBD-II PIDs and interpret the responses.
IDC supports diagnostics over CAN using ISO15765-2 and over IP/Ethernet using ISO13400. Both physical and functional ECU addressing is supported.
An IDC sequence file can in addition to diagnostic requests also contain commands, as described in [[IDC sequence file commands]].

==== LPD module ====
The LPD module supports long term driveline testing using a custom built Android app that connects to the WICE WCU.

==== M-Log module ====
The M-log module makes it possible to use an M-Log data logger connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the M-Log and data can be offloaded and uploaded to the portal.

==== Rapid Prototyping module ====
With the Rapid Prototyping (RP) module, custom software components can be run on the WCU for proof-of-concept testing of new in-vehicle functionality. A Signal Broker API (provided by the Signal Reader module, see below) can be used to easily access in-vehicle signals and parameters. Output data from the RP module is uploaded to the WICE back-end where it is made available in the WICE Portal. The RP module supports both native applications, compiled for the WCU processor architecture, and Node.js applications written in Javascript. The latter is particularly useful for providing in-vehicle GUI functionality.

For more information see [[WICE_RP_How-To]].

==== Signal Reader Module ====
The Signal Reader module executes a measurement task, monitors and logs time-series signal data and stores the data in an MDF file (Measurement Data
Format). Signals can be recorded from the vehicle's internal communication buses (e.g. CAN, LIN, FlexRay). A number of signals internal to the WCU are also available: [[WICE Internal Signals|WICE Internal Signals]]

Signal Reader also supports logging of signals using CCP, XCP and UDS diagnostics. This is sometimes referred to as Active signals.

Triggers are supported, switching between measurement set-ups and starting and stopping recorders. Trigger expression syntax is described [[Signal Reader Trigger Expressions|here]]. Pre- and post-trig recording can be specified, which results in signal data being recorded prior to or subsequent to a trigger condition respectively. Minimum and maximum shot lengths of recorders can also be specified.

==== State of Health Module ====
The State-of-Health (SoH) module is used to read out a limited data set
from test vehicles to monitor their operational status. The specific data to be read is configurable from the WICE portal and includes
position, mileage (odometer), battery voltage, ECU software numbers, Diagnostic Trouble Codes and uptime. The SoH module uses the IDC module to
service a sequence of diagnostic requests, created by the WICE Portal
based on which data is requested and the diagnostic database of the vehicle type. Position is accessed from the GPS Module (see below)
and uptime is accessed from the WCU internal module (see below).

==== SWDL module ====
The Software Download (SWDL) module makes it possible to download ECU software to connected vehicles for re-programming. The input to the SWDL module is a number of VBF (Versatile Binary Format) files containing the ECU software, and PIN codes for the ECUs to be reprogrammed. Sequence files can also be supplied for pre- and post-programming diagnostics.

==== Video module ====
The video module makes it possible to record video clips from cameras connected to the WCU. Video can also be streamed in real time from WCUs for live video monitoring purposes.
The recording of video can be triggered by a push-button connected to the WCU, or from the Signal Reader module by specifying a recorder name or a trigger expression. In the latter case, when the corresponding Signal Reader recorder is started (i.e. when a trigger condition is fulfilled) the video recording starts, and when the recorder stops, the video recording does as well. Pre-trig buffering is supported.
Video resolution, frame rate and compression format can be specified in the module configuration.

==== WCU internals Module ====
The WCU internals Module logs useful information about a WCU, including
uptime, battery voltage (on the WCU power input), and memory usage.

==== WCU Status Module ====
The WCU status Daemon, statusd,
monitors the status of the WCU, including all the modules, and
reports to the WICE Portal. The daemon also provides a common i/o API
for all modules, including GPS and digital i/o.

=== Power Management ===
The Power Management settings of the WCU determines how and when the unit is started and shut down. What Power Management mechanisms are available depends on the WCU hardware platform. The following refers to the MX4 platform.
The MX4 unit can be started and stopped based on the ''ignition'' input pin or on the availability or absence of CAN traffic on any of the CAN interfaces. The WCU can also be configured to start after a specific time interval from shut-down. The configuration is done in the [[The Portal Administrator View#Power Management| WCU Configuration]] in the WICE Portal.
Note that the behaviour of the ignition pin depends on the setting of the START switch on the back of the WCU. If the switch is set to INT the pin will always be active, so that if the WCU is set to''Wake on ignition'' it will be always on. If the switch is set to EXT, the pin will reflect the current state of the ignition of the vehicle (providing it is correctly installed).

WCU platform

2022-12-22T14:46:14Z

Mathias: /* WCU Modules */

The Wireless Communication Unit (WCU) is the in-vehicle unit running the WICE WCU software and communicating with the vehicle and the WICE back-end.

WCU:s are identified by a unique text string, which by convention is the MAC address of (one of) the ethernet interfaces in the unit. The WCU id is configured on each WCU (automatically from the MAC address) and is a search parameter available in the WICE Portal web-GUI.

=== WCU Hardware Platform ===
The following hardware platforms are supported for the WICE WCU:

* Host Mobility MX-4 (T20, T30, T30FR and V61)
* Fältcom MIIPS Committo
* Raspberry Pi
* Nvidia Jetson Xavier

Depending on the specific hardware platform, the WCU supports a number of communication interfaces, such as CAN, LIN, FlexRay and Ethernet and that be configured in different ways using the WICE Portal.

The WCU platform can also support some limited user-interaction through light-emitting diodes (LED) on the side of the unit. A description of the LEDs is available [[WCU LEDs|here]].

=== WCU Firmware ===
The WCU firmware is the operating system, device drivers and basic packages required to run the system. The WCU units are delivered with the firmware installed. It can be remotely upgraded from the WICE Portal in a similar way as the WCU Software (see below).

=== WCU Software ===
The WCU software is delivered as a self-extracting application installation package, which can be run on the WCU:s manually from a command prompt, using a suitably prepared USB stick, or updated remotely using the WICE Portal mechanism for remote software upgrades.

The WICE solution for remote update of the WCU software works as follows: The Alkit staff member responsible for the WCU software deployment publishes installation packages for supported versions of the WCU software at the WICE Portal, in the WICE back-end server infrastructure. WICE administrators can then select which version of the available WCU software versions should be run on each of the WCUs that are registered in the system (see [[The Portal Administrator View#Edit the WCU Configuration|Edit WCU Configuration]]). This is done by choosing a particular version in a drop-down menu in the WICE Portal in the WCU configuration view. Many WCUs can be configured at the same time.
Then, whenever a WCU connects to the back-end, a check is made to see whether a different WCU software version (higher or lower version) than the currently installed version for the WCU in question is configured. If so, the installation package is downloaded to the WCU’s solid-state storage over the secure TLS connection that was established when the WCU connected. When the download is finished, the WCU software package will be installed on the WCU. After the installation has finished, the WCU will report back to the WICE back-end infrastructure with the new version of the WCU, so that WICE administrators can keep track of the currently installed software version, as well as the history of software changes.
A similar process is performed to update the WCU firmware and operating system. When new firmware is installed, the partition where the certificate and configuration files reside is left unaltered.

The WCU software release history is available [[https://wice-sysdoc.alkit.se/index.php/WICE_WCU_Software_Revision_History here]].

==== Extra Bundles ====
Some WICE software packages, referred to as 'extra bundles' are not installed by default. The user needs to select which, if any, extra bundles should be installed on a particular WCU. This is done in the WICE Portal, Edit Configuration. [[Extra bundles|For more information about Extra bundles, click here]].

=== WCU Modules ===
The WCU Modules are the software components of the WCU producing
measurement data. They are configured through the Configuration Manager, which communicates with the WICE Portal, where the user can access and change the overall WCU configuration and the per-module configurations.

The data capture behavior of the WCU modules is described by a measurement task, downloaded from the WICE Portal by the Task Manager component, which sets up the modules.

The available WCU modules are:
* Arcos
* Area5
* Audio
* Blue piraT
* Canrecorder
* DoIP
* ETAS
* Ethernet capture
* GPS
* IDC
* LPD
* M-Log
* Rapid Prototyping
* Signal Reader
* State-of-Health
* SWDL
* Video
* WCU internals and status

==== Arcos module ====
The Arcos module makes it possible to use an Arcos data logger (from Ipetronik) connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the Arcos and data can be offloaded and uploaded to the portal.
==== Area5 module ====
The Area5 module is used to read out ECU memory segments using CCP or XCP. The binary data of the memory segments are uploaded to the back-end where they are translated into parameter sets and signals.

==== Audio module ====
The audio module makes it possible to record sound clips from microphones connected to the audio devices of WCUs. Audio can also be streamed in real time from WCUs for live audio monitoring purposes.
The recording of audio can be triggered by a push button connected to the WCU, or from the Signal Reader module by specifying a recorder name or a trigger expression. In the latter case, when the corresponding Signal Reader recorder is started or when the trigger condition is fulfilled the audio recording starts, and when the recorder stops, the audio recording does as well. Pre-trig buffering is supported.
Audio sample rate, number of channels (mono or stereo) and compression format can be specified in the module configuration.

==== Blue piraT Module ====
The Blue piraT module makes it possible to use a Blue piraT logger connected to the WCU through an Ethernet port.
Measurement configuration can be downloaded to the logger and measurement data can be offloaded and uploaded to the WICE Portal.

==== CAN Recorder Module ====
The CAN Recorder Module supports frame logging on the CAN-buses the WCU is connected to. Filters for the ECU identifiers to log can be
defined in the WICE Portal interface when creating a CAN Recorder measurement task.

==== DLT module ====
See [[DLT Module|DLT module]].

==== DoIP module ====
The DoIP module makes it possible to establish a tunnel over the Internet to a WCU for synchronous communication using the DoIP protocol.
In the WCU, the remote DoIP functionality is based on the DoIP daemon '''doipd''', which relays DoIP communication between vehicle and the back-end.
It also takes care of waking up the vehicle when communication requests are pending. For more information see [[Remote Diagnostics over IP (DoIP)|Remote Diagnostics over IP (DoIP)]].

==== Ethernet Capture Module ====
The Ethernet Capture module supports logging of ethernet frames on one of the WCU's ethernet interfaces. Filters can be set (in tcpdump format) for selecting which frames to capture. The result is logged in a pcap file, which is uploaded to the WICE Portal.

==== ETAS Module ====
The ETAS module makes it possible to use an ETAS ES720 measurement system connected to the WCU through an Ethernet port.
Measurement tasks can be downloaded to the ES720 and measurement data can be offloaded and uploaded to the WICE Portal.

==== File Fetcher Module ====
The only configuration in the File Fetcher Module is the debug level which specifies the amount of logging from the WCU regarding its handling of the File fetcher task.

==== GPS Module ====
The GPS Module reads the position of a WCU at regular intervals and
reports to the WICE Portal, to support map-based localization of vehicles for the fleet-management service and for the "Plot Route" function of the metrology service.

==== IDC module ====
The IDC module allows a sequence of diagnostic requests to be sent on the
in-vehicle network (either CAN or Ethernet), and the responses are collected in a result file. IDC can also read OBD-II PIDs and interpret the responses.
IDC supports diagnostics over CAN using ISO15765-2 and over IP/Ethernet using ISO13400. Both physical and functional ECU addressing is supported.
An IDC sequence file can in addition to diagnostic requests also contain commands, as described in [[IDC sequence file commands]].

==== LPD module ====
The LPD module supports long term driveline testing using a custom built Android app that connects to the WICE WCU.

==== M-Log module ====
The M-log module makes it possible to use an M-Log data logger connected to the WCU through an Ethernet port. Measurement tasks can be downloaded to the M-Log and data can be offloaded and uploaded to the portal.

==== Rapid Prototyping module ====
With the Rapid Prototyping (RP) module, custom software components can be run on the WCU for proof-of-concept testing of new in-vehicle functionality. A Signal Broker API (provided by the Signal Reader module, see below) can be used to easily access in-vehicle signals and parameters. Output data from the RP module is uploaded to the WICE back-end where it is made available in the WICE Portal. The RP module supports both native applications, compiled for the WCU processor architecture, and Node.js applications written in Javascript. The latter is particularly useful for providing in-vehicle GUI functionality.

For more information see [[WICE_RP_How-To]].

==== Signal Reader Module ====
The Signal Reader module executes a measurement task, monitors and logs time-series signal data and stores the data in an MDF file (Measurement Data
Format). Signals can be recorded from the vehicle's internal communication buses (e.g. CAN, LIN, FlexRay). A number of signals internal to the WCU are also available: [[WICE Internal Signals|WICE Internal Signals]]

Signal Reader also supports logging of signals using CCP, XCP and UDS diagnostics. This is sometimes referred to as Active signals.

Triggers are supported, switching between measurement set-ups and starting and stopping recorders. Trigger expression syntax is described [[Signal Reader Trigger Expressions|here]]. Pre- and post-trig recording can be specified, which results in signal data being recorded prior to or subsequent to a trigger condition respectively. Minimum and maximum shot lengths of recorders can also be specified.

==== State of Health Module ====
The State-of-Health (SoH) module is used to read out a limited data set
from test vehicles to monitor their operational status. The specific data to be read is configurable from the WICE portal and includes
position, mileage (odometer), battery voltage, ECU software numbers, Diagnostic Trouble Codes and uptime. The SoH module uses the IDC module to
service a sequence of diagnostic requests, created by the WICE Portal
based on which data is requested and the diagnostic database of the vehicle type. Position is accessed from the GPS Module (see below)
and uptime is accessed from the WCU internal module (see below).

==== SWDL module ====
The Software Download (SWDL) module makes it possible to download ECU software to connected vehicles for re-programming. The input to the SWDL module is a number of VBF (Versatile Binary Format) files containing the ECU software, and PIN codes for the ECUs to be reprogrammed. Sequence files can also be supplied for pre- and post-programming diagnostics.

==== Video module ====
The video module makes it possible to record video clips from cameras connected to the WCU. Video can also be streamed in real time from WCUs for live video monitoring purposes.
The recording of video can be triggered by a push-button connected to the WCU, or from the Signal Reader module by specifying a recorder name or a trigger expression. In the latter case, when the corresponding Signal Reader recorder is started (i.e. when a trigger condition is fulfilled) the video recording starts, and when the recorder stops, the video recording does as well. Pre-trig buffering is supported.
Video resolution, frame rate and compression format can be specified in the module configuration.

==== WCU internals Module ====
The WCU internals Module logs useful information about a WCU, including
uptime, battery voltage (on the WCU power input), and memory usage.

==== WCU Status Module ====
The WCU status Daemon, statusd,
monitors the status of the WCU, including all the modules, and
reports to the WICE Portal. The daemon also provides a common i/o API
for all modules, including GPS and digital i/o.

=== Power Management ===
The Power Management settings of the WCU determines how and when the unit is started and shut down. What Power Management mechanisms are available depends on the WCU hardware platform. The following refers to the MX4 platform.
The MX4 unit can be started and stopped based on the ''ignition'' input pin or on the availability or absence of CAN traffic on any of the CAN interfaces. The WCU can also be configured to start after a specific time interval from shut-down. The configuration is done in the [[The Portal Administrator View#Power Management| WCU Configuration]] in the WICE Portal.
Note that the behaviour of the ignition pin depends on the setting of the START switch on the back of the WCU. If the switch is set to INT the pin will always be active, so that if the WCU is set to''Wake on ignition'' it will be always on. If the switch is set to EXT, the pin will reflect the current state of the ignition of the vehicle (providing it is correctly installed).

New features in v2.80

2022-12-22T14:44:05Z

Mathias:

== Play multiple time-overlapping videos simultaneously in Preview data ==
[[Preview data]] has been improved so it displays multiple time-overlapping videos in the media controller appearing below the main plot if there are any video or audio measurements for the current selected measurement file.

All time-overlapping videos can be viewed simultaneously or individually. If two or more videos exists for the same point in time, one of the videos can be viewed in picture-in-picture mode and thus moved to any available screen.

== Edit test request name has now "test type" (Not in all versions of the Portal) ==
The window Edit Vehicle-dialog which is reached by going to the Vehicles tab, choosing a vehicle and pressing the "Edit Vehicle"-button and then "Edit test request name". It opens a window containing information about test-labels and associated names. These associated names, also known as "Test request names", can be edited or added for each test label value (TCPxRef value).

New feature in this window:

* Column "Test type" is added.
* Can now save [[Save View and Search Expressions|views]]
* Windows sizes are more dynamic.

== Edit signal reader assignment change which measurement setup that will startup ==
When edit/creating a signal reader assignment it was previously the first created measurement setup that will run at the start. Now it is possible to select another by selecting a setup and then click on "Set as startup". Read more about signal reader assignment [[Signal Reader Assignment Editor|here]].

== Support for signal names with square brackets in trigger expressions ==
Trigger expressions can now handle signal names with square brackets (i.e. [ and ]). Specifically, active signal names (from SDDB files) are now allowed to contain square brackets. (Previously they were replaced by underscore.)

== Area5 result file decoding handles non-ascii characters (Not in all versions of the Portal) ==
If there are non-ascii characters in an a2l file used for area5 decoding, the characters are escaped to produce valid json output.

WICE Internal Signals

2022-09-19T20:10:20Z

Mathias:

The following WICE-internal signals are supported by Signal Reader:

{| class="wikitable"
!'''Signal name'''
!Description
|-
|Accelerometer_X
|The value of the X direction of the WCU's built-in accelerometer.
|-
|Accelerometer_Y
|The value of the Y direction of the WCU's built-in accelerometer.
|-
|Accelerometer_Z
|The value of the Z direction of the WCU's built-in accelerometer.
|-
|Audio_Device_1
|The status of audio device 1 (1=recording, 0 = not recording). When present in a recorder, the audio module will record sound from the device.
|-
|Audio_Device_2
|The status of audio device 2 (1=recording, 0 = not recording). When present in a recorder, the audio module will record sound from the device.
|-
|Busload_CAN_<n>
|The bus load on CAN bus <n>
|-
|CSQ
|The built-in modem's CSQ value (Signal Quality)
|-
|Date_Year
|The year of the current date.
|-
|Date_Month
|The month (1-12) of the current date.
|-
|Date_Day
|The day of the month (1-31) of the current date.
|-
|Date_Weekday
|The day of the week (1-7, where 1 is Sunday).
|-
|Date_Hour
|The hour of the day (0-23).
|-
|Date_Minute
|The minute of the hour (0-59).
|-
|Date_Second
|The second of the minute (0-59).
|-
|Dynamic_<n>
|Special signals with values assignable from external software components (typically used for Rapid Prototyping).
|-
|IO__AI_<n>
|Analog input number <n>
|-
|IO__DI_<n>
|Digital input number <n>
|-
|IO__DO_<n>
|Digital output number <n>
|-
|Log_All_Frames_CAN_<n>
|Log all CAN frames on CAN bus <n>
|-
|Log_All_Frames_FlexRay_<n>
|Log all CAN frames on Flexray bus <n>
|-
|Latitude
|The GPS latitude
|-
|Longitude
|The GPS longitude
|-
|Network_Receive_Rate_eth0
|The rate i kilobilts per second of receiving data on the eth0 interface
|-
|Network_Receive_Rate_eth1
|The rate i kilobilts per second of receiving data on the eth1 interface
|-
|Network_Receive_Rate_ppp0
|The rate i kilobilts per second of receiving data on the ppp0 (i.e. mobile data communication) interface
|-
|Network_Transmit_Rate_eth0
|The rate i kilobilts per second of transmitting data on the eth0 interface
|-
|Network_Transmit_Rate_eth1
|The rate i kilobilts per second of transmitting data on the eth1 interface
|-
|Network_Transmit_Rate_ppp0
|The rate i kilobilts per second of transmitting data on the ppp0 (i.e. mobile data communication) interface
|-
|Power_Mode
|The power mode of the WCU
|-
|Random
|A random number generator
|-
|Random_Start
|A random number generator updated once, at program start
|-
|Random_Setup_Switch
|A random number generator updated at each measurement set-up switch
|-
|Start_Signal
|The start signal of the WCU
|-
|Start_Signal_Voltage
|The voltage of the start signal of the WCU, in millivolts
|-
|Speed
|The GPS speed
|-
|Start_Switch
|The start switch of the WCU
|-
|Tester_Present
|When present in a measurement set-up, a Tester Present diagnostic request (with suppress Positive Response bit set) will be sent periodically.
|-
|Time_Since_Epoch
|The time elapsed since the epoch (Jan 1, 1970, 00:00)
|-
|Time_Since_Start
|The time elapsed since the start of the task
|-
|Time_Since_Setup_Switch
|The time elapsed since the activation of the current measurement set-up
|-
|Trigger_Button
|The trigger button connected to the WCU
|-
|Usage_CPU
|The WCU CPU usage in percent
|-
|Usage_Memory
|The WCU memory usage in percent
|-
|Video_Camera_1
|The status of video camera 1 (1=connected, 0 = disconnected). When present in a recorder, the video module will record video from the camera.
|-
|Video_Camera_2
|The status of video camera 2 (1=connected, 0 = disconnected). When present in a recorder, the video module will record video from the camera.
|-
|WCU_Battery
|The WCU battery voltage in millivolts
|-
|WCU_Temp
|The WCU internal temperature in degrees Celsius
|-
|WCU_Voltage
|The WCU voltage in millivolts
|}

Signal Reader Trigger Expressions

2022-09-15T11:39:07Z

Mathias:

Trigger conditions are expressions evaluated by the Signal Reader module to control when recorders are started and stopped and when measurement set-up switches are performed.
Trigger conditions are boolean expressions, evaluated to either true or false. A number of operators can be combined to form the trigger expression. The allowed operators in trigger expressions are shown in the table below.

{| class="wikitable"
!=
|Tests for equality. Syntax: expression = expression
|-
!!=
|Tests for inequality. Syntax: expression != expression
|-
!<
|Tests for left side of expression being less than right side. Syntax: expression < expression
|-
!>
|Tests for left side of expression being greater than right side. Syntax: expression > expression
|-
!<=
|Tests for left side of expression being less or equal to right side. Syntax: expression <= expression
|-
!>=
|Tests for left side of expression being greater or equal to right side. Syntax: expression >= expression
|-
!AND
|Logical conjunction between left and right side boolean expressions. Syntax: boolean expression AND boolean expression
|-
!OR
|Logical disjunction between left and right side boolean expressions. Syntax: boolean expression OR boolean expression
|-
!CHANGE
|True when the specified signal changes value by at least the specified amount. Syntax: CHANGE(Signal, amount)
|-
!CHANGE_UP
|True when the specified signal increases its value with at least the specified amount. Syntax: CHANGE_UP(Signal, amount)
|-
!CHANGE_DOWN
|True when the specified signal decreases its value with at least the specified amount. Syntax: CHANGE_DOWN(Signal, amount)
|-
!CHANGE_BY
|True when the specified signal changes value by exactly the specified amount. Syntax: CHANGE_BY(Signal, amount)
|-
!CHANGE_UP_BY
|True when the specified signal increases its value by exactly the specified amount. Syntax: CHANGE_UP_BY(Signal, amount)
|-
!CHANGE_DOWN_BY
|True when the specified signal decreases its value by exactly the specified amount. Syntax: CHANGE_DOWN_BY(Signal, amount)
|-
!CHANGE_FROM_TO
|True when the specified signal changes from the specified value to the other specified value. Syntax: CHANGE_FROM_TO(Signal, value, value)
|-
!TIMER
|Effects a delay in seconds from that the specified signal is greater than zero. Syntax: TIMER(signal, time)
|-
!EXPR_TIMER
|Effects a delay in seconds from that the condition is fulfilled. Syntax: EXPR_TIMER(expression, time)
|-
!TIME_COUNTER
|Counts the time elapsed while the supplied boolean expression has been true. You can optionally supply an expression resetting the time counter to zero. Syntax: TIME_COUNTER(expression) or TIME_COUNTER(expression, expression)
|-
!SAMPLE_COUNTER
|Counts the number of samples received while the boolean expression is true. You can optionally supply an expression resetting the time counter to zero. Syntax: SAMPLE_COUNTER(expression) or SAMPLE_COUNTER(expression, expression)
|-
!EVERY
|Repeatedly becomes true after a time interval, specified in seconds, has elapsed. Syntax: EVERY(time)
|-
!MOVAV
|Calculates a moving average over the specified signal. Syntax: MOVAV(Signal)
|-
!ABS
|Calculates the absolute value of the specified expression. Syntax: ABS(expression)
|-
!MIN
|Calculates the minimum value of two expressions. Syntax: MIN(expression, expression)
|-
!MAX
|Calculates the maximum value of two expressions. Syntax: MAX(expression, expression)
|-
!MEAN
|Calculates the mean value of two expressions. Syntax: MEAN(expression, expression)
|-
!LOSS_OF_SIGNAL
|True when the specified signal disappears for the specified number of seconds. Syntax: LOSS_OF_SIGNAL(Signal, seconds)
|}

Signal Reader Trigger Expressions

2022-09-15T11:32:41Z

Mathias:

Trigger conditions are expressions evaluated by the Signal Reader module to control when recorders are started and stopped and when measurement set-up switches are performed.
Trigger conditions are boolean expressions, evaluated to either true or false. A number of operators can be combined to form the trigger expression. The allowed operators in trigger expressions are shown in the table below.

{| class="wikitable"
!=
|Tests for equality. Syntax: expression = expression
|-
!!=
|Tests for inequality. Syntax: expression != expression
|-
!<
|Tests for left side of expression being less than right side. Syntax: expression < expression
|-
!>
|Tests for left side of expression being greater than right side. Syntax: expression > expression
|-
!<=
|Tests for left side of expression being less or equal to right side. Syntax: expression <= expression
|-
!>=
|Tests for left side of expression being greater or equal to right side. Syntax: expression >= expression
|-
!AND
|Logical conjunction between left and right side boolean expressions. Syntax: boolean expression AND boolean expression
|-
!OR
|Logical disjunction between left and right side boolean expressions. Syntax: boolean expression OR boolean expression
|-
!CHANGE
|True when the specified signal changes value by at least the specified amount. Syntax: CHANGE(Signal, amount)
|-
!CHANGE_UP
|True when the specified signal increases its value with at least the specified amount. Syntax: CHANGE_UP(Signal, amount)
|-
!CHANGE_DOWN
|True when the specified signal decreases its value with at least the specified amount. Syntax: CHANGE_DOWN(Signal, amount)
|-
!CHANGE_FROM_TO
|True when the specified signal changes from the specified value to the other specified value. Syntax: CHANGE_FROM_TO(Signal, value, value)
|-
!CHANGE_BY
|True when the specified signal changes value by exactly the specified amount. Syntax: CHANGE_BY(Signal, amount)
|-
!CHANGE_UP_BY
|True when the specified signal increases its value by exactly the specified amount. Syntax: CHANGE_UP_BY(Signal, amount)
|-
!CHANGE_DOWN_BY
|True when the specified signal decreases its value by exactly the specified amount. Syntax: CHANGE_DOWN_BY(Signal, amount)
|-
!CHANGE_FROM_TO
|True when the specified signal changes from the specified value to the other specified value. Syntax: CHANGE_FROM_TO(Signal, value, value)
|-
!TIMER
|Effects a delay in seconds from that the specified signal is greater than zero. Syntax: TIMER(signal, time)
|-
!EXPR_TIMER
|Effects a delay in seconds from that the condition is fulfilled. Syntax: EXPR_TIMER(expression, time)
|-
!TIME_COUNTER
|Counts the time elapsed while the supplied boolean expression has been true. You can optionally supply an expression resetting the time counter to zero. Syntax: TIME_COUNTER(expression) or TIME_COUNTER(expression, expression)
|-
!SAMPLE_COUNTER
|Counts the number of samples received while the boolean expression is true. You can optionally supply an expression resetting the time counter to zero. Syntax: SAMPLE_COUNTER(expression) or SAMPLE_COUNTER(expression, expression)
|-
!EVERY
|Repeatedly becomes true after a time interval, specified in seconds, has elapsed. Syntax: EVERY(time)
|-
!MOVAV
|Calculates a moving average over the specified signal. Syntax: MOVAV(Signal)
|-
!ABS
|Calculates the absolute value of the specified expression. Syntax: ABS(expression)
|-
!MIN
|Calculates the minimum value of two expressions. Syntax: MIN(expression, expression)
|-
!MAX
|Calculates the maximum value of two expressions. Syntax: MAX(expression, expression)
|-
!MEAN
|Calculates the mean value of two expressions. Syntax: MEAN(expression, expression)
|-
!LOSS_OF_SIGNAL
|True when the specified signal disappears for the specified number of seconds. Syntax: LOSS_OF_SIGNAL(Signal, seconds)
|}

New features in v2.75

2022-04-19T06:19:15Z

Mathias:

== New way of handling diagnostic references for vehicle profiles ==
[[File:Edit-diag-ref-edit-mode.png|thumb|The dialog for editing diagnostic references - a new way to choose ECUs for a vehicle profile.]]
Before, one and only one diagnostic reference file (sddb-file) could be connected to a vehicle profile. This release introduces a new and more complex way of choosing which ECUs and software versions that are associated to a vehicle profile. It is possible to select single files like before, combine multiple files or manually add/remove single ECUs.

This functionality is reached through [[Vehicle Profiles|the Vehicle Profiles tab]] and how to manage it is described in the section [[Vehicle Profiles#Edit diagnostic reference - Manage active signals connected to the vehicle profile|Edit diagnostic reference]].

== New trigger expression for Loss of Signal ==
Signal Reader supports a new trigger expression intended for situations where a signals disappears after being present on a communication bus. The syntax is LOSS_OF_SIGNAL(SignalName, Seconds), which will become true when the named signal is gone for at least the specified number of seconds.

== Signal Reader support for J1939 DM1 messages ==
Signal Reader now supports reading and logging of J1939 DM1 messages.

== Support for alternative means of automatic connection of a vehicle to a WCU ==
Historically, WCUs have had the functionality of automatically telling the portal which vehicle it is in. This has been done by reading the vehicle's VIN number and reporting this to portal which then has made a connection between the two entities.

== The periodicity of Active Signals can be set in the Signal Reader Assignment Editor ==
The periodicity active signals can be set in the 'Modules' tab in the Signal Reader assignment editor. Click the 'Modules Settings' button to browse the Active Signals by ECU and view/edit the periodicity.

== Support for M-Log firmware updates ==
The firmware of an M-Log unit can be updated by selecting the desired firmware version in the M-Log module settings.

New features in v2.75

2022-04-19T06:17:04Z

Mathias:

Signal Reader Trigger Expressions

2022-04-14T06:48:16Z

Mathias:

Trigger conditions are expressions evaluated by the Signal Reader module to control when recorders are started and stopped and when measurement set-up switches are performed.
Trigger conditions are boolean expressions, evaluated to either true or false. A number of operators can be combined to form the trigger expression. The allowed operators in trigger expressions are shown in the table below.

{| class="wikitable"
!=
|Tests for equality. Syntax: expression = expression
|-
!!=
|Tests for inequality. Syntax: expression != expression
|-
!<
|Tests for left side of expression being less than right side. Syntax: expression < expression
|-
!>
|Tests for left side of expression being greater than right side. Syntax: expression > expression
|-
!<=
|Tests for left side of expression being less or equal to right side. Syntax: expression <= expression
|-
!>=
|Tests for left side of expression being greater or equal to right side. Syntax: expression >= expression
|-
!AND
|Logical conjunction between left and right side boolean expressions. Syntax: boolean expression AND boolean expression
|-
!OR
|Logical disjunction between left and right side boolean expressions. Syntax: boolean expression OR boolean expression
|-
!CHANGE
|True when the specified signal changes value by at least the specified amount. Syntax: CHANGE(Signal, amount)
|-
!CHANGE_UP
|True when the specified signal increases its value with the specified amount. Syntax: CHANGE_UP(Signal, amount)
|-
!CHANGE_DOWN
|True when the specified signal increases its value with the specified amount. Syntax: CHANGE_DOWN(Signal, amount)
|-
!CHANGE_FROM_TO
|True when the specified signal changes from the specified value to the other specified value. Syntax: CHANGE_FROM_TO(Signal, value, value)
|-
!TIMER
|Effects a delay in seconds from that the specified signal is greater than zero. Syntax: TIMER(signal,time)
|-
!EXPR_TIMER
|Effects a delay in seconds from that the condition is fulfilled. Syntax: EXPR_TIMER(expression,time)
|-
!TIME_COUNTER
|Counts the time elapsed while the supplied boolean expression has been true. You can optionally supply an expression resetting the time counter to zero. Syntax: TIME_COUNTER(expression) or TIME_COUNTER(expression, expression)
|-
!SAMPLE_COUNTER
|Counts the number of samples received while the boolean expression is true. You can optionally supply an expression resetting the time counter to zero. Syntax: SAMPLE_COUNTER(expression) or SAMPLE_COUNTER(expression, expression)
|-
!EVERY
|Repeatedly becomes true after a time interval, specified in seconds, has elapsed. Syntax: EVERY(time)
|-
!MOVAV
|Calculates a moving average over the specified signal. Syntax: MOVAV(Signal)
|-
!ABS
|Calculates the absolute value of the specified expression. Syntax: ABS(expression)
|-
!MIN
|Calculates the minimum value of two expressions. Syntax: MIN(expression, expression)
|-
!MAX
|Calculates the maximum value of two expressions. Syntax: MAX(expression, expression)
|-
!MEAN
|Calculates the mean value of two expressions. Syntax: MEAN(expression, expression)
|-
!LOSS_OF_SIGNAL
|True when the specified signal disappears for the specified number of seconds. Syntax: LOSS_OF_SIGNAL(Signal, seconds)
|}

New features in v2.75

2022-04-13T12:27:01Z

Mathias:

New features in v2.74

2022-03-18T07:15:48Z

Mathias: /* MSW validation for MLog tasks */

== Users table: Two new columns showing users' access to M2M and the Portal ==
In the [[The Portal Administrator View#The User Tab|Users tab]] (found under the Administration tab) there are two new columns for each user row:

* M2M access
* Portal access

Denoting whether or not the user has access to the M2M API (Application Programmatic Interface) or to the Portal (the web-based graphical user interface).

If logged in as an administrator these accesses can be edited for users.

== Removed dialogs regarding file downloads ==
After this release there are no dialogs asking about file naming when downloading result files for a task. Hence less actions required before the files can be downloaded.

== Read snapshot & Extended Data for DREC in Signal Reader assignment editor ==
It is now possible to choose to get snapshot and extended data in Assignment editor for DTCs read out in a DREC. If the sequence file contains a DTC read-out request (19 02) it will be possible to activate this function.

== Unlimited number of shots selectable for recorders in Signal Reader assignment editor ==
Th number of shots can now be set to infinite (unlimited).

== New DAQ information window ==
A new window in the assignment editor is added. It can be reached from the modules tab or the measurement setup view by clicking on the button “DAQ Information”. The new window shows each module in every measurement setup that has signals in a recorder and comes from an A2L file. For each module, this window will show signals in it and which DAQ-list it belongs to. If the information about the DAQ list can be parsed from the a2l file, with the selected interface, it will also show how many bytes each list can contain.
== MSW validation for MLog tasks ==
It is now possible to enter MSW numbers for Mlog Tasks, to ensure the measurement setup of the Mlog is using the correct description files.

== Signal Reader improvements ==
There are multiple improvements to the Signal Reader module:

* Now properly supports pre-trigged recording of WICE internal signals,
* Supports for an unlimited number of shots in recorders,
* Supports diagnostic recorders (DRECs) using DoIP,
* Handles DTC extended data and shaphots per DREC,
* Enables and disables Ethernet using digital out 4 at MS switches when using DoIP,
* Has a more lenient MSW validation mechanism: if ECU SW numbers read-out using SoH do not match the assignment, validation fails.
* Bugfixes.

New features in v2.74

2022-03-18T07:13:46Z

Mathias:

== Users table: Two new columns showing users' access to M2M and the Portal ==
In the [[The Portal Administrator View#The User Tab|Users tab]] (found under the Administration tab) there are two new columns for each user row:

* M2M access
* Portal access

Denoting whether or not the user has access to the M2M API (Application Programmatic Interface) or to the Portal (the web-based graphical user interface).

If logged in as an administrator these accesses can be edited for users.

== Removed dialogs regarding file downloads ==
After this release there are no dialogs asking about file naming when downloading result files for a task. Hence less actions required before the files can be downloaded.

== Read snapshot & Extended Data for DREC in Signal Reader assignment editor ==
It is now possible to choose to get snapshot and extended data in Assignment editor for DTCs read out in a DREC. If the sequence file contains a DTC read-out request (19 02) it will be possible to activate this function.

== Unlimited number of shots selectable for recorders in Signal Reader assignment editor ==
Th number of shots can now be set to infinite (unlimited).

== New DAQ information window ==
A new window in the assignment editor is added. It can be reached from the modules tab or the measurement setup view by clicking on the button “DAQ Information”. The new window shows each module in every measurement setup that has signals in a recorder and comes from an A2L file. For each module, this window will show signals in it and which DAQ-list it belongs to. If the information about the DAQ list can be parsed from the a2l file, with the selected interface, it will also show how many bytes each list can contain.
== MSW validation for MLog tasks ==
It is now possible to enter MSW numbers for Mlog Tasks, to ensure the measurement setup of the Mlog is done using the correct description files.

== Signal Reader improvements ==
There are multiple improvements to the Signal Reader module:

* Now properly supports pre-trigged recording of WICE internal signals,
* Supports for an unlimited number of shots in recorders,
* Supports diagnostic recorders (DRECs) using DoIP,
* Handles DTC extended data and shaphots per DREC,
* Enables and disables Ethernet using digital out 4 at MS switches when using DoIP,
* Has a more lenient MSW validation mechanism: if ECU SW numbers read-out using SoH do not match the assignment, validation fails.
* Bugfixes.

New features in v2.74

2022-03-18T07:06:21Z

Mathias: /* Users table: Two new columns showing users' access to M2M and the Portal */

== Users table: Two new columns showing users' access to M2M and the Portal ==
In the [[The Portal Administrator View#The User Tab|Users tab]] (found under the Administration tab) there are two new columns for each user row:

* M2M access
* Portal access

Denoting whether or not the user has access to the M2M API (Application Programmatic Interface) or to the Portal (the web-based graphical user interface).

If logged in as an administrator these accesses can be edited for users.

== Removed dialogs regarding file downloads ==
After this release there are no dialogs asking about file naming when downloading result files for a task. Hence less actions required before the files can be downloaded.

== Read snapshot & Extended Data for DREC in assignment editor ==
It is now possible to choose to get snapshot and extended data in Assignment editor for DTCs read out in a DREC. If the sequence file contains a DTC read-out request (19 02) it will be possible to activate this function.

== New DAQ information window ==
A new window in the assignment editor is added. It can be reached from the modules tab or the measurement setup view by clicking on the button “DAQ Information”. The new window shows each module in every measurement setup that has signals in a recorder and comes from an A2L file. For each module, this window will show signals in it and which DAQ-list it belongs to. If the information about the DAQ list can be parsed from the a2l file, with the selected interface, it will also show how many bytes each list can contain.
== MSW validation for MLog tasks ==
It is now possible to enter MSW numbers for Mlog Tasks, to ensure the measurement setup of the Mlog is done using the correct description files.

New features in v2.74

2022-03-18T07:03:09Z

Mathias:

New features in v2.74

2022-03-18T06:58:38Z

Mathias: /* Read snapshot & Extended Data for DREC in assignment editor */

New features in v2.72

2022-02-07T07:39:15Z

Mathias: /* File fetcher: A new task to fetch files from other units in vehicle (Not in all versions of the Portal) */

== DLT task supports several daemons ==
[[File:New-task-dlt-2-72.png|thumb|The DLT new task dialog|200x200px]]
The [[Creating a Task#Diagnostic Log and Trace (DLT)|Diagnostic Log and Trace (DLT)]] task can now fetch logs from several daemons.

Previously the task could only have one daemon. Then the address and port number of the daemon were specified in the [[DLT Module]], while the filters to be applied to the logs were specified while creating the task itself. This is still the case for WCUs that have a software version earlier than 2.72.0.

From this release the addresses and port numbers for each daemon as well as the filters are specified while creating the task, given that the software version of the WCUs are 2.72.0. The only thing that hereby is specified in the DLT Module is the debug level.

== File fetcher: A new module to fetch files from other units in vehicle (Not in all versions of the Portal) ==
[[File:New-task-file-fetcher-2x72.png|thumb|New task dialog of the File fetcher task.|200x200px]]
[[Creating a Task#File fetcher|The File fetcher task]] will make the WCU fetch files from another unit in the vehicle and make them available for downloading in the Portal.

The following needs to be specified when creating such a task:

* '''File path''' - The path to a file or file-containing directory on the unit's file system. This specifies which files that will be fetched.
* '''Username''' - To log in to the unit.
* '''Password''' - To log in to unit.
* '''IP address''' - To find the unit.
* '''Port''' - To find the unit.

[[WCU platform#File Fetcher Module|The File fetcher module]] only contains debug level to steer the log output of the WCU when it is handling the task.

== VIN reader supports method "DoIP" ==
It is now possible to choose DoIP as a VIN reader method in the [[The Portal Administrator View#Configure the Vinreader Module|VIN reader module]].

== WCU History: new searchable columns "WCU Version" and "WCU Firmware Version" ==
In [[Vehicles|the Vehicles tab]], when right-clicking a WCU and choosing "Show WCU history", a dialog window with the changes made to the WCU shows up.

This release adds two new ''searchable'' columns to this dialog window:

* '''WCU Version''' - Shows when a new version has been applied to the WCU.
* '''WCU Firmware version''' - shows when a new firmware version has been applied to the WCU.

The columns are searched using [[Tasks Tab#Search columns with regular expressions|regular expressions]].

== Support for UDS (2C/2A) and XCP over CAN for A2L-based signals in the Signal Reader Assignment Editor ==
From version 2.72, Signal Reader supports UDS (service 2C/2A) and XCP/CAN communication for A2L-based signals. In the Signal Reader Assignment Editor the selection of whether to use UDS or XCP/CAN (or the previously available CCP/CAN, XCP/UDP or XCP/TCP) for A2L Signals is done in the Modules tab. For more information about this, see [[Signal Reader Assignment Editor]].

== Module settings for Signal Reader now has support for selecting DoIP as default diagnostic channel ==
In the module settings for Signal Reader you can now select DoIP as default channel. This affects diagnostics based signals and DRECs. When DoIP is selected as the default interface it is also possible to select static IP or the IP that the vehicle announces.

== Signal Reader Assignment Editor shows IP address and port from A2L-file ==
In the assignment editor for Signal Reader, for communication interfaces over Ethernet (XCP/UDP and XCP/TCP), the IP address and port that is specified in the A2L file is displayed. It is also possible to change the address and port for the specific assignment in the same window.

== Edit test request name (Not in all versions of the Portal) ==
A new button has been added to the Edit Vehicle-dialog which is reached by going to [[Vehicles|the Vehicles tab]], choosing a vehicle and pressing the "Edit Vehicle"-button.
[[File:Edit-vechicle-with-edit-test-request-name-btn-ver-2x72.png|thumb|The new button showing in the "Edit vechicle"-dialog. Not all versions of the Portal contain this button.]]
The new button is called "Edit test request name". It opens a window containing information about test-labels and associated names. These associated names, also known as "Test request names", can be edited or added for each test label value (TCPxRef value).

New features in v2.72

2022-02-07T07:34:40Z

Mathias: /* Signal Reader A2L. Interface that is over Ethernet shows the IP-Address that is from the A2L-file */

== DLT task supports several daemons ==
[[File:New-task-dlt-2-72.png|thumb|The DLT new task dialog|200x200px]]
The [[Creating a Task#Diagnostic Log and Trace (DLT)|Diagnostic Log and Trace (DLT)]] task can now fetch logs from several daemons.

Previously the task could only have one daemon. Then the address and port number of the daemon were specified in the [[DLT Module]], while the filters to be applied to the logs were specified while creating the task itself. This is still the case for WCUs that have a software version earlier than 2.72.0.

From this release the addresses and port numbers for each daemon as well as the filters are specified while creating the task, given that the software version of the WCUs are 2.72.0. The only thing that hereby is specified in the DLT Module is the debug level.

== File fetcher: A new task to fetch files from other units in vehicle (Not in all versions of the Portal) ==
[[File:New-task-file-fetcher-2x72.png|thumb|New task dialog of the File fetcher task.|200x200px]]
[[Creating a Task#File fetcher|The File fetcher task]] will make the WCU fetch files from another unit in the vehicle and make them available for downloading in the Portal.

The following needs to be specified when creating such a task:

* '''File path''' - The path to a file or file-containing directory on the unit's file system. This specifies which files that will be fetched.
* '''Username''' - To log in to the unit.
* '''Password''' - To log in to unit.
* '''IP address''' - To find the unit.
* '''Port''' - To find the unit.

[[WCU platform#File Fetcher Module|The File fetcher module]] only contains debug level to steer the log output of the WCU when it is handling the task.

== VIN reader supports method "DoIP" ==
It is now possible to choose DoIP as a VIN reader method in the [[The Portal Administrator View#Configure the Vinreader Module|VIN reader module]].

== WCU History: new searchable columns "WCU Version" and "WCU Firmware Version" ==
In [[Vehicles|the Vehicles tab]], when right-clicking a WCU and choosing "Show WCU history", a dialog window with the changes made to the WCU shows up.

This release adds two new ''searchable'' columns to this dialog window:

* '''WCU Version''' - Shows when a new version has been applied to the WCU.
* '''WCU Firmware version''' - shows when a new firmware version has been applied to the WCU.

The columns are searched using [[Tasks Tab#Search columns with regular expressions|regular expressions]].

== Support for UDS (2C/2A) and XCP over CAN for A2L-based signals in the Signal Reader Assignment Editor ==
From version 2.72, Signal Reader supports UDS (service 2C/2A) and XCP/CAN communication for A2L-based signals. In the Signal Reader Assignment Editor the selection of whether to use UDS or XCP/CAN (or the previously available CCP/CAN, XCP/UDP or XCP/TCP) for A2L Signals is done in the Modules tab. For more information about this, see [[Signal Reader Assignment Editor]].

== Module settings for Signal Reader now has support for selecting DoIP as default diagnostic channel ==
In the module settings for Signal Reader you can now select DoIP as default channel. This affects diagnostics based signals and DRECs. When DoIP is selected as the default interface it is also possible to select static IP or the IP that the vehicle announces.

== Signal Reader Assignment Editor shows IP address and port from A2L-file ==
In the assignment editor for Signal Reader, for communication interfaces over Ethernet (XCP/UDP and XCP/TCP), the IP address and port that is specified in the A2L file is displayed. It is also possible to change the address and port for the specific assignment in the same window.

== Edit test request name (Not in all versions of the Portal) ==
A new button has been added to the Edit Vehicle-dialog which is reached by going to [[Vehicles|the Vehicles tab]], choosing a vehicle and pressing the "Edit Vehicle"-button.
[[File:Edit-vechicle-with-edit-test-request-name-btn-ver-2x72.png|thumb|The new button showing in the "Edit vechicle"-dialog. Not all versions of the Portal contain this button.]]
The new button is called "Edit test request name". It opens a window containing information about test-labels and associated names. These associated names, also known as "Test request names", can be edited or added for each test label value (TCPxRef value).

New features in v2.72

2022-02-07T07:30:23Z

Mathias: /* Module settings for signal reader has now support for selecting DoIP as default channel interface (Affecting active signals) */

== DLT task supports several daemons ==
[[File:New-task-dlt-2-72.png|thumb|The DLT new task dialog|200x200px]]
The [[Creating a Task#Diagnostic Log and Trace (DLT)|Diagnostic Log and Trace (DLT)]] task can now fetch logs from several daemons.

Previously the task could only have one daemon. Then the address and port number of the daemon were specified in the [[DLT Module]], while the filters to be applied to the logs were specified while creating the task itself. This is still the case for WCUs that have a software version earlier than 2.72.0.

From this release the addresses and port numbers for each daemon as well as the filters are specified while creating the task, given that the software version of the WCUs are 2.72.0. The only thing that hereby is specified in the DLT Module is the debug level.

== File fetcher: A new task to fetch files from other units in vehicle (Not in all versions of the Portal) ==
[[File:New-task-file-fetcher-2x72.png|thumb|New task dialog of the File fetcher task.|200x200px]]
[[Creating a Task#File fetcher|The File fetcher task]] will make the WCU fetch files from another unit in the vehicle and make them available for downloading in the Portal.

The following needs to be specified when creating such a task:

* '''File path''' - The path to a file or file-containing directory on the unit's file system. This specifies which files that will be fetched.
* '''Username''' - To log in to the unit.
* '''Password''' - To log in to unit.
* '''IP address''' - To find the unit.
* '''Port''' - To find the unit.

[[WCU platform#File Fetcher Module|The File fetcher module]] only contains debug level to steer the log output of the WCU when it is handling the task.

== VIN reader supports method "DoIP" ==
It is now possible to choose DoIP as a VIN reader method in the [[The Portal Administrator View#Configure the Vinreader Module|VIN reader module]].

== WCU History: new searchable columns "WCU Version" and "WCU Firmware Version" ==
In [[Vehicles|the Vehicles tab]], when right-clicking a WCU and choosing "Show WCU history", a dialog window with the changes made to the WCU shows up.

This release adds two new ''searchable'' columns to this dialog window:

* '''WCU Version''' - Shows when a new version has been applied to the WCU.
* '''WCU Firmware version''' - shows when a new firmware version has been applied to the WCU.

The columns are searched using [[Tasks Tab#Search columns with regular expressions|regular expressions]].

== Support for UDS (2C/2A) and XCP over CAN for A2L-based signals in the Signal Reader Assignment Editor ==
From version 2.72, Signal Reader supports UDS (service 2C/2A) and XCP/CAN communication for A2L-based signals. In the Signal Reader Assignment Editor the selection of whether to use UDS or XCP/CAN (or the previously available CCP/CAN, XCP/UDP or XCP/TCP) for A2L Signals is done in the Modules tab. For more information about this, see [[Signal Reader Assignment Editor]].

== Module settings for Signal Reader now has support for selecting DoIP as default diagnostic channel ==
In the module settings for Signal Reader you can now select DoIP as default channel. This affects diagnostics based signals and DRECs. When DoIP is selected as the default interface it is also possible to select static IP or the IP that the vehicle announces.

== Signal Reader A2L. Interface that is over Ethernet shows the IP-Address that is from the A2L-file ==
In the assignment editor for signal reader when an interface that is over Ethernet is selected for the A2L modules, the IP and port address that comes from the file is displayed.

It is also possible to change the address for the specific assignment in the same window.

== Edit test request name (Not in all versions of the Portal) ==
A new button has been added to the Edit Vehicle-dialog which is reached by going to [[Vehicles|the Vehicles tab]], choosing a vehicle and pressing the "Edit Vehicle"-button.
[[File:Edit-vechicle-with-edit-test-request-name-btn-ver-2x72.png|thumb|The new button showing in the "Edit vechicle"-dialog. Not all versions of the Portal contain this button.]]
The new button is called "Edit test request name". It opens a window containing information about test-labels and associated names. These associated names, also known as "Test request names", can be edited or added for each test label value (TCPxRef value).

New features in v2.72

2022-02-07T07:25:35Z

Mathias: /* Support for USD & XCP Can for A2L Signals in the Signal Reader Assignment Editor */

== DLT task supports several daemons ==
[[File:New-task-dlt-2-72.png|thumb|The DLT new task dialog|200x200px]]
The [[Creating a Task#Diagnostic Log and Trace (DLT)|Diagnostic Log and Trace (DLT)]] task can now fetch logs from several daemons.

Previously the task could only have one daemon. Then the address and port number of the daemon were specified in the [[DLT Module]], while the filters to be applied to the logs were specified while creating the task itself. This is still the case for WCUs that have a software version earlier than 2.72.0.

From this release the addresses and port numbers for each daemon as well as the filters are specified while creating the task, given that the software version of the WCUs are 2.72.0. The only thing that hereby is specified in the DLT Module is the debug level.

== File fetcher: A new task to fetch files from other units in vehicle (Not in all versions of the Portal) ==
[[File:New-task-file-fetcher-2x72.png|thumb|New task dialog of the File fetcher task.|200x200px]]
[[Creating a Task#File fetcher|The File fetcher task]] will make the WCU fetch files from another unit in the vehicle and make them available for downloading in the Portal.

The following needs to be specified when creating such a task:

* '''File path''' - The path to a file or file-containing directory on the unit's file system. This specifies which files that will be fetched.
* '''Username''' - To log in to the unit.
* '''Password''' - To log in to unit.
* '''IP address''' - To find the unit.
* '''Port''' - To find the unit.

[[WCU platform#File Fetcher Module|The File fetcher module]] only contains debug level to steer the log output of the WCU when it is handling the task.

== VIN reader supports method "DoIP" ==
It is now possible to choose DoIP as a VIN reader method in the [[The Portal Administrator View#Configure the Vinreader Module|VIN reader module]].

== WCU History: new searchable columns "WCU Version" and "WCU Firmware Version" ==
In [[Vehicles|the Vehicles tab]], when right-clicking a WCU and choosing "Show WCU history", a dialog window with the changes made to the WCU shows up.

This release adds two new ''searchable'' columns to this dialog window:

* '''WCU Version''' - Shows when a new version has been applied to the WCU.
* '''WCU Firmware version''' - shows when a new firmware version has been applied to the WCU.

The columns are searched using [[Tasks Tab#Search columns with regular expressions|regular expressions]].

== Support for UDS (2C/2A) and XCP over CAN for A2L-based signals in the Signal Reader Assignment Editor ==
From version 2.72, Signal Reader supports UDS (service 2C/2A) and XCP/CAN communication for A2L-based signals. In the Signal Reader Assignment Editor the selection of whether to use UDS or XCP/CAN (or the previously available CCP/CAN, XCP/UDP or XCP/TCP) for A2L Signals is done in the Modules tab. For more information about this, see [[Signal Reader Assignment Editor]].

== Module settings for signal reader has now support for selecting DoIP as default channel interface (Affecting active signals) ==
Module settings for signal reader can select DoIP as default channel. This affects the signals that are active and has the setting “Default channel” to the interface. For DoIP it is also possible to select static IP or the IP that the vehicle announces.

This setting also affects the DREC for signal readers.

== Signal Reader A2L. Interface that is over Ethernet shows the IP-Address that is from the A2L-file ==
In the assignment editor for signal reader when an interface that is over Ethernet is selected for the A2L modules, the IP and port address that comes from the file is displayed.

It is also possible to change the address for the specific assignment in the same window.

== Edit test request name (Not in all versions of the Portal) ==
A new button has been added to the Edit Vehicle-dialog which is reached by going to [[Vehicles|the Vehicles tab]], choosing a vehicle and pressing the "Edit Vehicle"-button.
[[File:Edit-vechicle-with-edit-test-request-name-btn-ver-2x72.png|thumb|The new button showing in the "Edit vechicle"-dialog. Not all versions of the Portal contain this button.]]
The new button is called "Edit test request name". It opens a window containing information about test-labels and associated names. These associated names, also known as "Test request names", can be edited or added for each test label value (TCPxRef value).

Signal Reader Assignment Editor

2022-02-07T07:22:18Z

Mathias: /* Select different communication interface or transport protocol */

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 send diagnostic requests onto the vehicle's communication buses and record the responses. The diagnostic requests are supplied in a sequence file uploaded by the user. The sequence file contains one diagnostic request per line, with the ECU id at the beginning of the line. There can optionally be other information as well. The syntax is the same as the one used for the IDC module, see [[IDC_Sequence_File_Syntax |Sequence File Syntax]]. The result from a DREC will be a diagnostic log file, a text file containing both the requests from the sequence file and the corresponding responses.

====Recorder - SREC====
SREC (Signal recorder) is used to record signals on the vehicle's communication buses. The result of an SREC is an MDF file containing the time series data of the selected signals.[[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.

'''PLA-Compressions''' level can be set per signal by clicking on the pla column for the signal or select a row and click on “Edit PLA”. Read more [[PLA-compression window|here]].
=====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 (232).

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 (232).

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 (232).

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]]

== Active signals ==
An Active Signal is a signal that is created på polling an ECU for a numerical value at a predefined frequency. The polling is typically done using the ReadDataByIdentifier diagnostic service. To create an assignment with active signals, the vehicle profile has to have a diagnostic description. This is set in the vehicle profile settings [[Vehicle Pofiles|here]]. There has to be a diagnostic description connected to the vehicle profile when the assignments are created to be able to select active signals. If a vehicle profile is updated, an assignment can be upgraded to match the new vehicle profile by doing a copy. This will automatically upgrade it and if there is a diagnostic description connected it will be possible to use active signals.

Select “Active signal” in signal Source. Then it is possible to select ECU in ECU name. After that available signals will show up and select/deselect works like for the other signal sources.

When creating a task with an assignment that has active signals selected, a button “ECU SW mappings” will show up. If there is a red exclamation mark, a specific software version has to be selected for one or more ECUs. If a recorder signal does not exist in the selected software version it will be removed. Note that the software version has to contain all active signals that exist in the trigger conditions otherwise it will not be possible to create the task.

==Editing an assignment==
[[File:View assignments.png|thumb|600x600px|View Assignments|link=https://wiki.alkit.se/wice264/index.php/File:View_assignments.png]]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'''. 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.

== Select different communication interface or transport protocol ==
Under the "Modules" tab, the different signal sources are visible. In the "I/O" column, the selected communication interface and transport protocol are shown. By selecting a row and then clicking on the button “Edit Interface” this can be changed. Currently this is only possible for modules with type “A2L” or "Diagnostics." When changing this, a validation of the settings with what is red from the corresponding A2L file is done. If the validation is successful, a green icon will appear. If the icon is a red cross the A2L file does not contain the necessary information for the setting.

When selecting between CAN and Ethernet/DoIP diagnostics, a window pops up where you can select the interface between "Default Channel", "CAN" or "DoIP". Selecting "Default Channel" means that the default channel in the signal reader module settings on the wcu is going to be used. Interface "CAN" a specific CAN interface can be selected to be used for the diagnostic requests. If selecting "DoIP", the diagnostics will be performed over Ethernet using the Diagnostics-over-IP (DoIP) protocol. In this case, you can also select whether to use the IP address broadcasted by the vehicle in a "Vehicle Announcement" message, or you can specify the IP address explicitly (in which case the Vehicle Announcement will be ignored). The DoIP port number to use (default 13400) can also be specified.

A2L modules support the following interfaces, CPP-CAN, XCP-CAN, XCP-TCP, XCP-UDP and UDS (2C/2A).[[File:DoIP-ass-ed.png|alt=CAN or DoIP settings|thumb|CAN or DoIP settings]]

Signal Reader Assignment Editor

2022-01-21T07:40:28Z

Mathias: /* Active signals */

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 send diagnostic requests onto the vehicle's communication buses and record the responses. The diagnostic requests are supplied in a sequence file uploaded by the user. The sequence file contains one diagnostic request per line, with the ECU id at the beginning of the line. There can optionally be other information as well. The syntax is the same as the one used for the IDC module, see [[IDC_Sequence_File_Syntax |Sequence File Syntax]]. The result from a DREC will be a diagnostic log file, a text file containing both the requests from the sequence file and the corresponding responses.

====Recorder - SREC====
SREC (Signal recorder) is used to record signals on the vehicle's communication buses. The result of an SREC is an MDF file containing the time series data of the selected signals.[[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.

'''PLA-Compressions''' level can be set per signal by clicking on the pla column for the signal or select a row and click on “Edit PLA”. Read more [[PLA-compression window|here]].
=====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 (232).

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 (232).

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 (232).

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]]

== Active signals ==
An Active Signal is a signal that is created på polling an ECU for a numerical value at a predefined frequency. The polling is typically done using the ReadDataByIdentifier diagnostic service. To create an assignment with active signals, the vehicle profile has to have a diagnostic description. This is set in the vehicle profile settings [[Vehicle Pofiles|here]]. There has to be a diagnostic description connected to the vehicle profile when the assignments are created to be able to select active signals. If a vehicle profile is updated, an assignment can be upgraded to match the new vehicle profile by doing a copy. This will automatically upgrade it and if there is a diagnostic description connected it will be possible to use active signals.

Select “Active signal” in signal Source. Then it is possible to select ECU in ECU name. After that available signals will show up and select/deselect works like for the other signal sources.

When creating a task with an assignment that has active signals selected, a button “ECU SW mappings” will show up. If there is a red exclamation mark, a specific software version has to be selected for one or more ECUs. If a recorder signal does not exist in the selected software version it will be removed. Note that the software version has to contain all active signals that exist in the trigger conditions otherwise it will not be possible to create the task.

==Editing an assignment==
[[File:View assignments.png|thumb|600x600px|View Assignments|link=https://wiki.alkit.se/wice264/index.php/File:View_assignments.png]]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'''. 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.

== Select different communication interface or transport protocol ==
Under the "Modules" tab, the different signal sources are visible. In the "I/O" column, the selected communication interface and transport protocol are shown. By selecting a row and then clicking on the button “Edit Interface” this can be changed. Currently this is only possible for modules with type “A2L” or "Diagnostics." When changing this, a validation of the settings with what is red from the corresponding A2L file is done. If the validation is successful, a green icon will appear. If the icon is a red cross the A2L file does not contain the necessary information for the setting.

When selecting between CAN and Ethernet/DoIP diagnostics, a window pops up where you can select interface between "Default CAN", "CAN" or "DoIP". Selecting "Default CAN" means the the CAN channel designated as "Default diagnostics channel" in the Signal Reader module settings will be used. If selecting "CAN" a specific CAN interface can be selected to be used for the diagnostic requests. If selecting "DoIP", the diagnostics will be performed over Ethernet using the Diagnostics-over-IP (DoIP) protocol. In this case, you can also select whether to use the IP address broadcasted by the vehicle in a "Vehicle Announcement" message, or you can specify the IP address explicitly (in which case the Vehicle Announcement will be ignored). The DoIP port number to use (default 13400) can also be specified.
[[File:DoIP-ass-ed.png|alt=CAN or DoIP settings|thumb|CAN or DoIP settings]]

Signal Reader Assignment Editor

2022-01-21T07:33:42Z

Mathias: /* Recorder - SREC */

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 send diagnostic requests onto the vehicle's communication buses and record the responses. The diagnostic requests are supplied in a sequence file uploaded by the user. The sequence file contains one diagnostic request per line, with the ECU id at the beginning of the line. There can optionally be other information as well. The syntax is the same as the one used for the IDC module, see [[IDC_Sequence_File_Syntax |Sequence File Syntax]]. The result from a DREC will be a diagnostic log file, a text file containing both the requests from the sequence file and the corresponding responses.

====Recorder - SREC====
SREC (Signal recorder) is used to record signals on the vehicle's communication buses. The result of an SREC is an MDF file containing the time series data of the selected signals.[[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.

'''PLA-Compressions''' level can be set per signal by clicking on the pla column for the signal or select a row and click on “Edit PLA”. Read more [[PLA-compression window|here]].
=====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 (232).

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 (232).

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 (232).

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]]

== Active signals ==
To create an active signal assignment the vehicle profile has to have a diagnostic description. This is set in the vehicle profile settings [[Vehicle Pofiles|here]]. There has to be a diagnostic description connected to the vehicle profile when the assignments are created to be able to select active signals. If a vehicle profile is updated a assignment can be upgraded to match the new vehicle profile by doing a copy. This will automatically upgrade it and if there is a diagnostic description connected it will be possible to use active signals.

Select “Active signal” in signal Source. Then it is possible to select ECU in ECU name. After that will possible signals show up and select/deselect works like for the other signal sources.

When creating a task with an assignment that has active signals connected a button “ECU SW mappings” will show up. If there is a red exclamation mark software version has to be selected for one or more ECU. If a recorder signal does not exist in the selected software version it will be removed. Note that the software version has to contain all active signals that exist in the trigger conditions otherwise it will not be possible to create the task.

==Editing an assignment==
[[File:View assignments.png|thumb|600x600px|View Assignments|link=https://wiki.alkit.se/wice264/index.php/File:View_assignments.png]]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'''. 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.

== Select different communication interface or transport protocol ==
Under the "Modules" tab, the different signal sources are visible. In the "I/O" column, the selected communication interface and transport protocol are shown. By selecting a row and then clicking on the button “Edit Interface” this can be changed. Currently this is only possible for modules with type “A2L” or "Diagnostics." When changing this, a validation of the settings with what is red from the corresponding A2L file is done. If the validation is successful, a green icon will appear. If the icon is a red cross the A2L file does not contain the necessary information for the setting.

When selecting between CAN and Ethernet/DoIP diagnostics, a window pops up where you can select interface between "Default CAN", "CAN" or "DoIP". Selecting "Default CAN" means the the CAN channel designated as "Default diagnostics channel" in the Signal Reader module settings will be used. If selecting "CAN" a specific CAN interface can be selected to be used for the diagnostic requests. If selecting "DoIP", the diagnostics will be performed over Ethernet using the Diagnostics-over-IP (DoIP) protocol. In this case, you can also select whether to use the IP address broadcasted by the vehicle in a "Vehicle Announcement" message, or you can specify the IP address explicitly (in which case the Vehicle Announcement will be ignored). The DoIP port number to use (default 13400) can also be specified.
[[File:DoIP-ass-ed.png|alt=CAN or DoIP settings|thumb|CAN or DoIP settings]]

Signal Reader Assignment Editor

2022-01-21T07:31:50Z

Mathias: /* Recorder - DREC */

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 send diagnostic requests onto the vehicle's communication buses and record the responses. The diagnostic requests are supplied in a sequence file uploaded by the user. The sequence file contains one diagnostic request per line, with the ECU id at the beginning of the line. There can optionally be other information as well. The syntax is the same as the one used for the IDC module, see [[IDC_Sequence_File_Syntax |Sequence File Syntax]]. The result from a DREC will be a diagnostic log file, a text file containing both the requests from the sequence file and the corresponding responses.

====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.

'''PLA-Compressions''' level can be set per signal by clicking on the pla column for the signal or select a row and click on “Edit PLA”. Read more [[PLA-compression window|here]].
=====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 (232).

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 (232).

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 (232).

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]]
== Active signals ==
To create an active signal assignment the vehicle profile has to have a diagnostic description. This is set in the vehicle profile settings [[Vehicle Pofiles|here]]. There has to be a diagnostic description connected to the vehicle profile when the assignments are created to be able to select active signals. If a vehicle profile is updated a assignment can be upgraded to match the new vehicle profile by doing a copy. This will automatically upgrade it and if there is a diagnostic description connected it will be possible to use active signals.

Select “Active signal” in signal Source. Then it is possible to select ECU in ECU name. After that will possible signals show up and select/deselect works like for the other signal sources.

When creating a task with an assignment that has active signals connected a button “ECU SW mappings” will show up. If there is a red exclamation mark software version has to be selected for one or more ECU. If a recorder signal does not exist in the selected software version it will be removed. Note that the software version has to contain all active signals that exist in the trigger conditions otherwise it will not be possible to create the task.

==Editing an assignment==
[[File:View assignments.png|thumb|600x600px|View Assignments|link=https://wiki.alkit.se/wice264/index.php/File:View_assignments.png]]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'''. 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.

== Select different communication interface or transport protocol ==
Under the "Modules" tab, the different signal sources are visible. In the "I/O" column, the selected communication interface and transport protocol are shown. By selecting a row and then clicking on the button “Edit Interface” this can be changed. Currently this is only possible for modules with type “A2L” or "Diagnostics." When changing this, a validation of the settings with what is red from the corresponding A2L file is done. If the validation is successful, a green icon will appear. If the icon is a red cross the A2L file does not contain the necessary information for the setting.

When selecting between CAN and Ethernet/DoIP diagnostics, a window pops up where you can select interface between "Default CAN", "CAN" or "DoIP". Selecting "Default CAN" means the the CAN channel designated as "Default diagnostics channel" in the Signal Reader module settings will be used. If selecting "CAN" a specific CAN interface can be selected to be used for the diagnostic requests. If selecting "DoIP", the diagnostics will be performed over Ethernet using the Diagnostics-over-IP (DoIP) protocol. In this case, you can also select whether to use the IP address broadcasted by the vehicle in a "Vehicle Announcement" message, or you can specify the IP address explicitly (in which case the Vehicle Announcement will be ignored). The DoIP port number to use (default 13400) can also be specified.
[[File:DoIP-ass-ed.png|alt=CAN or DoIP settings|thumb|CAN or DoIP settings]]

Signal Reader Assignment Editor

2022-01-21T07:30:16Z

Mathias: /* Recorder - DREC */

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 send diagnostic requests onto the vehicle's communication buses and record the responses. The diagnostic requests are supplied in a sequence file uploaded by the user. The sequence file contains one diagnostic request per line, with the ECU id at the beginning of the line. There can optionally be other information as well. The syntax is the same as the one used for the IDC module, see [[IDC_Sequence_File_Syntax |Sequence File Syntax]].

====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.

'''PLA-Compressions''' level can be set per signal by clicking on the pla column for the signal or select a row and click on “Edit PLA”. Read more [[PLA-compression window|here]].
=====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 (232).

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 (232).

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 (232).

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]]
== Active signals ==
To create an active signal assignment the vehicle profile has to have a diagnostic description. This is set in the vehicle profile settings [[Vehicle Pofiles|here]]. There has to be a diagnostic description connected to the vehicle profile when the assignments are created to be able to select active signals. If a vehicle profile is updated a assignment can be upgraded to match the new vehicle profile by doing a copy. This will automatically upgrade it and if there is a diagnostic description connected it will be possible to use active signals.

Select “Active signal” in signal Source. Then it is possible to select ECU in ECU name. After that will possible signals show up and select/deselect works like for the other signal sources.

When creating a task with an assignment that has active signals connected a button “ECU SW mappings” will show up. If there is a red exclamation mark software version has to be selected for one or more ECU. If a recorder signal does not exist in the selected software version it will be removed. Note that the software version has to contain all active signals that exist in the trigger conditions otherwise it will not be possible to create the task.

==Editing an assignment==
[[File:View assignments.png|thumb|600x600px|View Assignments|link=https://wiki.alkit.se/wice264/index.php/File:View_assignments.png]]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'''. 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.

== Select different communication interface or transport protocol ==
Under the "Modules" tab, the different signal sources are visible. In the "I/O" column, the selected communication interface and transport protocol are shown. By selecting a row and then clicking on the button “Edit Interface” this can be changed. Currently this is only possible for modules with type “A2L” or "Diagnostics." When changing this, a validation of the settings with what is red from the corresponding A2L file is done. If the validation is successful, a green icon will appear. If the icon is a red cross the A2L file does not contain the necessary information for the setting.

When selecting between CAN and Ethernet/DoIP diagnostics, a window pops up where you can select interface between "Default CAN", "CAN" or "DoIP". Selecting "Default CAN" means the the CAN channel designated as "Default diagnostics channel" in the Signal Reader module settings will be used. If selecting "CAN" a specific CAN interface can be selected to be used for the diagnostic requests. If selecting "DoIP", the diagnostics will be performed over Ethernet using the Diagnostics-over-IP (DoIP) protocol. In this case, you can also select whether to use the IP address broadcasted by the vehicle in a "Vehicle Announcement" message, or you can specify the IP address explicitly (in which case the Vehicle Announcement will be ignored). The DoIP port number to use (default 13400) can also be specified.
[[File:DoIP-ass-ed.png|alt=CAN or DoIP settings|thumb|CAN or DoIP settings]]

Signal Reader Assignment Editor

2022-01-21T07:29:35Z

Mathias: /* Recorder - DREC */

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 send diagnostic requests onto the vehicle's communication buses and record the responses. The diagnostic requests are supplied in a sequence file uploaded by the user. The sequence file contains one diagnostic request per line, with the ECU id at the beginning of the line. There can optionally be other information as well. The syntax is the same as the one used for the IDC module, see [[Sequence File Syntax|IDC_Sequence_File_Syntax]].

====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.

'''PLA-Compressions''' level can be set per signal by clicking on the pla column for the signal or select a row and click on “Edit PLA”. Read more [[PLA-compression window|here]].
=====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 (232).

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 (232).

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 (232).

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]]
== Active signals ==
To create an active signal assignment the vehicle profile has to have a diagnostic description. This is set in the vehicle profile settings [[Vehicle Pofiles|here]]. There has to be a diagnostic description connected to the vehicle profile when the assignments are created to be able to select active signals. If a vehicle profile is updated a assignment can be upgraded to match the new vehicle profile by doing a copy. This will automatically upgrade it and if there is a diagnostic description connected it will be possible to use active signals.

Select “Active signal” in signal Source. Then it is possible to select ECU in ECU name. After that will possible signals show up and select/deselect works like for the other signal sources.

When creating a task with an assignment that has active signals connected a button “ECU SW mappings” will show up. If there is a red exclamation mark software version has to be selected for one or more ECU. If a recorder signal does not exist in the selected software version it will be removed. Note that the software version has to contain all active signals that exist in the trigger conditions otherwise it will not be possible to create the task.

==Editing an assignment==
[[File:View assignments.png|thumb|600x600px|View Assignments|link=https://wiki.alkit.se/wice264/index.php/File:View_assignments.png]]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'''. 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.

== Select different communication interface or transport protocol ==
Under the "Modules" tab, the different signal sources are visible. In the "I/O" column, the selected communication interface and transport protocol are shown. By selecting a row and then clicking on the button “Edit Interface” this can be changed. Currently this is only possible for modules with type “A2L” or "Diagnostics." When changing this, a validation of the settings with what is red from the corresponding A2L file is done. If the validation is successful, a green icon will appear. If the icon is a red cross the A2L file does not contain the necessary information for the setting.

When selecting between CAN and Ethernet/DoIP diagnostics, a window pops up where you can select interface between "Default CAN", "CAN" or "DoIP". Selecting "Default CAN" means the the CAN channel designated as "Default diagnostics channel" in the Signal Reader module settings will be used. If selecting "CAN" a specific CAN interface can be selected to be used for the diagnostic requests. If selecting "DoIP", the diagnostics will be performed over Ethernet using the Diagnostics-over-IP (DoIP) protocol. In this case, you can also select whether to use the IP address broadcasted by the vehicle in a "Vehicle Announcement" message, or you can specify the IP address explicitly (in which case the Vehicle Announcement will be ignored). The DoIP port number to use (default 13400) can also be specified.
[[File:DoIP-ass-ed.png|alt=CAN or DoIP settings|thumb|CAN or DoIP settings]]