TgCloudCmd_internal.h

浏览该文件的文档.

/** \file TgCloudCmd_internal.h
 *
 * 内部命令，仅限SDK和App使用.
 */
 
#ifndef __TgCloudCmd_internal_h__
#define __TgCloudCmd_internal_h__
 
#include "basedef.h"
 
#define TCI_CMD_TELNET                 0x0004
typedef struct TcisSubControl {
    int subcmd;   ///< SUB_CTRL_xxx
    union unionSUBCMD {
#define SUB_CTRL_TELNET_OPEN   0
        //for resp: the encryption key of 16-bytes using to encrypt the data to send to remote
        uint8_t encrypt_key[16];
 
#define SUB_CTRL_TELNET_CLOSE  1
 
#define SUB_CTRL_TELNET_DATA     2   //data from/to telnetd
#define SUB_CTRL_FILE_BLOCK      8   //file block from/to app
#define SUB_CTRL_LAST_FILE_BLOCK 10  //last file block from/to app
        uint8_t data[1]; ///<
 
#define SUB_CTRL_PUT_FILE      4
        struct SUBCTRL_PUTFILE {
            uint32_t flen;
            uint8_t md5[16];
            char path[1];
        } __PACKED__ putfile;
 
#define SUB_CTRL_PUT_FILE_RESP 5
        int putfile_result; ///< 收到请求返回101, 开始发送文件。接收中或接收完发一次状态码(200:ok; >=500:error)
 
#define SUB_CTRL_GET_FILE      6
        struct SUBCTRL_GETFILE {
            char path[1];
        } __PACKED__ getfile;
 
#define SUB_CTRL_GET_FILE_RESP 7
        struct SUBCTRL_GETFILE_RESP {
            int status;  ///< error flag
            int flen;  ///< status=0; >=0: length of file; -1:chucked
            uint8_t md5[16];
        } __PACKED__ getfileresp;
    } u;
 
} __PACKED__ TcisSubControl;
 
 
#define TCI_CMD_GET_MEDIAINFO          0x01FC ///< req: Tcis_GetMediaInfo; resp Tcis_MediaInfo
//定义在 TgCloudCmdEx.h
//#define   TCI_CMD_VIDEOSTART              0x01FF ///< WARNING: 命令为奇数
//#define   TCI_CMD_VIDEOSTOP               0x02FF ///< WARNING: 命令为奇数
//#define   TCI_CMD_AUDIOSTART              0x0300
//#define   TCI_CMD_AUDIOSTOP               0x0301 ///< WARNING: 命令为奇数
 
/** 呼叫设备，等待用户应答. 
 * 需要发送正应答后才才能拉流和对讲.
 *
 * req: Tcis_CallReq; resp: 要以 @ref extended_general_response "扩展的通用状态应答" 方式返回 Tcis_CallResp
 *
 * 接听后设备端挂断通话(TciHangup()), App会在命令通道上收到 @ref RTM_GOINGTO_SLEEP 消息.
 * App挂断在TCI_CMD_ANSWERCALL 命令里发送 CALLSTATE_HANGUP 状态.
 *
 * 访问端要在新连接上执行呼叫, 通话结束或呼叫失败都要关掉连接.
 *
 * 能力描述: 在 @ref Feature_Profile 中加入 \c Callee  属性
 */
#define TCI_CMD_CALL                    0x0302
 
 
#define TCI_CMD_TESTSPEED               0x0200
//#define TCI_CMD_TESTSPEED_DATA          0x0201
 
 
#define TCI_CMD_SPEAKERSTART            0x0350
#define TCI_CMD_SPEAKERSTOP             0x0351 ///< WARNING: 这个命令值为奇数
#define TCI_CMD_START_TALK              0x0332 ///< 代替 TCI_CMD_SPEAKERSTART
 
#define TCI_CMD_SETSTREAMCTRL_REQ       0x0320
#define TCI_CMD_SETSTREAMCTRL_RESP      0x0321
#define TCI_CMD_GETSTREAMCTRL_REQ       0x0322
#define TCI_CMD_GETSTREAMCTRL_RESP      0x0323
 
#define TCI_CMD_DEVINFO_REQ             0x0330
#define TCI_CMD_DEVINFO_RESP            0x0331
 
#define TCI_CMD_ENTER_SETUP             0x0338  ///< 进入设置页. 无参数无应答
#define TCI_CMD_LEAVE_SETUP             0x0336  ///< 离开设置页. 无参数无应答
 
/** @struct Tcis_AVStream
   TCI_CMD_VIDEOSTART               = 0x01FF,
   TCI_CMD_VIDEOSTOP                    = 0x02FF,
   TCI_CMD_AUDIOSTART           = 0x0300,
   TCI_CMD_AUDIOSTOP            = 0x0301,
   TCI_CMD_SPEAKERSTART             = 0x0350,
   TCI_CMD_SPEAKERSTOP          = 0x0351,
   TCI_CMD_START_TALK              0x0332 //代替 TCI_CMD_SPEAKERSTART
 */
 
