smartrack-sdk 1.0.0__py3-none-any.whl

smartrack_sdk/models/__init__.py

@@ -0,0 +1,85 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+数据模型包
+包含所有枚举类、请求类、响应类和回调模型
+"""
+
+# 导入枚举类
+from .enums import (
+    LedColors,
+    CellStatus,
+    RackTestMode,
+    OperationResultCode,
+    TriggerState,
+)
+
+# 导入请求类
+from .requests import (
+    BaseRequest,
+    ClearErrorRequest,
+    RackTestRequest,
+    StockInRequest,
+    StockOutRequest,
+    StockOutSheetRequest,
+    StockOutSheetCancelRequest,
+    StockOutSheetFinishRequest,
+    StockInFinishRequest,
+    ResetCellRequest,
+    GetStockByGRNListRequest,
+)
+
+# 导入响应类
+from .responses import (
+    BaseResponse,
+    ClearErrorResponse,
+    StockDataResponse,
+    StockDataDto,
+    StockOutResponse,
+    StockOutResponseDto,
+    StockOutSheetResponse,
+)
+
+# 导入回调模型
+from .callback import (
+    CellEventData,
+    CellEventHandleRequest,
+    CellEventHandleResponse,
+)
+
+__all__ = [
+    # 枚举类
+    "LedColors",
+    "CellStatus",
+    "RackTestMode",
+    "OperationResultCode",
+    "TriggerState",
+
+    # 请求类
+    "BaseRequest",
+    "ClearErrorRequest",
+    "RackTestRequest",
+    "StockInRequest",
+    "StockOutRequest",
+    "StockOutSheetRequest",
+    "StockOutSheetCancelRequest",
+    "StockOutSheetFinishRequest",
+    "StockInFinishRequest",
+    "ResetCellRequest",
+    "GetStockByGRNListRequest",
+
+    # 响应类
+    "BaseResponse",
+    "ClearErrorResponse",
+    "StockDataResponse",
+    "StockDataDto",
+    "StockOutResponse",
+    "StockOutResponseDto",
+    "StockOutSheetResponse",
+
+    # 回调模型
+    "CellEventData",
+    "CellEventHandleRequest",
+    "CellEventHandleResponse",
+]

smartrack_sdk/models/callback.py

@@ -0,0 +1,184 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+回调模型类
+包含储位事件回调相关的数据模型
+"""
+
+from dataclasses import dataclass, field
+from typing import List, Optional, Any, Dict
+from datetime import datetime
+
+from .enums import LedColors, TriggerState, OperationResultCode
+
+
+@dataclass
+class CellEventData:
+    """储位事件回调数据"""
+
+    code: int = 0  # 操作结果
+    message: str = ""  # 返回消息
+    cell_id: str = ""  # 储位号
+    cell_state: TriggerState = TriggerState.TAKE_OUT  # 触发状态
+    grn: Optional[str] = None  # 朔源码
+    sheet_id: Optional[str] = None  # 单号
+    led_color: LedColors = LedColors.OFF  # 亮灯颜色
+    is_blink: bool = False  # 是否闪烁
+    rack_id: Optional[str] = None  # 料架编号
+
+    @property
+    def operation_result(self) -> OperationResultCode:
+        """获取操作结果枚举"""
+        return OperationResultCode.from_value(self.code)
+
+    @property
+    def is_success(self) -> bool:
+        """是否成功"""
+        return self.code == 0
+
+    @property
+    def is_put_in(self) -> bool:
+        """是否为放入操作"""
+        return self.cell_state == TriggerState.PUT_IN
+
+    @property
+    def is_take_out(self) -> bool:
+        """是否为取出操作"""
+        return self.cell_state == TriggerState.TAKE_OUT
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> 'CellEventData':
+        """从字典创建实例"""
+        cell_state = data.get("CellState", 0)
+        led_color = data.get("LedColor", 0)
+
+        return cls(
+            code=data.get("Code", 0),
+            message=data.get("Message", ""),
+            cell_id=data.get("CellId", ""),
+            cell_state=TriggerState.from_value(cell_state),
+            grn=data.get("GRN"),
+            sheet_id=data.get("SheetId"),
+            led_color=LedColors.from_value(led_color),
+            is_blink=data.get("IsBlink", False),
+            rack_id=data.get("RackId"),
+        )
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典"""
+        return {
+            "Code": self.code,
+            "Message": self.message,
+            "CellId": self.cell_id,
+            "CellState": self.cell_state.value,
+            "GRN": self.grn,
+            "SheetId": self.sheet_id,
+            "LedColor": self.led_color.value,
+            "IsBlink": self.is_blink,
+            "RackId": self.rack_id,
+        }
+
+    def __str__(self) -> str:
+        return (f"CellEventData(cell_id={self.cell_id}, grn={self.grn}, "
+                f"state={self.cell_state.name_en}, code={self.code})")
+
+
+@dataclass
+class CellEventHandleRequest:
+    """储位事件回调请求"""
+
+    user_id: str = ""  # 操作人
+    client_id: str = ""  # 客户端ID
+    session_id: str = ""  # 会话ID
+    timestamp: str = field(default_factory=lambda: datetime.now().isoformat())  # 时间戳
+    data: List[CellEventData] = field(default_factory=list)  # 数据集合
+
+    def add_event_data(self, event_data: CellEventData) -> None:
+        """添加事件数据"""
+        self.data.append(event_data)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> 'CellEventHandleRequest':
+        """从字典创建实例"""
+        event_list = []
+        for item in data.get("Data", []):
+            event_list.append(CellEventData.from_dict(item))
+
+        return cls(
+            user_id=data.get("UserId", ""),
+            client_id=data.get("ClientId", ""),
+            session_id=data.get("SessionId", ""),
+            timestamp=data.get("Timestamp", datetime.now().isoformat()),
+            data=event_list,
+        )
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典"""
+        return {
+            "UserId": self.user_id,
+            "ClientId": self.client_id,
+            "SessionId": self.session_id,
+            "Timestamp": self.timestamp,
+            "Data": [event.to_dict() for event in self.data],
+        }
+
+    def __str__(self) -> str:
+        return (f"CellEventHandleRequest(user_id={self.user_id}, "
+                f"client_id={self.client_id}, events={len(self.data)})")
+
+
+@dataclass
+class CellEventHandleResponse:
+    """储位事件回调响应"""
+
+    code: int = 0  # 返回代码
+    message: str = "OK"  # 返回消息
+    session_id: str = ""  # 会话Id
+    timestamp: str = field(default_factory=lambda: datetime.now().isoformat())  # 时间戳
+
+    @property
+    def is_success(self) -> bool:
+        """是否成功"""
+        return self.code == 0
+
+    @classmethod
+    def success(cls, session_id: str) -> 'CellEventHandleResponse':
+        """创建成功响应"""
+        return cls(
+            code=0,
+            message="OK",
+            session_id=session_id,
+        )
+
+    @classmethod
+    def error(cls, code: int, message: str, session_id: str) -> 'CellEventHandleResponse':
+        """创建失败响应"""
+        return cls(
+            code=code,
+            message=message,
+            session_id=session_id,
+        )
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> 'CellEventHandleResponse':
+        """从字典创建实例"""
+        return cls(
+            code=data.get("code", 0),
+            message=data.get("message", "OK"),
+            session_id=data.get("sessionId", ""),
+            timestamp=data.get("timestamp", datetime.now().isoformat()),
+        )
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典"""
+        return {
+            "code": self.code,
+            "message": self.message,
+            "sessionId": self.session_id,
+            "timestamp": self.timestamp,
+        }
+
+    def __str__(self) -> str:
+        return (f"CellEventHandleResponse(code={self.code}, "
+                f"message={self.message}, session_id={self.session_id})")

smartrack_sdk/models/enums.py

@@ -0,0 +1,203 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+枚举类定义
+包含所有SmartRack API中使用的枚举类型
+"""
+
+from enum import Enum, IntEnum
+from typing import Dict, Any
+
+
+class LedColors(IntEnum):
+    """LED灯颜色枚举"""
+
+    OFF = 0  # 关闭
+    RED = 1  # 红色
+    GREEN = 2  # 绿色
+    YELLOW = 3  # 黄色
+    BLUE = 4  # 蓝色
+    MAGENTA = 5  # 洋红色
+    CYAN = 6  # 青色
+    WHITE = 7  # 白色
+
+    BLINK = 128  # 闪烁
+    RED_BLINK = 129  # 红色闪烁
+    GREEN_BLINK = 130  # 绿色闪烁
+    YELLOW_BLINK = 131  # 黄色闪烁
+    BLUE_BLINK = 132  # 蓝色闪烁
+    MAGENTA_BLINK = 133  # 洋红色闪烁
+    CYAN_BLINK = 134  # 青色闪烁
+    WHITE_BLINK = 135  # 白色闪烁
+
+    @classmethod
+    def from_value(cls, value: int) -> 'LedColors':
+        """根据值获取枚举实例"""
+        try:
+            return cls(value)
+        except ValueError:
+            raise ValueError(f"Invalid LedColors value: {value}")
+
+    @property
+    def name_en(self) -> str:
+        """获取英文名称"""
+        names = {
+            0: "Off",
+            1: "Red",
+            2: "Green",
+            3: "Yellow",
+            4: "Blue",
+            5: "Magenta",
+            6: "Cyan",
+            7: "White",
+            128: "Blink",
+            129: "RedBlink",
+            130: "GreenBlink",
+            131: "YellowBlink",
+            132: "BlueBlink",
+            133: "MagentaBlink",
+            134: "CyanBlink",
+            135: "WhiteBlink",
+        }
+        return names.get(self.value, "Unknown")
+
+    def __str__(self) -> str:
+        return f"{self.name_en} ({self.value})"
+
+
+class CellStatus(IntEnum):
+    """储位状态枚举"""
+
+    EMPTY = 0  # 空
+    HOLD = 1  # 非空
+    LOCKED = 2  # 预定状态
+    TAKE_OUT = 3  # 已取料
+    CHECKED = 4  # 已复核
+    MOVE = 5  # 移库已取出
+
+    ILLEGAL_TAKE_OUT = -3  # 非法取料
+    ILLEGAL_TAKE_IN = -2  # 非法上料
+    DISABLED = -1  # 禁用储位
+
+    @classmethod
+    def from_value(cls, value: int) -> 'CellStatus':
+        """根据值获取枚举实例"""
+        try:
+            return cls(value)
+        except ValueError:
+            raise ValueError(f"Invalid CellStatus value: {value}")
+
+    @property
+    def name_en(self) -> str:
+        """获取英文名称"""
+        names = {
+            0: "Empty",
+            1: "Hold",
+            2: "Locked",
+            3: "TakeOut",
+            4: "Checked",
+            5: "Move",
+            -3: "IllegalTakeOut",
+            -2: "IllegalTakeIn",
+            -1: "Disabled",
+        }
+        return names.get(self.value, "Unknown")
+
+    def __str__(self) -> str:
+        return f"{self.name_en} ({self.value})"
+
+
+class RackTestMode(IntEnum):
+    """料架测试模式枚举"""
+
+    ALL_OFF = 0  # 全部灭灯
+    RGB_TEST = 1  # RGB测试
+    LIGHT_SEQUENCE_TEST = 2  # 灯序测试
+    WARNING_LIGHT_TEST = 3  # 警示灯测试
+    EMPTY_LIGHT = 4  # 空位亮灯
+    NON_EMPTY_LIGHT = 5  # 非空亮灯
+
+    @classmethod
+    def from_value(cls, value: int) -> 'RackTestMode':
+        """根据值获取枚举实例"""
+        try:
+            return cls(value)
+        except ValueError:
+            raise ValueError(f"Invalid RackTestMode value: {value}")
+
+    @property
+    def name_en(self) -> str:
+        """获取英文名称"""
+        names = {
+            0: "AllOff",
+            1: "RgbTest",
+            2: "LightSequenceTest",
+            3: "WarningLightTest",
+            4: "EmptyLight",
+            5: "NonEmptyLight",
+        }
+        return names.get(self.value, "Unknown")
+
+    def __str__(self) -> str:
+        return f"{self.name_en} ({self.value})"
+
+
+class OperationResultCode(IntEnum):
+    """操作结果代码枚举"""
+
+    SUCCESS = 0  # 操作成功
+    ILLEGAL_STOCK_IN = 2  # 非法上架
+    ILLEGAL_STOCK_OUT = 4  # 非法下架
+    ILLEGAL_STOCK_IN_CLEAR_ERROR = 8  # 非法上架清错
+    ILLEGAL_STOCK_OUT_CLEAR_ERROR = 16  # 非法下架清错
+
+    @classmethod
+    def from_value(cls, value: int) -> 'OperationResultCode':
+        """根据值获取枚举实例"""
+        try:
+            return cls(value)
+        except ValueError:
+            raise ValueError(f"Invalid OperationResultCode value: {value}")
+
+    @property
+    def name_en(self) -> str:
+        """获取英文名称"""
+        names = {
+            0: "Success",
+            2: "IllegalStockIn",
+            4: "IllegalStockOut",
+            8: "IllegalStockInClearError",
+            16: "IllegalStockOutClearError",
+        }
+        return names.get(self.value, "Unknown")
+
+    def __str__(self) -> str:
+        return f"{self.name_en} ({self.value})"
+
+
+class TriggerState(IntEnum):
+    """触发状态枚举"""
+
+    TAKE_OUT = 0  # 取出
+    PUT_IN = 1  # 放入
+
+    @classmethod
+    def from_value(cls, value: int) -> 'TriggerState':
+        """根据值获取枚举实例"""
+        try:
+            return cls(value)
+        except ValueError:
+            raise ValueError(f"Invalid TriggerState value: {value}")
+
+    @property
+    def name_en(self) -> str:
+        """获取英文名称"""
+        names = {
+            0: "TakeOut",
+            1: "PutIn",
+        }
+        return names.get(self.value, "Unknown")
+
+    def __str__(self) -> str:
+        return f"{self.name_en} ({self.value})"