22 m1x22_clearvoltageiet, 23 m1x22_startmeasurecurrent, M1x22_clearvoltageiet – Maxim Integrated 73M1822/73M1922 Modem API User Manual

Page 19: M1x22_startmeasurecurrent

Advertising
background image

UG_1x22_055

73M1822/73M1922 Modem API User Guide

Rev. 1.0

19

2.22 M1X22_ClearVoltageIET

Description

Delete the line voltage IET table entry.

Prototype

int M1X22_ClearVoltageIET (

M1X22_HANDLE channel,
unsigned int ietIndex);


Parameters

Data Type

Name

Description

M1X22_HANDLE

channel

Channel handle obtained from open channel.

unsigned int

ietIndex

IET entry index – row number (0 – 9).

Return Values

Data Type

Description

M1X22_RET

M1X22_SUCCESS – Successfully clear the IET entry.
M1X22_FAILED – Failure.

2.23 M1X22_StartMeasureCurrent

Description

Start the line current measurement process. This API starts measuring the line current of the specified
channel at a sampling interval time of “sampleTime” with averaging count of “averageSampleCount”.

Prototype

int M1X22_StartMeasureCurrent (

M1X22_HANDLE channel,
unsigned int sampleTime,
unsigned int averageSampleCount );


Parameters

Data Type

Name

Description

M1X22_HANDLE

channel

Channel handle obtained from open channel.

unsigned int

sampleTime

Time interval between two consecutive samples.

unsigned int

averageSampleCount Sample count for average calculation.


Return Values

Data Type

Description

M1X22_RET

M1X22_SUCCESS – Successfully started.
M1X22_FAILED – Failure.


Advertising