# HDBaseT Telemetry

Telemetry messages are messages that are sent by the IoT device to the cloud platform every given time, or when a certain event happens. More information is available in the [API documentation](https://partners.syncpro.io/api#overview).

For HDBaseT devices, both the TX and RX of each link can send telemetry messages. Each device can send data about itself (noted with the "local" prefix) and about the remote device (noted with the "remote" prefix). The server will couple the two devices based on their chip\_ids.

In order for CloudOS to display HDBaseT related information in a proper way, and send alerts and notifications based on the received data, HDBaseT products must strictly follow the following **common** fields and data types. Additional fields can be sent if required.

{% hint style="info" %}
Note: Every telemetry message should include the full DTO (see below). 
{% endhint %}

### **Periodic Telemetry Messages**

Each device must send a telemetry message every 5 minutes or less to notify the server that it is online. If no messages were received by the server for over 5 minutes, the server assumes that the device is offline, and will indicate it to the end-user.

For HDBaseT devices, the server will use the mse, max\_err and retransition rate to indicate if the link is good, or if IT admins should be notified of an error. 

```
"telemetries":
{
    "status": "online",      //Note that this is a mandatory field for every message
    "local_gender": "TX",
    "remote_gender": "RX",
    "port_hdbt_cablelength": 15,
    "local_system_chip_id": "04:04:ea:4c:49:fa",
    "remote_system_chip_id": "04:04:ea:4c:4a:f5",
    "local_hdbt_mse_ch_a_db": -20.169,
    "local_hdbt_mse_ch_b_db": -19.359,
    "local_hdbt_mse_ch_c_db": -20.763,
    "local_hdbt_mse_ch_d_db": -20.631,
    "local_hdbt_retransrate": 0,
    "remote_hdbt_mse_ch_a_db": -14.735,
    "remote_hdbt_mse_ch_b_db": -14.311,
    "remote_hdbt_mse_ch_c_db": -13.124,
    "remote_hdbt_mse_ch_d_db": -14.436,
    "remote_hdbt_retransrate": 8087121,
    "local_hdbt_max_err_ch_a_db": 0.42188,
    "local_hdbt_max_err_ch_b_db": 0.5,
    "local_hdbt_max_err_ch_c_db": 0.42969,
    "local_hdbt_max_err_ch_d_db": 0.40625,
    "local_hdbt_device_vendor_id": 0,
    "remote_hdbt_max_err_ch_a_db": 0.9375,
    "remote_hdbt_max_err_ch_b_db": 1.0703,
    "remote_hdbt_max_err_ch_c_db": 1.2344,
    "remote_hdbt_max_err_ch_d_db": 1.0703,
    "remote_hdbt_device_vendor_id": 0
}
```

### **Event-Based Telemetry Messages**

Event-based telemetry messages should be sent as soon as an event triggers to notify the server of the change. The list below is a mandatory list that ensures that the server is up to date with the most recent information. Additional events can be added as required. 

#### Startup Event 

Following a successful registration of the device to the service, or following a software or hardware reset, the device should notify the server with its full status. 

```
"telemetries":
{
    "status": "online",
    "link_status": true,
    "local_gender": "TX",
    "remote_gender": "RX",
    "local_hdmi_5vin": true,
    "local_hdmi_5Vout": false,
    "local_hdmi_HpdIn": false,
    "remote_hdmi_5vin": false,
    "local_hdmi_hpdout": false,
    "remote_hdmi_5Vout": true,
    "remote_hdmi_HpdIn": false,
    "remote_hdmi_hpdout": false,
    "local_system_chip_id": "04:04:ea:4c:49:fa",
    "port_hdbt_cablelength": 15,
    "remote_system_chip_id": "04:04:ea:4c:4a:f5",
    "local_hdbt_mse_ch_a_db": -20.169,
    "local_hdbt_mse_ch_b_db": -19.359,
    "local_hdbt_mse_ch_c_db": -20.763,
    "local_hdbt_mse_ch_d_db": -20.631,
    "local_hdbt_retransrate": 0,
    "port_hdbt_operationmode": "active",
    "remote_hdbt_mse_ch_a_db": -14.735,
    "remote_hdbt_mse_ch_b_db": -14.311,
    "remote_hdbt_mse_ch_c_db": -13.124,
    "remote_hdbt_mse_ch_d_db": -14.436,
    "remote_hdbt_retransrate": 8087121,
    "local_hdbt_chip_fw_version": "V3.4.41 (Test)",
    "local_hdbt_max_err_ch_a_db": 0.42188,
    "local_hdbt_max_err_ch_b_db": 0.5,
    "local_hdbt_max_err_ch_c_db": 0.42969,
    "local_hdbt_max_err_ch_d_db": 0.40625,
    "local_hdbt_device_vendor_id": 0,
    "local_hdmi_hdmiin_read_edid": "00FFFFFFFFFFFF004A8B3B2A010101011718010380342078EA1EC5AE4F34B1260E5054A54B008180A940D1C0714F010101010101010108E80030F2705A80B0588A00C48F2100001A000000FF004A3235374D3936423030464C0A000000FC0052544B205548440A2020202020000000FD00384C1E5111000A20202020202001CE020343F3586190050460656603020716011F121314201511065D5E5F622309070783010000E3050301E20F716E030C001000383D2000800102030467D85DC401788000023A801871382D40582C4500132B2100001E023A801871382D40582C450006442100001E011D8018711C1620582C250006442100009E0000000000005D",
    "port_hdbt_operationmoderate": "active_1000",
    "remote_hdbt_chip_fw_version": "V3.4.25 (Test)",
    "remote_hdbt_max_err_ch_a_db": 0.9375,
    "remote_hdbt_max_err_ch_b_db": 1.0703,
    "remote_hdbt_max_err_ch_c_db": 1.2344,
    "remote_hdbt_max_err_ch_d_db": 1.0703,
    "remote_hdbt_device_vendor_id": 0,
    "local_hdmi_in_tmds_clock_freq": 192,
    "remote_hdmi_hdmiout_read_edid": "00FFFFFFFFFFFF004A8B3B2A010101011718010380342078EA1EC5AE4F34B1260E5054A54B008180A940D1C0714F010101010101010108E80030F2705A80B0588A00C48F2100001A000000FF004A3235374D3936423030464C0A000000FC0052544B205548440A2020202020000000FD00384C1E5111000A20202020202001CE020343F3586190050460656603020716011F121314201511065D5E5F622309070783010000E3050301E20F716E030C001000383D2000800102030467D85DC401788000023A801871382D40582C4500132B2100001E023A801871382D40582C450006442100001E011D8018711C1620582C250006442100009E0000000000005D",
    "local_hdbt_hdmi_in_color_depth": "30_bits",
    "local_hdbt_product_part_number": "VS3000",
    "local_hdmi_out_tmds_clock_freq": 0,
    "remote_hdmi_in_tmds_clock_freq": 0,
    "local_hdbt_hdmi_in_refresh_rate": 48,
    "local_hdbt_hdmi_in_video_format": "RGB",
    "remote_hdbt_product_part_number": "VS3000",
    "remote_hdmi_out_tmds_clock_freq": 192,
    "local_hdbt_hdmi_in_pixel_clock_rate": 153,
    "local_hdbt_hdmi_in_video_is_interlaced": false,
    "local_hdbt_hdmi_in_vertical_total_pixels": 1235,
    "local_hdbt_hdmi_in_vertical_active_pixels": 1200,
    "local_hdbt_hdmi_in_horizontal_total_pixels": 2600,
    "local_hdbt_hdmi_in_horizontal_active_pixels": 2400
}
```

#### Link Connect / Disconnect

When the HDBaseT link is disconnected, immediate notification should be sent to the server, which will alert the end-user. As with all other telemetry messages, the full DTO is required, but these fields below are the relevant fields for the event - 

```
"telemetries":
{
    "status": "error",
    "link_status": false,
    "local_system_chip_id": "04:04:ea:4c:49:fa"
}
```

When the HDBaseT link is up again, the device should update the server -

```
"telemetries":
{
    "status": "online",
    "link_status": true,
    "local_system_chip_id": "04:04:ea:4c:49:fa",
    "remote_system_chip_id": "04:04:ea:4c:4a:f5"
}
```

#### Link Status Change

The link status fields (MSE, Max\_err etc.) are sent to the server as part of the periodic telemetry messages. However, if a change to these values happens, the device can choose to immediately notify the server.

#### 5V at TX Side (Source Connect/Disconnect)

When a source connects or disconnects to the HDBaseT transmitter,  the device should send update for these fields - 

```
"telemetries":
{
    "status": "online",
    "link_status": true,
    "local_gender": "TX",
    "remote_gender": "RX",
    "local_hdmi_5vin": true,
    "local_hdmi_5Vout": false,
    "remote_hdmi_5vin": false,
    "remote_hdmi_5Vout": true,
    "local_system_chip_id": "04:04:ea:4c:49:fa",
    "remote_system_chip_id": "04:04:ea:4c:4a:f5",
    "local_hdmi_hdmiin_read_edid": "00FFFFFFFFFFFF004A8B3B2A010101011718010380342078EA1EC5AE4F34B1260E5054A54B008180A940D1C0714F010101010101010108E80030F2705A80B0588A00C48F2100001A000000FF004A3235374D3936423030464C0A000000FC0052544B205548440A2020202020000000FD00384C1E5111000A20202020202001CE020343F3586190050460656603020716011F121314201511065D5E5F622309070783010000E3050301E20F716E030C001000383D2000800102030467D85DC401788000023A801871382D40582C4500132B2100001E023A801871382D40582C450006442100001E011D8018711C1620582C250006442100009E0000000000005D"
}
```

#### HPD at RX Side (Sink Connect/Disconnect)

When a sink connects or disconnects from the HDBaseT receiver, the device should update the following fields to the server - 

```
"telemetries":
{
    "status": "online",
    "link_status": true,
    "local_gender": "TX",
    "remote_gender": "RX",
    "local_hdmi_hpdin": false,
    "local_hdmi_hpdout": false,
    "remote_hdmi_hpdin": false,
    "remote_hdmi_hpdout": false,
    "local_system_chip_id": "04:04:ea:4c:49:fa",
    "remote_system_chip_id": "04:04:ea:4c:4a:f5",
    "remote_hdmi_hdmiout_read_edid": "00FFFFFFFFFFFF004A8B3B2A010101011718010380342078EA1EC5AE4F34B1260E5054A54B008180A940D1C0714F010101010101010108E80030F2705A80B0588A00C48F2100001A000000FF004A3235374D3936423030464C0A000000FC0052544B205548440A2020202020000000FD00384C1E5111000A20202020202001CE020343F3586190050460656603020716011F121314201511065D5E5F622309070783010000E3050301E20F716E030C001000383D2000800102030467D85DC401788000023A801871382D40582C4500132B2100001E023A801871382D40582C450006442100001E011D8018711C1620582C250006442100009E0000000000005D"
}
```

#### Change In Power Mode

```
"telemetries":
{
    "status": "online",
    "link_status": true,
    "local_gender": "TX",
    "remote_gender": "RX",
    "local_system_chip_id": "04:04:ea:4c:49:fa",
    "remote_system_chip_id": "04:04:ea:4c:4a:f5",
    "port_hdbt_operationmode": "active",
    "port_hdbt_operationmoderate": "active_1000"
}
```

### Full DTO

This is the full HDBaseT device DTO. Additional fields can be reported as needed. 

```
"telemetries":
{
    "status": "online",
    "link_status": true,
    "local_gender": "TX",
    "remote_gender": "RX",
    "local_hdmi_5vin": true,
    "local_hdmi_5Vout": false,
    "local_hdmi_HpdIn": false,
    "remote_hdmi_5vin": false,
    "local_hdmi_hpdout": false,
    "remote_hdmi_5Vout": true,
    "remote_hdmi_HpdIn": false,
    "remote_hdmi_hpdout": false,
    "local_system_chip_id": "04:04:ea:4c:49:fa",
    "port_hdbt_cablelength": 15,
    "remote_system_chip_id": "04:04:ea:4c:4a:f5",
    "local_hdbt_mse_ch_a_db": -20.169,
    "local_hdbt_mse_ch_b_db": -19.359,
    "local_hdbt_mse_ch_c_db": -20.763,
    "local_hdbt_mse_ch_d_db": -20.631,
    "local_hdbt_retransrate": 0,
    "port_hdbt_operationmode": "active",
    "remote_hdbt_mse_ch_a_db": -14.735,
    "remote_hdbt_mse_ch_b_db": -14.311,
    "remote_hdbt_mse_ch_c_db": -13.124,
    "remote_hdbt_mse_ch_d_db": -14.436,
    "remote_hdbt_retransrate": 8087121,
    "local_hdbt_chip_fw_version": "V3.4.41 (Test)",
    "local_hdbt_max_err_ch_a_db": 0.42188,
    "local_hdbt_max_err_ch_b_db": 0.5,
    "local_hdbt_max_err_ch_c_db": 0.42969,
    "local_hdbt_max_err_ch_d_db": 0.40625,
    "local_hdbt_device_vendor_id": 0,
    "local_hdmi_hdmiin_read_edid": "00FFFFFFFFFFFF004A8B3B2A010101011718010380342078EA1EC5AE4F34B1260E5054A54B008180A940D1C0714F010101010101010108E80030F2705A80B0588A00C48F2100001A000000FF004A3235374D3936423030464C0A000000FC0052544B205548440A2020202020000000FD00384C1E5111000A20202020202001CE020343F3586190050460656603020716011F121314201511065D5E5F622309070783010000E3050301E20F716E030C001000383D2000800102030467D85DC401788000023A801871382D40582C4500132B2100001E023A801871382D40582C450006442100001E011D8018711C1620582C250006442100009E0000000000005D",
    "port_hdbt_operationmoderate": "active_1000",
    "remote_hdbt_chip_fw_version": "V3.4.25 (Test)",
    "remote_hdbt_max_err_ch_a_db": 0.9375,
    "remote_hdbt_max_err_ch_b_db": 1.0703,
    "remote_hdbt_max_err_ch_c_db": 1.2344,
    "remote_hdbt_max_err_ch_d_db": 1.0703,
    "remote_hdbt_device_vendor_id": 0,
    "local_hdmi_in_tmds_clock_freq": 192,
    "remote_hdmi_hdmiout_read_edid": "00FFFFFFFFFFFF004A8B3B2A010101011718010380342078EA1EC5AE4F34B1260E5054A54B008180A940D1C0714F010101010101010108E80030F2705A80B0588A00C48F2100001A000000FF004A3235374D3936423030464C0A000000FC0052544B205548440A2020202020000000FD00384C1E5111000A20202020202001CE020343F3586190050460656603020716011F121314201511065D5E5F622309070783010000E3050301E20F716E030C001000383D2000800102030467D85DC401788000023A801871382D40582C4500132B2100001E023A801871382D40582C450006442100001E011D8018711C1620582C250006442100009E0000000000005D",
    "local_hdbt_hdmi_in_color_depth": "30_bits",
    "local_hdbt_product_part_number": "VS3000",
    "local_hdmi_out_tmds_clock_freq": 0,
    "remote_hdmi_in_tmds_clock_freq": 0,
    "local_hdbt_hdmi_in_refresh_rate": 48,
    "local_hdbt_hdmi_in_video_format": "RGB",
    "remote_hdbt_product_part_number": "VS3000",
    "remote_hdmi_out_tmds_clock_freq": 192,
    "local_hdbt_hdmi_in_pixel_clock_rate": 153,
    "local_hdbt_hdmi_in_video_is_interlaced": false,
    "local_hdbt_hdmi_in_vertical_total_pixels": 1235,
    "local_hdbt_hdmi_in_vertical_active_pixels": 1200,
    "local_hdbt_hdmi_in_horizontal_total_pixels": 2600,
    "local_hdbt_hdmi_in_horizontal_active_pixels": 2400
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://pdocs.xyte.io/hdbaset-resources/common-telemetry.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.