添加ESP系列设备的OTA

This commit is contained in:
2026-01-12 11:44:55 +08:00
parent 3580717087
commit 3f1bd0731b
10 changed files with 765 additions and 15 deletions

View File

@@ -1,11 +1,13 @@
from typing import Annotated
from uuid import UUID
from fastapi import APIRouter, Depends
from sqlalchemy.ext.asyncio import AsyncSession
from fastapi import APIRouter, Depends, File, Form, Query, UploadFile
from starlette.status import HTTP_204_NO_CONTENT
from middleware.admin import is_admin
from model import database
from model.response import DefaultResponse
from middleware.dependencies import SessionDep
from model import User, DefaultResponse
from model.firmware import ChipTypeEnum
from services import admin as admin_service
Router = APIRouter(
@@ -38,7 +40,7 @@ async def verity_admin() -> DefaultResponse:
response_description='设置项列表'
)
async def get_settings(
session: Annotated[AsyncSession, Depends(database.Database.get_session)],
session: SessionDep,
name: str | None = None
) -> DefaultResponse:
data = await admin_service.fetch_settings(session=session, name=name)
@@ -53,9 +55,110 @@ async def get_settings(
response_description='更新结果'
)
async def update_settings(
session: Annotated[AsyncSession, Depends(database.Database.get_session)],
session: SessionDep,
name: str,
value: str
) -> DefaultResponse:
result = await admin_service.update_setting_value(session=session, name=name, value=value)
return DefaultResponse(data=result)
# 固件管理接口
@Router.post(
path='/firmware',
summary='上传固件包',
description='管理员上传新的固件更新包',
status_code=HTTP_204_NO_CONTENT,
response_description='上传成功'
)
async def upload_firmware(
session: SessionDep,
admin: Annotated[User, Depends(is_admin)],
chip_type: ChipTypeEnum = Form(..., description='芯片类型'),
version: str = Form(..., description='版本号'),
description: str | None = Form(None, description='更新说明'),
file: UploadFile = File(..., description='固件文件'),
):
"""
上传固件包。
支持的文件格式:.bin
文件大小限制4MB
"""
await admin_service.upload_firmware(
session=session,
admin=admin,
chip_type=chip_type,
version=version,
description=description,
file=file,
)
@Router.get(
path='/firmwares',
summary='获取固件列表',
description='获取已上传的固件列表',
response_model=DefaultResponse,
response_description='固件列表'
)
async def list_firmwares(
session: SessionDep,
admin: Annotated[User, Depends(is_admin)],
chip_type: ChipTypeEnum | None = Query(None, description='筛选芯片类型'),
is_active: bool | None = Query(None, description='筛选启用状态'),
) -> DefaultResponse:
"""
获取固件列表。
"""
result = await admin_service.list_firmwares(
session=session,
chip_type=chip_type,
is_active=is_active,
)
return DefaultResponse(data=result)
@Router.delete(
path='/firmware/{firmware_id}',
summary='删除固件',
description='删除指定的固件包',
status_code=HTTP_204_NO_CONTENT,
response_description='删除成功'
)
async def delete_firmware(
session: SessionDep,
admin: Annotated[User, Depends(is_admin)],
firmware_id: UUID,
):
"""
删除固件包。
"""
await admin_service.delete_firmware(
session=session,
firmware_id=firmware_id,
)
@Router.patch(
path='/firmware/{firmware_id}/status',
summary='切换固件状态',
description='启用或禁用固件',
status_code=HTTP_204_NO_CONTENT,
response_description='操作成功'
)
async def toggle_firmware_status(
session: SessionDep,
admin: Annotated[User, Depends(is_admin)],
firmware_id: UUID,
is_active: bool = Query(..., description='目标状态'),
):
"""
切换固件启用状态。
"""
await admin_service.toggle_firmware_status(
session=session,
firmware_id=firmware_id,
is_active=is_active,
)

98
routes/ota.py Normal file
View File

@@ -0,0 +1,98 @@
"""OTA API 路由,处理 ESP32/8266 设备的在线升级请求。"""
from fastapi import APIRouter, Query, status
from starlette.status import HTTP_204_NO_CONTENT
from middleware.dependencies import SessionDep, DeviceDep
from model import DefaultResponse
from model.firmware import FirmwareCheckUpdateRequest, FirmwareCheckUpdateResponse
from services import ota as ota_service
Router = APIRouter(prefix='/api/ota', tags=['OTA升级'])
@Router.post(
path='/check-update',
summary='检查固件更新',
description='设备通过 mTLS 认证后查询是否有新版本固件',
response_model=DefaultResponse,
response_description='更新检查结果'
)
async def check_update(
session: SessionDep,
device: DeviceDep,
request_data: FirmwareCheckUpdateRequest,
) -> DefaultResponse:
"""
检查固件更新。
设备需要提供有效的 mTLS 客户端证书,证书 CN 字段为设备序列号。
"""
result = await ota_service.check_firmware_update(
session=session,
device=device,
chip_type=request_data.chip_type,
current_version=request_data.current_version,
)
return DefaultResponse(data=result)
@Router.get(
path='/download/{firmware_id}',
summary='下载固件包',
description='下载指定的固件更新包',
)
async def download_firmware(
session: SessionDep,
device: DeviceDep,
firmware_id: str,
):
"""
下载固件包。
需要有效的设备证书,且下载会记录统计信息。
"""
return await ota_service.get_firmware_file(
session=session,
firmware_id=firmware_id,
device=device,
)
@Router.post(
path='/report-version',
summary='上报设备版本',
description='设备上报当前运行的固件版本',
status_code=HTTP_204_NO_CONTENT,
response_description='上报成功'
)
async def report_version(
session: SessionDep,
device: DeviceDep,
version: str = Query(..., description='当前版本号'),
):
"""
上报设备当前运行的固件版本。
"""
await ota_service.update_device_version(
session=session,
device=device,
version=version,
)
@Router.post(
path='/report-lost',
summary='上报设备丢失',
description='设备上报丢失状态',
status_code=HTTP_204_NO_CONTENT,
response_description='上报成功'
)
async def report_lost(
session: SessionDep,
device: DeviceDep,
):
"""
设备上报丢失状态(复用现有丢失处理逻辑)。
"""
await ota_service.report_device_lost(session=session, device=device)