CydandClaude Opus 4.8
b3cb764f4d
Port the RIO wire protocol from legacy/riovjoy2.cpp into testable C#: - Protocol/: command + length table, 7-bit checksum, packet builder, and a streaming receive-side framing state machine (PacketParser) that mirrors the legacy ReadCommBlock framing/resync (high-bit-mid-packet abort). Typed RIO->PC decodes: AnalogReport (14-bit sign-extend), VersionInfo, CheckStatus; lamp-state composition. - Serial/: RioSerialLink drives an async receive loop with ACK/NAK reply policy (legacy force-accept vs. opt-in VerifyInboundChecksum), the analog poll timer, and the >5s reset-recovery watchdog. IRioTransport abstracts the COM port; the SerialPort-backed transport does 9600 8N1 + DTR reset pulse, and acquire/release is just create/dispose (foundation for native-game serial yield). - tests/RioJoy.Core.Tests: 54 xUnit tests covering checksum, framing/resync, builder round-trips, analog sign-extension + sentinel rejection, lamp combos, and the read loop driven against an in-memory fake transport. Hardware verification (version/check/analog against a cabinet) remains; it can't be done off-device. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
33 lines
1.4 KiB
C#
33 lines
1.4 KiB
C#
namespace RioJoy.Core.Serial;
|
|
|
|
/// <summary>Tunables for <see cref="RioSerialLink"/>.</summary>
|
|
public sealed record RioSerialLinkOptions
|
|
{
|
|
/// <summary>
|
|
/// How often to request an analog update while the link runs. The legacy
|
|
/// watch thread polls on a ~55 ms timeout (riovjoy2.cpp#L1069).
|
|
/// </summary>
|
|
public TimeSpan AnalogPollInterval { get; init; } = TimeSpan.FromMilliseconds(55);
|
|
|
|
/// <summary>
|
|
/// If no <see cref="Protocol.RioCommand.AnalogReply"/> arrives within this
|
|
/// window, issue a general reset to recover (legacy >5 s rule,
|
|
/// riovjoy2.cpp#L1096).
|
|
/// </summary>
|
|
public TimeSpan AnalogRecoveryTimeout { get; init; } = TimeSpan.FromSeconds(5);
|
|
|
|
/// <summary>Whether the link should automatically poll for analog updates.</summary>
|
|
public bool AutoPollAnalog { get; init; } = true;
|
|
|
|
/// <summary>
|
|
/// When <see langword="true"/>, a button packet that fails its checksum is
|
|
/// NAK'd (the documented protocol). When <see langword="false"/> (default),
|
|
/// every framed packet is ACK'd regardless of checksum, matching the legacy
|
|
/// receive path which force-accepts (see docs/PROTOCOL.md §2 ⚠️).
|
|
/// </summary>
|
|
public bool VerifyInboundChecksum { get; init; }
|
|
|
|
/// <summary>Read buffer size for the receive loop.</summary>
|
|
public int ReadBufferSize { get; init; } = 256;
|
|
}
|