Configuring eRTOS Components
eRTOS Runtime includes the following optional components:
- Network Link Layer (NL2)
- TCP/IP Stack (This feature requires a separate license)
- USB Stack
You can configure eRTOS components and store custom user values for applications by editing the RtConfig.rtreg configuration file accessible from <InstallDrive>\MaxRT\eRTOS\. The RtConfig.rtreg file is written in human readable plain text, which makes it easy to read and modify.
Note: This RtConfig.rtreg file is read during startup of each component. If you modify the RtConfig.rtreg file after a component is started, the changes will not take place until you restart eRTOS.
Note: eRTOS only recognizes one RtConfig.rtreg file and it has a specific syntax.
Syntax
[SectionPath1]
“DataItemName1”=DataType1:DataValue1
“DataItemName2”=DataType2:DataValue2
[SectionPath2]
“DataItemName3”=DataType3:DataValue3
Parameters
SectionPathx
The unique path that separates each hierarchy. For example: HKEY_LOCAL_MACHINE\SOFTWARE\INTERVALZERO\eRTOS. The SearchPath must be surrounded by brackets ([ ]). RtConfig.rtreg can contain several unique paths. Each path is case sensitive and can contain one or many data items.
The following SearchPaths locations should not be modified since they are reserved for eRTOS components:
- HKEY_LOCAL_MACHINE\SOFTWARE\INTERVALZERO\eRTOS – general eRTOS settings.
- HKEY_LOCAL_MACHINE\SOFTWARE\INTERVALZERO\eRTOS\NL2 – general NL2 settings.
- HKEY_LOCAL_MACHINE\SOFTWARE\INTERVALZERO\eRTOS\TCPIP – general TCP/IP Stack settings
- HKEY_LOCAL_MACHINE\SOFTWARE\INTERVALZERO\eRTOS\RtUSB – general USB settings
- HKEY_LOCAL_MACHINE\SOFTWARE\INTERVALZERO\eRTOS\NL2Interfaces - NL2 Interfaces settings. Each NL2 interface should have a subkey whose name is the name of the NL2 interface. The NL2 will load the interfaces in the order they appear in the RtConfig.rtreg file.
Below are examples of possible unique paths where a user could store custom data:
- HKEY_LOCAL_MACHINE\MyData\MyApplication
- HKEY_USERS\MyData\MyApplication
DataItemNamex
The name of a unique data item. An equal sign (=) immediately follows the name of the data item. For example, if you wanted to represent the data item MyDword with a value of 99 you would write “MyDword”=dword:99. If you wanted to represent the data item MyQword with a value of 9999999999 you would write “MyQword”=qword:9999999999. If you wanted to represent a string for a data item MyString that contains a string value of This is a string!, you would write "MyString"=" This is a string!". No data type is needed for strings. The data item name is case-sensitive.
Note: You can enter several DataItemNamex lines for the same section path.
DataTypex
A keyword that specifies the type of data value assigned to a DataItemNamex data item. A string is the default data type, so it does not need to be provided. For all other data types, the type must follow the equal sign (=) without spaces. A colon (:) must immediately follow the data type.
Typical data types:
Data type | In RtConfig.rtreg |
---|---|
dword | Data represented by a number that is 4 bytes long (a 32-bit unsigned integer). The number must be written in decimal notation (not hex) and be in the range 0..4294967295. |
qword | Data represented by a number that is a 64-bit unsigned integer. The number must be written in decimal notation (not hex) and be in the range 0..18446744073709551615. |
DataValuex
Immediately follows the colon (or the equal sign with string value) and must be in the appropriate format (for example, string or decimal).
Registry Types
The RtConfig.rtreg file supports these registry types:
Registry type | Format example |
---|---|
REG_DWORD | "MyDword"=dword:123 |
REG_QWORD | "MyQword"=qword:977348343935 |
REG_SZ |
"MyString"="This is a string!" |