# Installation guide

## Supported platforms and devices

* i.MX 8
  * CCpilot V510
  * CCpilot V700
  * CCpilot V705
  * CCpilot V710
  * CCpilot V1000
  * CCpilot V1200
* i.MX 6
  * CCpilot VI2
  * CCpilot VS
* i.MX 5
  * CCpilot VA
  * CCpilot VC
  * CCpilot XA/XS
* Core i7
  * CCpilot X900
  * CCpilot X1200
* LinX Software Suite DevEnv
  * v4
  * v5

## Prerequisites

* On versions up to 3.4.0, Qt 5.4.0 or newer

## Installing Data Engine

### CCL 4

Dataengine can be installed on the target in two different ways. For production use should be installed on the target through a RACU bundle. For development / testing dataengine can be installed on the target manually by manually unlocking `appfs` and unpacking it under `appfs`.

#### i.MX 8 CCL 4

##### RAUC bundle

Please reference the `CC Linux - Using RAUC` documentation on the support web site for more information about how to generate a RAUC bundle.

##### Unlock /appfs for development/testing

1. Open an ssh session to the target:
    <code>ssh ccs\<ip-address></code>
2. Change write permissions of /appfs:
    <code>sudo mount -o remount,rw /appfs</code>
3. Check which version partition /appfs is mounted to:
    <code>rauc status</code>
4. Unmount /appfs:
    <code>sudo umount /appfs</code>
5. Format the partition:
    <code>sudo mkfs.ext4 /dev/\<partition></code>
6. Remount /appfs:
    <code>sudo mount /dev/\<partition> /appfs</code>

##### Unpacking tarball

1. Download the tarball, dataengine-ccl4_\<version>_\<TARGET>.tar.gz, from the support site.
2. Transfer the tar.gz package to device:
    <code>scp dataengine-ccl4_\<version>_\<TARGET>.tar.gz ccs@\<ip-address>:/tmp</code>
3. Open an ssh session to the target:
    <code>ssh ccs@\<ip-address></code>
4. Change directory to `/tmp`:
    <code>cd /tmp</code>
5. Run the following code to unpack it:
    <code>sudo tar xzf dataengine-ccl4_\<version>_\<TARGET>.tar.gz -C /appfs</code>
6. Data Engine will not automatically start at boot. See [Service management](runtime#service-management).

#### Core i7 CCL 4

1. Download the tarball, dataengine-ccl4_\<version>_\<TARGET>.tar.gz, from the support site.
2. Follow steps 2-6 from [i.MX 8 CCL 4](#imx-8-ccl-4).

### CCL 3 & CCL 2

#### i.MX 8

1. Download `dataengine_<version>_imx8_USB.zip` from the support site.
2. Extract archive content to an USB flash drive.
3. Attach the USB flash drive to the unit.
4. Wait for the installer to finish.
   * One beep - Success
   * Two beeps - Failure
5. A file named `install.log` is stored on the USB flash drive and contains information regarding the installation.
   Refer to this log in the case that the installation fails.
6. Detach the USB flash drive form the unit.
7. Data Engine will start automatically during next system startup

#### i.MX 6

1. Download `dataengine_<version>_imx6_USB.zip` from the support site.
2. Follow steps 2-7 from [i.MX 8](#i-mx-8).

#### i.MX 5

1. Download `dataengine_<version>_imx5_USB.zip` from the support site.
2. Follow steps 2-7 from [i.MX 8](#i-mx-8).

#### Core i7

1. Download `dataengine_<version>_corei7_USB.zip` from the support site.
2. Follow steps 2-7 from [i.MX 8](#i-mx-8).

### LinX Software Suite DevEnv v5/v4

These steps are intended to be performed in the UX Designer VM.

1. Download `dataengine_<version>_amd64.deb` from the support site
2. Double-click on the package to open it with GDebi
3. Follow the instructions to install the package

It's also possible to install the package using the terminal:

``` shell
sudo apt install ./dataengine_<version>_amd64.deb
```

## Troubleshooting

Please refer to our [Knowledge Base](https://support.crosscontrol.com/knowledge-base) for
further information and troubleshooting guides.