最近做的一个安卓项目是使用蓝牙基于Ymodem协议传输bin文件,实现对硬件设备进行升级。
做的过程中遇到了不少困难,用我这半吊子的语文水平,记录一下吧
怎么办,平时对各种文件传输协议真的是知之甚少啊。
先看看从百科里面盗过来的图吧
嗯...不好理解
流程:
大概流程呢就是 :
手机 --------------[我要传东西给你,听到了,你就答复一下]------------------------>硬件
手机 <--------------[好的,我听到了,但是你再确定一下]------------------------硬件
手机 --------------[我确定发送]------------------------>硬件
手机 <--------------[给你响应一个 C,表示你可以传东西过来了]------------------------硬件
手机 --------------[接收到C,我要开始发包头给你了,也就是文件名称和文件大小]------------------------>硬件
手机 <--------------[我收到了你的包头,给你发ack 0x06 表示确认,我收到了你的包头]------------------------硬件
手机 --------------[上面发送完了包头,现在发的是包数据流,也就是bin文件]------------------------>硬件
手机 <--------------[这个数据流我收到了,给你响应ack 0x06 确认]------------------------硬件
手机 --------------[继续发送剩下的包数据流]------------------------>硬件
手机 <--------------[继续给你响应ack 0x06确认]------------------------硬件
...
手机 --------------[检查到文件读完了,发送0x04,告诉你我要发送最后一个包了]------------------------>硬件
手机 <--------------[知道了,给你ack 0x06 响应]------------------------硬件
手机 --------------[ok,这是我最后一个包,给你了]------------------------>硬件
手机 <--------------[ok,最后一个包没有问题,检查通过,给你响应0x05]------------------------硬件
手机显示传输成功
Ymodem支持128字节和1024字节一个数据包。128字节以(SOH)开始,1024字节以(STX)开始。
private static final byte SOH = 0x01;
private static final byte STX = 0x02;
private static final byte EOT = 0x04;
数据 (参考数据都是经过16进制转换输出的):
一般包头和包尾为128字节,中间包为1024字节,也就是每次发送的包数据流为1kb。
包头数据参考,包头128字节,开始信号为 SOH ,也就是0x01开始 ,接着就是 00 FF,再接着就是文件名称和文件大小,
0100ff 70776d2832292e62696e 00 3332393336 00
0000000000000000000000000000000000000000
0000000000000000000000000000000000000000
00000000000000000000006a5d
包数据流参考,开始信号为STX,也就是0x02开头的,09为帧数。
包尾数据参考,开始信号为 SOH,也就是0x01,紧接着00FF (下面的参考是通过转16进制输出的)
0100ff 0000000000000000000000000000000000
0000000000000000000000000000000000000000
0000000000000000000000000000000000000000
0000000000000000000000000000000000000000
0000000000000000000000000000000000000000
0000000000000000000000000000000000000000
00000000000000000000000000
代码:
这方面的资料实属毕竟稀缺,但百度大法好,还是找到了一个好的开源项目。
如下所示,Ymodem传输的关键代码都在这了。
当然基本上做不到拿来就用,实际开发的时候,还是需要稍作修改,我使用的过程中,主要是两处修改,一个是 InputStreamSource 类中获取文件流,一个是Ymodem类中的 onReceiveData(byte[] respData) 方法,流程调整,和指令。
进行一个简单的介绍,希望可以帮到有缘人。
首先实现ymodem设备升级是需要用到蓝牙开发的,如果之前没有接触过蓝牙开发的话,可以去了解一下 FastBleLib 蓝牙连接库,参考我都另一篇文章快速入门。
首先介绍一下Library文件吧
CRC16 -- CRC校验类
FileStreamThread -- 读取需要传输的文件流
InputStreamSource -- 通过filepath得到文件流
L -- Ymodem日志输出
SourceScheme -- 枚举,文件类型
TimeOutHelper -- 计时器
YModem -- 主体,主要控制逻辑
YModemListener -- Ymodem回调接口
YModemUtil -- 获取包头,获取数据流
这里省去蓝牙扫描、蓝牙连接步骤,重点介绍文件的发送与响应。
感谢这位大佬 @LeonXtp ,写的代码还是流弊,已经封装很好了,调用非常方便。
ymodem = new YModem.Builder()
.with(this)
.filePath(file.getAbsolutePath())
.fileName(file.getName())
.checkMd5("") // 没有md5校验直接空字符串就行
.callback(new YModemListener() {
@Override
public void onDataReady(byte[] data) {
// 这里回调的是将要通过蓝牙发送给硬件的数据,包括文件名称文件大小的包头,文件流,包尾,以及应答
// 我用的是FastBleLib 蓝牙连接库,和发送指令一样
BleManager.getInstance().write(
bleDeviceBean.getBleDevice(),
bleDeviceBean.getUuid_service(),
bleDeviceBean.getUuid_write(),
data, // 发出去的数据
new BleWriteCallback() {
@Override
public void onWriteSuccess(int current, int total, byte[] justWrite) {
// justWrite 为发出去的数据
}
@Override
public void onWriteFailure(BleException exception) {
// 发送数据到设备失败
}
});
}
@Override
public void onProgress(int currentSent, int total) {
// 传输过程
}
@Override
public void onSuccess() {
// 传输成功
}
@Override
public void onFailed(String reason) {
//传输失败
}
}).build();
// 开始传输
ymodem.start();
如果是原生开发应该是把 BleManager.getInstance().write() 替换成
mbluetoothGattCharacteristic.setValue(news);
bluetoothGatt.writeCharacteristic(mbluetoothGattCharacteristic);
还是上面那个蓝牙库,上面是将数据读取并发送出去。
而下面的notify是用来实时接收来自硬件设备的data[]数据,比说硬件响应的 字符'C' ,或者0x06 ,交给YModem这个类处理。
BleManager.getInstance().notify(
bleDeviceBean.getBleDevice(),
bleDeviceBean.getUuid_service(),
bleDeviceBean.getUuid_write(),
new BleNotifyCallback() {
@Override
public void onNotifySuccess() {
// 打开通知操作成功
}
@Override
public void onNotifyFailure(BleException exception) {
// 打开通知操作失败
}
@Override
public void onCharacteristicChanged(byte[] data) {
// 我们需要将这个数据交给 ymodem 处理
ymodem.onReceiveData(data);
}
}
});
对接的时候可以将传输日志打印出来(16进制形式),这样方便双方定位问题。
byte[] justWrite;// 硬件响应或者发送的byte[]对象
StringBuilder getdata = new StringBuilder();
for (int i = 0; i < justWrite.length; i++) {
getdata.append(String.format("%02x", justWrite[i]));
}
Log.i(TAG,getdata .toString() + "------------- [ " + ( justWrite.length + 1 ) + " ] ------------- >" );
// or
Log.i(TAG,getdata .toString() + "<------------- [ " + ( justWrite.length + 1 ) + " ] ------------- " );
其实如果流程完全对接上,以上代码就可以进行传输了,但是往往多多少少会有些改动。
我使用时,主要是两个改动。
一个是Ymodem类中的 onReceiveData(byte[] respData) 方法,流程调整,和指令。
一个是 InputStreamSource 类中获取文件流,一直给我报 Unsupported file source
异常,就改成了下面这样。