OTA V3 iOS SDK

1. 集成

• 导入SifliOCore.xcframework，SifliOtaSDK.xcframework, SifliSol2Model

import SifliOtaSDK
import SifliOCore

• Swift Package

https://github.com/OpenSiFli/SifliOtaSDK_iOS.git
https://github.com/OpenSiFli/SifliOCore.git
https://github.com/OpenSiFli/SifliSol2Model_iOS.git

可选
https://github.com/OpenSiFli/SFSSZipArchivePlugin.git

• 最新版本匹配

    'SifliOCore','2.2.3'
    'SifliOtaSDK','3.4.1'
    'SifliSol2Model','3.3.9'
  
  可选
    pod  'SFSSZipArchivePlugin','1.0.2'

• 初始化

let manager = SFOtaV3Manager.shared()

 override func viewDidLoad() {
 //需要实现SFOtaV3ManagerDelegate
  manager.delegate = self
 }

• zip 插件

3.3.6版本之后，zip 模块从SifliOCore剥离，如果要进行NAND 差分包升级，可以使用SFSSZipArchivePlugin,也可以自行实现这个插件接口。

初始化方式

import SFSSZipArchivePlugin
SFZipHelper.shared().zipDelegate = SFSSZipArchiver.shared()

• OTA V3 Demo

2. 接口调用

2.1 资源传输

调用otaManager如下方法

/// 资源ota
/// - Parameters:
///   - identifier: 蓝牙设备地址
///   - otaV3Type: 0-表盘，1-多语言, 2-背景图，3-自定义, 4-音乐,5-JS,8-4G模块, 9-GUIBuilder 表盘, 
///                12-GUIBuilder App,13-GUIBuilder 扩展资源。其它类型查阅文档
///   - resourceFile: 资源文件描述
///   - tryResume: 是否尝试续传
- (void)startOtaResWithIdentifier:(NSString *)identifier
                          otaV3Type:(SFOtaV3Type)otaV3Type
                          resourceFile:(SFOtaV3ResourceFileInfo *)resourceFile
                          tryResume:(BOOL)tryResume;

SFOtaV3Type

typedef NS_ENUM(NSUInteger, SFOtaV3Type) {
    SFOtaV3TypeDynamicModule = 0,//表盘
    SFOtaV3TypeMutilLanguage = 1,//多语言
    SFOtaV3TypeBgPicture = 2,//背景图
    SFOtaV3TypeCustomFile = 3,//自定义
    SFOtaV3TypeMusic = 4,//背景音乐
    SFOtaV3TypeQjs = 5,//JavaScript
    SFOtaV3TypePhotoView = 7,//拍照预览
    SFOtaV3TypeAicModule = 8,//4g模块
    SFOtaV3TypeSilfiWatchface = 9,//SifliGuiBuiler 表盘
    SFOtaV3TypeFirmware = 10,//固件
    SFOtaV3TypeFirmwareManager = 11,//固件 ota manager
    SFOtaV3TypeSifliApp = 12,//SifliGuiBuilder app
    SFOtaV3TypeSifliAppRes = 13,//SifliGuiBuilder app 拓展资源
    SFOtaV3TypeSifliAppWidget = 14//SifliGuiBuilder app 拓展组件
};

SFOtaV3ResourceFileInfo

typedef NS_ENUM(NSUInteger, SFOtaV3DfuFileType) {
    SFOtaV3DfuFileTypeZipResource = 0,//zip资源文件
    SFOtaV3DfuFileTypeZipResourceNoFilePath = 1,//zip资源没有路径
    SFOtaV3DfuFileTypeCtrlFile = 2,//固件ota 控制文件
    SFOtaV3DfuFileTypeBinFile = 3,//固件ota image bin文件
    SFOtaV3DfuFileTypeTransBinFile = 4,//直接传输的bin文件
};
@interface SFOtaV3FileInfo : NSObject
@property (nonatomic,copy,readonly)NSString *filePath;
@property (nonatomic,assign,readonly)SFOtaV3DfuFileType fileType;
- (instancetype)initWidthFileType:(SFOtaV3DfuFileType)fileType filePath:(NSString *)filePath;

@end

@interface SFOtaV3ResourceFileInfo : SFOtaV3FileInfo
@property(nonatomic,assign)BOOL withByteAlign;

- (instancetype)initWithFileType:(SFOtaV3DfuFileType)fileType
                filePath:(NSString *)filePath
           withByteAlign:(BOOL)withByteAlign;

- (BOOL)isFilePathNullOrEmpty;
@end

2.2 固件传输

调用如下方法

/// 固件ota
/// - Parameters:
///   - identifier: 蓝牙设备地址
///   - resourceFile: 差分包资源文件描述
///   - imageFiles: 固件ota的bin文件，包括ctrl packet
///   - tryResume: 是否尝试续传
- (void)startOtaFirmwareWithIdentifier:(NSString *)identifier
                          resourceFile:(nullable SFOtaV3ResourceFileInfo *)resourceFile
                            imageFIles:(nullable NSArray<SFOtaV3BinFileInfo *> *)imageFiles
                             tryResume:(BOOL)tryResume;

SFOtaV3BinFileInfo

typedef NS_ENUM(uint16_t, SFOtaV3ImageID) {
    SFOtaV3ImageIDHcpu = 0,
    SFOtaV3ImageIDLcpu = 1,
    SFOtaV3ImageIDLcpuPatch = 2,
    SFOtaV3ImageIDNorResOrNandPic = 3,
    SFOtaV3ImageIDNorFontOrNandFont = 4,
    SFOtaV3ImageIDNorRootOrNandLang = 5,
    SFOtaV3ImageIDNorOtaManagerOrNandRing = 6,
    SFOtaV3ImageIDNorTinyFontOrNandRoot = 7,
    SFOtaV3ImageIDNorFtabOrNandMusic = 8,
    SFOtaV3ImageIDNandDyn = 9,
    SFOtaV3ImageIDNandNym = 10,
    SFOtaV3ImageIDNandFtab = 11
};

@interface SFOtaV3BinFileInfo : SFOtaV3FileInfo
///参照SFOtaV3ImageID
@property(nonatomic,assign) uint16_t imageId;

/// 新地址（十六进制字符串，大端书写，即人类习惯的地址值）
///
/// 填写规则：
/// - 按地址值的大端书写习惯填入，例如地址 0x87654321 填 @"87654321"；
/// - 不要带 "0x" 前缀、空格或分隔符，仅 0-9A-Fa-f；
/// - 建议正好 8 位（不足 8 位 SDK 会自动左补 0，超过 8 位报错）；
/// - 留空/nil 表示地址 0。
///
/// 说明：SDK 内部会将此大端书写值转换为小端序写入通信包（wire 字节为
/// 0x21 0x43 0x65 0x87），MCU 侧可直接按 uint32 读取得到 0x87654321。
/// 本字段语义与 Android SDK 一致，请勿"反着填"。
@property(nonatomic,copy,nullable)NSString *hexNewAddr;
- (instancetype)initWidthFileType:(SFOtaV3DfuFileType)fileType filePath:(NSString *)filePath imageId:(uint16_t)imageId;
@end

3. 错误码

错误码参见ios-sdk-error-code