Skip to content

Latest commit

 

History

History
308 lines (305 loc) · 9.29 KB

api.md

File metadata and controls

308 lines (305 loc) · 9.29 KB

Extending Micboard

Micboard provides data from receivers in a machine readable JSON format. This data is easily accessible via HTTP and WebSockets. In addition to the data that micboard processes, micboard also supplies raw receiver data.

This data can be found at http://your_micboard_ip:8058/data.json

This capability lets you do a few extra things with the data

  • Make a 40' high VU meter with LED tape
  • Log metrics into a database like InfluxDB

Example Axient Digital Data

{
  "ip": "10.9.49.54",
  "raw": {
    "DEVICE_ID": "RF 5-8",
    "ENCRYPTION_MODE": "OFF",
    "FW_VER": "1.1.43.0",
    "MODEL": "AD4Q-A",
    "QUADVERSITY_MODE": "OFF",
    "RF_BAND": "G57",
    "TRANSMISSION_MODE": "STANDARD"
  },
  "status": "CONNECTED",
  "tx": [{
      "antenna": "XX",
      "audio_level": 13,
      "battery": 255,
      "channel": 1,
      "frequency": "594.075",
      "id": "05",
      "name": "",
      "name_raw": "05",
      "quality": 255,
      "raw": {
        "ALL": "255 000 005 033 XX 00 011 00 012",
        "AUDIO_GAIN": "018",
        "AUDIO_LED_BITMAP": "000",
        "AUDIO_LEVEL_PEAK": "005",
        "AUDIO_LEVEL_RMS": "020",
        "AUDIO_MUTE": "OFF",
        "CHAN_NAME": "05",
        "CHAN_QUALITY": "255",
        "ENCRYPTION_STATUS": "OK",
        "FD_MODE": "OFF",
        "FREQUENCY": "0594075",
        "GROUP_CHANNEL": "--,--",
        "INTERFERENCE_STATUS": "NONE",
        "METER_RATE": "00100",
        "RSSI": "2 012",
        "RSSI_LED_BITMAP": "2 00",
        "SLOT_": "",
        "SLOT_BATT_BAR": "",
        "SLOT_BATT_BARS": "8 255",
        "SLOT_BATT_CHARGE_PERCENT": "8 255",
        "SLOT_BATT_CYCLE_COUNT": "8 65535",
        "SLOT_BATT_HEALTH_PERCENT": "8 255",
        "SLOT_BATT_MINS": "8 65535",
        "SLOT_BATT_TYPE": "8 UNKN",
        "SLOT_INPUT_PAD": "8 255",
        "SLOT_OFFSET": "8 255",
        "SLOT_POLARITY": "8 UNKNOWN",
        "SLOT_RF_OUTPUT": "8 UNKNOWN",
        "SLOT_RF_POWER": "8 255",
        "SLOT_RF_POWER_MODE": "8 UNKNOWN",
        "SLOT_SHOWLINK_STATUS": "8 255",
        "SLOT_STATUS": "8 EMPTY",
        "SLOT_TX_DEVICE_ID": "8",
        "SLOT_TX_MODEL": "8 UNKNOWN",
        "TX_BATT_": "",
        "TX_BATT_BARS": "255",
        "TX_BATT_CHARGE_PERCENT": "255",
        "TX_BATT_CYCLE_COUNT": "65535",
        "TX_BATT_HEALTH_PERCENT": "255",
        "TX_BATT_MINS": "65535",
        "TX_BATT_TEMP_C": "255",
        "TX_BATT_TEMP_F": "255",
        "TX_BATT_TYPE": "UNKN",
        "TX_DEVICE_ID": "",
        "TX_INPUT_PAD": "255",
        "TX_LOCK": "UNKNOWN",
        "TX_MODEL": "UNKNOWN",
        "TX_MUTE_MODE_STATUS": "UNKNOWN",
        "TX_OFFSET": "255",
        "TX_POLARITY": "UNKNOWN",
        "TX_POWER_LEVEL": "255",
        "TX_TALK_SWITCH": "UNKNOWN",
        "UNREGISTERED_TX_STATUS": "OK"
      },
      "rf_level": 9,
      "slot": 5,
      "status": "TX_COM_ERROR",
      "tx_offset": -9,
      "type": "axtd"
    },
    {
      "antenna": "XX",
      "audio_level": 13,
      "battery": 255,
      "channel": 2,
      "frequency": "594.975",
      "id": "06",
      "name": "",
      "name_raw": "06",
      "quality": 255,
      "raw": {
        "ALL": "255 000 005 033 XX 00 011 00 012",
        "AUDIO_GAIN": "018",
        "AUDIO_LED_BITMAP": "000",
        "AUDIO_LEVEL_PEAK": "005",
        "AUDIO_LEVEL_RMS": "020",
        "AUDIO_MUTE": "OFF",
        "CHAN_NAME": "06",
        "CHAN_QUALITY": "255",
        "ENCRYPTION_STATUS": "OK",
        "FD_MODE": "OFF",
        "FREQUENCY": "0594975",
        "GROUP_CHANNEL": "--,--",
        "INTERFERENCE_STATUS": "NONE",
        "METER_RATE": "00100",
        "RSSI": "2 013",
        "RSSI_LED_BITMAP": "2 00",
        "SLOT_": "",
        "SLOT_BATT_BAR": "",
        "SLOT_BATT_BARS": "8 255",
        "SLOT_BATT_CHARGE_PERCENT": "8 255",
        "SLOT_BATT_CYCLE_COUNT": "8 65535",
        "SLOT_BATT_HEALTH_PERCENT": "8 255",
        "SLOT_BATT_MINS": "8 65535",
        "SLOT_BATT_TYPE": "8 UNKN",
        "SLOT_INPUT_PAD": "8 255",
        "SLOT_OFFSET": "8 255",
        "SLOT_POLARITY": "8 UNKNOWN",
        "SLOT_RF_OUTPUT": "8 UNKNOWN",
        "SLOT_RF_POWER": "8 255",
        "SLOT_RF_POWER_MODE": "8 UNKNOWN",
        "SLOT_SHOWLINK_STATUS": "8 255",
        "SLOT_STATUS": "8 EMPTY",
        "SLOT_TX_DEVICE_ID": "8",
        "SLOT_TX_MODEL": "8 UNKNOWN",
        "TX_BATT_BARS": "255",
        "TX_BATT_CHARGE_PERCENT": "255",
        "TX_BATT_CYCLE_COUNT": "65535",
        "TX_BATT_HEALTH_PERCENT": "255",
        "TX_BATT_MINS": "65535",
        "TX_BATT_TEMP_C": "255",
        "TX_BATT_TEMP_F": "255",
        "TX_BATT_TYPE": "UNKN",
        "TX_DEVICE_ID": "",
        "TX_INPUT_PAD": "255",
        "TX_LOCK": "UNKNOWN",
        "TX_MODEL": "UNKNOWN",
        "TX_MUTE_MODE_STATUS": "UNKNOWN",
        "TX_OFFSET": "255",
        "TX_POLARITY": "UNKNOWN",
        "TX_POWER_LEVEL": "255",
        "TX_TALK_SWITCH": "UNKNOWN",
        "UNREGISTERED_TX_STATUS": "OK"
      },
      "rf_level": 9,
      "slot": 6,
      "status": "TX_COM_ERROR",
      "tx_offset": -9,
      "type": "axtd"
    },
    {
      "antenna": "XX",
      "audio_level": 13,
      "battery": 255,
      "channel": 3,
      "frequency": "592.800",
      "id": "07",
      "name": "",
      "name_raw": "07",
      "quality": 255,
      "raw": {
        "ALL": "255 000 005 033 XX 00 013 00 012",
        "AUDIO_GAIN": "018",
        "AUDIO_LED_BITMAP": "000",
        "AUDIO_LEVEL_PEAK": "005",
        "AUDIO_LEVEL_RMS": "020",
        "AUDIO_MUTE": "OFF",
        "CHAN_NAME": "07",
        "CHAN_QUALITY": "255",
        "ENCRYPTION_STATUS": "OK",
        "FD_MODE": "OFF",
        "FREQUENCY": "0592800",
        "GROUP_CHANNEL": "--,--",
        "INTERFERENCE_STATUS": "NONE",
        "METER_RATE": "00100",
        "RSSI": "2 012",
        "RSSI_LED_BITMAP": "2 00",
        "SLOT_": "",
        "SLOT_BATT_BAR": "",
        "SLOT_BATT_BARS": "8 255",
        "SLOT_BATT_CHARGE_PERCENT": "8 255",
        "SLOT_BATT_CYCLE_COUNT": "8 65535",
        "SLOT_BATT_HEALTH_PERCENT": "8 255",
        "SLOT_BATT_MINS": "8 65535",
        "SLOT_BATT_TYPE": "8 UNKN",
        "SLOT_INPUT_PAD": "8 255",
        "SLOT_OFFSET": "8 255",
        "SLOT_POLARITY": "8 UNKNOWN",
        "SLOT_RF_OUTPUT": "8 UNKNOWN",
        "SLOT_RF_POWER": "8 255",
        "SLOT_RF_POWER_MODE": "8 UNKNOWN",
        "SLOT_SHOWLINK_STATUS": "8 255",
        "SLOT_STATUS": "8 EMPTY",
        "SLOT_TX_DEVICE_ID": "8",
        "SLOT_TX_MODEL": "8 UNKNOWN",
        "TX_BATT_BARS": "255",
        "TX_BATT_CHARGE_PERCENT": "255",
        "TX_BATT_CYCLE_COUNT": "65535",
        "TX_BATT_HEALTH_PERCENT": "255",
        "TX_BATT_MINS": "65535",
        "TX_BATT_TEMP_C": "255",
        "TX_BATT_TEMP_F": "255",
        "TX_BATT_TYPE": "UNKN",
        "TX_DEVICE_ID": "",
        "TX_INPUT_PAD": "255",
        "TX_LOCK": "UNKNOWN",
        "TX_MODEL": "UNKNOWN",
        "TX_MUTE_MODE_STATUS": "UNKNOWN",
        "TX_OFFSET": "255",
        "TX_POLARITY": "UNKNOWN",
        "TX_POWER_LEVEL": "255",
        "TX_TALK_SWITCH": "UNKNOWN",
        "UNREGISTERED_TX_STATUS": "OK"
      },
      "rf_level": 11,
      "slot": 7,
      "status": "TX_COM_ERROR",
      "tx_offset": -9,
      "type": "axtd"
    },
    {
      "antenna": "XX",
      "audio_level": 0,
      "battery": 255,
      "channel": 4,
      "frequency": "591.150",
      "id": "08",
      "name": "",
      "name_raw": "08",
      "quality": 255,
      "raw": {
        "ALL": "255 000 005 020 XX 00 013 00 013",
        "AUDIO_GAIN": "018",
        "AUDIO_LED_BITMAP": "000",
        "AUDIO_LEVEL_PEAK": "005",
        "AUDIO_LEVEL_RMS": "020",
        "AUDIO_MUTE": "OFF",
        "CHAN_NAME": "08",
        "CHAN_QUALITY": "255",
        "ENCRYPTION_STATUS": "OK",
        "FD_MODE": "OFF",
        "FREQUENCY": "0591150",
        "GROUP_CHANNEL": "--,--",
        "INTERFERENCE_STATUS": "NONE",
        "METER_RATE": "00100",
        "RSSI": "2 013",
        "RSSI_LED_BITMAP": "2 00",
        "SLOT_": "",
        "SLOT_BATT_BAR": "",
        "SLOT_BATT_BARS": "8 255",
        "SLOT_BATT_CHARGE_PERCENT": "8 255",
        "SLOT_BATT_CYCLE_COUNT": "8 65535",
        "SLOT_BATT_HEALTH_PERCENT": "8 255",
        "SLOT_BATT_MINS": "8 65535",
        "SLOT_BATT_TYPE": "8 UNKN",
        "SLOT_INPUT_PAD": "8 255",
        "SLOT_OFFSET": "8 255",
        "SLOT_POLARITY": "8 UNKNOWN",
        "SLOT_RF_OUTPUT": "8 UNKNOWN",
        "SLOT_RF_POWER": "8 255",
        "SLOT_RF_POWER_MODE": "8 UNKNOWN",
        "SLOT_SHOWLINK_STATUS": "8 255",
        "SLOT_STATUS": "8 EMPTY",
        "SLOT_TX_DEVICE_ID": "8",
        "SLOT_TX_MODEL": "8 UNKNOWN",
        "TX_BATT_BARS": "255",
        "TX_BATT_CHARGE_PERCENT": "255",
        "TX_BATT_CYCLE_COUNT": "65535",
        "TX_BATT_HEALTH_PERCENT": "255",
        "TX_BATT_MINS": "65535",
        "TX_BATT_TEMP_C": "255",
        "TX_BATT_TEMP_F": "255",
        "TX_BATT_TYPE": "UNKN",
        "TX_DEVICE_ID": "",
        "TX_INPUT_PAD": "255",
        "TX_LOCK": "UNKNOWN",
        "TX_MODEL": "UNKNOWN",
        "TX_MUTE_MODE_STATUS": "UNKNOWN",
        "TX_OFFSET": "255",
        "TX_POLARITY": "UNKNOWN",
        "TX_POWER_LEVEL": "255",
        "TX_TALK_SWITCH": "UNKNOWN",
        "UNREGISTERED_TX_STATUS": "OK"
      },
      "rf_level": 11,
      "slot": 8,
      "status": "TX_COM_ERROR",
      "tx_offset": 255,
      "type": "axtd"
    }
  ],
  "type": "axtd"
}