===== Setup the EAPI in Visual Studio for development =====

====Prerequisites====
  * Download and Install VisualStudio((A license might be required for use)) ([[https://visualstudio.microsoft.com/ |visit Website]])
  * Current version of the Windows EAPI ([[https://support.tq-group.com/en/x86/eapi_windows |EAPI Overview]])
\\
==== Install VisualStudio IDE ====
To install Visual Studio, the installer must be downloaded and executed.\\
Follow the installer until you reach the workload selection.\\
Now the packages have to be selected, which are needed for the corresponding application. \\
The EAPI consists of C code and therefore in this example the package %%"Desktop development with C++"%% is used. \\

++++ Show Screenshot |
{{:en:x86:vs_installer_c.jpg?nolink|}}
++++
After that they have to be installed by clicking install.
Follow the instructions of the installer for the setup of Visual Studio.
\\
\\
==== Setup EAPI project ====
=== create new project ===
After installation, Visual Studio can be started from the Start menu.\\
After the initial setup, the IDE start page should be displayed. \\
Here a new project must be created, in which the EAPI can then be integrated and used in the own application.\\
For this example, we use a %%C++%% console app for the first application. \\
\\
{{:en:x86:vs_setup_project.gif?nolink|}}
\\
=== Copy EAPI header and Libraries to project ===
To use the EAPI functions, the libraries and headers must be included in the project.\\
1. Unpack the EAPI archive and open the EAPI folder (e.g. //TqWin64EAPI_R01.05//)\\
2. Go to the //SDK// folder and copy the folders //Include// and //lib// into the Project folder\\

{{:en:x86:vs_project_folder_structure.png?nolink|}}
\\

----

=== Configure Visual Studio Project ===
For the use of the just copied libraries and header files it is necessary to add them to the project properties.\\
1. Open the project properties under Project -> ExampleApplication Properties\\
++++ Show Screenshot |
{{:en:x86:vs_open_project_properties.gif?nolink|}}
++++
\\
2. In the Property Pages window, navigate to **C/C%%++%%** > **General** and enter the paths to the previously copied include files (header files):
<code>
$(SolutionDir)Include\Eapi;$(SolutionDir)Include\TqLibrary;
</code>
<callout type="primary" icon="true">
The variable **$(SolutionDir)** is a macro which returns the root path of the current project.\\
You can also use an absolute path, e.g.: //C:\workspace\ExampleApplication\//
</callout>
{{:en:x86:projectproperties_include.png?nolink&800|}} \\
\\
3.  navigate to **Linker** > **General** and enter the paths to the previously copied include files:
<code>
$(SolutionDir)\lib\Eapi;$(SolutionDir)\lib\TqLibrary
</code>
{{:en:x86:projectproperties_linkerlib.png?nolink&800|}} \\
\\
4. navigate to **Input** and include the .lib files as //Additional Dependencies//:
<code>
EAPI_1.lib;TqLibrary.lib;
</code>
{{:en:x86:projectproperties_includelib.png?nolink&800|}}
<callout type="warning" icon="true">
== Important ==
The existing entries in the field must not be overwritten!\\
The EAPI entries can simply be added at the beginning of the line.
</callout>
\\
5. Press the //OK// button to save and close the Properties window.
\\ 

----

==== Create simple EAPI Application ====
After configuring the project, the development of the application can be started. 
For a simple example, the existing code must be deleted and replaced with the following example code
++++ view Code: |
<code c++>
//console output
#include <iostream>

//EAPI Header Files
#include "EApi.h"
#include "EApiCommon.h"
#include "EApiTq.h"

//Strings for results
char   manufacturer[30], 
       board[30], 
       bios[30];

uint32_t    runtime;    //runtime value
uint32_t    string_len; //length of char arrays

int main()
{ 
    //Initialise EAPI
    EApiLibInitialize();
    std::cout << "Initialise EAPI\n";
    
    //Get manufacturer 
    string_len = sizeof(manufacturer);
    EApiBoardGetStringA(EAPI_ID_BOARD_MANUFACTURER_STR, manufacturer, &string_len);
    std::cout << "\nManufacturer: \t" << manufacturer;

    //Get board name
    string_len = sizeof(board);
    EApiBoardGetStringA(EAPI_ID_BOARD_NAME_STR, board, &string_len);
    std::cout << "\nBoard Name: \t" << board;

    //Get BIOS version
    string_len = sizeof(bios);
    EApiBoardGetStringA(EAPI_ID_BOARD_BIOS_REVISION_STR, bios, &string_len);
    std::cout << "\nBIOS Version: \t" << bios;

    //Get system uptime
    EApiBoardGetValue(EAPI_ID_BOARD_RUNNING_TIME_METER_VAL, &runtime);
    std::cout << "\nSystem Uptime: \t" << runtime << " Min.\n";

    //wait for user input to exit program
    std::cout << "\nPress enter to close...";
    std::cin.get();

    //UnInitialise EAPI
    EApiLibUnInitialize();
}
</code>
++++

After the code has been integrated into the project, the project can be built. Now the executable application for the target system will be created.
To build the project you need to click the button under **Build > Build ExampleApplication** (Shortcut: //Ctrl + B//)
{{:en:x86:vs_open_project_build.gif?nolink|}}

<callout type="primary" icon="true">
The project is also built when you click on **//Local Windows Debugger//**. \\
However, when the application is executed automatically, an error occurs because the application only works on a Taget system with EAPI installed.
</callout>
\\

----


==== Setup Remote Debugger on Target====
In order to test the programmed application on the target system, the [[https://docs.microsoft.com/en-us/visualstudio/debugger/remote-debugging|Visual Studio Remote Debugger]] can be used. \\
The Visual Studio Remote Debugger is a tool from Microsoft, which makes it possible to establish a connection (over ethernet) between the IDE on the host computer and the target system. \\
By using the tool, the builder result is automatically deployed to the target and executed. It also allows debugging the application using the IDE. \\
To download the tool, visit [[https://visualstudio.microsoft.com/de/downloads/#remote-tools-for-visual-studio-2022 |visualstudio.microsoft.com]]\\

=== Installation ===

After downloading, run the //VS_RemoteTools.exe// installer and follow the setup instructions to install the tool.\\
Make sure that the latest TQ EAPI is installed on the target: [[https://support.tq-group.com/en/x86/eapi_windows#installation|How to install the EAPI]]

=== Target Configuration ===
After installation, the Remote Debugger can be started from the Windows Start menu.\\
At the first startup, the tool must be configured for the current network. \\
For ease of use, the mode can be used without authentication. \\

<callout type="warning" icon="true">
== Important ==
The following setting makes the system accessible on the network even without authentication. \\
This is not secure and is only recommended in a local test-network.
</callout>

{{:en:x86:vs_rd_setup.gif?nolink|}}
\\

----


==== Setup Remote Debugger on Host (IDE) ====
In order to be able to debug the program via the IDE, we have to establish a connection with our target in the IDE. \\
1. Open the project properties under Project -> ExampleApplication Properties \\
2. Go to the debugging entry and change the "Debugger to launch" to "Remote Windows Debugger" \\
3. Adjust the entries to fit your remote system. We use the following values in this example: \\

{{:en:x86:vs_rd_config.png?nolink|}}

<grid>
<col sm="6">
^Remote Command|C:\deploy\ExampleApplication.exe|
^Working Directiry|C:\deploy|
^Remote Server Name|//can be found in Remote Debugger Tool on Target//|
^Connection|Remote with no authentication|
^Deployment Directory|C:\deploy|
</col>
</grid>
4. Go to the Configuration Manager and check the Deploy box to automatically deploy the application to the target.
++++ Show Screenshot |
{{:en:x86:vs_rd_deploy.gif?nolink|}}
++++
5. after closing the window with the OK button the application can be started on the target. For this the button {{:en:x86:start_remote_debugger.png?nolink|}} in the IDE must be pressed. \\
Then the console application should start on the target and output module informations:\\

{{:en:x86:app_output.png?nolink| }}

<callout type="primary" icon="true">
If you get an error on the target (e.g. EAPI_1.dll not found) make sure that the [[https://support.tq-group.com/en/x86/eapi_windows#installation|TQ-EAPI]] is installed correctly.
</callout>