Metadata-Version: 2.4
Name: bc_stark_sdk
Version: 1.2.2
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
License-File: LICENSE
Summary: BrainCo Stark SDK
Author: BrainCo
License: 	
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Source Code, https://github.com/BrainCoTech/bc-stark-sdk

# BrainCo Stark Python SDK

Industrial-grade dexterous robotic hand control SDK with multi-protocol support and cross-platform compatibility.

## 🤖 Supported Devices

| Device | Motor | Touch Sensor | Protocols |
|--------|-------|--------------|-----------|
| **Revo1 Basic** | 6-DOF | - | Modbus, CAN 2.0 |
| **Revo1 Touch** | 6-DOF | Capacitive | Modbus, CAN 2.0 |
| **Revo1 Advanced** | 6-DOF | - | Modbus, CAN 2.0, CANFD, EtherCAT |
| **Revo1 Advanced Touch** | 6-DOF | Capacitive | Modbus, CAN 2.0, CANFD, EtherCAT |
| **Revo2 Basic** | 6-DOF | - | Modbus, CAN 2.0, CANFD, EtherCAT |
| **Revo2 Touch** | 6-DOF | Capacitive | Modbus, CAN 2.0, CANFD, EtherCAT |
| **Revo2 Touch Pressure** | 6-DOF | Pressure (Modulus) | Modbus, CAN 2.0, CANFD, EtherCAT |

### Touch Sensor Capabilities

- **Capacitive**: Normal/tangential force detection, proximity sensing
- **Pressure (Modulus)**: High-precision pressure distribution mapping

## 🔌 Protocol & Platform Support

| Protocol | Linux | macOS | Windows | Hardware |
|----------|:-----:|:-----:|:-------:|----------|
| **Modbus RTU** | ✅ | ✅ | ✅ | USB-RS485 adapter |
| **CAN 2.0 / CANFD** | ✅ | ✅ | ✅ | See CAN adapters below |
| **EtherCAT** | ✅ | ❌ | ❌ | EtherCAT NIC |

### CAN Adapter Support (built-in)

| Adapter | Linux | macOS | Windows | Notes |
|---------|:-----:|:-----:|:-------:|-------|
| **ZQWL USB-CAN** | ✅ | ✅ | ✅ | Cross-platform, 6Mbps serial, recommended |
| **SocketCAN** | ✅ | ❌ | ❌ | Linux kernel native |
| **ZLG USBCANFD** | ✅ | ❌ | ✅ | Requires ZLG driver |

## 🚀 Key Features

### Motor Control
- Position, speed, current, and force control modes
- Real-time status monitoring (angle, current, error, voltage)
- Trajectory planning and action sequences

### Touch Sensing
- Proximity and contact detection
- Normal and tangential force measurement
- High-precision pressure distribution (Modulus sensors)

### Device Management
- Auto-detection across multiple protocols
- Firmware updates (DFU/OTA)
- Configuration management (baudrate, CAN ID, limits)
- Device info retrieval (SN, firmware version, hardware type)

### Developer Tools
- Comprehensive Python API with type hints
- C/C++ bindings for embedded systems
- GUI debugging tools included
- Extensive examples and documentation

## 📦 Installation

```bash
pip install bc-stark-sdk
```

## 📚 Documentation & Examples

- **[Official Documentation](https://www.brainco-hz.com/docs/revolimb-hand/revo2/get_sdk.html)** - Complete SDK guide
- **[Python Examples](https://github.com/BrainCoTech/stark-serialport-example/blob/main/python/README.md)** - Python code samples
- **[C++ Examples](https://github.com/BrainCoTech/stark-serialport-example/blob/main/c/README.md)** - C/C++ integration guide

## 🔗 API Reference

- [Python Type Stubs](https://github.com/BrainCoTech/bc-stark-sdk/blob/main/python/bc_stark_sdk/main_mod.pyi) - Full Python API
- [C Header File](https://github.com/BrainCoTech/bc-stark-sdk/blob/main/dist/include/stark-sdk.h) - C/C++ API

## 📄 License

Proprietary - © 2015-2026 BrainCo Inc. All rights reserved.

