Class Emeter

constructor

• new Emeter(device, apiModuleName, childId?): Emeter

• Parameters

  • device: AnyDevice

  • apiModuleName: string

  • childId: undefined | string = undefined

  Returns Emeter

Readonly apiModuleName

Readonly childId

Readonly device

realtime

• get realtime(): RealtimeNormalized

• Returns cached results from last retrieval of emeter.get_realtime.

  Returns RealtimeNormalized

eraseStats

• eraseStats(sendOptions?): Promise<unknown>

• Erase Emeter Statistics.

  Sends emeter.erase_runtime_stat command. Supports childId.

  Parameters

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

getDayStats

• getDayStats(year, month, sendOptions?): Promise<unknown>

• Get Daily Emeter Statistics.

  Sends emeter.get_daystat command. Supports childId.

  Parameters

  • year: number

  • month: number

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

getMonthStats

• getMonthStats(year, sendOptions?): Promise<unknown>

• Get Monthly Emeter Statistics.

  Sends emeter.get_monthstat command. Supports childId.

  Parameters

  • year: number

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

getRealtime

• getRealtime(sendOptions?): Promise<unknown>

• Gets device's current energy stats.

  Requests emeter.get_realtime. Older devices return current, voltage, etc, while newer devices return current_ma, voltage_mv etc This will return a normalized response including both old and new style properties for backwards compatibility. Supports childId.

  Parameters

  • Optional sendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError