AntennexApiClient 3.5.999-beta.1

AntennexApiClient

.NET client for ANTENNEX The Wireless Connector(tm) - a reverberation-chamber-based instrument for automated over-the-air measurement of wireless devices.

Product information: antennex.tech Full documentation: docs.antennex.tech

Install

dotnet add package AntennexApiClient

Getting started

Point the client at your chamber's address and call it:

using Antennex;

using var httpClient = new HttpClient();
var client = AntennexApi.CreateClient(httpClient, new Uri("http://10.0.2.3:8080"));

// What is this chamber running, and is it ready?
var version = await client.GetVersionDetailedAsync();
Console.WriteLine($"measurement service {version.MeasurementService}");

var status = await client.GetChamberStatusAsync();
Console.WriteLine($"status = {status.Status}");

A measurement follows the same shape - select the application, apply settings, acquire, read the data back:

await client.SetMachineModeAsync(AcquisitionMode.Spectrum);
await client.RestoreSettingsToDefaultsAsync(SettingsTypes.Measurement);

await client.SetSettingsAsync(
    new Settings { FrequencyStart = 5.0e9, FrequencyEnd = 6.0e9 },
    SettingsTypes.Measurement);

await client.AcquireDefaultAsync(wait: true);

var spectrum = await client.GetDataAsync(nameof(DataTypes.Spectrum));
Console.WriteLine($"peak = {spectrum.Metrics.Spectrum.PeakPower} {spectrum.Unit}");

Worked examples

The package ships 16 runnable examples in its samples/ folder, covering spectrum and zero-span measurements, antenna efficiency, noise figure, FMCW, chamber calibration, presets, and manual stirrer control. After restoring the package they are on disk under:

~/.nuget/packages/antennexapiclient/<version>/samples/

Each is a self-contained class with a RunAsync method - copy the one you need into your own project and adapt it. Every example's <remarks> documents the hardware and application licences it requires (a spectrum analyser, a VNA, the Noise Figure or Antenna Efficiency licence, and so on).

Two small things when copying one out:

• Examples carry a [Sample("...")] attribute, which only exists so this library's own test suite can find and run them. Either copy SampleAttribute.cs across with the example, or simply delete that one line - nothing else depends on it.

• PlotHelper.cs is only needed by the examples that plot a result. It wraps ScottPlot, which this package does not depend on, so copying one of those examples means adding that yourself:

  dotnet add package ScottPlot --version 5.1.59
  

  The examples are written against ScottPlot 5; its API changed substantially between 4 and 5, so the version matters here.

Supported frameworks

Pick net8.0 unless your application runs on .NET Framework; NuGet selects the right one automatically.

A flattened DLL bundle is also published with each release, for applications that deploy by copying a folder rather than by consuming a NuGet package.

License

BSD-3-Clause. Copyright (c) ANTENNEX B.V.