__BEGIN_PACKED__
 
typedef struct
{
    unsigned int avIndex; ///< avIndex
    unsigned int channel; ///< Camera Index
} __PACKED__ Tcis_AVStream;
 
#if 0
/** @struct Tcis_GetStreamCtrlReq
   TCI_CMD_GETSTREAMCTRL_REQ        = 0x0322,
 */
typedef struct
{
    unsigned int channel;   ///< Camera Index
    unsigned char reserved[4];
} __PACKED__ Tcis_GetStreamCtrlReq;
#endif
 
typedef struct Tcis_GetMediaInfo {
    int type;  ///< 0: get type
    int dummy;
} __PACKED__ Tcis_GetMediaInfo;
 
typedef struct Tcis_MediaInfo {
    int type;
    union {
        struct {
            int n_achn;
            int n_vchn, n_streams_per_vchn;
            unsigned char types[32];
        } mt;
    } u;
} __PACKED__ Tcis_MediaInfo;
 
/** 视频质量表示*/
typedef enum  ENUM_QUALITY_LEVEL
{
    TCIC_QUALITY_AUTO               = 0x00,  ///< 自适应码流(需要设备支持 @ref Feature_Resolutions)
    TCIC_QUALITY_MAX                = 0x01,  ///< 最高质量
    TCIC_QUALITY_HIGH               = 0x02,
    TCIC_QUALITY_MIDDLE             = 0x03,
    TCIC_QUALITY_LOW                = 0x04,
    TCIC_QUALITY_MIN                = 0x05,  ///< 最低质量
} ENUM_QUALITY_LEVEL;
 
/**
   TCI_CMD_SETSTREAMCTRL_REQ        = 0x0320,
   TCI_CMD_GETSTREAMCTRL_RESP   = 0x0323,
 * @struct Tcis_SetStreamCtrlReq, @struct Tcis_GetStreamCtrlResp
 */
typedef struct
{
    unsigned int  channel;  ///< Camera Index
    unsigned char quality;  //refer to @ref ENUM_QUALITY_LEVEL
    unsigned char reserved[3];
} __PACKED__ Tcis_SetStreamCtrlReq, Tcis_GetStreamCtrlResp;
 
/** @struct Tcis_SetStreamCtrlResp
   TCI_CMD_SETSTREAMCTRL_RESP   = 0x0321,
 */
typedef struct
{
    int result; ///< 0: success; otherwise: failed.
    unsigned char reserved[4];
} __PACKED__ Tcis_SetStreamCtrlResp;
 
/** @struct Tcis_GetRecordReq
   TCI_CMD_GETRECORD_REQ            = 0x0312,
 */
typedef struct
{
    unsigned int channel; ///< Camera Index
    unsigned char reserved[4];
} __PACKED__ Tcis_GetRecordReq;
 
/** @struct Tcis_DeviceInfoReq
   TCI_CMD_DEVINFO_REQ          = 0x0330,
 */
typedef struct
{
    unsigned char reserved[4];
} __PACKED__ Tcis_DeviceInfoReq;
 
 
/** @struct Tcis_DeviceInfoResp
   TCI_CMD_DEVINFO_RESP         = 0x0331,
 */
typedef struct
{
    char model[16];     ///< IPCam mode
    char vendor[16];    ///< IPCam manufacturer
    unsigned int version;       ///< IPCam firmware version ex. v1.2.3.4 => 0x01020304;  v1.0.0.2 => 0x01000002
    unsigned int channel;       ///< Camera index
    unsigned int total;         ///< 0: No cards been detected or an unrecognizeable sdcard that could not be re-formatted.
    ///< -1: if camera detect an unrecognizable sdcard, and could be re-formatted
    ///< otherwise: return total space size of sdcard (MBytes)                              
 
    unsigned int free;          ///< Free space size of sdcard (MBytes)
    unsigned char reserved[8];  ///< reserved
} __PACKED__ Tcis_DeviceInfoResp;
 
#define TCI_CMD_GETGPSINFO_REQ            0x0334
typedef struct Tcis_GetGpsInfoReq {
    int flags;     ///< 0: Request/Answer方式取一次, 忽略avIndex; 
                   ///< 1: 流式，在avIndex通道上发送. 暂时只支持R/A方式
 
    int avIndex;   ///< flags==1时为流式发送的p2p通道
} __PACKED__ Tcis_GetGpsInfoReq;
 
 
#define TCI_CMD_GETGPSINFO_RESP           0x0335
/** gps information */
typedef struct TcisGpsInfo {
    uint32_t time;                   ///< 采集时间，utc
    uint32_t signal_strength;        ///< 0-未知; 1-弱; 2-一般; 3-强
    double   longitude, latitude;    ///< 经/纬度
    double   speed;                  ///< 速度: km/h
    int32_t  angle;                  ///< 相对于正北的方位角(度): 0~359
} __PACKED__ TcisGpsInfo;
typedef struct TcisGpsInfo Tcis_GetGpsInfoResp;
 
