枚举

此处定义了一些常量枚举

__all__ module-attribute

__all__ = ('MessageType', 'RetCode', 'MessageDataHead', 'StrengthOperationType', 'FeedbackButton', 'Channel')

MessageType

Bases: str, Enum

WebSocket 消息类型

Attributes:

Name	Type	Description
HEARTBEAT		心跳包数据
BIND		ID 关系绑定
MSG		波形下发/强度变化/队列清空等数据指令
BREAK		连接断开
ERROR		服务错误

HEARTBEAT class-attribute instance-attribute

HEARTBEAT = 'heartbeat'

BIND class-attribute instance-attribute

BIND = 'bind'

MSG class-attribute instance-attribute

MSG = 'msg'

BREAK class-attribute instance-attribute

BREAK = 'break'

ERROR class-attribute instance-attribute

ERROR = 'error'

RetCode

Bases: IntEnum

WebSocket 消息错误码枚举

Attributes:

Name	Type	Description
SUCCESS		成功
CLIENT_DISCONNECTED		对方客户端已断开
INVALID_CLIENT_ID		二维码中没有有效的 clientId
SERVER_DELAY		Socket 连接上了，但服务器迟迟不下发 App 端的 ID 来绑定
ID_ALREADY_BOUND		此 ID 已被其他客户端绑定关系
TARGET_CLIENT_NOT_FOUND		要绑定的目标客户端不存在
INCOMPATIBLE_RELATIONSHIP		收信方和寄信方不是绑定关系
NON_JSON_CONTENT		发送的内容不是标准 JSON 对象
RECIPIENT_NOT_FOUND		未找到收信人（离线）
MESSAGE_TOO_LONG		下发的 message 长度大于 1950
SERVER_INTERNAL_ERROR		服务器内部异常

SUCCESS class-attribute instance-attribute

SUCCESS = 200

CLIENT_DISCONNECTED class-attribute instance-attribute

CLIENT_DISCONNECTED = 209

INVALID_CLIENT_ID class-attribute instance-attribute

INVALID_CLIENT_ID = 210

SERVER_DELAY class-attribute instance-attribute

SERVER_DELAY = 211

ID_ALREADY_BOUND class-attribute instance-attribute

ID_ALREADY_BOUND = 400

TARGET_CLIENT_NOT_FOUND class-attribute instance-attribute

TARGET_CLIENT_NOT_FOUND = 401

INCOMPATIBLE_RELATIONSHIP class-attribute instance-attribute

INCOMPATIBLE_RELATIONSHIP = 402

NON_JSON_CONTENT class-attribute instance-attribute

NON_JSON_CONTENT = 403

RECIPIENT_NOT_FOUND class-attribute instance-attribute

RECIPIENT_NOT_FOUND = 404

MESSAGE_TOO_LONG class-attribute instance-attribute

MESSAGE_TOO_LONG = 405

SERVER_INTERNAL_ERROR class-attribute instance-attribute

SERVER_INTERNAL_ERROR = 500

MessageDataHead

Bases: str, Enum

WebSocket 消息数据开头部分

Attributes:

Name	Type	Description
TARGET_ID		Socket 通道与终端绑定
DG_LAB		关系绑定
STRENGTH		强度操作
PULSE		波形操作
CLEAR		清空波形队列
FEEDBACK		App 反馈

TARGET_ID class-attribute instance-attribute

TARGET_ID = 'targetId'

DG_LAB class-attribute instance-attribute

DG_LAB = 'DGLAB'

STRENGTH class-attribute instance-attribute

STRENGTH = 'strength'

PULSE class-attribute instance-attribute

PULSE = 'pulse'

CLEAR class-attribute instance-attribute

CLEAR = 'clear'

FEEDBACK class-attribute instance-attribute

FEEDBACK = 'feedback'

StrengthOperationType

Bases: IntEnum

强度变化模式

Attributes:

Name	Type	Description
DECREASE		通道强度减少
INCREASE		通道强度增加
SET_TO		通道强度变化为指定数值

DECREASE class-attribute instance-attribute

DECREASE = 0

INCREASE class-attribute instance-attribute

INCREASE = 1

SET_TO class-attribute instance-attribute

SET_TO = 2

FeedbackButton

Bases: IntEnum

App 反馈按钮

• A 通道 5 个按钮（从左至右）的角标为 0,1,2,3,4
• B 通道 5 个按钮（从左至右）的角标为 5,6,7,8,9

A1 class-attribute instance-attribute

A1 = 0

A2 class-attribute instance-attribute

A2 = 1

A3 class-attribute instance-attribute

A3 = 2

A4 class-attribute instance-attribute

A4 = 3

A5 class-attribute instance-attribute

A5 = 4

B1 class-attribute instance-attribute

B1 = 5

B2 class-attribute instance-attribute

B2 = 6

B3 class-attribute instance-attribute

B3 = 7

B4 class-attribute instance-attribute

B4 = 8

B5 class-attribute instance-attribute

B5 = 9

Channel

Bases: IntEnum

通道

Attributes:

Name	Type	Description
A		A 通道
B		B 通道

A class-attribute instance-attribute

A = 1

B class-attribute instance-attribute

B = 2