Installation Walkthrough

This article was written for version 2.0.9 of Core. Click here for the most recent version of the help center.

This article walks you through installing PolySync onto your device.

1. Download PolySync Core

Download PolySync Core from the download center to a local machine that meets the supported architecture requirements. You will need to accept the license agreement before you can download PolySync Core.

The PolySync Core release package must match your ECUs architecture and operating system. Contact support help@polysync.io to get access to a specific release package.

2. Migrating from earlier versions of PolySync

2.1 Prepare your files for migration

PolySync has provided a migration script for those of you who are upgrading from a pre-release version to PolySync Core 2.0.9.

The migration script is going to look in the default location /usr/local/polysync/ $PSYNC_HOME for the existing install and do two things:

  • Imports the configuration and logfile sessions that are currently in $PSYNC_HOME to the expected locations in $HOME/.local/share/polysync
  • Creates a backup tarball of the existing installation
    • The backup tarball can be copied to any Ubuntu 16.04 machine and the migration script will place the files where they’re expected for PolySync Core 2.0.9
    • Note: the migration script will delete the contents of $PSYNC_HOME after creating the backup tarball

The migration script, polysync-prerelease-migrate, ships with the PolySync Core 2.0.9 release package.

2.1.1 Run the migration script on the pre-release host
$ cd ~/Downloads
$ tar xf polysync-core_2.0.9.tar.gz
$ cd polysync-core_2.0.9
sudo ./polysync-prerelease-migrate

The migration script will create a backup tarball file in the /opt/ directory with a timestamp, for example /opt/polysync-backup-1476514517.tar.gz.

The migration script needs to be run once more on the new machine, but this time we will supply a command line argument that is the path to the backup tarball that was created in the previous step.

$ sudo ./polysync-prerelease-migrate /opt/polysync-backup-<your-UTC-timestamp-here>.tar.gz

The migration script will decompress the archive in a temporary location and then copy the configuration and logfile files to the expected locations on the system.

The script can take some time, especially if there were large logfile sessions on the pre-release host.

Note: if the migration script detects an existing SDF on the new system, it will not overwrite the newer SDF in $HOME/.local/share/polysync/config with the SDF from the original machine.

To install the original SDF on the new system, extract the SDF file from the polysync-backup-*.tar.gz tarball and copy it to the new location:

$ cd ~/Downloads
$ tar xf polysync-backup-<your-UTC-timestamp-here>.tar.gz
$ cp polysync/db/psync.sdf ~/.local/share/polysync/config/

Now that your pre-release files have been migrated to your new system you can install PolySync.

2.2 Moving your license to a new host

On your pre-release host run:

$ polysync-license-tool -a


*****************************
*** PolySync License Tool ***
API Build Version: 2.0.8-1478129437

Host ID: '(Ethernet) xxxxxxxxxxxx'

[...]
License status: valid
*****************************

On your new-host install the new version and run polysync-license-tool -a

Send mail to help@polysync.io telling them you are migrating to a new host. Be sure to include your: Host ID: '(Ethernet) xxxxxxxxxxxx' from your pre-release and new host systems.

3. Installing PolySync Core

If you are upgrading from a pre-release version of PolySync follow: Migrating files

After you have downloaded the PolySync Core tar file, open a terminal and navigate to the directory where it has been downloaded.

$ cd ~/Downloads
$ tar xf polysync-core_2.0.9.tar.gz
$ cd polysync-core_2.0.9
$ source ./install.sh    #  You will be prompted for your sudo password.

It can take up to 15 minutes for the installation to complete.

The install location, also known as the PolySync Core Home directory, is located at /usr/local/polysync and is denoted with the bash variable $PSYNC_HOME.

4. Activating the license

To download an existing license from the server when upgrading or reinstalling PolySync run the license tool with just the ‘-a’ flag.

$ polysync-license-tool -a


*****************************
*** PolySync License Tool ***
API Build Version: 2.0.9-1486398127

Host ID: '(Ethernet) xxxxxxxxxxxx'

[...]
License status: valid
*****************************
  • Your output should look similar to the output above.

If you do not have a valid license or are having problems activating your license: Contact support help@polysync.io. Be sure to include your: Host ID: '(Ethernet) xxxxxxxxxxxx'

4.1 Known License Error

If you see this error when running the license tool:

$ polysync-license-tool -a

*****************************
*** PolySync License Tool ***
API Build Version: 2.0.9-1486943244

[...]
2017-02-13 14:41:29.02s ERROR  [polysync-license-tool-0] - adding trusted storage license source returned: 1879048255
2017-02-13 14:41:29.02s DEBUG  [polysync-license-tool-0] - trusted storage based licensing may not be available
License status: invalid
To request a license, email help@polysync.io with your machines unique Host ID: '(Ethernet) xxxxxxxxxxxx'
*****************************

You will need to run the following command to clear your license cache:

rm ~/.local/share/polysync/license/am*

5. Start PolySync manager service

We are going to start the polysync-core-manager as a service. It will start the predefined nodes in the System Design File (SDF) with the command:

$ sudo service polysync-core-manager start

You can see the system SDF by opening the SDF Configurator

  • It defines the PolySync runtime:
    • All hosts and nodes in the system
    • What sensors are connected to the ECU, or
    • What sensors will be replaying data

Open the SDF Configurator with this command:

$ polysync-core-sdf-configurator

Note that while in the replay state, the system is referencing the replay SDF .