#define TCI_CMD_PASSWORD_REQ        0X8002
typedef struct Tcis_ExPassWordReq
{
    STimeDay    livetime;           ///< 配网时清0. AP直连时设为手机的时间
    char          password[48];
    unsigned char reserved[4];
    char        timezone[0];        ///< 结构长度大于60时存在timezone成员。以'\0'结尾
} __PACKED__ Tcis_ExPassWordReq;
 
#define TCI_CMD_PASSWORD_RESP       0x8003
typedef struct  {
    unsigned int result;                //0 pass -1 no pass
    unsigned char reserved[4];
} __PACKED__ Tcis_ExPassWordResp;
 
#define TCI_CMD_SETPASSWORD_REQ         0x8004
/** 设置直连模式密码请求参数结构体.
  @ref TCI_CMD_SETPASSWORD_REQ        = 0x8004,
  */
typedef struct
{
    char oldpasswd[32];            ///< The old security code
    char newpasswd[32];            ///< The new security code
} __PACKED__ Tcis_SetPasswdReq;
 
 
#define TCI_CMD_APLINK_SETWIFI_REQ      0X8006
//req: _TG_IPC_REGISTER_INFO_AP;
#define TCI_CMD_APLINK_SETWIFI_RESP     0X8007 //resp: Tcis_SetWifiResp;
#if 0 //defined in TgCloudCmd.h
typedef struct Tcis_SetWifiResp {
    int result;                 ///< 0: wifi connected; 1: failed to connect
    unsigned char reserved[4];
} __PACKED__ Tcis_SetWifiResp;
#endif
 
#define TCI_CMD_AP_PREVIEW_REQ      0X8008
typedef struct Tcis_ExApPreviewReq {    
    unsigned int  option;
    char account[48];
    char password[48];
    unsigned char reserved[4];
} __PACKED__ Tcis_ExApPreviewReq;
 
#define TCI_CMD_AP_PREVIEW_RESP     0x8009
 
typedef struct Tcis_ExApPreviewResp {
    unsigned int result;                ///< 1: pass , !1: no pass
    unsigned char reserved[4];
} __PACKED__ Tcis_ExApPreviewResp;
 
 
 
/***************** 查询设备硬件能力 **************/
#define TCI_CMD_GET_FEATURE_REQ     0x8024
typedef struct {
    char feature[4];                ///< Ignored. No parameters required
} __PACKED__ Tcis_GetFeatureReq;
 
#define TCI_CMD_GET_FEATURE_RESP    0x8025
typedef struct {
    char feature[1];             ///< json string of features
} __PACKED__ Tcis_GetFeatureResp;
 
#define TCI_CMD_SET_CLOUD_VIDEO_QUALITY_REQ    0x8028
typedef struct
{
    unsigned int channel;   ///< Camera Index
    unsigned int quality;   ///< 0: HD; 1: SD
    unsigned char reserved[4];
} __PACKED__ Tcis_SetCloudVideoQualityReq;
 
#define TCI_CMD_SET_CLOUD_VIDEO_QUALITY_RESP   0x8029
typedef struct
{
    unsigned int result;                ///< 1 ok , !1  no ok
    unsigned char reserved[4];          ///< reserved, all zeros
} Tcis_SetCloudVideoQualityResp;
 
 
/** request of TCI_CMD_CALL */
typedef
struct Tcis_CallReq {
    int  call;     ///< 1:call; 0:cancel
    //以下成员在 call==1 时才需要
    int  flavor;   ///< @ref ECALLFLAVOR
    /** null 结束的字符串, 长度不限.  \n
     *  如果是普通字符串，内容为呼叫都标志; 如果是json格式(以'{'开头)，内容由通话双方自定义
     */
    char name[36];
} __PACKED__ Tcis_CallReq;
 
/** 呼叫响应码 */
typedef enum {
    CRC_BUSY = -2,         ///< 占线
    CRC_MISSED = -1,       ///< 无人接听
    CRC_REJECT = 0,        ///< 拒接
    CRC_FLAVOR_VOICE = 1,  ///< 语音通话
    CRC_FLAVOR_VIDEO = 2   ///< 视频通话
} ECALLRESPCODE;
 
/** response of TCI_CMD_CALL.
 * 本响应必须通过 @ref extended_general_response "扩展通用状态应答" 的方式返回.
 */
typedef struct Tcis_CallResp {
    /** 参见 @ref ECALLRESPCODE. */
    int status;
    int reserved; ///< 0
} __PACKED__ Tcis_CallResp;
 
__END_PACKED__
#endif