├── .gitattributes ├── .gitignore ├── BlazorSerial.sln ├── BlazorSerial ├── BlazorSerial.csproj ├── Enums │ ├── ConnectResponseEnum.cs │ └── RequestPortResponseEnum.cs ├── Exceptions │ ├── AlreadyConnectedException.cs │ └── PortNotChoosenException.cs ├── ISerialPort.cs ├── SerialPort.cs ├── ServiceCollectionExtensions.cs ├── _Imports.razor └── wwwroot │ └── blazorSerial.js └── README.md /.gitattributes: -------------------------------------------------------------------------------- 1 | ############################################################################### 2 | # Set default behavior to automatically normalize line endings. 3 | ############################################################################### 4 | * text=auto 5 | 6 | ############################################################################### 7 | # Set default behavior for command prompt diff. 8 | # 9 | # This is need for earlier builds of msysgit that does not have it on by 10 | # default for csharp files. 11 | # Note: This is only used by command line 12 | ############################################################################### 13 | #*.cs diff=csharp 14 | 15 | ############################################################################### 16 | # Set the merge driver for project and solution files 17 | # 18 | # Merging from the command prompt will add diff markers to the files if there 19 | # are conflicts (Merging from VS is not affected by the settings below, in VS 20 | # the diff markers are never inserted). Diff markers may cause the following 21 | # file extensions to fail to load in VS. An alternative would be to treat 22 | # these files as binary and thus will always conflict and require user 23 | # intervention with every merge. To do so, just uncomment the entries below 24 | ############################################################################### 25 | #*.sln merge=binary 26 | #*.csproj merge=binary 27 | #*.vbproj merge=binary 28 | #*.vcxproj merge=binary 29 | #*.vcproj merge=binary 30 | #*.dbproj merge=binary 31 | #*.fsproj merge=binary 32 | #*.lsproj merge=binary 33 | #*.wixproj merge=binary 34 | #*.modelproj merge=binary 35 | #*.sqlproj merge=binary 36 | #*.wwaproj merge=binary 37 | 38 | ############################################################################### 39 | # behavior for image files 40 | # 41 | # image files are treated as binary by default. 42 | ############################################################################### 43 | #*.jpg binary 44 | #*.png binary 45 | #*.gif binary 46 | 47 | ############################################################################### 48 | # diff behavior for common document formats 49 | # 50 | # Convert binary document formats to text before diffing them. This feature 51 | # is only available from the command line. Turn it on by uncommenting the 52 | # entries below. 53 | ############################################################################### 54 | #*.doc diff=astextplain 55 | #*.DOC diff=astextplain 56 | #*.docx diff=astextplain 57 | #*.DOCX diff=astextplain 58 | #*.dot diff=astextplain 59 | #*.DOT diff=astextplain 60 | #*.pdf diff=astextplain 61 | #*.PDF diff=astextplain 62 | #*.rtf diff=astextplain 63 | #*.RTF diff=astextplain 64 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Mono auto generated files 17 | mono_crash.* 18 | 19 | # Build results 20 | [Dd]ebug/ 21 | [Dd]ebugPublic/ 22 | [Rr]elease/ 23 | [Rr]eleases/ 24 | x64/ 25 | x86/ 26 | [Ww][Ii][Nn]32/ 27 | [Aa][Rr][Mm]/ 28 | [Aa][Rr][Mm]64/ 29 | bld/ 30 | [Bb]in/ 31 | [Oo]bj/ 32 | [Oo]ut/ 33 | [Ll]og/ 34 | [Ll]ogs/ 35 | 36 | # Visual Studio 2015/2017 cache/options directory 37 | .vs/ 38 | # Uncomment if you have tasks that create the project's static files in wwwroot 39 | #wwwroot/ 40 | 41 | # Visual Studio 2017 auto generated files 42 | Generated\ Files/ 43 | 44 | # MSTest test Results 45 | [Tt]est[Rr]esult*/ 46 | [Bb]uild[Ll]og.* 47 | 48 | # NUnit 49 | *.VisualState.xml 50 | TestResult.xml 51 | nunit-*.xml 52 | 53 | # Build Results of an ATL Project 54 | [Dd]ebugPS/ 55 | [Rr]eleasePS/ 56 | dlldata.c 57 | 58 | # Benchmark Results 59 | BenchmarkDotNet.Artifacts/ 60 | 61 | # .NET Core 62 | project.lock.json 63 | project.fragment.lock.json 64 | artifacts/ 65 | 66 | # ASP.NET Scaffolding 67 | ScaffoldingReadMe.txt 68 | 69 | # StyleCop 70 | StyleCopReport.xml 71 | 72 | # Files built by Visual Studio 73 | *_i.c 74 | *_p.c 75 | *_h.h 76 | *.ilk 77 | *.meta 78 | *.obj 79 | *.iobj 80 | *.pch 81 | *.pdb 82 | *.ipdb 83 | *.pgc 84 | *.pgd 85 | *.rsp 86 | *.sbr 87 | *.tlb 88 | *.tli 89 | *.tlh 90 | *.tmp 91 | *.tmp_proj 92 | *_wpftmp.csproj 93 | *.log 94 | *.vspscc 95 | *.vssscc 96 | .builds 97 | *.pidb 98 | *.svclog 99 | *.scc 100 | 101 | # Chutzpah Test files 102 | _Chutzpah* 103 | 104 | # Visual C++ cache files 105 | ipch/ 106 | *.aps 107 | *.ncb 108 | *.opendb 109 | *.opensdf 110 | *.sdf 111 | *.cachefile 112 | *.VC.db 113 | *.VC.VC.opendb 114 | 115 | # Visual Studio profiler 116 | *.psess 117 | *.vsp 118 | *.vspx 119 | *.sap 120 | 121 | # Visual Studio Trace Files 122 | *.e2e 123 | 124 | # TFS 2012 Local Workspace 125 | $tf/ 126 | 127 | # Guidance Automation Toolkit 128 | *.gpState 129 | 130 | # ReSharper is a .NET coding add-in 131 | _ReSharper*/ 132 | *.[Rr]e[Ss]harper 133 | *.DotSettings.user 134 | 135 | # TeamCity is a build add-in 136 | _TeamCity* 137 | 138 | # DotCover is a Code Coverage Tool 139 | *.dotCover 140 | 141 | # AxoCover is a Code Coverage Tool 142 | .axoCover/* 143 | !.axoCover/settings.json 144 | 145 | # Coverlet is a free, cross platform Code Coverage Tool 146 | coverage*.json 147 | coverage*.xml 148 | coverage*.info 149 | 150 | # Visual Studio code coverage results 151 | *.coverage 152 | *.coveragexml 153 | 154 | # NCrunch 155 | _NCrunch_* 156 | .*crunch*.local.xml 157 | nCrunchTemp_* 158 | 159 | # MightyMoose 160 | *.mm.* 161 | AutoTest.Net/ 162 | 163 | # Web workbench (sass) 164 | .sass-cache/ 165 | 166 | # Installshield output folder 167 | [Ee]xpress/ 168 | 169 | # DocProject is a documentation generator add-in 170 | DocProject/buildhelp/ 171 | DocProject/Help/*.HxT 172 | DocProject/Help/*.HxC 173 | DocProject/Help/*.hhc 174 | DocProject/Help/*.hhk 175 | DocProject/Help/*.hhp 176 | DocProject/Help/Html2 177 | DocProject/Help/html 178 | 179 | # Click-Once directory 180 | publish/ 181 | 182 | # Publish Web Output 183 | *.[Pp]ublish.xml 184 | *.azurePubxml 185 | # Note: Comment the next line if you want to checkin your web deploy settings, 186 | # but database connection strings (with potential passwords) will be unencrypted 187 | *.pubxml 188 | *.publishproj 189 | 190 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 191 | # checkin your Azure Web App publish settings, but sensitive information contained 192 | # in these scripts will be unencrypted 193 | PublishScripts/ 194 | 195 | # NuGet Packages 196 | *.nupkg 197 | # NuGet Symbol Packages 198 | *.snupkg 199 | # The packages folder can be ignored because of Package Restore 200 | **/[Pp]ackages/* 201 | # except build/, which is used as an MSBuild target. 202 | !**/[Pp]ackages/build/ 203 | # Uncomment if necessary however generally it will be regenerated when needed 204 | #!**/[Pp]ackages/repositories.config 205 | # NuGet v3's project.json files produces more ignorable files 206 | *.nuget.props 207 | *.nuget.targets 208 | 209 | # Microsoft Azure Build Output 210 | csx/ 211 | *.build.csdef 212 | 213 | # Microsoft Azure Emulator 214 | ecf/ 215 | rcf/ 216 | 217 | # Windows Store app package directories and files 218 | AppPackages/ 219 | BundleArtifacts/ 220 | Package.StoreAssociation.xml 221 | _pkginfo.txt 222 | *.appx 223 | *.appxbundle 224 | *.appxupload 225 | 226 | # Visual Studio cache files 227 | # files ending in .cache can be ignored 228 | *.[Cc]ache 229 | # but keep track of directories ending in .cache 230 | !?*.[Cc]ache/ 231 | 232 | # Others 233 | ClientBin/ 234 | ~$* 235 | *~ 236 | *.dbmdl 237 | *.dbproj.schemaview 238 | *.jfm 239 | *.pfx 240 | *.publishsettings 241 | orleans.codegen.cs 242 | 243 | # Including strong name files can present a security risk 244 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 245 | #*.snk 246 | 247 | # Since there are multiple workflows, uncomment next line to ignore bower_components 248 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 249 | #bower_components/ 250 | 251 | # RIA/Silverlight projects 252 | Generated_Code/ 253 | 254 | # Backup & report files from converting an old project file 255 | # to a newer Visual Studio version. Backup files are not needed, 256 | # because we have git ;-) 257 | _UpgradeReport_Files/ 258 | Backup*/ 259 | UpgradeLog*.XML 260 | UpgradeLog*.htm 261 | ServiceFabricBackup/ 262 | *.rptproj.bak 263 | 264 | # SQL Server files 265 | *.mdf 266 | *.ldf 267 | *.ndf 268 | 269 | # Business Intelligence projects 270 | *.rdl.data 271 | *.bim.layout 272 | *.bim_*.settings 273 | *.rptproj.rsuser 274 | *- [Bb]ackup.rdl 275 | *- [Bb]ackup ([0-9]).rdl 276 | *- [Bb]ackup ([0-9][0-9]).rdl 277 | 278 | # Microsoft Fakes 279 | FakesAssemblies/ 280 | 281 | # GhostDoc plugin setting file 282 | *.GhostDoc.xml 283 | 284 | # Node.js Tools for Visual Studio 285 | .ntvs_analysis.dat 286 | node_modules/ 287 | 288 | # Visual Studio 6 build log 289 | *.plg 290 | 291 | # Visual Studio 6 workspace options file 292 | *.opt 293 | 294 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 295 | *.vbw 296 | 297 | # Visual Studio LightSwitch build output 298 | **/*.HTMLClient/GeneratedArtifacts 299 | **/*.DesktopClient/GeneratedArtifacts 300 | **/*.DesktopClient/ModelManifest.xml 301 | **/*.Server/GeneratedArtifacts 302 | **/*.Server/ModelManifest.xml 303 | _Pvt_Extensions 304 | 305 | # Paket dependency manager 306 | .paket/paket.exe 307 | paket-files/ 308 | 309 | # FAKE - F# Make 310 | .fake/ 311 | 312 | # CodeRush personal settings 313 | .cr/personal 314 | 315 | # Python Tools for Visual Studio (PTVS) 316 | __pycache__/ 317 | *.pyc 318 | 319 | # Cake - Uncomment if you are using it 320 | # tools/** 321 | # !tools/packages.config 322 | 323 | # Tabs Studio 324 | *.tss 325 | 326 | # Telerik's JustMock configuration file 327 | *.jmconfig 328 | 329 | # BizTalk build output 330 | *.btp.cs 331 | *.btm.cs 332 | *.odx.cs 333 | *.xsd.cs 334 | 335 | # OpenCover UI analysis results 336 | OpenCover/ 337 | 338 | # Azure Stream Analytics local run output 339 | ASALocalRun/ 340 | 341 | # MSBuild Binary and Structured Log 342 | *.binlog 343 | 344 | # NVidia Nsight GPU debugger configuration file 345 | *.nvuser 346 | 347 | # MFractors (Xamarin productivity tool) working folder 348 | .mfractor/ 349 | 350 | # Local History for Visual Studio 351 | .localhistory/ 352 | 353 | # BeatPulse healthcheck temp database 354 | healthchecksdb 355 | 356 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 357 | MigrationBackup/ 358 | 359 | # Ionide (cross platform F# VS Code tools) working folder 360 | .ionide/ 361 | 362 | # Fody - auto-generated XML schema 363 | FodyWeavers.xsd -------------------------------------------------------------------------------- /BlazorSerial.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 16 4 | VisualStudioVersion = 16.0.31729.503 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "BlazorSerial", "BlazorSerial\BlazorSerial.csproj", "{02E8234F-9E7D-46F0-B763-F6CF69693B5C}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {02E8234F-9E7D-46F0-B763-F6CF69693B5C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {02E8234F-9E7D-46F0-B763-F6CF69693B5C}.Debug|Any CPU.Build.0 = Debug|Any CPU 16 | {02E8234F-9E7D-46F0-B763-F6CF69693B5C}.Release|Any CPU.ActiveCfg = Release|Any CPU 17 | {02E8234F-9E7D-46F0-B763-F6CF69693B5C}.Release|Any CPU.Build.0 = Release|Any CPU 18 | EndGlobalSection 19 | GlobalSection(SolutionProperties) = preSolution 20 | HideSolutionNode = FALSE 21 | EndGlobalSection 22 | GlobalSection(ExtensibilityGlobals) = postSolution 23 | SolutionGuid = {9478F1B9-0B3C-4EA3-A168-437D5427CC1D} 24 | EndGlobalSection 25 | EndGlobal 26 | -------------------------------------------------------------------------------- /BlazorSerial/BlazorSerial.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net6.0 5 | jasniec 6 | A blazor WASM library to wrap Serial API (for chrome based browsers). 7 | MIT 8 | https://github.com/jasniec/BlazorSerial 9 | https://github.com/jasniec/BlazorSerial 10 | Blazor,WASM,Serial,SerialPort 11 | true 12 | 1.0.3.1 13 | 1.0.3.1 14 | 1.0.3.1 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /BlazorSerial/Enums/ConnectResponseEnum.cs: -------------------------------------------------------------------------------- 1 | namespace BlazorSerial.Enums 2 | { 3 | public enum ConnectResponseEnum 4 | { 5 | Unknown, 6 | Ok, 7 | 8 | /// 9 | /// Indicates that the port is already open. 10 | /// 11 | InvalidStateError, 12 | 13 | /// 14 | /// Indicates that the attempt to open the port failed. 15 | /// 16 | NetworkError, 17 | } 18 | } -------------------------------------------------------------------------------- /BlazorSerial/Enums/RequestPortResponseEnum.cs: -------------------------------------------------------------------------------- 1 | namespace BlazorSerial.Enums 2 | { 3 | public enum RequestPortResponseEnum 4 | { 5 | Unknown, 6 | Ok, 7 | 8 | /// 9 | /// Feature Policy restricts use of this API or a permission to use it has not granted via a user gesture. 10 | /// 11 | SecurityError, 12 | 13 | /// 14 | /// User does not select a port when prompted 15 | /// 16 | AbortError, 17 | } 18 | } -------------------------------------------------------------------------------- /BlazorSerial/Exceptions/AlreadyConnectedException.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace BlazorSerial.Exceptions 4 | { 5 | public class AlreadyConnectedException : Exception 6 | { 7 | } 8 | } -------------------------------------------------------------------------------- /BlazorSerial/Exceptions/PortNotChoosenException.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace BlazorSerial.Exceptions 4 | { 5 | public class PortNotChoosenException : Exception 6 | { 7 | } 8 | } -------------------------------------------------------------------------------- /BlazorSerial/ISerialPort.cs: -------------------------------------------------------------------------------- 1 | using BlazorSerial.Enums; 2 | using System.Threading.Tasks; 3 | 4 | namespace BlazorSerial 5 | { 6 | public interface ISerialPort 7 | { 8 | bool IsConnected { get; } 9 | bool IsPortChosen { get; } 10 | 11 | Task Open(int baudRate); 12 | Task IsSupported(); 13 | Task RequestPort(); 14 | Task Write(string text); 15 | Task Close(); 16 | } 17 | } -------------------------------------------------------------------------------- /BlazorSerial/SerialPort.cs: -------------------------------------------------------------------------------- 1 | using BlazorSerial.Enums; 2 | using BlazorSerial.Exceptions; 3 | using Microsoft.JSInterop; 4 | using System; 5 | using System.Threading.Tasks; 6 | 7 | namespace BlazorSerial 8 | { 9 | public class SerialPort : ISerialPort 10 | { 11 | public bool IsConnected { get; private set; } 12 | public bool IsPortChosen { get; private set; } 13 | 14 | private readonly IJSRuntime _jsRuntime; 15 | 16 | public SerialPort(IJSRuntime jsRuntime) 17 | { 18 | _jsRuntime = jsRuntime; 19 | } 20 | 21 | public async Task IsSupported() => await _jsRuntime.InvokeAsync("blazorSerialIsSupported"); 22 | 23 | public async Task RequestPort() 24 | { 25 | var result = Enum.Parse(await _jsRuntime.InvokeAsync("blazorSerialGetPort")); 26 | 27 | if (result == RequestPortResponseEnum.Ok) 28 | { 29 | IsPortChosen = true; 30 | } 31 | 32 | return result; 33 | } 34 | 35 | public async Task Open(int baudRate) 36 | { 37 | if (!IsPortChosen) 38 | { 39 | throw new PortNotChoosenException(); 40 | } 41 | 42 | if (IsConnected) 43 | { 44 | throw new AlreadyConnectedException(); 45 | } 46 | 47 | var connectionResult = Enum.Parse(await _jsRuntime.InvokeAsync("blazorSerialOpen", baudRate)); 48 | 49 | if (connectionResult == ConnectResponseEnum.Ok) 50 | { 51 | IsConnected = true; 52 | } 53 | 54 | return connectionResult; 55 | } 56 | 57 | public async Task Close() 58 | { 59 | if (IsConnected) 60 | { 61 | await _jsRuntime.InvokeVoidAsync("blazorSerialClose"); 62 | IsConnected = false; 63 | } 64 | } 65 | 66 | public async Task Write(string text) => await _jsRuntime.InvokeAsync("blazorSerialWriteText", text); 67 | } 68 | } -------------------------------------------------------------------------------- /BlazorSerial/ServiceCollectionExtensions.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.Extensions.DependencyInjection; 2 | 3 | namespace BlazorSerial 4 | { 5 | public static class ServiceCollectionExtensions 6 | { 7 | public static IServiceCollection AddBlazorSerial(this IServiceCollection services) => services.AddSingleton(); 8 | } 9 | } -------------------------------------------------------------------------------- /BlazorSerial/_Imports.razor: -------------------------------------------------------------------------------- 1 | @using Microsoft.AspNetCore.Components.Web 2 | -------------------------------------------------------------------------------- /BlazorSerial/wwwroot/blazorSerial.js: -------------------------------------------------------------------------------- 1 | var blazorSerialPort; 2 | var blazorSerialTextEncoder = new TextEncoder(); 3 | 4 | function blazorSerialIsSupported() { 5 | return navigator.serial ? true : false; 6 | } 7 | 8 | async function blazorSerialGetPort() { 9 | try { 10 | blazorSerialPort = await navigator.serial.requestPort(); 11 | return "Ok"; 12 | } 13 | catch (ex) { 14 | if (ex instanceof SecurityError) { 15 | return "SecurityError"; 16 | } 17 | else if (ex instanceof AbortError) { 18 | return "AbortError"; 19 | } 20 | else { 21 | return "Unknown"; 22 | } 23 | } 24 | } 25 | 26 | async function blazorSerialOpen(baudRate) { 27 | try { 28 | await blazorSerialPort.open({ baudRate: baudRate }); 29 | return "Ok"; 30 | } 31 | catch (ex) { 32 | if (ex instanceof InvalidStateError) { 33 | return "InvalidStateError"; 34 | } 35 | else if (ex instanceof NetworkError) { 36 | return "NetworkError"; 37 | } 38 | else { 39 | return "Unknown"; 40 | } 41 | } 42 | } 43 | 44 | function blazorSerialWriteText(text) { 45 | let writer = blazorSerialPort.writable.getWriter(); 46 | writer.write(blazorSerialTextEncoder.encode(text)); 47 | writer.releaseLock(); 48 | } 49 | 50 | function blazorSerialClose() { 51 | blazorSerialPort.close(); 52 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # BlazorSerial 2 | 3 | BlazorSerial is a library that wraps the serial API in chrome based browsers [check it here](https://developer.mozilla.org/en-US/docs/Web/API/Web_Serial_API) 4 | 5 | ## Installation 6 | 7 | Use the package manager to install BlazorSerial. 8 | 9 | ```bash 10 | PM> Install-Package BlazorSerial 11 | ``` 12 | 13 | Or add [nuget](https://www.nuget.org/packages/BlazorSerial) instead 14 | 15 | Then, in your index file (wwwroot/index.html) add a line at the bottom of the body 16 | 17 | ```html 18 | 19 | ``` 20 | 21 | And register dependency in Program.cs file 22 | 23 | ```csharp 24 | builder.Services.AddBlazorSerial(); 25 | ``` 26 | 27 | ## Usage 28 | 29 | To write text to the serial port, you have to ask user to choose a port, if successfully chosen, you have to connect and then send some text. 30 | 31 | ```csharp 32 | @inject ISerialPort Serial 33 | 34 | // ... 35 | 36 | @code{ 37 | private async Task WriteHelloWorld() 38 | { 39 | if (await Serial.RequestPort() == BlazorSerial.Enums.RequestPortResponseEnum.Ok 40 | && await Serial.Open(115200) == BlazorSerial.Enums.ConnectResponseEnum.Ok) 41 | { 42 | await Serial.Write("Hello World!"); 43 | } 44 | } 45 | 46 | ``` 47 | 48 | ## Contributing 49 | Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. 50 | 51 | ## License 52 | [MIT](https://choosealicense.com/licenses/mit/) 53 | --------------------------------------------------------------------------------