Raptor:Target Definition Block: Difference between revisions
Jump to navigation
Jump to search
| (20 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[File:Raptor target def.png|right|frame|Raptor Target Definition]] | |||
Return to main '''[[Raptor_Platform|Raptor page]]'''. | Return to main '''[[Raptor_Platform|Raptor page]]'''. | ||
Return to '''[[Raptor-Dev-Configuration|Configuration page]]'''. | Return to '''[[Raptor-Dev-Configuration|Configuration page]]'''. | ||
== Description == | == Description == | ||
The target definition block must be included in every Raptor model. This block allows the user to select the hardware which the build process will target as well as set global parameters which control how the model is built. | |||
==Supported Modules== | ==Supported Modules== | ||
For a list of supported Raptor modules, '''[[Controllers#Raptor_Controllers| | For a list of supported Raptor modules, click '''[[Controllers#Raptor_Controllers|here]]'''. | ||
== Inputs == | == Inputs == | ||
| Line 45: | Line 45: | ||
|- | |- | ||
! Target ECU | ! Target ECU | ||
| | |style = "text-align:center;"| Dropdown | ||
| Selects the current hardware target. | | Selects the current hardware target. | ||
|- | |||
!ECU Address | |||
|style = "text-align:center;"| uint8 | |||
| The CAN ID in the range from [0-253] used to define the address that this application will respond to programming requests at. | |||
|- | |||
!Include Simulator in (.rpg) | |||
|style = "text-align:center;"| Checkbox | |||
| Makes simulator available in Raptor-Cal. Only available in display modules. | |||
|- | |||
!Auto-Run Simulator | |||
|style = "text-align:center;"| Checkbox | |||
| Automatically opens the display simulation window upon a successful build. Only available in display modules. | |||
|- | |- | ||
! Heap Size (bytes) | ! Heap Size (bytes) | ||
| | |style = "text-align:center;"| uint | ||
| Controls the amount of RAM allocated for the heap. | | Controls the amount of RAM allocated for the heap. Only available on select modules. | ||
|- | |||
!Foreground Size (bytes) | |||
|style = "text-align:center;"| uint | |||
| Controls the amount of RAM allocated for the foreground. Only available on select modules. | |||
|- | |- | ||
! Stack Size (bytes) | ! Stack Size (bytes) | ||
| | |style = "text-align:center;"| uint | ||
| Controls the amount of RAM allocated for the stack. | | Controls the amount of RAM allocated for the stack. Only available on select modules. | ||
|- | |||
!Background Stack Size (bytes) | |||
|style = "text-align:center;"| uint | |||
| Controls the amount of RAM allocated for the background stack. Only available on the GCM70. | |||
|- | |||
!Idle Stack Size (bytes) | |||
|style = "text-align:center;"| uint | |||
| Controls the amount of RAM allocated for the idle stack. Only available on the GCM70. | |||
|- | |||
!Interrupt Stack Size (bytes) | |||
|style = "text-align:center;"| uint | |||
| Controls the amount of RAM allocated for the interrupt stack. Only available on the GCM70. | |||
|- | |||
!Shutdown Stack Size (bytes) | |||
|style = "text-align:center;"| uint | |||
| Controls the amount of RAM allocated for the shutdown stack. Only available on the GCM70. | |||
|- | |||
!App Interrupt Stack Size (bytes) | |||
|style = "text-align:center;"| uint | |||
| Controls the amount of RAM allocated for the app interrupt stack. Only available on the GCM70. | |||
|- | |||
!UDS Address Is Extended | |||
|style = "text-align:center;"| Checkbox | |||
| Changes UDS address from 11 bits to 29 bits. Only available on select modules. | |||
|- | |||
!UDS Server Address | |||
|style = "text-align:center;"| uint32 | |||
| Address of the ECU's UDS server. Only available on select modules. | |||
|- | |||
!UDS Client Address | |||
|style = "text-align:center;"| uint32 | |||
| Address of the UDS server the user wants the ECU to communicate with. Only available on select modules. | |||
|- | |- | ||
! Calibration Location | ! Calibration Location | ||
| | |style = "text-align:center;"| Dropdown | ||
| Controls the storage type for the Calibration memory location. | | Controls the storage type for the Calibration memory location. | ||
|- | |- | ||
! Compiler | ! Compiler | ||
| | |style = "text-align:center;"| Dropdown | ||
| Selects the compiler to use during the build process. | | Selects the compiler to use during the build process. | ||
|- | |||
! Set Custom Output File Name | |||
|style = "text-align:center;"| Checkbox | |||
| When enabled, allows the user to set the name of the output file. | |||
|- | |||
!Output File Name | |||
|style = "text-align:center;"| String | |||
|Controls the name of the outputted build package. Only available when the Set Custom Output File Name box is checked. | |||
|- | |- | ||
! Append Build Number to output file | ! Append Build Number to output file | ||
| | |style = "text-align:center;"| Checkbox | ||
| When enabled, the output files from the build will include the model build number. | | When enabled, the output files from the build will include the model build number. | ||
|- | |||
!Minimum Characters for Version | |||
|style = "text-align:center;"| int | |||
|Specifies the minimum number of characters needed to classify the version in the output file. | |||
|- | |||
!Output HEX/A2L Files (Third-Party Tool Support) | |||
|style = "text-align:center;"| Checkbox | |||
| Creates HEX and A2L files used to support compatibility with third-party programs like INCA. | |||
|- | |- | ||
! Build Output Location | ! Build Output Location | ||
| | |style = "text-align:center;"| Dropdown | ||
| Controls the location of the output files from the build. | | Controls the location of the output files from the build. | ||
|- | |- | ||
! | ! RPG Output Location | ||
| String | |style = "text-align:center;"| String | ||
| | | Lists the location to save the build files to. Only available when Build Output Location is set to User Defined. | ||
|- | |- | ||
! | ! Choose RPG Location | ||
| | |style = "text-align:center;"| Button | ||
| | | Opens file explorer window to navigate to the intended location for the RPG file. Only available when Build Output Location is set to User Defined. | ||
|} | |} | ||
Latest revision as of 18:17, 7 March 2023
Return to main Raptor page.
Return to Configuration page.
Description
The target definition block must be included in every Raptor model. This block allows the user to select the hardware which the build process will target as well as set global parameters which control how the model is built.
Supported Modules
For a list of supported Raptor modules, click here.
Inputs
| Input | Type | Description |
|---|---|---|
| No Inputs | - | - |
Outputs
| Output | Type | Description |
|---|---|---|
| No Outputs | - | - |
Parameters
| Parameter | Type | Description |
|---|---|---|
| Target ECU | Dropdown | Selects the current hardware target. |
| ECU Address | uint8 | The CAN ID in the range from [0-253] used to define the address that this application will respond to programming requests at. |
| Include Simulator in (.rpg) | Checkbox | Makes simulator available in Raptor-Cal. Only available in display modules. |
| Auto-Run Simulator | Checkbox | Automatically opens the display simulation window upon a successful build. Only available in display modules. |
| Heap Size (bytes) | uint | Controls the amount of RAM allocated for the heap. Only available on select modules. |
| Foreground Size (bytes) | uint | Controls the amount of RAM allocated for the foreground. Only available on select modules. |
| Stack Size (bytes) | uint | Controls the amount of RAM allocated for the stack. Only available on select modules. |
| Background Stack Size (bytes) | uint | Controls the amount of RAM allocated for the background stack. Only available on the GCM70. |
| Idle Stack Size (bytes) | uint | Controls the amount of RAM allocated for the idle stack. Only available on the GCM70. |
| Interrupt Stack Size (bytes) | uint | Controls the amount of RAM allocated for the interrupt stack. Only available on the GCM70. |
| Shutdown Stack Size (bytes) | uint | Controls the amount of RAM allocated for the shutdown stack. Only available on the GCM70. |
| App Interrupt Stack Size (bytes) | uint | Controls the amount of RAM allocated for the app interrupt stack. Only available on the GCM70. |
| UDS Address Is Extended | Checkbox | Changes UDS address from 11 bits to 29 bits. Only available on select modules. |
| UDS Server Address | uint32 | Address of the ECU's UDS server. Only available on select modules. |
| UDS Client Address | uint32 | Address of the UDS server the user wants the ECU to communicate with. Only available on select modules. |
| Calibration Location | Dropdown | Controls the storage type for the Calibration memory location. |
| Compiler | Dropdown | Selects the compiler to use during the build process. |
| Set Custom Output File Name | Checkbox | When enabled, allows the user to set the name of the output file. |
| Output File Name | String | Controls the name of the outputted build package. Only available when the Set Custom Output File Name box is checked. |
| Append Build Number to output file | Checkbox | When enabled, the output files from the build will include the model build number. |
| Minimum Characters for Version | int | Specifies the minimum number of characters needed to classify the version in the output file. |
| Output HEX/A2L Files (Third-Party Tool Support) | Checkbox | Creates HEX and A2L files used to support compatibility with third-party programs like INCA. |
| Build Output Location | Dropdown | Controls the location of the output files from the build. |
| RPG Output Location | String | Lists the location to save the build files to. Only available when Build Output Location is set to User Defined. |
| Choose RPG Location | Button | Opens file explorer window to navigate to the intended location for the RPG file. Only available when Build Output Location is set to User Defined. |