Files
web-Iot/src/api/ota.ts
2026-10-08 08:55:36 +08:00

149 lines
4.3 KiB
TypeScript

// OTA 管理 API 层
// 后端接口:
// POST /iot/deviceOta/firmware/save → uploadFirmwarePackage
// GET /iot/deviceOta/firmware/list → getFirmwarePackageList
// GET /iot/deviceOta/firmware/detail → getFirmwareDetail (deviceType)
// POST /iot/deviceOta/firmware/upgrade → operateFirmware (upgrade/rollback/reboot)
// POST /iot/deviceOta/firmware/delete → deleteFirmwarePackage (id)
// GET /iot/deviceOta/record/detail → getRecordDetail (id)
// GET /iot/deviceOta/record/selectByDeviceId → getRecordByDeviceId (deviceId)
// POST /iot/deviceOta/record/select → getRecords (ids)
import request from './request';
// ====== 类型定义 ======
export type OtaOperateType = 'upload' | 'upgrade' | 'rollback' | 'reboot';
export interface FirmwarePackage {
id: number | string;
version: string; // 版本号
fileName: string; // 文件名
fileType?: string; // 服务端文件类型
md5?: string; // md5 校验
fileSize?: number; // 文件大小(bytes)
description?: string; // 描述
uploadTime?: string; // 上传时间
deviceType?: string; // 设备类型
}
export interface MachineVersion {
id: number | string;
code: string; // 设备编号/SN
name: string; // 设备名称
type: string; // 设备类型
online: 'ONLINE' | 'OFFLINE';
currentVersion: string; // 当前固件版本
previousVersion: string | null;
lastUpgradeTime: string | null;
status: 'IDLE' | 'UPGRADING' | 'FAILED' | 'SUCCESS';
}
export interface OtaRecord {
id: number | string;
deviceId?: string;
deviceName?: string;
firmwareId?: number | string;
operateType?: OtaOperateType | string;
fromVersion?: string;
toVersion?: string;
status?: string;
createTime?: string;
finishTime?: string;
message?: string;
}
interface ApiResponse<T = any> {
code: number;
msg: string;
data: T;
rows?: T[];
total?: number;
}
// ====== 固件包相关 ======
/** 上传固件包 (multipart/form-data),直接接收已构建好的 FormData */
export function uploadFirmwarePackage(formData: FormData) {
return request({
url: '/iot/deviceOta/firmware/save',
method: 'post',
data: formData,
headers: { 'Content-Type': 'multipart/form-data' },
}) as Promise<ApiResponse<FirmwarePackage>>;
}
/** 获取固件包列表 */
export function getFirmwarePackageList(params?: { deviceType?: string }) {
return request({
url: '/iot/deviceOta/firmware/list',
method: 'post',
params,
}) as Promise<ApiResponse<FirmwarePackage[]>>;
}
/** 根据设备类型查询固件详情 */
export function getFirmwareDetail(deviceType: string) {
return request({
url: '/iot/deviceOta/firmware/detail',
method: 'get',
params: { deviceType },
}) as Promise<ApiResponse<FirmwarePackage>>;
}
/** 删除固件包 */
export function deleteFirmwarePackage(ids: number[] | string[]) {
return request({
url: '/iot/deviceOta/firmware/delete',
method: 'post',
data: ids
}) as Promise<ApiResponse<null>>;
}
// ====== 设备升级操作 ======
/**
* 批量操作设备固件(升级 / 回退 / 重启)
* operateType: upgrade-升级, rollback-回退, reboot-重启
*/
export function operateFirmware(params: {
operateType: OtaOperateType;
deviceIds: (string | number)[];
firmwareId?: string | number;
}) {
return request({
url: '/iot/deviceOta/firmware/upgrade',
method: 'post',
data: params,
}) as Promise<ApiResponse<{ upgraded?: (string | number)[]; skipped?: (string | number)[] }>>;
}
// ====== 操作记录相关 ======
/** 根据记录 id 查询操作记录详情 */
export function getRecordDetail(id: number | string) {
return request({
url: '/iot/deviceOta/record/detail',
method: 'get',
params: { id },
}) as Promise<ApiResponse<OtaRecord>>;
}
/** 根据设备 id 查询升级记录 */
export function getRecordByDeviceId(deviceId: string | number) {
return request({
url: '/iot/deviceOta/record/selectListByDeviceId',
method: 'get',
params: { deviceId },
}) as Promise<ApiResponse<OtaRecord[]>>;
}
/** 根据记录 id 列表批量查询操作记录 */
export function getRecords(ids: (string | number)[]) {
return request({
url: '/iot/deviceOta/record/select',
method: 'post',
data: ids,
}) as Promise<ApiResponse<OtaRecord[]>>;
}