HDBaseT Entity

See the HDBaseT Entity for generic information.

group HDBaseTEntity

This entity is only available on certain modules, and provides information on HDBaseT extenders.

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

Gets the serial number of the HDBaseT device (6 bytes)

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: Length that was actually received and filled.

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• 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

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: A bit packet representation of the firmware version Major: Bits 24-31; Minor: Bits 16-23; Patch: Bits 8-15; Build: Bits 0-7

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• 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

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: Bit packeted representation of the state.

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• 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

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: Cable length in micro-meters

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

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

Gets the Mean Squared Error (MSE) for channel A

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: The current MSE for channel A in micro-dB

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

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

Gets the Mean Squared Error (MSE) for channel B

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: The current MSE for channel B in micro-dB

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

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

Gets the number of successful messages between retransmission

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: Instantaneous number of successful messages between retransmission. To be interpreted as: 1 / retransmissionRate for rate interpretation. If the value is 0, there have been no retransmissions, otherwise higher is better..

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• 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

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: Utilization in milli-percent

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• 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.

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: Signal modulation encoding type.

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• 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.

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: Length that was actually received and filled.

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• 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.

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: Length that was actually received and filled.

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• 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_getLinkRole(unsigned int *id, struct Result *result, const int index)

Gets the current link role In the case of “Auto” the getState API will provide the current role.

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

• value: Link role

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code and the requested value if successful.

• index – The index of the entity in question.

void hdbaset_setLinkRole(unsigned int *id, struct Result *result, const int index, const unsigned char role)

Sets the active link role

The result parameter will output the following fields:

• error: Common EntityClass Return Values common entity return value

Parameters:

• id – ID assigned through “module_createStem”

• result – Output object containing result code.

• index – The index of the entity in question.

• role – The role to be set.