HDBaseT Class¶
See the HDBaseT Entity for generic information.
-
class HDBaseTClass : public Acroname::BrainStem::EntityClass¶
HDBaseTClass: This entity is only available on certain modules, and provides information on HDBaseT extenders.
Public Functions
-
HDBaseTClass(void)¶
Constructor.
-
virtual ~HDBaseTClass(void)¶
Destructor.
-
void init(Module *pModule, const uint8_t index)¶
Initialize the HDBaseT Class.
- Parameters:
pModule – The module to which this entity belongs.
index – The index of the HDBaseT entity to be addressed.
-
aErr getSerialNumber(uint8_t *buffer, const size_t bufferLength, size_t *unloadedLength)¶
Gets the serial number of the HDBaseT device (6 bytes)
- Parameters:
buffer – pointer to the start of a c style buffer to be filled
bufferLength – Length of the buffer to be filed
unloadedLength – Length that was actually received and filled.
- Returns:
Returns common entity return values
-
aErr getFirmwareVersion(uint32_t *firmwareVersion)¶
Gets the firmware version of the HDBaseT device
- Parameters:
firmwareVersion – A bit packet representation of the firmware version Major: Bits 24-31; Minor: Bits 16-23; Patch: Bits 8-15; Build: Bits 0-7
- Returns:
Returns common entity return values
-
aErr getState(uint32_t *state)¶
Gets the current state of the HDBaseT link
- Parameters:
state – Bit packeted representation of the state.
- Returns:
Returns common entity return values
-
aErr getCableLength(uint32_t *cableLength)¶
Gets the perceived cable length
- Parameters:
cableLength – Cable length in micro-meters
- Returns:
Returns common entity return values
-
aErr getMSEA(int32_t *mseA)¶
Gets the Mean Squared Error (MSE) for channel A
- Parameters:
mseA – The current MSE for channel A in micro-dB
- Returns:
Returns common entity return values
-
aErr getMSEB(int32_t *mseB)¶
Gets the Mean Squared Error (MSE) for channel B
- Parameters:
mseB – The current MSE for channel B in micro-dB
- Returns:
Returns common entity return values
-
aErr getRetransmissionRate(uint32_t *retransmissionRate)¶
Gets the number of successful messages between retransmission
- Parameters:
retransmissionRate – 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..
- Returns:
Returns common entity return values
-
aErr getLinkUtilization(uint32_t *linkUtilization)¶
Gets the current link utilization
- Parameters:
linkUtilization – Utilization in milli-percent
- Returns:
Returns common entity return values
-
aErr getEncodingState(uint8_t *encodingState)¶
Gets the current encoding state.
- Parameters:
encodingState – Signal modulation encoding type.
- Returns:
Returns common entity return values
-
aErr getUSB2DeviceTree(uint8_t *buffer, const size_t bufferLength, size_t *unloadedLength)¶
Gets the USB2 tree at the HDBaseT device.
- Parameters:
buffer – pointer to the start of a c style buffer to be filled
bufferLength – Length of the buffer to be filed
unloadedLength – Length that was actually received and filled.
- Returns:
Returns common entity return values
-
aErr getUSB3DeviceTree(uint8_t *buffer, const size_t bufferLength, size_t *unloadedLength)¶
Gets the USB3 tree at the HDBaseT device.
- Parameters:
buffer – pointer to the start of a c style buffer to be filled
bufferLength – Length of the buffer to be filed
unloadedLength – Length that was actually received and filled.
- Returns:
Returns common entity return values
-
aErr getLinkRole(uint8_t *role)¶
Gets the current link role In the case of “Auto” the getState API will provide the current role.
- Parameters:
role – Link role
- Returns:
Returns common entity return values
-
aErr setLinkRole(const uint8_t role)¶
Sets the active link role
- Parameters:
role – The role to be set.
- Returns:
Returns common entity return values
-
HDBaseTClass(void)¶