HDBaseT¶
See the HDBaseT Entity for generic information.
- class brainstem.entity.HDBaseT(module, index)[source]¶
This entity is only available on certain modules, and provides information on HDBaseT extenders.
- getCableLength()[source]¶
Gets the perceived cable length
- Returns:
- Object containing error code and returned value on success.
- errorunsigned byte
An error result from the list of defined error codes
- valueunsigned int
Cable length in micro-meters
- Return type:
- getEncodingState()[source]¶
Gets the current encoding state.
- Returns:
- Object containing error code and returned value on success.
- errorunsigned byte
An error result from the list of defined error codes
- valueunsigned char
Signal modulation encoding type.
- Return type:
- getFirmwareVersion()[source]¶
Gets the firmware version of the HDBaseT device
- Returns:
- Object containing error code and returned value on success.
- errorunsigned byte
An error result from the list of defined error codes
- valueunsigned int
A bit packet representation of the firmware version Major: Bits 24-31; Minor: Bits 16-23; Patch: Bits 8-15; Build: Bits 0-7
- Return type:
- getLinkRole()[source]¶
Gets the current link role In the case of “Auto” the getState API will provide the current role.
- Returns:
- Object containing error code and returned value on success.
- errorunsigned byte
An error result from the list of defined error codes
- valueunsigned char
Link role
- Return type:
- getLinkUtilization()[source]¶
Gets the current link utilization
- Returns:
- Object containing error code and returned value on success.
- errorunsigned byte
An error result from the list of defined error codes
- valueunsigned int
Utilization in milli-percent
- Return type:
- getMSEA()[source]¶
Gets the Mean Squared Error (MSE) for channel A
- Returns:
- Object containing error code and returned value on success.
- errorunsigned byte
An error result from the list of defined error codes
- valueint
The current MSE for channel A in micro-dB
- Return type:
- getMSEB()[source]¶
Gets the Mean Squared Error (MSE) for channel B
- Returns:
- Object containing error code and returned value on success.
- errorunsigned byte
An error result from the list of defined error codes
- valueint
The current MSE for channel B in micro-dB
- Return type:
- getRetransmissionRate()[source]¶
Gets the number of successful messages between retransmission
- Returns:
- Object containing error code and returned value on success.
- errorunsigned byte
An error result from the list of defined error codes
- valueunsigned int
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..
- Return type:
- getSerialNumber(buffer_length=65536)[source]¶
Gets the serial number of the HDBaseT device (6 bytes)
- Parameters:
buffer_length (unsigned int) – Length of the buffer to be filed
- Returns:
- Object containing error code and returned value on success.
- errorunsigned byte
An error result from the list of defined error codes
- valuelist(unsigned char)
pointer to the start of a c style buffer to be filled
- Return type:
- getState()[source]¶
Gets the current state of the HDBaseT link
- Returns:
- Object containing error code and returned value on success.
- errorunsigned byte
An error result from the list of defined error codes
- valueunsigned int
Bit packeted representation of the state.
- Return type:
- getUSB2DeviceTree(buffer_length=65536)[source]¶
Gets the USB2 tree at the HDBaseT device.
- Parameters:
buffer_length (unsigned int) – Length of the buffer to be filed
- Returns:
- Object containing error code and returned value on success.
- errorunsigned byte
An error result from the list of defined error codes
- valuelist(unsigned char)
pointer to the start of a c style buffer to be filled
- Return type:
- getUSB3DeviceTree(buffer_length=65536)[source]¶
Gets the USB3 tree at the HDBaseT device.
- Parameters:
buffer_length (unsigned int) – Length of the buffer to be filed
- Returns:
- Object containing error code and returned value on success.
- errorunsigned byte
An error result from the list of defined error codes
- valuelist(unsigned char)
pointer to the start of a c style buffer to be filled
- Return type: