Optional information in JSON file

To include as much information as possible in the JSON files, there are some optional fields.

【device_detail】

The device_detail is a field to provide more detailed information about each device.

Example ↓

"device_detail" : "degg_glass_with_penetrator_hole"

【device_revision】

The device_revision is increased if the device is reworked.

As for (half) D-Eggs, if the components are replaced, the revision is incremented by 1, for instance.

Please note that this is a string to deal with some non-integer revisions like “4A”.

Example ↓

"device_revision" : "4.1"

【batch】

This is a production batch of each device.

Please note that this is also a string, not an integer.

Example ↓

"batch" : "3"

【model】

Some devices have their own unique model numbers.

Example ↓

"model" : "XRL-400-5O"

【aux_ids】

Some devices have various ids like flash, label, qr-code, etc. The aux_ids is useful to summarize these ids.

Example ↓

"aux_ids" : [
    {
        "type": "eeprom",
        "id": "f10000030334f423",
    },
    {
        "type": "fpga",
        "id": "00f1418818acf615"
    },
    {
        "type": "flash",
        "id": "f4cf51593801a1cc1644c37bd15d61f8"
    },
     {
        "type": "microcontroller",
        "id": "f700002c71e37f2d"
    },
    {
        "type": "data-matrix",
        "id": "0029"
    },
    {
        "type": "serial-number",
        "id": "REV2-016"
    }
    {
        "type": "nickname",
        "id": "Adelie_Penguin"
    },
    {
        "type": "label",
        "id": "E14"
    }
]

Note

For the Mainboard, ICM, and D-Egg, the names commnly used among xDOM are defined:

Link to the Upgrade Sharepoint document

This names are recommended to be included in the aux_ids fields.

Example ↓

"aux_ids": [
    {
        "type": "eeprom",
        "id": "0044350626307e10",
        "common_name": "MB Electronic ID"
    },
    {
        "type": "serial-number",
        "id": "4.1-016",
        "common_name": "MB Serial Number"
    },
    {
        "type": "eeprom",
        "id": "f700002c71e37f2d",
        "common_name": "ICM Electronic ID"
    },
    {
        "type": "serial-number",
        "id": "0029",
        "common_name": "ICM Serial Number"
    }
    {
        "type": "serial-number",
        "id": "DEgg2020-1-001",
        "common_name": "DOM Serial Number"
    }
]

【sub_devices】

Tier-1/2/3 devices basically include “lower” tier devices.

The sub_devices is useful to summarize these sub-devices.

Example ↓

"sub_devices": [
    {
        "device_type": "pmt",
        "uid": "degg-pmt_R5912-100-70_SQ0411"
    },
    {
        "device_type": "degg-hv-unit",
        "uid": "degg-hv-unit_20135b_584"
    },
    {
        "device_type": "opt-gel",
        "uid": "degg-opt-gel_OGN-3547_002103"
    },
    {
        "device_type": "glass",
        "uid": "degg-glass_1603_20200127_non-penetrated"
    },
    {
        "device_type": "mag-shield",
        "uid": "degg-mag-shield_FINEMET_20200217_002"
    },
    {
        "device_type": "penetrator",
        "uid": "degg-penetrator_180-1_14_E14"
    }
]

Note

As for the flasher ring and the camera ring, the LEDs/cameras are indexed by their positions.

To explicitly show these indexes, the index (integer) is included in the sub_devices field.

Example ↓

"sub_device_index": "led_position_clockwise",
"sub_devices": [
    {
        "device_type": "led",
        "index": 0,
        "uid": "degg-led_XRL-400-5O_20191223_002"
    },
    {
        "device_type": "led",
        "index": 1,
        "uid": "degg-led_XRL-400-5O_20191223_002"
    },
    {
        "device_type": "led",
        "index": 2,
        "uid": "degg-led_XRL-400-5O_20191223_002"
    },

    ...

    {
        "device_type": "led",
        "index": 11,
        "uid": "degg-led_XRL-400-5O_20191223_002"
    }
]

"sub_device_index": "camera_position_counterclockwise",
"sub_devices": [
    {
        "device_type": "cam-illum-board",
        "index": 0,
        "uid": "CAM-ILL_0044353598101817_M232"
    },
    {
        "device_type": "cam-illum-board",
        "index": 1,
        "uid": "CAM-ILL_0044353598103627_M231"
    },
    {
        "device_type": "cam-illum-board",
        "index": 2,
        "uid": "CAM-ILL_0044353598101619_M230"
    }
]

【Metadata】

Since we have DEgg Components Log Book (Google spereadsheet), it should be nice if we can include the path to it.

Please include comments (= values as a list of strings) which are useful for the future reference.

Example ↓

"metadata": [
    {
        "type": "spreadsheet",
        "location": "chiba google drive",
        "path": "(url to the corresponding sheet, e.g. PMT)",
        "name": "Comments for database",
        "values": [
            "socket orientation is corrected at chiba",
            "one of the pins is long and cut at NME"
        ]
    }
]

【support_files】

If the device has any supplemental materials, please include the information on them in the support_files field.

FYI, this field is also included in the measurement files. (See here)

Example ↓

"support_files": [
    {
        "type": "cadfile",
        "location": "chiba <hostname>",
        "path": "/path/to/file.dwg"
    }
]

"support_files": [
    {
        "type": "image",
        "location": "chiba <hostname>",
        "path": "/path/to/file.zip",
        "file": "file.raw"
    }
]