BrainCo EDU Serial SDK for educational device integration
Project description
BrainCo Device SDK
Developer Guide
Cross-Platform Validation
Since the SDK and its core dependencies (such as bc-ble-core) contain target-specific conditional compilations (e.g., Windows WinRT or Android JNI), building on macOS only exercises the macOS code path.
To easily validate that your code changes compile successfully on Windows without leaving your macOS environment, you can run the cross-platform syntax validation script:
sh scripts/check_cross_platform.sh
Under the hood, this script runs:
cargo check --target x86_64-pc-windows-msvc -p bc-ble-core
Since the complex, platform-specific Windows conditional-compilation code (WinRT BLE adapters) resides entirely inside the pure Rust bc-ble-core crate, validating it directly is extremely fast and guaranteed to succeed on macOS/Linux without encountering C-dependency cross-compilation compiler errors. This is highly recommended to verify your Windows-specific fixes before pushing to the repository.
Updating Private Dependencies
The SDK depends on the private repository bc-ble-core via SSH. Cargo locks the specific commit hash in Cargo.lock.
1. Local Development Patching
For local iterative development and debugging between the SDK and bc-ble-core, there is a patch configured at the bottom of the workspace Cargo.toml:
[patch."ssh://git@github.com/BrainCoTech/bc-ble-core.git"]
bc-ble-core = { path = "../bc-ble-core" }
When this patch is active, Cargo will automatically compile and check against your local, uncommitted changes in ../bc-ble-core whenever you compile or check this repository.
2. Syncing Remote Updates
When changes in bc-ble-core are pushed to the remote branch (e.g., main), your local environment and the CI will NOT automatically pull the latest commit due to lockfile pinning.
To force Cargo to pull the latest remote changes of bc-ble-core, run:
cargo update -p bc-ble-core
Then, commit and push the updated Cargo.lock to trigger the CI with the correct dependency commit.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file bc_edu_sdk-0.3.2-cp310-abi3-win_amd64.whl.
File metadata
- Download URL: bc_edu_sdk-0.3.2-cp310-abi3-win_amd64.whl
- Upload date:
- Size: 777.8 kB
- Tags: CPython 3.10+, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
eb3549a372a6844668e65443c27e77912a2c242bdc23c861e03dff9233e7e56a
|
|
| MD5 |
54261e58ef42ca7d08a6c8adb311decf
|
|
| BLAKE2b-256 |
e9321dd3605870df93a9f97fd9d32b5a68114568d237383bcd02a2193c459f87
|
File details
Details for the file bc_edu_sdk-0.3.2-cp310-abi3-macosx_11_0_arm64.whl.
File metadata
- Download URL: bc_edu_sdk-0.3.2-cp310-abi3-macosx_11_0_arm64.whl
- Upload date:
- Size: 691.4 kB
- Tags: CPython 3.10+, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
86da6e1ace7f9c65f98230c8778f107d7872c6ff1c1ee711fa5b130699a5d64d
|
|
| MD5 |
2cdaddc8d31d64d6ac7468f30c602b06
|
|
| BLAKE2b-256 |
485c2be5db8770501a330862318db1475df66c7ed72876146ef9102375d9c515
|
