.. role:: red .. role:: blue .. role:: navy DataLogger ========== :navy:`id` ~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **id** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Instrument ID number can be serial number or | mt01 | | | a designated ID. | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`manufacturer` ~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **manufacturer** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Who manufactured the instrument. | mt gurus | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`type` ~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Description of the instrument type. | broadband | | | | 32-bit | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`model` ~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **model** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Model version of the instrument. | falcon5 | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`name` ~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **name** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Standard marketing name of the instrument. | falcon5 | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`timing_system.comments.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **timing_system.comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`timing_system.comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **timing_system.comments.time_stamp** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Date and time of in UTC of when comment was | 2020-02- | | | made. | 01T09:23:45.453| | **Type**: float | int | numpy.datetime64 | pa| | 670+00:00 | | ndas._libs.tslibs.timestamps.Timest | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`timing_system.comments.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **timing_system.comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`timing_system.drift` ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **timing_system.drift** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Estimated drift of the timing system. | 0.001 | | | | | | **Type**: | | | | | | | | **Units**: seconds | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`timing_system.type` ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **timing_system.type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Type of timing system. | GPS | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`timing_system.uncertainty` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **timing_system.uncertainty** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Estimated uncertainty of the timing system. | 0.0002 | | | | | | **Type**: | | | | | | | | **Units**: seconds | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`timing_system.n_satellites` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **timing_system.n_satellites** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Number of satellites used for timing. | 6 | | | | | | **Type**: int | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`firmware.author` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **firmware.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Author of the software | Neo | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`firmware.version` ~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **firmware.version** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Software version | 12.01a | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`firmware.last_updated` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **firmware.last_updated** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Most recent date the software was updated. | 2020-01-01 | | | Prefer to use version, but this works for | | | **Type**: mt_metadata.common.mttime.MTime | | non-versioned software. | | | str | float | int | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`firmware.name` ~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **firmware.name** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Software name | mtrules | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`power_source.type` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **power_source.type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Description of battery type. | pb-acid gel | | | | cell | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`power_source.id` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **power_source.id** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | battery id | battery01 | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`power_source.voltage.start` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **power_source.voltage.start** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Starting value. | 1.0 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`power_source.voltage.end` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **power_source.voltage.end** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Ending value of the range. | 1.0 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`power_source.comments.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **power_source.comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`power_source.comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **power_source.comments.time_stamp** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Date and time of in UTC of when comment was | 2020-02- | | | made. | 01T09:23:45.453| | **Type**: float | int | numpy.datetime64 | pa| | 670+00:00 | | ndas._libs.tslibs.timestamps.Timest | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`power_source.comments.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **power_source.comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_storage.id` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_storage.id** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Instrument ID number can be serial number or | mt01 | | | a designated ID. | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_storage.manufacturer` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_storage.manufacturer** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Who manufactured the instrument. | mt gurus | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_storage.type` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_storage.type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Description of the instrument type. | broadband | | | | 32-bit | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_storage.model` ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_storage.model** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Model version of the instrument. | falcon5 | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_storage.name` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_storage.name** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Standard marketing name of the instrument. | falcon5 | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+