Band 5 Down-Converter Device

Band 5 Down-converter Device.

class B5dcDevice(logger, b5dc_interface)

B5dcDevice class.

__init__(logger, b5dc_interface)

Initialise the B5dcDevice class.

Parameters:

• logger (Logger) – logging handle

• b5dc_interface (B5dcInterface) – handle to the b5dc interface

exception B5dcDeviceAttenuationException

Exception used to indicate issue setting attenuation.

class B5dcDeviceConfigureAttenuation(logger, b5dc_interface)

B5dcDeviceConfigureAttenuation class.

MAX_ATTENUATION_DB = 32.0

__init__(logger, b5dc_interface)

Initialise the B5dcDeviceConfigureAttenuation class.

Parameters:

• logger (Logger) – logging handle

• b5dc_interface (B5dcInterface) – handle to the b5dc interface

async set_attenuation(set_attenuation_db, atten_attr_name)

Set the attenuation on the band 5 down converter.

Parameters:

• set_attenuation_db (int) – value to set in dB

• atten_attr_name (str) – specific register to set

Raises:

B5dcDeviceAttenuationException – for input validation, value not being set correctly, timeout on protocol layer.

Return type:

None

class B5dcDeviceConfigureFrequency(logger, b5dc_interface)

B5dcDeviceConfigureFrequency class.

__init__(logger, b5dc_interface)

Initialise the B5dcDeviceConfigureFrequency class.

Parameters:

• logger (Logger) – logging handle

• b5dc_interface (B5dcInterface) – handle to the b5dc interface

async set_frequency(frequency)

Set the frequency on the band 5 down converter.

Parameters:

frequency (B5dcFrequency) – frequency to set

Raises:

B5dcDeviceFrequencyException – for input validation, value not being set correctly, timeout on protocol layer.

Return type:

None

exception B5dcDeviceFrequencyException

Exception used to indicate issue setting frequency.

class B5dcDeviceSensors(logger, b5dc_interface)

B5dcDeviceSensors class.

__init__(logger, b5dc_interface)

Initialise the B5dcDeviceSensor class.

Parameters:

• logger (Logger) – logging handle

• b5dc_interface (B5dcInterface) – handle to the b5dc interface

async update_sensor(register_name)

Get updated data for sensor.

Return type:

None

async update_state()

Update all B5DC state.

Return type:

None

exception B5dcSpiBusy

Exception used to indicate SPI bus is busy.

Band 5 Down-converter Enum mappings.

exception B5dcAttenuationBusy

Exception used to indicate busy with attenuation configuration.

class B5dcFrequency(value)

Band 5 down-converter frequency options.

F_11_1_GHZ = 1

F_13_2_GHZ = 2

F_13_86_GHZ = 3

frequency_value_ghz()

Return the frequency in GHz based on the enum value.

Return type:

float

exception B5dcFrequencyBusy

Exception used to indicate busy with frequency configuration.

exception B5dcMappingException

Mapping exception.

class B5dcPllState(value)

Band 5 down-converter Phase lock loop state.

LOCKED = 0

LOCKED_WITH_LOSS_DETECTED = 1

NOT_LOCKED = 2

NOT_LOCKED_WITH_LOSS_DETECTED = 3

map_clk_photodiode_current_ma(reg_val)

Get the photodiode current in mA from register value.

Return type:

float

map_if_power_out_dbm(reg_val)

Get the if power out in dBm from register value.

Return type:

float

map_rf_power_in_dbm(reg_val)

Get the rf power in in dBm from register value.

Return type:

float

map_rfcm_attenuation_db(reg_val)

Get the attenuation value in dB from register value.

Return type:

float

map_rfcm_frequency_register(reg_val)

Get the frequency in GHz from the register value.

Return type:

float

map_rfcm_pll_lock_register(reg_val)

Get the PLL status from the register value.

Return type:

B5dcPllState

map_spi_bus_busy(reg_val)

Get the whether the spi bus is busy from register value.

Return type:

bool

map_temperature_degc(reg_val)

Get the temperature in deg C from register value.

Return type:

float