Eriksson Beam API
Search Results for

    Show / Hide Table of Contents

    Installation

    The Beam v6 client SDK supports net48 and net10.0-windows on Windows. Both x86 and x64 clients connect to the separate x64 Beam application.

    Prerequisites

    • The .NET 10 SDK to build the supplied sample.
    • The .NET Framework 4.8 developer pack when building net48.
    • The matching Windows Desktop runtime when running a .NET 10 client.
    • A compatible Beam v6 desktop installation and a separate Beam API license.

    Install the Replacement Package

    The licensing update is ErikssonBeamClientAPI 6.0.0-net48-preview.20261021.1. Keep nuget.org enabled for dependencies.

    From your consuming project directory:

    dotnet nuget add source "C:\Packages\ErikssonBeam" --name ErikssonBeamLocal
    dotnet add package ErikssonBeamClientAPI --version 6.0.0-net48-preview.20261021.1
    

    Use the actual folder containing the supplied .nupkg. In Visual Studio, add that folder under NuGet package sources and enable Include prerelease to select this version.

    Alternatively, use a project-local nuget.config:

    <?xml version="1.0" encoding="utf-8"?>
    <configuration>
      <packageSources>
        <clear />
        <add key="ErikssonBeamLocal" value="packages" />
        <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
      </packageSources>
    </configuration>
    

    The source path is relative to the configuration file.

    Project Configuration

    For a Framework client:

    <PropertyGroup>
      <TargetFramework>net48</TargetFramework>
      <UseWindowsForms>true</UseWindowsForms>
      <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
      <GenerateBindingRedirectsOutputType>true</GenerateBindingRedirectsOutputType>
    </PropertyGroup>
    <ItemGroup>
      <PackageReference Include="ErikssonBeamClientAPI" Version="6.0.0-net48-preview.20261021.1" />
    </ItemGroup>
    

    For .NET 10, use net10.0-windows as the target framework. Retain UseWindowsForms because the SDK exposes Windows Forms types. Set PlatformTarget to x86 or x64 as required by your application; the SDK itself is AnyCPU.

    Run the Supplied Sample

    Extract the forwarding pack so that packages and SimpleApiSample are sibling folders. The sample automatically selects the supplied package outside this repository. Its README contains build and run commands.

    Provide BEAM_API_LICENSE_KEY in licenseId:activationPassword format, plus the full executable and project paths. The sample copies the project to a temporary directory before editing it.

    Authenticate Before Pulling

    After launching or connecting:

    await client.AuthenticateAsync();
    var design = await client.PullBeamDesignerAsync("DefaultSeedBeam");
    

    The helper uses the existing server authentication request. It requires no protocol change in a Beam server that already supports AuthenticateRequest. First authentication activates the separate API license if needed; a valid local API license is reused.

    If the compiler cannot find AuthenticateAsync, check the resolved package version and rebuild. Older SDKs can send AuthenticateRequest directly as shown in License Setup.

    Dependencies

    NuGet restores the SDK's declared dependencies, including System.Text.Json, logging abstractions, NJsonSchema, threading channels, UnitsNet, and FluentValidation. The package does not require the Beam engine as a dependency. Framework applications should retain automatic binding redirects.

    Next Steps

    Continue with License Setup and First Connection.

    • Edit this page
    In this article
    Back to top Generated by DocFX