.. _version_retrieval:

=======================================
Retrieving Software Version Information
=======================================

.. contents:: Table of Contents

Overview
========

OpenECU provides methods for retrieving software version information. This
version information can be retrieved over CCP using your calibration tool, or
it can be retrieved using a standard J1939 or UDS message. Additionally, any
version information can be used by your application software.

----------------------------------------

How do I retrieve the platform software version that is running on my ECU?
==========================================================================

There are two blocks that allow you to retrieve the platform version:

- ``psc_PlatformBuildDate``: Outputs the day, month, and year that the
  platform software was built.

- ``psc_PlatformVersion``: Outputs the major, minor, and sub-minor version
  numbers for the platform software.

To find these blocks in the Simulink Library Browser, navigate to:

  OpenECU -> Versioning -> Target Versioning

Refer to the subsequent sections for methods on how to implement these blocks
in your model.

.. image:: version_retrieval_img1.jpg

To retrieve the software version from the target, simply add the newly created
signals as display variables in your calibration tool.

----------------------------------------

How do I retrieve the bootloader software version that is running on my ECU?
============================================================================

There are two blocks for retrieving the bootloader version:

- ``psc_BootBuildDate``: Outputs the day, month, and year the bootloader
  software was built.

- ``psc_BootVersion``: Outputs the major, minor, and sub-minor version numbers
  for the bootloader software.

To find these blocks in the Simulink Library Browser, navigate to:

  OpenECU -> Versioning -> Target Versioning

----------------------------------------

How do I retrieve the reprogramming software version that is running on my ECU?
===============================================================================

There are two blocks for retrieving the reprogramming software version:

- ``psc_PrgBuildDate``: Outputs the day, month, and year the reprogramming
  software was built.

- ``psc_PrgVersion``: Outputs the major, minor, and sub-minor version numbers
  for the reprogramming software.

To find these blocks in the Simulink Library Browser, navigate to:

 OpenECU -> Versioning -> Target Versioning

How do I retrieve the software version of my application that is running on my ECU?
-----------------------------------------------------------------------------------

There are two blocks for retrieving the application software version:

- ``psc_AppBuildDate``: Outputs the day, month, and year your application
  software was built.

- ``psc_AppVersion``: Outputs the major, minor, and sub-minor version numbers
  for your application software.

To find these blocks in the Simulink Library Browser, navigate to:

  OpenECU -> Versioning -> Target Versioning

How do I create a version number for my application?
-----------------------------------------------------

Every OpenECU model must include a ``put_Identification`` block.
Double-clicking the block opens a dialog where you can specify the version
numbers for your application.

.. image:: version_retrieval_img2.jpg
.. image:: version_retrieval_img3.jpg

Example:

* Major version number: 1
* Minor version number: 2
* Sub-minor version number: 3

After setting these, click OK and rebuild your model. Your application
software will now contain a version number.