StpOCSDK
SDK 以 pod 引入方式 获取。pod = ' StpOCSDK ' SDK 包括:
概述
本 SDK 主要提供了百进智能点读笔常用的五大模块接口
-
账号管理
- 登录
- 登出
- 设置操作设备
- 当前操作设备ID
-
设备管理
- 获取设备列表
- 获取设备详情
- 获取设备硬件信息
- 修改设备音量
- 修改设备名称
- 解除设备绑定
- 上传设备日志
-
学习报告
- 已读绘本列表(按日期查询、倒叙分页查询)
- 各项学习数据(点读、跟读、日报)(按日期查询、倒叙分页查询)
- 各项报告趋势(点读、跟读、学习时长、阅读绘本数)
-
绘本管理
- 全部绘本
- 搜索绘本
- 设备已添加绘本
- 绘本详情
- 下载绘本或点读包
- 删除绘本(单本、批量)
- 获取设备存储空间状态
- 全部点读包
- 已下载点读包
-
同步课堂
- 设置个推ID
- 同步课堂开关
- 同步课堂心跳
设备相关API
@interface STPDeviceApi
用户账户相关API
@interface STPAuthApi
@interface STPUserApi
绘本相关API
@interface STPPictureBookApi
学习报告相关API
@interface STPStudyReportApi
Installation
安装方式
pod 'StpOCSDK'
相关流程
Config配置
在调用SDK相关API之前,需要先配置
@interface STPAccessConfig
设置开发环境
STPAccessConfiger.developEnv = Env_Development;
[STPAccessConfiger setPackageId:@"输入分配给您的PackageId"];
登录流程
用户选择登录方式,包括 普通用户登录 和 第三方登录的方式。
. 普通用户登录
@param phoneNum 手机号码
@param passWord 用户密码
@param pushToken 推送token
+ (void)login:(NSString*_Nonnull)phoneNum passWord:(NSString*_Nonnull)passWord pushToken:(NSString*)token completionBlock:(nullable void (^)(STPUserModel *user,NSError *error)) completionBlock;
. 第三方登录
/**
第三方登录
@param phone 客户用户唯一标识
@param passwd 用户密码(可以传空字符)
@param thirdCode 客户用户token鉴权码
*/
+(void)loginEx:(NSString*)phone passwd:(NSString*)passwd thirdCode:(NSString*)thirdCode block:(void (^)(STPUserModel *user,NSError *error))block;
. 设置当前操作的设备ID与设备AppId
/**
设置操作点读笔
@param currDeviceID 点读笔设备ID
@param appId 点读笔AppId
*/
-(void)setCurrDeviceID:(NSString * _Nonnull)currDeviceID appId:(NSString *_Nonnull) appId;
配网流程
. 首先连接硬件蓝牙,然后将wifi名称和密码信息(包括wifi密码和用户ID)发送到硬件设备端。发送之后硬件会提示:正在配网中。 此时APP端定时轮询获取配网的结果。
/** 获取配网的结果 建议采用定时轮询 */
+(void)getDeviceBindInfo:(void (^)(STPBindInfo* _Nullable response, NSError *_Nullable error))block;
. 蓝牙配网Demo
参见blueTooth Demo
https://github.com/Felix-2022/StpDemo
全部SDK接口使用Demo
https://github.com/Felix-2022/StpOCSDK/blob/master/Example/StpOCSDK/STPViewController.m