DioGetPwmStatus

Function

Retrieves the PWM status for the specified channel.

Format

Ret = DioGetPwmStatus( Id , ChNo , ChNum , Status , Error)

Parameters

Id [ VB.NET： Short ] [ C, C++： short ] [ C#： short ] [ Python: ctypes.c_short ]
Specify the device ID retrieved from DioInit.

ChNo [ VB.NET： Short ] [ C, C++： short * ] [ C#： out short ] [ Python: ctypes.POINTER(ctypes.c_short) ]
Specify the start address of the array that stores the channel numbers to retrieve the PWM status.

ChNum [ VB.NET： Short ] [ C, C++： short ] [ C#： short ] [ Python: ctypes.c_short ]
Specify the number of channels specified in ChNo.

Status [ VB.NET： UShort ] [ C, C++： unsigned short * ] [ C#： out ushort ] [ Python: ctypes.POINTER(ctypes.c_ushort) ]
Specify the start address of the array that stores the PWM status.

Bit

Description

Value

0

PWM operation status

0: PWM stopped
1: PWM operation

15:1

Reserved

-

Error [ VB.NET： UShort ] [ C, C++： unsigned short * ] [ C#： out ushort ] [ Python: ctypes.POINTER(ctypes.c_ushort) ]
(Reserved)

Return Value

Ret [ VB.NET： Integer ] [ C, C++： long ] [ C#： int ] [ Python: ctypes.c_long ]

Definition

Value

[Dec]

Description

DIO_ERR_SUCCESS

0

Normal completed.

DIO_ERR_SYS_RECOVERED_FROM_STANDBY

7

Execute DioResetDevice function because the device has recovered from standby mode.

DIO_ERR_DLL_INVALID_ID

10001

Invalid ID specified.

DIO_ERR_DLL_CALL_DRIVER

10002

Not call the driver (Failure on DEVICE I/O CONTROL).

DIO_ERR_DLL_BUFF_ADDRESS

10100

Invalid data buffer address.

DIO_ERR_SYS_NOT_SUPPORTED

20001

This board couldn't use this function.

DIO_ERR_SYS_CH_NO

20105

Channel No. is outside the setting range.

DIO_ERR_SYS_CH_NUM

20106

Channel number is outside the setting range.

DIO_ERR_SYS_DEVICE_ERR_DRIVER_IC_ERR

21200

Driver IC error occurred.

DIO_ERR_SYS_DEVICE_ERR_PCOM_FAILURE

21201

PCOM power failure occurred.

The others (See also: Details of Error Code)

Example

Retrieve the PWM status for Channel 0 and Channel 1.

VB.NET

Dim Ret As Integer
Dim ChNo(1) As Short
Dim Status(1) As UShort
Dim Error(1) As UShort

ChNo(0) = 0
ChNo(1) = 1
Ret = DioGetPwmStatus( Id , ChNo , 2 , Status , Error)
 

C, C++

long Ret;
short ChNo[2]
unsigned short Status[2];
unsigned short Error[2];

ChNo[0] = 0;
ChNo[1] = 1;
Ret = DioGetPwmStatus( Id , &ChNo[0] , 2 , &Status[0] , &Error[0] );
 

C#

int Ret;
short[] ChNo = new short[2];
uint[] Status= new uint[2];

ChNo[0] = 0;
ChNo[1] = 1;
Ret = dio.GetPwmStatus( Id , out ChNo , 2 , out Status , out Error );
 

Python

Ret = ctypes.c_long()
ChNoType = ctypes.c_short * 2
ChNo = ChNoType()
StatusType = ctypes.c_ulong * 2
Status = StatusType()

ChNo[0] = 0
ChNo[1] = 1
Ret.value = cdio.DioGetPwmStatus( Id , ChNo , 2 , Status , Error )
 

See Also

PWM function