功能接口

更新时间:2024-03-25 07:08:24下载pdf

出行 SDK 依赖于涂鸦 智能生活 App SDK,基于此基础上进行拓展开发。因此,接入出行 SDK 前,请先实现智能生活 App SDK 设备控制 功能。

户外出行设备

类名(协议名) 说明
ThingSmartDevice (ThingSmartOutdoor) 设备相关能力户外 SDK 拓展分类
ThingSmartOutdoorDeviceListService 设备列表相关数据服务
ThingSmartSchemaModel (ThingSmartOutdoor) DP 信息户外 SDK 拓展分类

下发 DP 控制设备

SDK 基于 ThingSmartDevice 主类 DP(Data Point,设备功能标识)发送方法进行二次包装,增加了对 DP 高级语法逻辑判断支持。

接口说明

- (void)tsod_publishDPWithCode:(NSString *)code
                       DPValue:(id)DPValue
                       success:(nullable ThingSuccessHandler)success
                       failure:(nullable ThingFailureError)failure;

参数说明

参数 说明
code 发送的 DPCode(设备功能标识符)
DPValue 发送的 DP 数据(原始数据,您无需做 DP 数据转换)
success 发送成功回调
failure 发送失败回调

获取设备 DP 模型信息

接口说明

- (ThingSmartSchemaModel *)tsod_schemaMWithCode:(NSString *)code;

参数说明

参数 说明
code 发送的 DPCode

获取设备高清图标

接口说明

- (void)requestProductIconWithDeviceIDList:(NSSet<NSString *> *)deviceIDList
                                   success:(void(^)(NSDictionary<NSString *, ThingSmartOutdoorProductIconModel *> *productIconMap))success
                                   failure:(void(^__nullable)(NSError * error))failure;

参数说明

参数 说明
deviceIDList 设备 ID 列表
success 成功回调
failure 失败回调

ThingSmartOutdoorProductIconModel 数据模型

参数 说明
icon 800x800 尺寸的高清产品图标

获取设备硬件信息

接口说明

- (void)requestHardwareWithDeviceID:(NSString *)deviceID
                            success:(void(^)(ThingSmartOutdoorDeviceHardwareModel *hardwareModel))success
                            failure:(void(^)(NSError *error))failure;

参数说明

参数 说明
deviceID 设备 ID
success 成功回调
failure 失败回调

ThingSmartOutdoorDeviceHardwareModel 数据模型

参数 说明
chassisNo 车架号
activeTime 设备激活时间
productModel 设备型号

骑行导航

包含获取骑行轨迹信息和蓝牙车上报轨迹的接口,提供以下类:

类名 说明
ThingSmartOutdoorCycleRecordModel 骑行轨迹数据模型
ThingSmartOutdoorLocationUploadModel 蓝牙设备上报轨迹模型
ThingSmartOutdoorCyclingService 骑行相关接口

获取轨迹列表

接口说明

- (void)requestTripTrackWithDeviceId:(NSString *)devId
                        size:(NSInteger)size
                        completion:(void (^)(NSArray<ThingSmartOutdoorCycleRecordModel *> *records, NSError *error))completion;

参数说明

参数 说明
devId 设备 ID
size 请求返回的条数
completion 接口回调

ThingSmartOutdoorCycleRecordModel 数据模型

字段 类型 描述
mileageUnitType NSString 单位默认为千米(km)
speed Double 平均速度
mileage Double 单次总里程
battery Double 耗电电量
duration Double 轨迹耗时
bufferFlag Int 耗电电量
startTime Double 轨迹开始时间
endTime Double 轨迹结束时间
savingCarbonData Double 碳数据,负数代表无效

获取轨迹统计信息

接口说明

- (void)requestTripTrackStatisticWithDeviceId:(NSString *)devId
                                    startTime:(double)startTime
                                      endTime:(double)endTime
                                   completion:(void (^)(ThingSmartOutdoorCycleRecordModel *record, NSError *error))completion;

参数说明

参数 说明
devId 设备 ID
startTime 轨迹开始时间
endTime 轨迹结束时间
completion 接口回调

蓝牙车辆上报轨迹

接口说明

- (void)uploadLocatonWithDeviceId:(NSString *)devId
                        productId:(NSString *)pid
                    uploadModel:(ThingSmartOutdoorLocationUploadModel *)uploadModel
                     completion:(void (^)(BOOL success, NSError *error))completion;

参数说明

参数 说明
devId 设备 ID
pid 设备产品 ID,从 deviceModel 中可以获取
uploadModel 上报的数据
completion 接口回调

ThingSmartOutdoorLocationUploadModel 数据模型

字段 类型 描述
coord CLLocationCoordinate2D 坐标点
speed Double 当前速度
mileage Double 当前里程
started BOOL 车辆启动状态,如果上报 false 表示结束轨迹
batteryValue Double 当前电池电量

线下门店

类名 说明
ThingSmartOutdoorStoreRequestModel 按半径搜索门店参数模型
ThingSmartOutdoorStorePageRequestModel 按关键字分页搜索门店参数模型
ThingSmartOutdoorStoreModel 门店数据模型
ThingSmartOutdoorStoreService 门店相关接口

获取一定半径内门店

接口说明

- (void)requestStoreWithParams:(ThingSmartOutdoorStoreRequestModel *)params
                    completion:(void (^)(NSArray<ThingSmartOutdoorStoreModel*> *storeList, NSError *error))completion;

参数说明

参数 说明
params 请求数据模型
completion 接口回调

ThingSmartOutdoorStoreRequestModel 数据模型

字段 类型 描述
coordType NSString 坐标类型
  • WGS84:谷歌地图
  • GCJ02:高德地图
  • BD09LL:百度地图
latitude Double 纬度
longitiude Double 经度
radius NSInteger 半径,单位为千米
max NSInteger 最大数量,默认为 100

ThingSmartOutdoorStoreModel 数据模型

字段 类型 描述
identifier NSString 门店唯一 ID
coverUrl NSString 门店图片
vendername NSString 门店名
address NSString 门店地址
phoneNumber NSString 门店电话
coordType NSString 坐标类型
  • WGS84:谷歌地图
  • GCJ02:高德地图
  • BD09LL:百度地图
distance NSInteger 门店距离当前位置的距离
latitude Double 纬度
longitiude Double 经度

按关键字分页获取门店

接口说明

- (void)requestStorePagesWithParams:(ThingSmartOutdoorStorePageRequestModel *)params
                         completion:(void (^)(NSArray<ThingSmartOutdoorStoreModel*> *storeList, NSError *error))completion;

参数说明

参数 说明
params 请求数据模型
completion 接口回调

ThingSmartOutdoorStorePageRequestModel 数据模型

字段 类型 描述
coordType NSString 坐标类型
  • WGS84:谷歌地图
  • GCJ02:高德地图
  • BD09LL:百度地图
latitude Double 纬度
longitiude Double 经度
keyword NSString 搜索关键字
pageIndex NSInteger 分页索引
pageSize NSInteger 分页大小