有线适配接口

本文介绍了综合 SDK 的有线适配接口。

结构体定义

NW_IP_S

typedef struct
{
    char ip[16];
    char mask[16];
    char gw[16];
} NW_IP_S;

功能说明(Summary)

IP 地址信息结构体。

成员说明

成员名称	说明
ip	网络接口的 IP 地址
mask	网络接口的子网掩码
gw	网络接口的默认网关

NW_MAC_S

typedef struct
{
    uint8_t mac[TY_MAC_ADDR_LEN];
}NW_MAC_S;

功能说明(Summary)

MAC 地址信息结构体。

成员说明

成员名称	说明
mac	MAC 地址，去掉 “:” 按字节存储

接口说明

tuya_adapter_wired_get_ip

OPERATE_RET tuya_adapter_wired_get_ip(OUT NW_IP_S *ip)

功能说明

获取有线网络接口的 IP 地址。

参数说明

参数名称	说明
ip	IP 信息结构体。详见 NW_IP_S。

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

tuya_adapter_wired_station_conn

BOOL_T tuya_adapter_wired_station_conn(VOID)

功能说明

获取有线连接状态。

参数说明

参数名称	说明
VOID

返回值

返回值	说明
TRUE	有线已连接。
FALSE	有线未连接。

tuya_adapter_wired_get_mac

OPERATE_RET tuya_adapter_wired_get_mac(OUT NW_MAC_S *mac)

功能说明

获取有线网络接口的 MAC 地址，为预留接口，无需实现。

参数说明

参数名称	说明
mac	MAC 地址信息结构体，详见 NW_MAC_S

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

tuya_adapter_wired_set_mac

OPERATE_RET tuya_adapter_wired_set_mac(IN CONST NW_MAC_S *mac)

功能说明

设置有线网络接口 MAC 地址，为预留接口，无需实现。

参数说明

参数名称	说明
mac	MAC 地址信息结构体，详见 NW_MAC_S

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

tuya_adapter_wired_if_connect_internet

OPERATE_RET tuya_adapter_wired_if_connect_internet(IN CONST CHAR_T *ssid, 
                                                   IN CONST CHAR_T *passwd)

功能说明

连接路由器接口，仅在有线 + 无线 SDK 有效，并且该接口的前置条件是 tuya_adapter_wired_wifi_need_cfg 接口返回 TRUE。为预留接口，无需实现。

参数说明

参数名称	说明
ssid	路由器的 SSID。
password	路由器的密码。

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

tuya_adapter_wired_wifi_need_cfg

BOOL_T tuya_adapter_wired_wifi_need_cfg(VOID)

功能说明

设置是否支持无线连接，仅在有线 + 无线 SDK 有效。为预留接口，无需实现。

参数说明

参数名称	说明
VOID

返回值

返回值	说明
TRUE	支持无线连接。
FALSE	不支持无线连接。

tuya_adapter_wired_wifi_station_get_conn_ap_rssi

OPERATE_RET tuya_adapter_wired_wifi_station_get_conn_ap_rssi(OUT SCHAR_T *rssi)

功能说明

获取无线信号强度接口，仅在有线+无线 SDK 有效，并且当前是无线连接时，才通过该接口获取无线信号强度。

参数说明

参数名称	说明
rssi	把获取到信号强度存到该变量。

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

tuya_adapter_wired_get_nw_stat

OPERATE_RET tuya_adapter_wired_get_nw_stat(GW_BASE_NW_STAT_T *stat)

功能说明

获取网络状态，为预留接口，无需实现。

参数说明

参数名称	说明
status	网络状态，定义： GB_STAT_LAN_UNCONN：有线未连接。 GB_STAT_LAN_CONN：有线已连接，但 MQTT 未连接。 GB_STAT_CLOUD_CONN：有线已连接，且 MQTT 已连接。

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h