USB2XXX 1.2
USB2XXX接口函数说明文档
载入中...
搜索中...
未找到
结构体 | 函数
USB转UCAN

USB转UCAN接口函数和数据类型定义 更多...

结构体

struct  UCAN_CONFIG
 UCAN初始化结构体定义 更多...
 
struct  UCAN_MSG
 适用于ELMOS芯片的UCAN帧结构体定义 更多...
 
struct  UCAN_RAW_MSG
 通用的UCAN数据结构体定义 更多...
 

函数

int WINAPI UCAN_Init (int DevHandle, unsigned char UCANIndex, UCAN_CONFIG *pConfig)
 初始化UCAN总线，使用UCAN功能时必须调用 更多...
 
int WINAPI UCAN_MasterStartSch (int DevHandle, unsigned char UCANIndex, UCAN_MSG *pMsg, unsigned int MsgLen, unsigned int SendTimes, unsigned char ReadBackFlag)
 执行UCAN帧调度表，可以使用该函数实现发送数据或者读取数据 更多...
 
int WINAPI UCAN_MasterStopSch (int DevHandle, unsigned char UCANIndex)
 停止执行调度表 更多...
 
int WINAPI UCAN_Stop (int DevHandle, unsigned char UCANIndex)
 停止UCAN总线，调用该函数后盖总线无法继续使用，需要继续使用需要重新调用 UCAN_Init 函数对总线进行初始化 更多...
 
int WINAPI UCAN_GetRawMsg (int DevHandle, unsigned char UCANIndex, UCAN_RAW_MSG *pUCANRawMsg, int BufferSize)
 获取UCAN原始数据 更多...
 
long long WINAPI UCAN_GetStartTime (int DevHandle, unsigned char UCANIndex)
 获取CAN起始时间戳，该时间戳可以转换成实际的时间 更多...
 
int WINAPI UCAN_ResetStartTime (int DevHandle, unsigned char UCANIndex)
 复位时间戳，复位后起始时间戳为当前时间 更多...
 
int WINAPI UCAN_SetStartTime (int DevHandle, unsigned char UCANIndex, long long StartTimeMs)
 设置数据起始时间戳，主要用于将数据时间戳转换成实时时间用 更多...
 

函数返回错误值宏定义

函数调用出错后返回值定义

#define UCAN_SUCCESS   (0)
 函数执行成功
 
#define UCAN_ERR_NOT_SUPPORT   (-1)
 适配器不支持该函数
 
#define UCAN_ERR_USB_WRITE_FAIL   (-2)
 USB写数据失败
 
#define UCAN_ERR_USB_READ_FAIL   (-3)
 USB读数据失败
 
#define UCAN_ERR_CMD_FAIL   (-4)
 命令执行失败
 
#define UCAN_ERR_PARAMETER   (-5)
 参数错误
 

详细描述

USB转UCAN接口函数和数据类型定义

函数说明

◆ UCAN_Init()

int WINAPI UCAN_Init ( int  DevHandle,
unsigned char  UCANIndex,
UCAN_CONFIG *  pConfig 
)

初始化UCAN总线，使用UCAN功能时必须调用

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
UCANIndexCAN通道号，0-CAN1，1-CAN2
[in]pConfigUCAN初始化相关参数，具体可以参考 UCAN_CONFIG
返回
函数执行状态
返回值
=0函数执行成功
<0函数调用失败

◆ UCAN_MasterStartSch()

int WINAPI UCAN_MasterStartSch ( int  DevHandle,
unsigned char  UCANIndex,
UCAN_MSG *  pMsg,
unsigned int  MsgLen,
unsigned int  SendTimes,
unsigned char  ReadBackFlag 
)

执行UCAN帧调度表，可以使用该函数实现发送数据或者读取数据

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
IndexUCAN通道号，0-CAN1，1-CAN2
pMsg待发送的调度表帧数组
MsgLen待发送的调度表帧数
SendTimes调度表里面的帧数据循环发送次数，若设置为0xFFFFFFFF则会循环执行，直到调用 UCAN_MasterStopSch 函数为止
ReadBackFlag回读调度表执行帧标志，0-不回读，1-底层会存储调度表发送的帧到数据缓冲区，通过调用 UCAN_GetMsg 函数可以获取到调度表发送的帧数据
返回
函数执行状态
返回值
0函数调用成功
<0函数调用失败

◆ UCAN_MasterStopSch()

int WINAPI UCAN_MasterStopSch ( int  DevHandle,
unsigned char  UCANIndex 
)

停止执行调度表

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
IndexUCAN通道号，0-CAN1，1-CAN2
返回
函数执行状态
返回值
0函数调用成功
<0函数调用失败

◆ UCAN_Stop()

int WINAPI UCAN_Stop ( int  DevHandle,
unsigned char  UCANIndex 
)

停止UCAN总线，调用该函数后盖总线无法继续使用，需要继续使用需要重新调用 UCAN_Init 函数对总线进行初始化

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
IndexUCAN通道号，0-CAN1，1-CAN2
返回
函数执行状态
返回值
0函数调用成功
<0函数调用失败

◆ UCAN_GetRawMsg()

int WINAPI UCAN_GetRawMsg ( int  DevHandle,
unsigned char  UCANIndex,
UCAN_RAW_MSG *  pUCANRawMsg,
int  BufferSize 
)

获取UCAN原始数据

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
UCANIndexCAN通道号，0-CAN1，1-CAN2
[out]pUCANRawMsg存储UCAN消息数据缓冲区指针，若想单次获取较多的数据，可以把缓冲区设置大点
BufferSizeUCAN消息缓冲区大小
返回
函数执行状态
返回值
=0函数执行成功
<0函数调用失败

◆ UCAN_GetStartTime()

long long WINAPI UCAN_GetStartTime ( int  DevHandle,
unsigned char  UCANIndex 
)

获取CAN起始时间戳，该时间戳可以转换成实际的时间

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
UCANIndexCAN通道号，0-CAN1，1-CAN2
返回
CAN起始时间戳
返回值
<0函数调用失败

◆ UCAN_ResetStartTime()

int WINAPI UCAN_ResetStartTime ( int  DevHandle,
unsigned char  UCANIndex 
)

复位时间戳，复位后起始时间戳为当前时间

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
UCANIndexCAN通道号，0-CAN1，1-CAN2
返回
函数执行状态
返回值
<0函数调用失败

◆ UCAN_SetStartTime()

int WINAPI UCAN_SetStartTime ( int  DevHandle,
unsigned char  UCANIndex,
long long  StartTimeMs 
)

设置数据起始时间戳，主要用于将数据时间戳转换成实时时间用

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
UCANIndexCAN通道号，0-CAN1，1-CAN2
StartTimeMs开始记录数据的起始时间戳，该时间戳为实时时间戳
返回
函数执行状态
返回值
<0函数调用失败
制作者 doxygen 1.9.5