Skip to content

Add high-level SDK with transport abstraction for TypeScript, Python, C++, and C# (opt-in via flags) #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rijesha merged 9 commits into from
Dec 18, 2025
Merged

Add high-level SDK with transport abstraction for TypeScript, Python, C++, and C# (opt-in via flags) #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
580f786
Initial plan
Copilot Dec 18, 2025
ae8d1e5
Add SDK implementations for TypeScript, Python, C++, and C#
Copilot Dec 18, 2025
938717f
Add comprehensive SDK documentation for all languages
Copilot Dec 18, 2025
316fd5a
Fix SDK directory copying in code generation
Copilot Dec 18, 2025
efd5e32
Address code review feedback - improve frame size calculation documen…
Copilot Dec 18, 2025
db5c9ab
Rename SDK directories to struct_frame_sdk for better namespacing
Copilot Dec 18, 2025
b08c2bc
Implement ASIO network transports and improve C# WebSocket handling
Copilot Dec 18, 2025
21c0a12
Remove STL dependencies from observer.hpp and add SDK generation flags
Copilot Dec 18, 2025
8973c50
Update SDK documentation to explain --sdk and --sdk_embedded flags
Copilot Dec 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,17 @@ The CI pipeline:

You can view test results in the "Actions" tab of the GitHub repository. Test artifacts (generated code and binary files) are available for download for 5 days after each run.

## Higher-Level SDK

Struct Frame provides high-level SDKs for simplified message communication:

- **TypeScript/JavaScript**: Promise-based with UDP, TCP, WebSocket, and Serial transports
- **Python**: Both sync and async implementations with socket, pyserial, websockets support
- **C++**: Header-only with observer/subscriber pattern, ideal for embedded systems
- **C#**: Async/await-based for .NET Core, Xamarin, and MAUI applications

See the [SDK Overview](https://struct-frame.mylonics.com/user-guide/sdk-overview/) for details.

## Framing System

Struct Frame provides a message framing system for reliable communication over serial links, network sockets, or any byte stream. Framing solves the fundamental problem of determining where messages begin and end in a continuous data stream.
Expand Down
Loading