root/fi.utu.tech.powergoblin.drivers.model/ChannelState

ChannelState

data class ChannelState(val id: String, val pollPeriod: Int, val energy: Long = 0, val maxVoltage: Int? = null, val minVoltage: Int? = null, val cumulativeVoltage: Long = 0, val maxCurrent: Int? = null, val minCurrent: Int? = null, val cumulativeCurrent: Long = 0, val maxPower: Int? = null, val minPower: Int? = null, val cumulativePower: Long = 0, val errorCount: Long = 0, val readCount: Long = 0, val latestEvent: MeterReading? = null)

Keeps track of channel state. Units in millis mW, mV, mA Units in micros: µJ

Note that the energy reading is signed and can store up to 2^63-1 µJ. Another limitation comes from the fact that numbers in JavaScript are represented by 64-bit floats with a 53-bit mantissa. The fractions of a joule consume 20 bits. There's 33 bits left. Thus, we can measure a 2000W device up to 24 days.

Constructors

constructor(id: String, pollPeriod: Int, energy: Long = 0, maxVoltage: Int? = null, minVoltage: Int? = null, cumulativeVoltage: Long = 0, maxCurrent: Int? = null, minCurrent: Int? = null, cumulativeCurrent: Long = 0, maxPower: Int? = null, minPower: Int? = null, cumulativePower: Long = 0, errorCount: Long = 0, readCount: Long = 0, latestEvent: MeterReading? = null)

Properties

cumulativeCurrent

val cumulativeCurrent: Long = 0

Cumulative current reading

cumulativePower

val cumulativePower: Long = 0

Cumulative power reading

cumulativeVoltage

val cumulativeVoltage: Long = 0

Cumulative voltage, used for calculating averages

val energy: Long = 0

Cumulative energy reading during the observation period (µJ)

val errorCount: Long = 0

Number of observed read errors during the observation period

Channel id, must be equal to one of channel ids in PowerMeter metadata

val latestEvent: MeterReading? = null

Latest meter event for this channel during the observation period

val maxCurrent: Int? = null

Highest encountered current value during this observation period if any

val maxPower: Int? = null

Highest encountered power value during this observation period if any

val maxVoltage: Int? = null

Highest encountered voltage value during this observation period if any

val minCurrent: Int? = null

Lowest encountered current value during this observation period if any

val minPower: Int? = null

Lowest encountered power value during this observation period if any

val minVoltage: Int? = null

Lowest encountered voltage value during this observation period if any

val pollPeriod: Int

Meter's poll period

val readCount: Long = 0

Number of observed events during the observation period

Functions

fun averageCurrent(): Double

fun averagePower(): Double

fun averageVoltage(): Double

fun errorCountStat(): Double

fun maxPower(): Double

fun minPower(): Double

fun readCountStat(): Double

fun reset(): ChannelState

fun totalEnergy(): Double

fun update(event: MeterReading): ChannelState