Das2

Site Catalog Browser

VESPA Search

Test Catalog

Unknown node type WebSockSrc

Raw catalog entry displayed below

{
  "_path": "tag:das2.org,2012:site:/uiowa/tracers/tracers-2/l1a/magic/hsk_fast/flexRT",
  "_url": "https://space.physics.uiowa.edu/das/stream/source/tracers/tracers-2/l1a/magic/hsk_fast/flexRT.json",
  "contacts": [
    {
      "email": "chris-piker@uiowa.edu",
      "name": "Chris Piker",
      "type": "maintainer"
    },
    {
      "name": "David Miles",
      "type": "scientific"
    }
  ],
  "interface": {
    "coords": {
      "time": {
        "label": "Time",
        "props": {
          "max": {
            "label": "Maximum",
            "set": {
              "param": "read.time.max",
              "required": true
            },
            "title": "Maximum time value to stream",
            "value": null
          },
          "min": {
            "label": "Minimum",
            "set": {
              "param": "read.time.min",
              "required": true
            },
            "title": "Minimum time value to stream",
            "value": null
          },
          "res": {
            "label": "Resolution",
            "set": {
              "param": "bin.time.max",
              "required": false
            },
            "title": "The maximum time bin width for bin-reduced data in seconds",
            "units": "s",
            "value": null
          },
          "units": {
            "value": "UTC"
          }
        },
        "validRange": [
          "2025-08-12T22:22",
          "2025-08-31T23:40"
        ]
      }
    },
    "data": {
      "adc_board_temp": {
        "label": "Board Temp",
        "props": {
          "enabled": {
            "set": {
              "flag": "adc_board_temp",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Board Temperature"
      },
      "adc_input_current": {
        "label": "Bus Curr",
        "props": {
          "enabled": {
            "set": {
              "flag": "adc_input_current",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Input Bus Current"
      },
      "adc_input_voltage": {
        "label": "Bus Volts",
        "props": {
          "enabled": {
            "set": {
              "flag": "adc_input_voltage",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Input Bus Voltage"
      },
      "adc_ref_v": {
        "label": "2.5V ADC Ref",
        "props": {
          "enabled": {
            "set": {
              "flag": "adc_ref_v",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "2.5V ADC Reference"
      },
      "adc_ref_v1_24": {
        "label": "1.24V Ref",
        "props": {
          "enabled": {
            "set": {
              "flag": "adc_ref_v1_24",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Reference Voltage"
      },
      "adc_sens_temp": {
        "label": "Sensor Temp",
        "props": {
          "enabled": {
            "set": {
              "flag": "adc_sens_temp",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Sensor Temperature"
      },
      "adc_zener_ref": {
        "label": "Zener Ref",
        "props": {
          "enabled": {
            "set": {
              "flag": "adc_zener_ref",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Zener Reference"
      },
      "adc_zener_temp": {
        "label": "Zener Temp",
        "props": {
          "enabled": {
            "set": {
              "flag": "adc_zener_temp",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Zener Temperature"
      },
      "cmd_count": {
        "label": "Cmd Counter",
        "props": {
          "enabled": {
            "set": {
              "flag": "cmd_count",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Power On # of accepted commands"
      },
      "cmd_err_count": {
        "label": "Cmd Error Count",
        "props": {
          "enabled": {
            "set": {
              "flag": "cmd_err_count",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Power On # of rejected commands"
      },
      "drive_ena": {
        "label": "RC Drive Enable",
        "props": {
          "enabled": {
            "set": {
              "flag": "drive_ena",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Ringcore h-bridge drive enable"
      },
      "ext_sync_ref": {
        "label": "Ext Sync Ref",
        "props": {
          "enabled": {
            "set": {
              "flag": "ext_sync_ref",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "MAGIC sync reference is external (1) or internally generated (0) "
      },
      "filt_ena": {
        "label": "Filter Enable",
        "props": {
          "enabled": {
            "set": {
              "flag": "filt_ena",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Firmware implementation of FIR filter on science data"
      },
      "last_cmd_addr": {
        "label": "Last Cmd Addr",
        "props": {
          "enabled": {
            "set": {
              "flag": "last_cmd_addr",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Address portion of the past command"
      },
      "last_cmd_data": {
        "label": "Last Cmd Data",
        "props": {
          "enabled": {
            "set": {
              "flag": "last_cmd_data",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Data portion of the past command"
      },
      "mag_magic_sync": {
        "label": "Mag-Magic Sync",
        "props": {
          "enabled": {
            "set": {
              "flag": "mag_magic_sync",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Up-time of mag sync xor magic sync (# of clock cycles)"
      },
      "mag_sync_sum": {
        "label": "Mag Sync Sum",
        "props": {
          "enabled": {
            "set": {
              "flag": "mag_sync_sum",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Total uptime over housekeeping table refresh (# of clock cycles)"
      },
      "oscil_pwm": {
        "label": "Oscillator PWM",
        "props": {
          "enabled": {
            "set": {
              "flag": "oscil_pwm",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "PWM Value for Oscillator"
      },
      "por_flag": {
        "label": "Power On Reset",
        "props": {
          "enabled": {
            "set": {
              "flag": "por_flag",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Power On Reset Flag"
      },
      "pps_offset": {
        "label": "PPS Offset",
        "props": {
          "enabled": {
            "set": {
              "flag": "pps_offset",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Time since PPS (# of clock cycles)"
      },
      "pwr_spp_sync": {
        "label": "Pwr Supply Sync",
        "props": {
          "enabled": {
            "set": {
              "flag": "pwr_spp_sync",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Flag indicating power supply sync has failed"
      },
      "second_counter": {
        "label": "Second Counter",
        "props": {
          "enabled": {
            "set": {
              "flag": "second_counter",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Count rising edge of PPS"
      },
      "sens_heat_ena": {
        "label": "Sensor Heat On",
        "props": {
          "enabled": {
            "set": {
              "flag": "sens_heat_ena",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Sensor Heater Enable"
      },
      "subsec_counter": {
        "label": "Subsec Counter",
        "props": {
          "enabled": {
            "set": {
              "flag": "subsec_counter",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Clock cycles between rising edge of PPS and Sample"
      },
      "sync_avg_duty": {
        "label": "Sync Avg Duty",
        "props": {
          "enabled": {
            "set": {
              "flag": "sync_avg_duty",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Average oscillator pulse-width modulator duty cycle"
      },
      "sync_jitter": {
        "label": "Sync Jitter",
        "props": {
          "enabled": {
            "set": {
              "flag": "sync_jitter",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Oscillator control pulse-width modulator duty cycle difference"
      },
      "sync_pid_ena": {
        "label": "MM Sync PID Ena",
        "props": {
          "enabled": {
            "set": {
              "flag": "sync_pid_ena",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "MAG-MAGIC synchronization PID controller enable"
      },
      "test_ptrn_ena": {
        "label": "Data Gen Enable",
        "props": {
          "enabled": {
            "set": {
              "flag": "test_ptrn_ena",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Data Generator Enable"
      },
      "tics_per_pps": {
        "label": "Ticks per PPS",
        "props": {
          "enabled": {
            "set": {
              "flag": "tics_per_pps",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Counting tick per pps (clock frequency)"
      },
      "time": {
        "label": "time",
        "props": {
          "enabled": {
            "set": {
              "flag": "time",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        }
      },
      "vgse_ena": {
        "label": "VGSE Enable",
        "props": {
          "enabled": {
            "set": {
              "flag": "vgse_ena",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Debugging enable for VGSE portion of electronics"
      },
      "wdt_flag": {
        "label": "Watchdog Timer",
        "props": {
          "enabled": {
            "set": {
              "flag": "wdt_flag",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Watchdog Timer Flag"
      },
      "x_clipped": {
        "label": "X Clipped",
        "props": {
          "enabled": {
            "set": {
              "flag": "x_clipped",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Flag indicating x-channel adc has clipped"
      },
      "y_clipped": {
        "label": "Y Clipped",
        "props": {
          "enabled": {
            "set": {
              "flag": "y_clipped",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Flag indicating y-channel adc has clipped"
      },
      "z_clipped": {
        "label": "Z Clipped",
        "props": {
          "enabled": {
            "set": {
              "flag": "z_clipped",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Flag indicating z-channel adc has clipped"
      },
      "znr_heater_pwm": {
        "label": "Zener Heat PWM",
        "props": {
          "enabled": {
            "set": {
              "flag": "znr_heater_pwm",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "PWM Duty cycle of Zener Heater"
      },
      "znr_pid_ena": {
        "label": "Znr PID Ena",
        "props": {
          "enabled": {
            "set": {
              "flag": "znr_pid_ena",
              "param": "read.data",
              "value": true
            },
            "type": "boolean",
            "value": false
          }
        },
        "title": "Zener PID enable"
      }
    },
    "examples": [
      {
        "label": "Most Recent 10 minutes (das3)",
        "settings": {
          "coords/time/props/max": "2025-08-31T23:40",
          "coords/time/props/min": "2025-08-31T23:28"
        }
      },
      {
        "label": "Most Recent Day (CDF)",
        "settings": {
          "coords/time/props/max": "2025-08-31T23:40",
          "coords/time/props/min": "2025-08-30T23:40",
          "formats/cdf/props/enabled": true
        }
      }
    ],
    "formats": {
      "cdf": {
        "label": "CDF file",
        "mimeTypes": [
          "application/x-cdf"
        ],
        "props": {
          "enabled": {
            "set": {
              "param": "format.type",
              "pval": "cdf",
              "value": true
            },
            "type": "boolean",
            "value": false,
            "xorGroup": "format"
          },
          "nocompress": {
            "label": "No-Compression",
            "set": {
              "param": "format.cdf.nocomp",
              "pval": "1",
              "value": true
            },
            "title": "Do not compress variables, needed for PDS compliant output.",
            "type": "boolean",
            "value": false
          }
        },
        "title": "NASA Common Data Format"
      },
      "csv": {
        "label": "CSV stream",
        "mimeTypes": [
          "text/csv"
        ],
        "order": [
          "enabled",
          "attributes",
          "headers",
          "datasetIds",
          "delimiter",
          "fracSecs",
          "sigDigits"
        ],
        "props": {
          "attributes": {
            "label": "Attributes",
            "set": {
              "param": "format.csv.props",
              "pval": "1",
              "value": true
            },
            "title": "Output data object property rows",
            "type": "boolean",
            "value": false
          },
          "datasetIds": {
            "label": "Dataset IDs",
            "pval": "1",
            "set": {
              "param": "format.csv.dsid",
              "pval": "1",
              "value": false
            },
            "title": "Output the dataset ID column",
            "type": "boolean",
            "value": true
          },
          "delimiter": {
            "label": "Value Separator",
            "set": {
              "enum": [
                {
                  "pval": ",",
                  "value": "Comma"
                },
                {
                  "pval": ";",
                  "value": "Semicolon"
                },
                {
                  "pval": "|",
                  "value": "Pipe"
                },
                {
                  "pval": "tab",
                  "value": "Tab"
                }
              ],
              "param": "format.delim"
            },
            "type": "enum",
            "value": "Comma"
          },
          "enabled": {
            "set": {
              "param": "format.type",
              "pval": "csv",
              "value": true
            },
            "type": "boolean",
            "value": false,
            "xorGroup": "format"
          },
          "fracSecs": {
            "label": "Factional Seconds",
            "set": {
              "param": "format.secfrac"
            },
            "title": "Number of fractional seconds digits in text streams",
            "value": 3
          },
          "headers": {
            "label": "Headers",
            "set": {
              "param": "format.headers",
              "pval": "1",
              "value": false
            },
            "title": "Output column headers",
            "type": "boolean",
            "value": true
          },
          "sigDigits": {
            "label": "Significant Digits",
            "set": {
              "param": "format.sigdigit"
            },
            "title": "General significant digits for values in text streams",
            "value": 5
          }
        },
        "title": "(Comma) Separated Values for export"
      },
      "das": {
        "label": "das stream",
        "mimeTypes": [
          "application/vnd.das2.das2stream",
          "application/vnd.das.stream",
          "text/vnd.das2.das2stream"
        ],
        "order": [
          "enabled",
          "version",
          "serial",
          "sigDigits",
          "fracSecs"
        ],
        "props": {
          "enabled": {
            "set": {
              "param": "format.type",
              "pval": "das",
              "value": true
            },
            "type": "boolean",
            "value": true,
            "xorGroup": "format"
          },
          "fracSecs": {
            "label": "Factional Seconds",
            "set": {
              "param": "format.secfrac"
            },
            "title": "Number of fractional seconds digits in text streams",
            "value": 3
          },
          "serial": {
            "label": "Serialization",
            "set": {
              "enum": [
                {
                  "value": "text"
                },
                {
                  "value": "binary"
                }
              ],
              "param": "format.serial"
            },
            "value": "binary"
          },
          "sigDigits": {
            "label": "Significant Digits",
            "set": {
              "param": "format.sigdigit"
            },
            "title": "General significant digits for values in text streams",
            "value": 5
          },
          "version": {
            "label": "Stream Version",
            "set": {
              "enum": [
                {
                  "pval": "3",
                  "value": "das3"
                },
                {
                  "pval": "2",
                  "value": "das2"
                }
              ],
              "param": "format.version"
            },
            "type": "enum",
            "value": "das3"
          }
        },
        "title": "Streaming format for plots"
      }
    },
    "options": {
      "label": "Options",
      "props": {
        "filter": {
          "label": "AppID Filter",
          "set": {
            "enum": [
              {
                "title": "Housekeeping",
                "value": "x201"
              },
              {
                "title": "Raw Frames at 128 Hz",
                "value": "x20f"
              }
            ],
            "param": "read.apid"
          },
          "title": "Filter output data by CCSDS AppID",
          "type": "enum",
          "value": null
        },
        "realtime": {
          "label": "Rate",
          "set": {
            "enum": [
              {
                "title": "Send data as fast as possible",
                "value": "nolimit"
              },
              {
                "title": "Send data at intrinsic collection rate",
                "value": "realtime"
              }
            ],
            "param": "comm.rate"
          },
          "title": "Select the data transmission rate",
          "value": "nolimit"
        },
        "subscribe": {
          "label": "Transaction",
          "set": {
            "enum": [
              {
                "title": "Keep connection open for new data",
                "value": "subscribe"
              },
              {
                "title": "Get data in range and close connection",
                "value": "request"
              }
            ],
            "param": "comm.transaction"
          },
          "title": "Select the server communication method",
          "type": "enum",
          "value": "request"
        }
      },
      "title": "Optional properties for this data source"
    }
  },
  "label": "HSK_Fast",
  "name": "TS2_MAGIC_HSK-Fast",
  "protocol": {
    "authorization": {
      "required": false
    },
    "baseUrls": [
      "wss://space.physics.uiowa.edu/das/rtstream/tracers/tracers-2/l1a/magic/hsk_fast/flexRT"
    ],
    "convention": "HTTP/1.1",
    "httpParams": {
      "bin.time.max": {
        "required": false,
        "type": "real",
        "units": "s"
      },
      "comm.rate": {
        "enum": [
          "realtime",
          "nolimit"
        ],
        "required": false,
        "type": "enum"
      },
      "comm.transaction": {
        "enum": [
          "request",
          "subscribe",
          "publish"
        ],
        "required": false,
        "type": "enum"
      },
      "format.cdf.nocomp": {
        "required": false,
        "type": "boolean"
      },
      "format.csv.dsid": {
        "required": false,
        "type": "boolean"
      },
      "format.csv.props": {
        "required": false,
        "type": "boolean"
      },
      "format.delim": {
        "required": false,
        "type": "string"
      },
      "format.headers": {
        "required": false,
        "type": "boolean"
      },
      "format.secfrac": {
        "range": [
          0,
          9
        ],
        "required": false,
        "type": "integer"
      },
      "format.serial": {
        "enum": [
          "text",
          "binary"
        ],
        "label": "Serialization",
        "required": false,
        "type": "enum"
      },
      "format.sigdigit": {
        "range": [
          2,
          17
        ],
        "required": false,
        "type": "integer"
      },
      "format.type": {
        "enum": [
          "das",
          "ccsds"
        ],
        "required": false,
        "type": "enum"
      },
      "format.version": {
        "required": false,
        "type": "string"
      },
      "read.apid": {
        "enum": [
          "x201",
          "x20f"
        ],
        "required": false,
        "type": "enum"
      },
      "read.data": {
        "flagSep": ",",
        "flags": {
          "adc_board_temp": {
            "value": "adc_board_temp"
          },
          "adc_input_current": {
            "value": "adc_input_current"
          },
          "adc_input_voltage": {
            "value": "adc_input_voltage"
          },
          "adc_ref_v": {
            "value": "adc_ref_v"
          },
          "adc_ref_v1_24": {
            "value": "adc_ref_v1_24"
          },
          "adc_sens_temp": {
            "value": "adc_sens_temp"
          },
          "adc_zener_ref": {
            "value": "adc_zener_ref"
          },
          "adc_zener_temp": {
            "value": "adc_zener_temp"
          },
          "cmd_count": {
            "value": "cmd_count"
          },
          "cmd_err_count": {
            "value": "cmd_err_count"
          },
          "drive_ena": {
            "value": "drive_ena"
          },
          "ext_sync_ref": {
            "value": "ext_sync_ref"
          },
          "filt_ena": {
            "value": "filt_ena"
          },
          "last_cmd_addr": {
            "value": "last_cmd_addr"
          },
          "last_cmd_data": {
            "value": "last_cmd_data"
          },
          "mag_magic_sync": {
            "value": "mag_magic_sync"
          },
          "mag_sync_sum": {
            "value": "mag_sync_sum"
          },
          "oscil_pwm": {
            "value": "oscil_pwm"
          },
          "por_flag": {
            "value": "por_flag"
          },
          "pps_offset": {
            "value": "pps_offset"
          },
          "pwr_spp_sync": {
            "value": "pwr_spp_sync"
          },
          "second_counter": {
            "value": "second_counter"
          },
          "sens_heat_ena": {
            "value": "sens_heat_ena"
          },
          "subsec_counter": {
            "value": "subsec_counter"
          },
          "sync_avg_duty": {
            "value": "sync_avg_duty"
          },
          "sync_jitter": {
            "value": "sync_jitter"
          },
          "sync_pid_ena": {
            "value": "sync_pid_ena"
          },
          "test_ptrn_ena": {
            "value": "test_ptrn_ena"
          },
          "tics_per_pps": {
            "value": "tics_per_pps"
          },
          "time": {
            "value": "time"
          },
          "vgse_ena": {
            "value": "vgse_ena"
          },
          "wdt_flag": {
            "value": "wdt_flag"
          },
          "x_clipped": {
            "value": "x_clipped"
          },
          "y_clipped": {
            "value": "y_clipped"
          },
          "z_clipped": {
            "value": "z_clipped"
          },
          "znr_heater_pwm": {
            "value": "znr_heater_pwm"
          },
          "znr_pid_ena": {
            "value": "znr_pid_ena"
          }
        },
        "required": false,
        "type": "FlagSet"
      },
      "read.time.max": {
        "required": true,
        "type": "isotime"
      },
      "read.time.min": {
        "required": true,
        "type": "isotime"
      }
    },
    "method": "GET",
    "subprotocols": [
      "request"
    ]
  },
  "title": "TRACERS-2 MAGIC: Fast Housekeeping Level 1A",
  "type": "WebSockSrc",
  "version": "0.1"
}