# Specifications # Mnemonics Database We store our mnemonic defintions within a flat tab delimited plain text format. The format has evolved over time to support required functionality. The first row contains the header. The header defines the columns contents. The columns can be in any order. Each row defines a single mnemonic and is uniquely identified by the `DATA_ID`. `DATA_ID` is also often refered to as `Housekeeping ID` or `HKID` for shorthand.

If required, the column must exist but row values may still be empty. Empty values will be default initialized.

Column	Type	Description	Required	Empty Allowed	Default Value
SUB\_SYSTEM	String	The subsystem. May be empty. Ex: CDH	Yes	Yes	Empty String
NAME	String	The mnemonic's name. Ex: PowerSupplyCurrent	Yes	No
DESCRIPTION	String	The mnemonic's description	Yes	Yes	Empty String
ADC\_#	Integer	The ADC channel	No	Yes	0
DATA\_ID	Integer	The unique ID	Yes	No
PACKET\_TYPE	Integer	The packet type or CCSDS Application ID	Yes	No
PACKET\_SUBTYPE	Integer	Packet subtype	No	Yes	0
PACKET\_NAME	String	The name of the packet the mnemonic belongs to	No	Yes	Empty String
APPLY\_WHEN	String	Apply when condition of the format: HKID=RANGE.	No	Yes	No apply when conditions
DECODE\_TYPE	Integer	The decoder type	Yes	No
DECODE\_ID1	Integer	Decode ID 1	Yes	No
DECODE\_ID2	Integer	Decode ID 2	Yes	No
DECODE\_ID3	Integer	Decode ID 3	Yes	No
DECODE\_ID4	Integer	Decode ID 4	Yes	No
CLOCK	String	The clock's name	No	Yes	Empty String
RAW\_FMT	String	The raw format	Yes	No
ENG\_FMT	String	The string formatting when engineering conversion is applied	Yes	No
ENG\_EQ\_TYPE	Integer	The type of conversion to apply to the raw value	Yes	No
ENG\_K1	Double	Eng Coefficient 1	Yes	No
ENG\_K2	Double	Eng Coefficient 2	Yes	No
SCI\_UNITS	String	The science units	Yes	Yes
SCI\_FMT	String	The string formatting when science conversion is applied	Yes	No
SCI\_EQ\_TYPE	Integer	The type of conversion to apply	Yes	No
SCI\_FROM\_ENG	bool	If true, the engineering conversion will be applied before applying the science conversion	Yes	No
SCI\_K1	Double	Science Coefficient 1	Yes	No
SCI\_K2	Double	Science Coefficient 2	Yes	No
SCI\_K3	Double	Science Coefficient 3	Yes	No
SCI\_K4	Double	Science Coefficient 4	Yes	No
SCI\_K5	Double	Science Coefficient 5	Yes	No
SCI\_K6	Double	Science Coefficient 6	Yes	No
SCI\_K7	Double	Science Coefficeint 7	Yes	No
SCI\_K8	Double	Science Coefficient 8	Yes	No
MUX\_CH	Integer	The corresponding mux channel for this mnemonic	No	Yes
LIMIT\_TYPE\_1	Integer	Bit pattern defining the limit configuration	No	Yes
YELLOW\_LIMIT\_1	Double	The yellow limit value	No	Yes
RED\_LIMIT\_1	Double	The red limit value	No	Yes
LIMIT\_TYPE\_2	Integer	Bit pattern defining the limit configuration	No	Yes
YELLOW\_LIMIT\_2	Double	The yellow limit value	No	Yes
RED\_LIMIT\_2	Double	The red limit value	No	Yes
LIMITS	JSON	The limit set definition	No	Yes
EXTRA\_1	String	Used for various purposes depending on the SCI\_EQ\_TYPE	No	Yes
XINA\_MINE\_TYPE	Integer	The XINA mining mode	No	Yes
XINA\_MINE\_RAW	bool	Whether or not to mine the RAW values	No	Yes
XINA\_MINE\_ENG	bool	Whether or not to mine the ENG values	No	Yes
DISCRETE\_LABELS	String	Maps a value to string	No	Yes
BUNDLE\_ID	Integer	The XINA bundle ID	No	Yes

# Metadata File # Mnemonic Limit Definitions This page defines the format of the limit definitions used by the Data Viewer application. A Limit Definition is a JSON object that describes limit thresholds for a single mnemonic telemetry value. The operator/user will be notified when a limit is triggered. The top level object supports the following fields:

Field	Required	Value Format	Meaning
`limits`	Yes	JSON Array	Array of 1 or more limit objects. Each object defines a set of limit thresholds. If a Limit Definition does not define a context mnemonic, the array should contain a single object.
`cm`	No	String or integer	Context Mnemonic. The optional mnemonic that is used to determine if a limit should be checked. For example, you may want to only check a current monitor mnemonic's limit when a temperature is between 25 and 30 celsius. In that case, the temperature mnemonic would be the context mnemonic. Can be provided as the mnemonic name or numeric ID e.g. `MMC.HK:WRP_CURRENT` or `5204`.

Each limit object supports the following fields:

Field	Required	Value Format	Meaning
`cr`	No	Single number or range syntax	Context range. Only used if `cm` is provided at the top level. If the context mnemonic equals this value or falls within this range, the limit will be checked. If `cm` is provided but `cr` is not, the limit object will be used as the "default" limit. Single number example: `1.5` the limit will be used when the context mnemonic's value equals `1.5.`. Range example: `"5.2..10.3"` the limit will be used when the context mnemonic's value falls between 5.2 and 10.3, inclusive.
`ec`	No	Integer	Excursion count. Number of consecutive telemetry values that must exceed a threshold before the limit is triggered. Defaults to 2 if not provided.
`yh`	No	Number	Yellow high threshold. Triggers a yellow high alarm when the telemetry value is greater than or equal to this value for the required excursion count.
`yl`	No	Number	Yellow low threshold. Triggers a yellow low alarm when the telemetry value is less than or equal to this value for the required excursion count.
`rh`	No	Number	Red high threshold. Triggers a red high alarm when the telemetry value is greater than or equal to this value for the required excursion count.
`rl`	No	Number	Red low threshold. Triggers a red low alarm when the telemetry value is less than or equal to this value for the required excursion count.

**Notes:** - At least 1 of the threshold values must be defined - Threshold will be compared against the telemetry value's converted/science value #### Example A: - Limit definition for a `BOARD_TEMP` mnemonic - Single limit with no context mnemonic - Yellow high undefined - Excursion count of 5 means the value must exceed the threshold for 5 consecutive values ```json { "limits": [ { "ec": 5, "rh": 20, "yl": -5, "rl": -12 } ] } ``` The below visualizes how the limit thresholds are evaluated: ``` y-axis: Telemetry value ^ | | RED HIGH alarm zone | value >= 20 for 5 consecutive samples 20 +------------------------------------------------ rh | | | | Nominal range | | | -5 +------------------------------------------------ yl | YELLOW LOW alarm zone | value =< -5 for 5 consecutive samples | -12 +------------------------------------------------ rl | RED LOW alarm zone | value =< -12 for 5 consecutive samples | +----------------------------------------------------> x-axis: time / samples | ``` #### Example B: - Limit definition for a `CURRENT_MONITOR` mnemonic - `BOARD_TEMP` context mnemonic is used to determine which limit should be checked - Defines a "default" limit that is used when none of the context ranges are satisfied - Defines a limit with a context range using the range syntax. If the `BOARD_TEMP` is \[0, 25\], then this limit will be used. ```json { "cm": "BOARD_TEMP", "limits": [ { "rh": 2.5, "yh": 2.0 }, { "cr": "0..25", "ec": 3, "rh": 2.3, "yh": 1.8 } ] } ``` #### Example C: - Limit definition for a `VOLTAGE_MONITOR` mnemonic - `MODE` context mnemonic is used to determine which limit should be checked - If `MODE`'s value does not match any of the configured limits' context ranges, no limit will be checked. Note how the context range value is provided as a number. ```json { "cm": "MODE", "limits": [ { "cr": 0, "rh": 1.5, "yh": 1.0 }, { "cr": 1, "ec": 2, "rh": 5.0, "yh": 4.5 }, { "cr": 2, "ec": 4, "rh": 10.0, "yh": 9.5 } ] } ``` # Expected Values Definition The Expected Values Definition file is a CSV file that is used by the c\_expectedvaluechk Python tool.