深湾创新

接口列表

环境要求

  • 脑波设备是通过低功耗蓝牙传输数据,需要相应的开发平台支持BLE,版本>=4.X

接口列表

方法 参数 返回 说明
init (String param, BLListener listener) - 初始化,自动调用auth方法,请在鉴权成功后再进行后续操作 原生平台需要实现BLListener类中的onMsg方法,用于接收sdk消息
auth (String accountId, String token) - 此方法会在初始化时自动调用,仅在鉴权失败时供开发者调用
scanDevice - - 扫描设备,数据中address为设备唯一id
scanStop - - 停止扫描(扫描设备消耗较大,请开发者在合适时机停止扫描)
connectDevice (String address) - 连接设备,设备的连接稳定性无法保证100%,开发者需要自行处理设备异常断开的问题,设备断开后会发送断开消息
disconnectDevice (String address) - 断开连接,大多数情况下,设备无需断开
removeDevice (String address) - 从设备列表中移除设备并断开连接
getDevice (String address) json 获取特定设备信息
getDeviceList - jsonarray 获取所有扫描发现的设备信息
sendCmd (String address, String cmd) - 向设备发送命令
removeCache - - 清除缓存数据,某些情况下存在全局缓存的数据,可调用此接口进行清除
setAppState (int state) - state为0时设备停止发送数据,1则恢复发送数据 此方法供开发者需要时调用,比如当app进入后台后,不想再接收数据
changeBlink (int left, int right) - 更改眨眼阈值 left=左眼 right=右眼
changeListener (BLListener listener) - 更改数据接收对象,考虑到开发者有切换场景的需求
checkBLE - bool 检查蓝牙可用性,仅安卓
checkLocation - bool 请求位置权限(12以下)或蓝牙权限(12及以上),仅安卓

param参数说明-json

参数 说明 说明
accountId string,必须 分配给开发者的账号id
token string,必须 分配给开发者的token
blDebug bool,非必须,默认true 打印蓝牙日志
blCheck bool,非必须,默认true 自动调用checkBLE、checkLocation方法
blRaw bool,非必须,默认false 是否接收设备原始电幅值
dataType int,非必须,默认0 设备传输数据0=综合数据、1=全部通道数据
dataDelta int,非必须,默认1000 设备数据传输频率0=即时传输、500=每0.5秒1次、1000=每秒1次

返回数据说明-json

返回数据参考,详见接口数据说明

1 "type" 0, //类型
2 "address" "xxxx", //设备地址,即设备唯一id
3 "state" 0
4 "name" "设备名称", //2.5.x版本后address字段变为设备名称,可以忽略此字段了
5 "hex" "控制命令数据"

type字段说明

type 说明
0 鉴权结果。state:0=成功、1=失败
1 返回脑波数据
2 发现设备。state:0=未连接、1=正在连接、2=已连接
3 设备连接成功
4 设备连接失败
5 设备断开连接
6 返回控制命令数据。hex
7 返回原始电幅值。AF7Data、AF8Data
8 返回眨眼数据

getStressLevel()

功能:获取压力值指标

返回值:压力值数值 (0-100)

// 示例调用
const stress = await sdk.getStressLevel();
console.log(`当前压力值: ${stress}`);

事件监听接口

onDataReceived(callback)

功能:监听数据接收事件

参数:callback - 回调函数

// 示例调用
sdk.onDataReceived((data) => {
    console.log('接收到新数据:', data);
    // 处理数据
});

onDeviceStatusChanged(callback)

功能:监听设备状态变化

参数:callback - 回调函数

// 示例调用
sdk.onDeviceStatusChanged((status) => {
    console.log('设备状态变化:', status);
    if (status === 'connected') {
        console.log('设备已连接');
    } else if (status === 'disconnected') {
        console.log('设备已断开');
    }
});

配置接口

setConfig(config)

功能:设置SDK配置

参数:config - 配置对象

// 示例调用
sdk.setConfig({
    sampleRate: 250,
    filterEnabled: true,
    dataFormat: 'json'
});

sendCmd(cmd)

功能:发送命令到设备

参数:cmd - 命令字符串

返回值:命令执行结果

// 示例调用
const result = await sdk.sendCmd('start_recording');
console.log('命令执行结果:', result);