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 | Req | 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 | Yes | |||
| ENG_EQ_TYPE | Integer | Yes | |||
| ENG_K1 | Double | Yes | |||
| ENG_K2 | Double | Yes | |||
| SCI_UNITS | String | Yes | |||
| SCI_FMT | String | Yes | |||
| SCI_EQ_TYPE | Integer | Yes | |||
| SCI_FROM_ENG | bool | Yes | |||
| SCI_K1 | Double | Yes | |||
| SCI_K2 | Double | Yes | |||
| SCI_K3 | Double | Yes | |||
| SCI_K4 | Double | Yes | |||
| SCI_K5 | Double | Yes | |||
| SCI_K6 | Double | Yes | |||
| SCI_K7 | Double | Yes | |||
| SCI_K8 | Double | Yes | |||
| MUX_CH | Integer | No | |||
| LIMIT_TYPE_1 | Integer | No | |||
| YELLOW_LIMIT_1 | Double | No | |||
| RED_LIMIT_1 | Double | No | |||
| LIMIT_TYPE_2 | Integer | No | |||
| YELLOW_LIMIT_2 | Double | No | |||
| RED_LIMIT_2 | Double | No | |||
| LIMITS | JSON | No | |||
| EXTRA_1 | String | No | |||
| XINA_MINE_TYPE | Integer | No | |||
| XINA_MINE_RAW | bool | No | |||
| XINA_MINE_ENG | bool | No | |||
| DISCRETE_LABELS | String | No | |||
| BUNDLE_ID | Integer | No |