STPM3x

java.lang.Object
- com.iotize.jvm.utilities.STPM3x

Direct Known Subclasses:: STPM32_W6

public abstract class STPM3x
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`debug`
`static byte`	`DFE_CR1_0`
`static byte`	`DFE_CR1_1`
`static byte`	`DFE_CR2_0`
`static byte`	`DFE_CR2_1`
`static byte`	`DSP_CR10`
`static byte`	`DSP_CR11`
`static byte`	`DSP_CR12`
`static byte`	`DSP_CR3_0`
`static byte`	`DSP_CR3_1`
`static byte`	`DSP_CR4`
`static byte`	`DSP_CR5`
`static byte`	`DSP_CR6`
`static byte`	`DSP_CR7`
`static byte`	`DSP_CR8`
`static byte`	`DSP_CR9`
`static byte`	`DSP_REG1`
`static byte`	`DSP_REG14`
`static byte`	`DSP_REG15`
`static byte`	`DSP_REG16`
`static byte`	`DSP_REG17`
`static byte`	`DSP_REG18`
`static byte`	`DSP_REG19`
`static byte`	`DSP_SR1`
`static byte`	`DSP_SR2`
`static byte`	`DUMMY`
`boolean`	`firstReadEnergy`
`static int`	`FRAME_LENGTH_WITH_CRC`
`static int`	`MD_CURRENT`
`static int`	`MD_VOLTAGE`
`static byte`	`NULL`
`static int`	`OFFSET_POWER`
`protected int`	`overflowCounter`
`static byte`	`PH1_REG1`
`static byte`	`PH1_REG5`
`static byte`	`PH2_REG1`
`static byte`	`PH2_REG5`
`static byte`	`POWER_REGISTER`
`static int`	`RET_KO`
`static int`	`RET_OK`
`protected Spi`	`spi`
`static int`	`SPI_DEFAULT_FREQUENCY`
`static int`	`SPI_DEFAULT_MODE`
`static int`	`SPI_DEFAULT_TIMEOUT`
`static int`	`SPI_DEFAULT_USE_CS`
`long[]`	`totalEnergy`

Constructor Summary

Constructors
Constructor and Description

STPM3x()

Constructors
Constructor and Description
`STPM3x()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract float`	`calcCurrent(int value)` Returns current in A.
`abstract double`	`calcEnergy(double value)` Returns Energy in Ws.
`abstract float`	`calcPower(int value)` Returns power in W.
`int`	`calculateAndPutCRC(byte[] buffer)`
`abstract float`	`calcVoltage(int value)` Returns voltage in V.
`void`	`calibration()`
`protected void`	`debugLog(java.lang.String message)`
`int`	`extendSign(int bitsize, int val)`
`float`	`getCurrent(int chan)`
`double`	`getEnergy(int chan)`
`float`	`getPeriod(int chan)`
`float`	`getPhase(int chan)`
`float`	`getPower(int chan)`
`float`	`getVoltage(int chan)`
`void`	`initSequence()` Default initialization sequence of the STPM3x
`int`	`readRegister(byte address)`
`void`	`reset()`
`void`	`resetSequence()` Default reset sequence of the STPM3x sensor.
`byte[]`	`sendFrame(byte readAddress, byte writeAddress, byte dataLSB, byte dataMSB)`
`void`	`setCalibration(short value, int chan, int mode)`
`abstract void`	`setChipSelectState(boolean enabled)`
`abstract void`	`setEnableState(boolean enabled)`
`abstract void`	`setSynchroState(boolean enabled)`
`int`	`startPowerAcquisition()`
`int`	`writeRegister16(byte address, short value)`
`int`	`writeRegister32(byte address, int value)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SPI_DEFAULT_FREQUENCY
```
public static final int SPI_DEFAULT_FREQUENCY
```
    See Also:
    
    Constant Field Values
  - SPI_DEFAULT_MODE
```
public static final int SPI_DEFAULT_MODE
```
    See Also:
    
    Constant Field Values
  - SPI_DEFAULT_USE_CS
```
public static final int SPI_DEFAULT_USE_CS
```
    See Also:
    
    Constant Field Values
  - SPI_DEFAULT_TIMEOUT
```
public static final int SPI_DEFAULT_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - FRAME_LENGTH_WITH_CRC
```
public static final int FRAME_LENGTH_WITH_CRC
```
    See Also:
    
    Constant Field Values
  - DUMMY
```
public static final byte DUMMY
```
    See Also:
    
    Constant Field Values
  - NULL
```
public static final byte NULL
```
    See Also:
    
    Constant Field Values
  - RET_OK
```
public static final int RET_OK
```
    See Also:
    
    Constant Field Values
  - RET_KO
```
public static final int RET_KO
```
    See Also:
    
    Constant Field Values
  - MD_VOLTAGE
```
public static final int MD_VOLTAGE
```
    See Also:
    
    Constant Field Values
  - MD_CURRENT
```
public static final int MD_CURRENT
```
    See Also:
    
    Constant Field Values
  - OFFSET_POWER
```
public static final int OFFSET_POWER
```
    See Also:
    
    Constant Field Values
  - POWER_REGISTER
```
public static final byte POWER_REGISTER
```
    See Also:
    
    Constant Field Values
  - DSP_CR3_0
```
public static final byte DSP_CR3_0
```
    See Also:
    
    Constant Field Values
  - DSP_CR3_1
```
public static final byte DSP_CR3_1
```
    See Also:
    
    Constant Field Values
  - PH1_REG1
```
public static final byte PH1_REG1
```
    See Also:
    
    Constant Field Values
  - PH2_REG1
```
public static final byte PH2_REG1
```
    See Also:
    
    Constant Field Values
  - PH1_REG5
```
public static final byte PH1_REG5
```
    See Also:
    
    Constant Field Values
  - PH2_REG5
```
public static final byte PH2_REG5
```
    See Also:
    
    Constant Field Values
  - DSP_REG1
```
public static final byte DSP_REG1
```
    See Also:
    
    Constant Field Values
  - DSP_REG14
```
public static final byte DSP_REG14
```
    See Also:
    
    Constant Field Values
  - DSP_REG15
```
public static final byte DSP_REG15
```
    See Also:
    
    Constant Field Values
  - DSP_REG16
```
public static final byte DSP_REG16
```
    See Also:
    
    Constant Field Values
  - DSP_REG17
```
public static final byte DSP_REG17
```
    See Also:
    
    Constant Field Values
  - DSP_REG18
```
public static final byte DSP_REG18
```
    See Also:
    
    Constant Field Values
  - DSP_REG19
```
public static final byte DSP_REG19
```
    See Also:
    
    Constant Field Values
  - DFE_CR1_0
```
public static final byte DFE_CR1_0
```
    See Also:
    
    Constant Field Values
  - DFE_CR1_1
```
public static final byte DFE_CR1_1
```
    See Also:
    
    Constant Field Values
  - DFE_CR2_0
```
public static final byte DFE_CR2_0
```
    See Also:
    
    Constant Field Values
  - DFE_CR2_1
```
public static final byte DFE_CR2_1
```
    See Also:
    
    Constant Field Values
  - DSP_SR1
```
public static final byte DSP_SR1
```
    See Also:
    
    Constant Field Values
  - DSP_SR2
```
public static final byte DSP_SR2
```
    See Also:
    
    Constant Field Values
  - DSP_CR4
```
public static final byte DSP_CR4
```
    See Also:
    
    Constant Field Values
  - DSP_CR5
```
public static final byte DSP_CR5
```
    See Also:
    
    Constant Field Values
  - DSP_CR6
```
public static final byte DSP_CR6
```
    See Also:
    
    Constant Field Values
  - DSP_CR7
```
public static final byte DSP_CR7
```
    See Also:
    
    Constant Field Values
  - DSP_CR8
```
public static final byte DSP_CR8
```
    See Also:
    
    Constant Field Values
  - DSP_CR9
```
public static final byte DSP_CR9
```
    See Also:
    
    Constant Field Values
  - DSP_CR10
```
public static final byte DSP_CR10
```
    See Also:
    
    Constant Field Values
  - DSP_CR11
```
public static final byte DSP_CR11
```
    See Also:
    
    Constant Field Values
  - DSP_CR12
```
public static final byte DSP_CR12
```
    See Also:
    
    Constant Field Values
  - overflowCounter
```
protected int overflowCounter
```
  - debug
```
protected boolean debug
```
  - spi
```
protected Spi spi
```
  - totalEnergy
```
public long[] totalEnergy
```
  - firstReadEnergy
```
public boolean firstReadEnergy
```
- Constructor Detail
  - STPM3x
```
public STPM3x()
```
- Method Detail
  - initSequence
```
public void initSequence()
```
    Default initialization sequence of the STPM3x
  - resetSequence
```
public void resetSequence()
```
    Default reset sequence of the STPM3x sensor.
  - reset
```
public void reset()
```
  - setCalibration
```
public void setCalibration(short value,
                           int chan,
                           int mode)
```
    Parameters:
    
    value - new calibration value, between -2048 and +2047
    
    chan - channel on the STPM3x (1 or 2)
    
    mode - 0 for voltage, 1 for current
  - calibration
```
public void calibration()
```
  - readRegister
```
public int readRegister(byte address)
```
  - writeRegister16
```
public int writeRegister16(byte address,
                           short value)
```
  - writeRegister32
```
public int writeRegister32(byte address,
                           int value)
```
  - calculateAndPutCRC
```
public int calculateAndPutCRC(byte[] buffer)
```
  - getPower
```
public float getPower(int chan)
```
  - getVoltage
```
public float getVoltage(int chan)
```
  - getCurrent
```
public float getCurrent(int chan)
```
  - getPeriod
```
public float getPeriod(int chan)
```
  - getPhase
```
public float getPhase(int chan)
```
  - getEnergy
```
public double getEnergy(int chan)
```
  - sendFrame
```
public byte[] sendFrame(byte readAddress,
                        byte writeAddress,
                        byte dataLSB,
                        byte dataMSB)
```
  - startPowerAcquisition
```
public int startPowerAcquisition()
```
  - debugLog
```
protected void debugLog(java.lang.String message)
```
  - calcPower
```
public abstract float calcPower(int value)
```
    Returns power in W. Default factor is the multiplication of the current and voltage factors. Correction factor depends on the hardware.
    
    Parameters:
    
    value - raw data from the STPM3x
    
    Returns:
    
    power value, in W.
    
    See Also:
    
    calcCurrent, calcVoltage
  - calcEnergy
```
public abstract double calcEnergy(double value)
```
    Returns Energy in Ws. Default factor is calculated from the power factor with the default clock of 7812.5Hz along the specifications of the STPM3x.
    
    Parameters:
    
    value - raw data from the STPM3x
    
    Returns:
    
    Energy consumed since the start of the sampling, in Ws.
    
    See Also:
    
    calcPower
  - calcCurrent
```
public abstract float calcCurrent(int value)
```
    Returns current in A. Default factor of 0.003138f obtained by calibration on a measuring bench.
    
    Parameters:
    
    value - raw data from the STPM3x
    
    Returns:
    
    current in A.
  - calcVoltage
```
public abstract float calcVoltage(int value)
```
    Returns voltage in V. Default factor of 0.0179f obtained by calibration on a measuring bench.
    
    Parameters:
    
    value - raw data from the STPM3x
    
    Returns:
    
    voltage in V.
  - extendSign
```
public int extendSign(int bitsize,
                      int val)
```
  - setSynchroState
```
public abstract void setSynchroState(boolean enabled)
```
  - setChipSelectState
```
public abstract void setChipSelectState(boolean enabled)
```
  - setEnableState
```
public abstract void setEnableState(boolean enabled)
```

Class STPM3x

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SPI_DEFAULT_FREQUENCY

SPI_DEFAULT_MODE

SPI_DEFAULT_USE_CS

SPI_DEFAULT_TIMEOUT

FRAME_LENGTH_WITH_CRC

DUMMY

NULL

RET_OK

RET_KO

MD_VOLTAGE

MD_CURRENT

OFFSET_POWER

POWER_REGISTER

DSP_CR3_0

DSP_CR3_1

PH1_REG1

PH2_REG1

PH1_REG5

PH2_REG5

DSP_REG1

DSP_REG14

DSP_REG15

DSP_REG16

DSP_REG17

DSP_REG18

DSP_REG19

DFE_CR1_0

DFE_CR1_1

DFE_CR2_0

DFE_CR2_1

DSP_SR1

DSP_SR2

DSP_CR4

DSP_CR5

DSP_CR6

DSP_CR7

DSP_CR8

DSP_CR9

DSP_CR10

DSP_CR11

DSP_CR12

overflowCounter

debug

spi

totalEnergy

firstReadEnergy

Constructor Detail

STPM3x

Method Detail

initSequence

resetSequence

reset

setCalibration

calibration

readRegister

writeRegister16

writeRegister32

calculateAndPutCRC

getPower

getVoltage

getCurrent

getPeriod

getPhase

getEnergy

sendFrame

startPowerAcquisition

debugLog

calcPower

calcEnergy

calcCurrent

calcVoltage

extendSign

setSynchroState

setChipSelectState