BrailleGCode 0.1.0

BrailleGCode

Generate CNC/laser G-code for Braille dots from plain text. Works in any .NET app: console, ASP.NET APIs, MAUI, WinForms, WPF.

Install

PM> Install-Package BrailleGCode
# or
> dotnet add package BrailleGCode

Quick start

using BrailleGCode;

var options = new GCodeOptions
{
    XOrigin = 0,
    YOrigin = 10,
    CellSpacingX = 6,
    RowSpacingY = 10,
    CellsPerRow = 29,
    DotPitch = 2.5,
    LaserOn = "M3 S500;",
    LaserOff = "M5",
    RapidFeed = 1000,
    LaserDwellSeconds = 0.1,
};

string gcode = GCodeGenerator.Generate("Hola Mundo 123", options);
Console.WriteLine(gcode);

Or stream without buffering the whole string:

// Write line-by-line (low memory / embedded)
using var writer = File.CreateText("output.gcode");
GCodeGenerator.Generate(writer, "Hola Mundo 123", options);

// Or async (good for ASP.NET streaming)
await GCodeGenerator.GenerateAsync(writer, "Hola Mundo 123", options);

ASP.NET API example

app.MapPost("/braille", (BrailleRequest req) =>
{
    var gcode = GCodeGenerator.Generate(req.Text);
    return Results.Text(gcode, "text/plain");
});

record BrailleRequest(string Text);

To stream directly to the response:

app.MapGet("/braille-stream", async (HttpContext ctx, string text) =>
{
    ctx.Response.ContentType = "text/plain";
    await GCodeGenerator.GenerateAsync(new StreamWriter(ctx.Response.Body), text);
});

MAUI / WinForms

• Call GCodeGenerator.Generate(text) in your click handler.
• Save to file: File.WriteAllText(path, gcode);
• Send to device via your existing serial/USB workflow.

For serial/USB streaming, write each line as it is produced:

foreach (var line in GCodeGenerator.GenerateLines(inputText))
{
    serialPort.WriteLine(line);
}

Notes

• Dictionary covers Latin letters, digits, and some punctuation.
• Configure spacing and laser commands with GCodeOptions.
• Output uses absolute coordinates and alternates left-to-right per row (configurable via AlternateRowDirection).
• Targets: netstandard2.0, net6.0, and net9.0.
• Guidance: Use netstandard2.0 when consuming from .NET Framework apps (e.g., WinForms/WPF). Use net6.0/net9.0 for modern .NET apps; they include the same API with the latest runtime features.
• Optional end move: set EndY to adjust or null to skip the final Y move.