//========================================================================================
// @file   BioIdentifyMsg.proto
// @brief  生物识别服务（app_bio_identify_srv）相关的消息
// @author yikenan
//========================================================================================

syntax="proto2";
package iot_idl;

// 用到了SVariable
// import "Public.proto";

// 缩写说明：
//< APP  : Application 应用程序，比如HMI
//< BIS  : Biological Identification Server，即生物识别服务
//< Srv  : Service 服务
//< ID   : Identification 认证


//========================================================================================
// 消息类型枚举
//========================================================================================
enum EnBisMsgType
{
    //< APP->SRV，向服务端请求开启认证，发往本域
    //< 消息内容：固定为"BIS"，用作正确性校验，其他内容不认
    MT_BIS_START_ID_REQ = 1;

    //< SRV->APP，服务端回复开启认证结果，点对点回复
    //< 消息总线消息的 Para1 为0表示成功，其他表示失败，暂不定义错误码体系
    //< 消息内容：错误时有效，错误文本，可展示给用户
    MT_BIS_START_ID_REP = 2;

    //< SRV->APP，认证结果，点对点回复
    //< 消息总线消息的 Para1 为0表示成功，其他表示失败，暂不定义错误码体系
    //< 消息内容：
    //<         成功：见下方 SBisIdResult 消息
    //<         失败：错误文本，可展示给用户
    MT_BIS_ID_RESULT = 3;

    //< APP->SRV，向服务端取消认证，发往本域。在识别过程中，当客户端主动取消时，需发送本消息，
    //< 否则，服务端将在超时时间（30s）后才停止认证，在此期间此设备不接受再开启认证，服务端会返回设备被占用。
    //< 收到 MT_BIS_ID_RESULT 后认证已完成，可以不需要发送本消息进行取消，发送了也没关系。
    //< 消息内容：固定为"BIS"，用作正确性校验，其他内容不认
    MT_BIS_CANCEL_ID = 4;
};

//========================================================================================
// 认证结果信息
//========================================================================================
message SBisIdResult
{
    required  int32     user_id          =1;  // 通过认证的用户ID
    required  string    acs_dev_tag      =2;  // ACS设备Tag，即用户是通过此设备认证的
    optional  bytes     pic_data         =3;  // 认证时抓拍的照片，二进制数据
}