Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | List of all members
pdumodel::Ade Interface Reference

Interface for ADE chips directly connected to main controller. More...

Classes

struct  MetaData
 ADE metadata. More...
 
struct  Sample
 Raw sample data for a single channel. More...
 

Public Types

typedef map< string, long > RegisterMap
 Map of ADE register values. More...
 

Public Member Functions

MetaData getMetaData ()
 Retrieve the ADE metadata. More...
 
vector< SamplegetLatestSample ()
 Retrieve the latest raw samples. More...
 
RegisterMap getCalibrationData ()
 Retrieve the values of all supported calibration registers. More...
 
int setCalibrationData (in RegisterMap regs)
 Set new values for some or all calibration registers. More...
 

Detailed Description

Interface for ADE chips directly connected to main controller.

Definition at line 15 of file Ade.idl.

Member Typedef Documentation

◆ RegisterMap

typedef map<string, long> pdumodel::Ade::RegisterMap

Map of ADE register values.

Definition at line 37 of file Ade.idl.

Member Function Documentation

◆ getCalibrationData()

RegisterMap pdumodel::Ade::getCalibrationData ( )

Retrieve the values of all supported calibration registers.

Returns
Map of calibration register values

◆ getLatestSample()

vector< Sample > pdumodel::Ade::getLatestSample ( )

Retrieve the latest raw samples.

Returns
Vector of samples, one for each channel

◆ getMetaData()

MetaData pdumodel::Ade::getMetaData ( )

Retrieve the ADE metadata.

Returns
ADE metadata

◆ setCalibrationData()

int pdumodel::Ade::setCalibrationData ( in RegisterMap  regs)

Set new values for some or all calibration registers.

Note
This command is only available during manufacturing!
Parameters
regsMap of new calibration register values
Returns
0 if OK
1 if any parameters are invalid
2 if the device is not in factory configuration mode

The documentation for this interface was generated from the following file: