# MCBleKit

**Repository Path**: morgan031/MCBleKit

## Basic Information

- **Project Name**: MCBleKit
- **Description**: 该微信小程序开源项目代码库用于管理微信小程序中的蓝牙功能。支持初始化蓝牙适配器、扫描和连接蓝牙设备、获取设备服务和特征、监听特征值变化、读写特征值以及断开连接等操作。通过设置不同的监听器，可灵活处理蓝牙连接状态变化、设备发现、服务和特征发现等事件，适用于需要与蓝牙设备进行数据交互的微信小程序开发场景。
This WeChat mini program open-source project cod
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-19
- **Last Updated**: 2025-08-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: JavaScript, npm, Bluetooth, wechat, miniprogram

## README

# MCBleKit
[![NPM version](https://img.shields.io/npm/v/mcblekit.svg)](https://www.npmjs.com/package/mcblekit)
![JavaScript](https://img.shields.io/badge/JavaScript-ES5+-yellow.svg)
[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/Json031/MCBleKit/blob/main/LICENSE)
<br>
该微信小程序开源项目代码库用于管理微信小程序中的蓝牙功能。支持初始化蓝牙适配器、扫描和连接蓝牙设备、获取设备服务和特征、监听特征值变化、读写特征值以及断开连接等操作。通过设置不同的监听器，可灵活处理蓝牙连接状态变化、设备发现、服务和特征发现等事件，适用于需要与蓝牙设备进行数据交互的微信小程序开发场景。
<br>This WeChat mini program open-source project code library is used to manage Bluetooth functionality in WeChat mini programs. Support initialization of Bluetooth adapters, scanning and connecting Bluetooth.

# 安装Install
* 最新版本 Latest Version: 
### 编辑package.json，添加mcblekit依赖。 <br>Edit packagejson and add mcblekit dependency:
 ```bash
{
  "dependencies": {
    "mcblekit": "latest"
  }
}
   ```
### 在小程序 package.json 所在的目录中执行命令安装 npm 包。 <br>Execute the command to install the npm package in the directory where the mini program packagejson is located：
 ```bash
cd /the/path/to/package.json file/
npm install
   ```

# 示例代码 <br>Example code:
在引用蓝牙管理类的js内引入 mcblekit 的模块，并将该模块的导出内容赋值给变量 MCBleKit. <br>Introduce the mcblekit module into the JS that references the Bluetooth management class, and assign the exported content of this module to the variable MCBleKit.

 ```bash
const MCBleKit = require('mcblekit')
   ```

 ```bash
    var writeServiceId = '108A'//write property service identifier
    var writeCharacteristicsId = '909C'//write property Characteristic identifier
    var serviceId = null
    var characteristicsId = null

    var mcblekit = MCBleKit.getSampleInstance("YOUR_BLUETOOTH_NAME")
    mcblekit.onCharacteristicFound((serviceId, res) => {
  
        for (var i = 0; i < res.characteristics.length; i++) {
            if (res.characteristics[i].uuid.toUpperCase().indexOf(writeCharacteristicsId.toUpperCase()) >= 0) {
                 characteristicsId = res.characteristics[i].uuid

                 //找到写入特征，开始写入数据 Find the write Characteristic and start writing data
                 //判断是否已连接 Determine if it is connected
                 if (mcblekit.connected) {
                      //发送数据write data Value
                      let buffer = new ArrayBuffer(2);
                      let view = new DataView(buffer);
                      view.setUint8(0, 0x0A);
                      view.setUint8(1, 0x01);
                      mcblekit.writeValue(buffer, 'writeNoResponse', serviceId, characteristicsId)
                 }
                 break
            }
        }

        console.log(`发现服务 ${serviceId} 的特征:`, res.characteristics);
    });

    mcblekit.onServicesFound((services) => {

        for (var i = 0; i < services.length; i++) {
            if (services[i].uuid.toUpperCase().indexOf(writeServiceId.toUpperCase()) >= 0) {
                 serviceId = services[i].uuid
                 break
            }
            console.log(`发现服务 ${services[i].uuid}`);
        }
    });
    mcblekit.bluetoothDeviceFound(() => {
        console.log('bluetoothDeviceFound:' + mcblekit.devices[mcblekit.devices.length - 1].name);
    });
    mcblekit.onConnectedStatusChange((connected) => {
        console.log('onConnectedStatusChange:' + (connected ? "connected" : "disconnected"));
    });
   ```
![console log](https://github.com/user-attachments/assets/492cef49-f311-4a54-a2f0-7fbb5a4457de)

# 许可证 License
This library is licensed under the [MIT License](https://github.com/Json031/MCBleKit/blob/main/LICENSE).