.. _Installation:

Installation
============


Ubuntu
------

* Obtain the correct ``neobotix-pilot-core-`` debian package for your architechture and Ubuntu version.
  For example, the file name for the `x86_64` `Ubuntu 20.04` package ends with ``-x86_64-ubuntu-20.04.deb``.
* Install the package as follows:

  .. code-block:: sh

	sudo dpkg -i neobotix-pilot-core-*.deb

* Install missing dependencies via:

  .. code-block:: sh
  
	sudo apt -f install

* The contents of the package should now be installed under ``/opt/neobotix/pilot-core/``.
* If you received a license security dongle and you already attached it,
  unplug it and attach it again in order for the installed udev rule to take
  effect.
* To change the default workspace folder (which is `~/pilot/`) set the following environment variable in your ``~/.bashrc``:

  .. code-block:: sh

	export PILOT_HOME=/your/custom/path
	source ~/.bashrc
	
* To setup the workspace execute the following script:

  .. code-block:: sh

	sh /opt/neobotix/pilot-core/scripts/pilot_setup.sh /opt/neobotix/pilot-core

  This will setup a folder ``~/pilot/`` with default settings.
  
* To enable autostart:

  .. code-block:: sh
    
    cp /opt/neobotix/pilot-core/share/applications/Neobotix-PlatformPilot.desktop ~/.config/autostart/
  
* In addition you can install a desktop launcher as follows:

  .. code-block:: sh
  
    xdg-desktop-icon install /opt/neobotix/pilot-core/share/applications/Neobotix-PlatformPilot.desktop
    
  You may need to right click on the icon first and select "Allow Launching" to activate it.
  
* Change the default configuration to match your platform type:

  .. code-block:: sh

	echo /opt/neobotix/pilot-core/config/default/mpo-700/ > config/local/parent

  where you replace ``mpo-700`` with your platform type.
* If you received a license security dongle, edit your
  ``config/local/LicenseCheck.json`` file to contain your license key
  which you should find printed on the dongle.
* Set a `name` and `serial` for your platform in ``config/local/platform.json``.
* Optionally set additional custom configuration options in ``config/local``, see :ref:`Configuration`. 
* Optionally setup users and passwords, see :ref:`users`.
* See :ref:`Running` on how to run `PlatformPilot`.

Windows
-------

* Execute the ``neobotix-pilot-core-?-windows10.exe`` installer.
* The package will be installed to your Profile Folder in ``C:\Users\?\PlatformPilot\``.
* Change into the folder ``PlatformPilot\bin\config\local``.
  Edit the file ``parent`` with a line like this::
  
	../../../config/default/mpo-700/

  where you substitute ``mpo-700`` with your platform type.
* If you received a license security dongle, edit your
  ``bin\config\local\LicenseCheck.json`` file to contain your license key
  which you should find printed on the dongle.
* Set a `name` and `serial` for your platform in ``bin\config\local\platform.json``.
* Optionally set additional custom configuration options in ``bin\config\local``, see :ref:`Configuration`.
* Optionally setup users and passwords, see :ref:`users`.
* See :ref:`Running` on how to run `PlatformPilot`.