القائمة
Step-by-step guide for adding a new platform implementation to DotSerial. Use when asked to add support for a new OS, transport, or connection type.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | new-platform-impl |
| description | Step-by-step guide for adding a new platform implementation to DotSerial. Use when asked to add support for a new OS, transport, or connection type. |
Follow these steps precisely when adding a new platform implementation.
| Scenario | Base class |
|---|---|
| New OS using native serial APIs | Extend SerialPortBase |
| New transport protocol (TCP, USB, BLE) | Implement ISerialPort directly |
| New Bluetooth variant | Extend SerialPortBase or implement directly |
File path convention:
src/DotSerial/Internal/{Platform}/{Platform}SerialPort.cssrc/DotSerial/Internal/{Platform}/{Platform}BluetoothSerialPort.cs (if Bluetooth variant)Use the copyright header. Class must be internal sealed.
Open src/DotSerial/DotSerial.csproj and add a <Compile Remove> block:
<!-- New platform — exclude from all other TFMs -->
<ItemGroup Condition="'$(TargetFramework)' != 'net10.0-{platform}'">
<Compile Remove="Internal\{Platform}\{Platform}SerialPort.cs" />
</ItemGroup>
If the new platform requires a new TFM, also add it to <TargetFrameworks>.
In SerialPortFactory.cs, add a branch inside Create():
#elif {PLATFORM_SYMBOL}
return settings.ConnectionType == Enums.ConnectionType.Bluetooth
? new Internal.{Platform}.{Platform}BluetoothSerialPort(
settings,
_loggerFactory.CreateLogger<Internal.{Platform}.{Platform}BluetoothSerialPort>())
: new Internal.{Platform}.{Platform}SerialPort(
settings,
_loggerFactory.CreateLogger<Internal.{Platform}.{Platform}SerialPort>());
Use the correct platform symbol (ANDROID, IOS, or define a new one via <DefineConstants>).
If the new platform introduces a new ConnectionType:
DotSerial.Enums.ConnectionTypeSerialPortSettings.Validate().github/copilot-instructions.md under ConnectionType and BluetoothIf the platform has port discovery or hotplug support, implement it in
SerialPortFactory.GetPortNames() and/or SerialPortFactory.CreateMonitor().
Add tests to tests/DotSerial.Tests.Unit/ that verify:
Open/Close/Write/Read lifecycle (mock the hardware layer)dotnet build
dotnet test tests/DotSerial.Tests.Unit
Verify and add the required copyright header to DotSerial C# source files. Use when creating a new .cs file or when a file is missing the header.
Debug failing GitHub Actions CI runs for DotSerial. Use when a CI build or test is failing on GitHub Actions and you need to understand why and fix it.
Format a Conventional Commits message for DotSerial changes. Use when asked to write a commit message, format a commit, or check if a message follows the project's commit conventions.
Build and test the DotSerial project. Use when asked to build, run tests, check CI status, or verify that changes don't break the build or test suite.
Pack and verify the DotSerial NuGet package. Use when asked to pack, publish, or verify the NuGet output for the DotSerial library.