HDBaseT Entity¶

group HDBaseTEntity

void hdbaset_getSerialNumber(unsigned int *id, struct Result *result, const int index, unsigned char *buffer, const unsigned int bufferLength)¶

Congratulations! You found an Easter egg! Unfortunately, this code is still under construction and should not be used.

HDBaseTClass: This entity is only available on certain modules, and provides a Power Over Ethernet control ability. Gets the serial number of the HDBaseT device (6 bytes)

Returns common entity return values

Parameters:

id – ID assigned through “module_createStem”
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Length that was actually received and filled.
index – The index of the entity in question.
buffer – pointer to the start of a c style buffer to be filled
bufferLength – Length of the buffer to be filed

void hdbaset_getFirmwareVersion(unsigned int *id, struct Result *result, const int index)¶

Gets the firmware version of the HDBaseT device

Returns common entity return values

Parameters:

id – ID assigned through “module_createStem”
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. A bit packet representation of the firmware version Major: Bits 24-31; Minor: Bits 16-23; Patch: Bits 8-15; Build: Bits 0-7
index – The index of the entity in question.

void hdbaset_getState(unsigned int *id, struct Result *result, const int index)¶

Gets the current state of the HDBaseT link

Returns common entity return values

Parameters:

id – ID assigned through “module_createStem”
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Bit packeted representation of the state.
index – The index of the entity in question.

void hdbaset_getCableLength(unsigned int *id, struct Result *result, const int index)¶

Gets the perceived cable length

Returns common entity return values

Parameters:

id – ID assigned through “module_createStem”
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Cable length in meters
index – The index of the entity in question.

void hdbaset_getMSE(unsigned int *id, struct Result *result, const int index)¶

Gets the Mean Squared Error (MSE)

Returns common entity return values

Parameters:

id – ID assigned through “module_createStem”
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. A bit packed representation for A and B channels Channel A: Bits 0-15; Channel B: Bits 16-31; Each channel has a unit of milli-dB, represented as a signed int16_t. Effective range of [-32.768dB, 32.767dB]
index – The index of the entity in question.

void hdbaset_getRetransmissionRate(unsigned int *id, struct Result *result, const int index)¶

Gets the number of retransmissions that have occurred

Returns common entity return values

Parameters:

id – ID assigned through “module_createStem”
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. retransmissions since link creation.
index – The index of the entity in question.

void hdbaset_getLinkUtilization(unsigned int *id, struct Result *result, const int index)¶

Gets the current link utilization

Returns common entity return values

Parameters:

id – ID assigned through “module_createStem”
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Utilization in milli-percent
index – The index of the entity in question.

void hdbaset_getEncodingState(unsigned int *id, struct Result *result, const int index)¶

Gets the current encoding state.

Returns common entity return values

Parameters:

id – ID assigned through “module_createStem”
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Signal modulation encoding type.
index – The index of the entity in question.

void hdbaset_getUSB2DeviceTree(unsigned int *id, struct Result *result, const int index, unsigned char *buffer, const unsigned int bufferLength)¶

Gets the USB2 tree at the HDBaseT device.

Returns common entity return values

Parameters:

id – ID assigned through “module_createStem”
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Length that was actually received and filled.
index – The index of the entity in question.
buffer – pointer to the start of a c style buffer to be filled
bufferLength – Length of the buffer to be filed

void hdbaset_getUSB3DeviceTree(unsigned int *id, struct Result *result, const int index, unsigned char *buffer, const unsigned int bufferLength)¶

Gets the USB3 tree at the HDBaseT device.

Returns common entity return values

Parameters:

id – ID assigned through “module_createStem”
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Length that was actually received and filled.
index – The index of the entity in question.
buffer – pointer to the start of a c style buffer to be filled
bufferLength – Length of the buffer to be filed