Ahsoka.Extensions.Storyboard
5.12.0
dotnet add package Ahsoka.Extensions.Storyboard --version 5.12.0
NuGet\Install-Package Ahsoka.Extensions.Storyboard -Version 5.12.0
<PackageReference Include="Ahsoka.Extensions.Storyboard" Version="5.12.0" />
<PackageVersion Include="Ahsoka.Extensions.Storyboard" Version="5.12.0" />
<PackageReference Include="Ahsoka.Extensions.Storyboard" />
paket add Ahsoka.Extensions.Storyboard --version 5.12.0
#r "nuget: Ahsoka.Extensions.Storyboard, 5.12.0"
#:package Ahsoka.Extensions.Storyboard@5.12.0
#addin nuget:?package=Ahsoka.Extensions.Storyboard&version=5.12.0
#tool nuget:?package=Ahsoka.Extensions.Storyboard&version=5.12.0
Ahsoka.Extensions.Storyboard
Connects an OpenPV application to a user interface built in Crank Storyboard. Storyboard Designer owns the look and the interaction; your application owns the data and the business logic. The two meet over SBIO, Storyboard's named-channel event transport.
What It Provides
- Code generation — turns a Storyboard project's event definitions into typed model classes for C# or C++, so a change to an event surfaces as a compile error rather than a UI that quietly stops updating.
- A runtime client —
StoryboardClientopens SBIO channels and carries events between your application and one or more Storyboard engines. - Packaging — copies the Storyboard Engine into the package, exports each
.gappthrough Storyboard Designer, and emits thesbenginecommands into the generated UI start script. - Multi-display support — one engine instance per display on OpenView Pro and Flex, driven from a single shared application model.
Client Usage
using Ahsoka.Storyboard;
var client = new StoryboardClient(StoryboardMetadata.EventMetadata);
// Add every channel before starting; order determines the channel id.
client.AddInputChannel("thermostat_backend");
client.AddOutputChannel("thermostat_frontend");
client.StartStoryboardUI();
Dispatcher.Default.RegisterCallback<StoryboardEventArgs>(HandleInputMessage, client);
Sending an update, using a generated model object:
var update = new ThermostatUpdate();
update.CurrentTemperature = 58;
update.TargetTemperature = 70;
client.SendEvent(update.Message);
The channel name must match the Storyboard application name stored inside the
.gdemodel, which is not necessarily the.gdefilename.
Platform Support
| Platform family | Displays | Surface binding |
|---|---|---|
| OpenView Pro / Flex | Multiple | ivi_application — surface id used directly |
| OpenView Select | One | xdg_shell — surface id resolved to an app id |
Applications can be developed and run on Windows, macOS, and desktop Linux with no display hardware: the client starts a desktop Storyboard Engine build itself. On a device the generated UI start script owns the engine instead.
Requirements
- .NET 10.0
- Ahsoka.Core 5.x
- Crank Storyboard Designer and matching Storyboard Engine builds, installed separately
- A Storyboard Runtime licence on any project packaged for a device
Demos
Five demos ship with this package and can be created from the OpenPV Developer Toolkit:
| Demo | Language | Shows |
|---|---|---|
Ahsoka.CS.Blank.Storyboard |
C# | Minimum wiring, with an empty Storyboard project |
Ahsoka.CS.Storyboard |
C# | A thermostat UI with events in both directions |
Ahsoka.CS.MultiScreen.Storyboard |
C# | Two displays, two engines, one shared model |
Ahsoka.CPP.Storyboard |
C++ | The same thermostat from C++ |
Documentation
Full documentation ships with this package. In the OpenPV Developer Toolkit, select the Storyboard extension on the Extensions tab and choose Docs & Help.
Companion Package
Ahsoka.Extensions.Storyboard.UX — An OpenPV Developer Toolkit plugin providing the UI for configuring Storyboard engine folders, code generation, and launch configurations.
Useful Links
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- Ahsoka.Core (>= 5.40.10)
- LightProto (>= 1.3.2)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Ahsoka.Extensions.Storyboard:
| Package | Downloads |
|---|---|
|
Ahsoka.Extensions.Storyboard.UX
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 5.12.0 | 164 | 11/3/2026 |
| 5.11.0 | 280 | 9/25/2026 |
| 5.10.0 | 239 | 9/16/2026 |
| 5.9.0 | 514 | 8/18/2026 |
| 5.8.0 | 520 | 7/22/2026 |
| 5.7.0 | 499 | 7/9/2026 |
| 5.6.0 | 668 | 6/17/2026 |
| 5.5.1-zzz-develop.4 | 94 | 6/17/2026 |
| 5.5.1-zzz-develop.3 | 116 | 6/17/2026 |
| 5.5.1-zzz-develop.2 | 234 | 6/11/2026 |
| 5.5.0 | 398 | 5/29/2026 |
| 5.4.1-zzz-develop.3 | 114 | 5/29/2026 |
| 5.4.1-zzz-develop.2 | 142 | 5/21/2026 |
| 5.4.1-zzz-develop.1 | 129 | 5/20/2026 |
| 5.4.0 | 325 | 5/15/2026 |
| 5.3.1-zzz-develop.7 | 106 | 5/15/2026 |
| 5.3.1-zzz-develop.6 | 131 | 5/14/2026 |
| 5.3.1-zzz-develop.4 | 122 | 5/14/2026 |
| 5.3.1-zzz-develop.3 | 191 | 5/7/2026 |
| 5.3.1-zzz-develop.2 | 349 | 4/8/2026 |