OEM data files
Every unit contains several pieces of identifying information:
Its model type, e.g. SXD, DAX/2, DAX/2m, DAX/T, or NS-112 (for the Aide)
Its name prefix, which is usually the same as the model but may vary for model variants; see table below
Its colors, specified as color, color_2, color_3, and color_4. If some colors are missing, they will be copied from preceding colors.
Its name, more technically referred to as its nominal designator
Its serial (xxx-nn-nnnn) or serial prefix (xxx). Serial prefixes are reserved by model type. Specify the serial as a number without any punctuation, e.g. 999-59-2351 is written as 999592351 in the example below.
Its vendor, i.e. the company that manufactured and assembled the unit
Its authority, i.e. the organization responsible for managing it (see Miscellaneous preferences)
The RLV path, used by personas (see Personas) and other features such as ATOS damage representation and the local console. This defaults to "~NS" and always resides within #RLV. Values are strongly encouraged to begin with "~" (tilde) so that assets can automatically be transferred into it.
All of this information can be specified centrally in the OEM license table, found in the _oem file in the main controller’s system memory. If values are not provided, the controller will generate default values for an NS-100 placeholder robot. The model, serial, and vendor cannot be changed any other way, although the prefix can be manipulated by a XNMS domain server. For instructions on how to edit files in system memory, see Managing packages and installed software in the Companion manual.
To remove the prefix, use prefix NONE.
An example OEM file:
To specify a serial prefix and permit random generation, provide only the first 3 digits of the serial number range desired. The OEM license table is reloaded when the foundation module is reset. The name, model, path and prefix fields must be ASCII.
WARNING: Attempting to forge model identifier information to imply your unit belongs to a line that it does not may cause software or hardware malfunction. The model designator is used to determine the screen geometry for embedded screen peripherals, as well as the socket aperture for battery alignment. Model designation changes should only be performed after consultation with Nanite Systems support personnel or to facilitate franchising.
Note: The path field defaults to ~NS. It is recommended that any custom value set here begin with a tilde ("~") to ensure that automatic console overlay delivery functions properly. (See RLV API documentation note)
Companion 8.4.0 and earlier: The OEM table is loaded when the foundation module, which represents the system's BIOS, is reset. The command reset foundation may be used by an owner at any time, or its equivalent menu entry, manage › modules › foundation.
Companion 8.4.1–8.4.5: The foundation module will automatically reset if the OEM table changes.
Companion 8.5 and later: The balance module will automatically reload the OEM file if it changes, without any module resets.
The OEM table can also contain system commands ("@ commands"), to be executed during the configuration phase of resetting the system's Foundation BIOS. For example,
The final line, scheme boot 12, adjusts the sound scheme used by the machine. This follows the syntax for the scheme command as documented in the command reference.
For some applications and markets, the safeword functionality may be undesirable. Add
to the OEM table to disable this. For safety reasons, safeword cannot be disabled through any other means.
model | vendor | name prefix | serial prefix | default color | serial ordering | common name |
---|---|---|---|---|---|---|
SXD | Nanite Systems Corporation | SXD | 999 | company | manual | |
DAX/2 | Nanite Systems Corporation | DAX/2 | 998 | company | random | |
DAX/2m | Nanite Systems Corporation | DAX/2 | 998 | company | random | "Mini" |
DAX/T | Tai Yong Labs | TYL | 997 | 1.0 0.7 0.8 | random | |
iKitten | Rhapsody Robotics | iKitten | 995 | 0.33 0.67 1 | random | |
DAX/3 | Nanite Systems Corporation | dax/3 | 998 | company | random | |
DAX/3m | Nanite Systems Corporation | dax/3 | 998 | company | random | "Mini" |
NS-112 | Nanite Systems Corporation | NS | 112 | amber | random | "Aide" |
NS-115 | Nanite Systems Corporation | NS | 115 | company | random | "Scout" |
NS-120 | Nanite Systems Corporation | M/ | 120 | company | random | "Mesta" |
NS-226 | Nanite Systems Corporation | NS | 226 | company | random | "Hephaestus" |
NS-304 | Nanite Systems Corporation | NS | 304 | company | random | "Daybreak" |
NS-409 | Nanite Systems Corporation | NF/3 | 409 | 0 0.8 1 | random | "Nightfall/3" |
NS-476 | Nanite Systems Corporation | NS | 476 | company | random | "Aegis" |
NS-478 | Nanite Systems Corporation | NS | 478 | company | random | "Revenant" |
All of this information can be specified centrally in the OEM license table, found in the _oem file in the main controller’s system memory. If values are not provided, the controller will generate default values for an NS-100 placeholder robot. The model, serial, and vendor cannot be changed any other way, although the prefix can be manipulated by a XNMS domain server. For instructions on how to edit files in system memory, see Managing packages and installed software in the Companion manual.
To remove the prefix, use prefix NONE.
An example OEM file:
vendor Nanite Systems Corporation
model SXD
authority Nanite Systems Consumer Products
serial 999592351
color 0.5 0.5 1
color_2 0.0 1.0 0.0
color_3 1.0 0.0 0.0
color_4 1.0 1.0 0.0
name vict0ria
prefix SXD
path ~SXD
model SXD
authority Nanite Systems Consumer Products
serial 999592351
color 0.5 0.5 1
color_2 0.0 1.0 0.0
color_3 1.0 0.0 0.0
color_4 1.0 1.0 0.0
name vict0ria
prefix SXD
path ~SXD
To specify a serial prefix and permit random generation, provide only the first 3 digits of the serial number range desired. The OEM license table is reloaded when the foundation module is reset. The name, model, path and prefix fields must be ASCII.
Restrictions
WARNING: Attempting to forge model identifier information to imply your unit belongs to a line that it does not may cause software or hardware malfunction. The model designator is used to determine the screen geometry for embedded screen peripherals, as well as the socket aperture for battery alignment. Model designation changes should only be performed after consultation with Nanite Systems support personnel or to facilitate franchising.
Note: The path field defaults to ~NS. It is recommended that any custom value set here begin with a tilde ("~") to ensure that automatic console overlay delivery functions properly. (See RLV API documentation note)
Reloading the OEM table
Companion 8.4.0 and earlier: The OEM table is loaded when the foundation module, which represents the system's BIOS, is reset. The command reset foundation may be used by an owner at any time, or its equivalent menu entry, manage › modules › foundation.
Companion 8.4.1–8.4.5: The foundation module will automatically reset if the OEM table changes.
Companion 8.5 and later: The balance module will automatically reload the OEM file if it changes, without any module resets.
Additional entries
The OEM table can also contain system commands ("@ commands"), to be executed during the configuration phase of resetting the system's Foundation BIOS. For example,
vendor Nanite Systems Corporation
model SXD
authority Nanite Systems Consumer Products
serial 999545620
color 1.0 0.0 0.5
color_2 0.0 1.0 0.0
color_3 1.0 0.0 0.0
color_4 1.0 1.0 0.0
name rhet0rica
prefix SXD
path ~SXD
scheme boot 12
model SXD
authority Nanite Systems Consumer Products
serial 999545620
color 1.0 0.0 0.5
color_2 0.0 1.0 0.0
color_3 1.0 0.0 0.0
color_4 1.0 1.0 0.0
name rhet0rica
prefix SXD
path ~SXD
scheme boot 12
The final line, scheme boot 12, adjusts the sound scheme used by the machine. This follows the syntax for the scheme command as documented in the command reference.
Safeword control
For some applications and markets, the safeword functionality may be undesirable. Add
disable-safeword
to the OEM table to disable this. For safety reasons, safeword cannot be disabled through any other means.