How supremainc/g-sdk works
Project type and purpose
• G-SDK is an open-source, cross-platform gRPC-based SDK for communicating with BioStar devices.
• It provides a single set of protobuf definitions and generated client libraries in C#, Go, Java, Node.js, and Python, plus usage examples and documentation.
High-level component breakdown
• External BioStar Server/Devices
– The actual BioStar hardware or server exposing gRPC endpoints.
• Protobuf Definition Layer
– *.proto files under each client/<lang>/biostar/proto and client/java/src/main/proto.
– Defines messages and services (access, auth, device, event, etc.).
• Code-Generation Pipeline
– Protoc + language-specific plugins (protoc-gen-go, grpc-java, grpc-node, grpc-python, etc.).
– Generates stubs under client/<lang>/biostar/service (e.g., *.pb.go, *_grpc_pb.js, *_pb2.py, etc.).
• Client SDK Modules
– Language folders (client/csharp, client/go, client/java, client/node, client/python).
– Each contains generated service code plus packaging/build files (Gradle, .NET csproj, package.json).
• Example Applications
– Under each language folder in .../example.
– Demonstrate CRUD calls, connect patterns, CLI menus.
• Documentation Site
– Jekyll-based site under docs/ with API reference, tutorials, release notes.
Relationships and data flow
A. Protobuf definitions → Code-generation → Language SDK stubs
B. SDK stubs + client application code → gRPC calls → BioStar Server
C. Documentation is generated from markdown in docs/ but separate from runtime.
Key architectural patterns
• Client–Server (gRPC)
• Code-generation pipeline for multi-language support
• Modular examples to validate each service
• Static site generator (Jekyll) for docs