Unify

class Unify

The main unify interface

Types

Companion

object Companion

Observer_

interface Observer_

Functions

addNetworkInstrument

suspend fun addNetworkInstrument(host: String): ConnectionResult

Add a network instrument.

configureCalibration

fun configureCalibration(calibration: Calibration): CalibrationConfigurationResult

Configure the calibration

configureOverlaySet

fun configureOverlaySet(overlaySet: OverlaySet): OverlaySetConfigurationResult

Configure the overlay set.

configureTest

fun configureTest(test: Test): TestConfigurationResult

Configure the test

connectInstrument

suspend fun connectInstrument(serialNumber: String): ConnectionResult

Connect to an instrument.

disconnectInstrument

suspend fun disconnectInstrument(serialNumber: String)

Disconnect an instrument.

getBatchedOverlayResults

fun getBatchedOverlayResults(): Flow<OverlayResult>

Get batched overlay results.

getBatchedTestResults

fun getBatchedTestResults(): Flow<BatchedTestResult>

Get batched test results.

getInstrumentDefinition

fun getInstrumentDefinition(serialNumber: String): InstrumentDefinition

Get the instrument definition for a serial number.

getInstrumentDefinitions

fun getInstrumentDefinitions(): List<InstrumentDefinition>

Get the available instrument definitions.

getInstrumentStates

fun getInstrumentStates(serialNumber: String): Flow<InstrumentState>

Get state updates for an instrument.

getLogs

fun getLogs(): Flow<Log>

Get the log stream.

getRealtimeOverlayResults

fun getRealtimeOverlayResults(): Flow<OverlayResult>

Get realtime overlay results.

getRealtimeTestResults

fun getRealtimeTestResults(): Flow<RealtimeTestResult>

Get realtime test results.

getReportDetails

fun getReportDetails(): ReportDetails

Get the report details.

getReportLogo

fun getReportLogo(): String?

Get the report logo.

getReportRecords

fun getReportRecords(): List<Record>

Get the report records.

getTestContexts

fun getTestContexts(): Flow<TestContext>

Get test contexts.

identifyInstrument

suspend fun identifyInstrument(serialNumber: String, text: String, duration: Double)

Display identification text on an instrument.

mergeReport

suspend fun mergeReport(filePath: String)

Merge a report from disk into the current report.

newReport

fun newReport()

Create a new report.

openReport

suspend fun openReport(filePath: String)

Open a report from disk.

printReportToPdf

suspend fun printReportToPdf(filePath: String, orientation: Orientation)

Print the report to a PDF file.

printTraceToPng

fun printTraceToPng(traceId: Long, filePath: String, width: Int, height: Int)

Print a trace to a PNG file.

recordImage

fun recordImage(filePath: String, tags: List<String>, comment: String?, location: Location?): Record

Record an image in the report.

recordTrace

fun recordTrace(traceId: Long, tags: List<String>, comment: String?, location: Location?, viewport: Viewport): Record

Record a trace in the report.

runBluetoothScan

suspend fun runBluetoothScan()

Run a Bluetooth scan.

runCalibration

fun runCalibration(): Flow<CalibrationState>

Run the calibration

runCalibrationStep

fun runCalibrationStep(stepId: String): Flow<Double>

Run the calibration step

runInstrumentDiscovery

fun runInstrumentDiscovery(): Flow<List<Instrument>>

Run instrument discovery.

runTest

fun runTest(checkRl: Boolean): Flow<TestProgress>

Run the test

saveReport

suspend fun saveReport(filePath: String)

Save the report to disk.

setInstrumentIsSoundOn

suspend fun setInstrumentIsSoundOn(serialNumber: String, on: Boolean)

Enable or disable the sound on the instrument

setLogLevels

fun setLogLevels(minLevel: LogLevel, maxLevel: LogLevel)

Set the minimum and maximum log levels.

setReportDetails

fun setReportDetails(reportDetails: ReportDetails)

Set the report details.

setReportLogo

fun setReportLogo(filePath: String?)

Set the report logo.

stopBluetoothScan

suspend fun stopBluetoothScan()

Stop the Bluetooth scan.

stopCalibration

suspend fun stopCalibration()

Stop the running calibration.

stopCalibrationStep

suspend fun stopCalibrationStep()

Stop the running calibration step.

stopTest

suspend fun stopTest()

Stop the running test.