taro-bluetooth-print
Advanced tools
Taro 蓝牙打印库 v2.0 - 现代化的 React Hooks 和 Zustand 状态管理，支持微信小程序、H5、React Native 等平台
# 使用 npm
npm install taro-bluetooth-print
# 使用 yarn
yarn add taro-bluetooth-print
# 使用 pnpm
pnpm add taro-bluetooth-print
import { createBluetoothPrinter } from 'taro-bluetooth-print';
// 创建打印实例
const printer = createBluetoothPrinter({
bluetooth: {
scanTimeout: 10000, // 扫描超时 10 秒
connectionTimeout: 8000, // 连接超时 8 秒
autoReconnect: true // 启用自动重连
},
printer: {
paperWidth: 58, // 58mm 纸张宽度
density: 8, // 打印密度
autoCut: true // 自动切纸
}
});
// 初始化
await printer.initialize();
// 扫描设备
const devices = await printer.scanDevices();
console.log(`发现 ${devices.length} 个设备`);
// 连接设备
if (devices.length > 0) {
const connected = await printer.connect(devices[0].deviceId);
if (connected) {
// 打印文本
await printer.printText('Hello, Taro Bluetooth Print!', {
align: 'center',
bold: true
});
// 打印二维码
await printer.printQRCode('https://github.com/your-org/taro-bluetooth-print', {
size: 8,
align: 'center'
});
// 断开连接
await printer.disconnect();
}
}
import React, { useState, useEffect } from 'react';
import { createBluetoothPrinter } from 'taro-bluetooth-print';
const BluetoothPrinter: React.FC = () => {
const [printer] = useState(() => createBluetoothPrinter());
const [devices, setDevices] = useState([]);
const [connected, setConnected] = useState(false);
const [status, setStatus] = useState('未连接');
useEffect(() => {
// 初始化
printer.initialize()
.then(() => setStatus('已初始化'))
.catch(error => {
console.error('初始化失败:', error);
setStatus('初始化失败');
});
// 监听事件
printer.on('bluetooth:device-found', device => {
setDevices(prev => [...prev, device]);
});
printer.on('bluetooth:connected', () => {
setConnected(true);
setStatus('已连接');
});
printer.on('bluetooth:disconnected', () => {
setConnected(false);
setStatus('未连接');
});
return () => {
printer.dispose();
};
}, []);
const handleScan = async () => {
try {
setDevices([]);
setStatus('扫描中...');
await printer.scanDevices();
setStatus('扫描完成');
} catch (error) {
console.error('扫描失败:', error);
setStatus('扫描失败');
}
};
const handleConnect = async (deviceId: string) => {
try {
setStatus('连接中...');
const success = await printer.connect(deviceId);
if (!success) {
setStatus('连接失败');
}
} catch (error) {
console.error('连接失败:', error);
setStatus('连接失败');
}
};
const handlePrint = async () => {
if (!connected) {
setStatus('请先连接设备');
return;
}
try {
setStatus('打印中...');
await printer.printText('Hello from React Component!', {
align: 'center',
bold: true
});
setStatus('打印完成');
} catch (error) {
console.error('打印失败:', error);
setStatus('打印失败');
}
};
return (
<View className="container">
<Text>状态: {status}</Text>
<Button onClick={handleScan} disabled={status === '扫描中...'}>
扫描设备
</Button>
{devices.length > 0 && (
<View>
<Text>发现设备:</Text>
{devices.map(device => (
<View key={device.deviceId}>
<Text>
{device.name || '未知设备'} ({device.deviceId})
</Text>
<Button
onClick={() => handleConnect(device.deviceId)}
disabled={connected}
>
连接
</Button>
</View>
))}
</View>
)}
{connected && (
<View>
<Button onClick={handlePrint}>打印测试</Button>
<Button onClick={() => printer.disconnect()}>
断开连接
</Button>
</View>
)}
</View>
);
};
export default BluetoothPrinter;
// 主要的蓝牙打印类
class BluetoothPrinter {
// 初始化
async initialize(): Promise<void>;
// 蓝牙管理
async scanDevices(): Promise<IBluetoothDevice[]>;
async connect(deviceId: string): Promise<boolean>;
async disconnect(): Promise<boolean>;
isConnected(): boolean;
// 打印功能
async printText(text: string, options?: TextPrintOptions): Promise<string>;
async printImage(image: string, options?: ImagePrintOptions): Promise<string>;
async printQRCode(data: string, options?: QRCodeOptions): Promise<string>;
async printBarcode(data: string, options?: BarcodeOptions): Promise<string>;
// 批量打印
async printBatch(requests: IPrintRequest[]): Promise<string[]>;
// 模板打印
async registerTemplate(template: ITemplate): Promise<void>;
async printTemplate(templateId: string, data: any): Promise<string>;
// 事件监听
on<T>(eventType: string, handler: IEventHandler<T>): void;
off<T>(eventType: string, handler: IEventHandler<T>): void;
// 资源清理
async dispose(): Promise<void>;
}
// 创建打印实例
function createBluetoothPrinter(
config?: Partial<IBluetoothPrinterConfig>
): BluetoothPrinter;
// 蓝牙事件
interface BluetoothEvents {
'bluetooth:device-found': IBluetoothDevice;
'bluetooth:connected': { deviceId: string };
'bluetooth:disconnected': { deviceId: string };
'bluetooth:error': BluetoothError;
}
// 打印事件
interface PrinterEvents {
'printer:job-started': { jobId: string };
'printer:job-completed': { jobId: string };
'printer:job-failed': { jobId: string; error: Error };
'printer:queue-empty': void;
}
bluetooth: {
scanTimeout: number; // 扫描超时时间(ms)，默认 10000
connectionTimeout: number; // 连接超时时间(ms)，默认 8000
autoReconnect: boolean; // 自动重连，默认 true
maxReconnectAttempts: number; // 最大重连次数，默认 3
reconnectInterval: number; // 重连间隔(ms)，默认 2000
}
printer: {
density: number; // 打印密度 (0-8)，默认 8
speed: number; // 打印速度 (0-4)，默认 2
paperWidth: number; // 纸张宽度 (mm)，默认 58
autoCut: boolean; // 自动切纸，默认 true
charset: string; // 字符集，默认 'PC437'
align: PrintAlignment; // 默认对齐方式，默认 'left'
}
queue: {
maxSize: number; // 队列最大大小，默认 100
concurrency: number; // 并发数，默认 1
retryAttempts: number; // 重试次数，默认 3
retryDelay: number; // 重试延迟(ms)，默认 1000
autoProcess: boolean; // 自动处理，默认 true
}
v2.0 是一个完全重构的版本，提供了更好的架构和更丰富的功能。主要变化：
// v1.x
const printer = new TaroBluePrint({
debug: true,
paperWidth: 58
});
// v2.0
const printer = createBluetoothPrinter({
printer: {
paperWidth: 58
},
logging: {
level: 'debug'
}
});
await printer.initialize();
// v1.x
printer.bluetooth.onDeviceFound((device) => {
console.log('Found device:', device);
});
// v2.0
printer.on('bluetooth:device-found', (device) => {
console.log('Found device:', device);
});
// v1.x
await printer.printer.printText('Hello');
// v2.0
await printer.printText('Hello');
详细的迁移指南请参考 API 文档
# 运行所有测试
npm test
# 运行单元测试
npm run test:unit
# 运行集成测试
npm run test:integration
# 运行 E2E 测试
npm run test:e2e
# 生成覆盖率报告
npm run test:coverage
-------------------|---------|----------|---------|---------|-------------------
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
-------------------|---------|----------|---------|---------|-------------------
All files | 100 | 100 | 100 | 100 |
src/ | 100 | 100 | 100 | 100 |
index.ts | 100 | 100 | 100 | 100 |
BluetoothPrinter.ts| 100 | 100 | 100 | 100 |
src/domain/ | 100 | 100 | 100 | 100 |
... | 100 | 100 | 100 | 100 |
-------------------|---------|----------|---------|---------|-------------------
我们欢迎所有形式的贡献！请查看 贡献指南 了解如何参与项目开发。
# 克隆仓库
git clone https://github.com/your-org/taro-bluetooth-print.git
cd taro-bluetooth-print
# 安装依赖
npm install
# 开发模式
npm run dev
# 构建项目
npm run build
# 运行测试
npm test
# 代码检查
npm run lint
# 格式化代码
npm run format
本项目采用 MIT 许可证。
感谢所有为这个项目做出贡献的开发者！
如果您在使用过程中遇到问题，可以通过以下方式获取帮助：
查看 CHANGELOG.md 了解详细的版本更新记录。
Made with ❤️ by Your Organization
FAQs
Taro 蓝牙打印库 v2.2 - 轻量级、高性能、跨平台支持微信、支付宝、百度、字节跳动小程序及H5 Web Bluetooth
The npm package taro-bluetooth-print receives a total of 37 weekly downloads. As such, taro-bluetooth-print popularity was classified as not popular.
We found that taro-bluetooth-print demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Malicious dYdX client packages were published to npm and PyPI after a maintainer compromise, enabling wallet credential theft and remote code execution.
Security News
gem.coop is testing registry-level dependency cooldowns to limit exposure during the brief window when malicious gems are most likely to spread.
Security News
Following multiple malicious extension incidents, Open VSX outlines new safeguards designed to catch risky uploads earlier.