Interface Emeter

ReadonlyapiModuleName

ReadonlychildId

Readonlydevice

realtime

• get realtime(): RealtimeNormalized

  Returns cached results from last retrieval of emeter.get_realtime.

  Returns RealtimeNormalized

eraseStats

• eraseStats(sendOptions?: SendOptions): Promise<unknown>

  Erase Emeter Statistics.

  Sends emeter.erase_runtime_stat command. Supports childId.

  Parameters

  • OptionalsendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

getDayStats

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

  Get Daily Emeter Statistics.

  Sends emeter.get_daystat command. Supports childId.

  Parameters

  • year: number
  • month: number
  • OptionalsendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

getMonthStats

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

  Get Monthly Emeter Statistics.

  Sends emeter.get_monthstat command. Supports childId.

  Parameters

  • year: number
  • OptionalsendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError

getRealtime

• getRealtime(sendOptions?: 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

  • OptionalsendOptions: SendOptions

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError