root/fi.utu.tech.powergoblin.drivers.meters/MeterHandler

MeterHandler

abstract class MeterHandler(val meter: PowerMeter) : Observable<ReadingObserver> , AutoCloseable, MeterControls

Abstract handler for different power meters. The handler is constructed from a power meter description. Only one handler should be associated with the description.

Inheritors

DummyMeterHandler

SimulatedMeterHandler

ElmorLabsPMD2Handler

SmartPower3Handler

SmartPowerHandler

Constructors

MeterHandler

constructor(meter: PowerMeter)

Properties

meter

val meter: PowerMeter

Functions

assign

open fun assign(observer: ReadingObserver)

Resets the meter state and adds an observer.

open override fun close()

Close the handler.

dummify

fun dummify(): MeterHandler

Unassigns this handler and returns & assigns a dummy copy.

fun id(): String

Shorthand for the meter's ID.

init

fun init()

Initialize the handler. Includes the opening of any associated ports and setting port parameters.

isAssigned

fun isAssigned(): Boolean

off

open fun off(channel: String? = null)

Power on the meter channel. After this call the channel should be powered off.

open fun on(channel: String? = null)

Power on the meter channel. After this call the channel should be powered on.

onOff

open fun onOff(channel: String? = null)

Toggle the power on the meter channel. After this call the channel should be in reverse state (on <-> off).

start

fun start()

Start receiving data.

state

fun state(): MeterStateStore

Shorthand for the meter's state.

toString

open override fun toString(): String

unassign

open fun unassign()

Resets the meter state and adds an observer.