Meter Reader

Release 1.1.2

Meter Reader is a client library and command line client for retrieving nearly realtime energy usage data from a smart meter via the Eagle™ Home Energy Gateway. See Rainforest™ Automation for more about the Eagle™ Home Energy Gateway.

Meter Reader is not affiliated with the Eagle™ Home Energy Gateway or Rainforest™ Automation.

Installation

$ pip install meter-reader

Usage

Meter Reader is intended to be used as a library for other applications but it does contain a command line application called mr.

$ mr < ip address >

This will run the list_devices devices command on the gateway and display a formatted response. Other commands, such as get_device_data, will first run the list_devices command to determine the MAC address of the gateway.

Commands can be specified with the '-c' option. For example

$ mr -c get_device_data < ip address >

MessageCluster
    DeviceMacId          xx:xx:xx:xx:xx:xx:xx:xx
    MeterMacId           xx:xx:xx:xx:xx:xx:xx
    TimeStamp            0
    Id                   0
    Priority             None
    Text                 None
    ConfirmationRequired N
    Confirmed            N
    Read                 Y
    Queue                active
CurrentSummation
    DeviceMacId          xx:xx:xx:xx:xx:xx:xx:xx
    MeterMacId           xx:xx:xx:xx:xx:xx:xx
    TimeStamp            2014-04-19 16:01:22+00:00
    SummationDelivered   12949746
    SummationReceived    0
    Multiplier           1
    Divisor              1000
    DigitsRight          3
    DigitsLeft           15
    SuppressLeadingZero  Y
NetworkInfo
...

$ mr -c get_summation_values < ip address >

2014-04-18 16:30:00+00:00, Summation, 0.350
2014-04-18 17:30:00+00:00, Summation, 0.322
2014-04-18 18:30:00+00:00, Summation, 0.193
2014-04-18 19:30:00+00:00, Summation, 0.285
2014-04-18 20:30:00+00:00, Summation, 0.286
2014-04-18 21:30:00+00:00, Summation, 0.351
...

There are two ways to retrieve instantaneous demand:

1. Send the get_instantaneous_demand command directly to the gateway. This will return a nearly raw response from the gateway (formatting is applied).

$ mr -c get_instantaneous_demand < ip address >

    InstantaneousDemand
    DeviceMacId         xx:xx:xx:xx:xx:xx:xx:xx
    MeterMacId          xx:xx:xx:xx:xx:xx:xx
    TimeStamp           2014-04-19 15:35:27+00:00
    Demand              297
    Multiplier          1
    Divisor             1000
    DigitsRight         3
    DigitsLeft          15
    SuppressLeadingZero Y

2. Supply the --get-instant-demand argument. This will post-process the response before displaying it.

$ mr --get-instant-demand < ip address >

2014-04-19 15:58:39+00:00, 0.292kW

Raw and unformatted data returned by the gatway, can be viewed by using the '-r' option.

$ mr -r -c get_device_data < ip address >

Including Meter Reader in an application

from meter_reader import Gateway

GATEWAY_ADDRESS = '192.168.1.10'

gw = Gateway(GATEWAY_ADDRESS)
response = gw.run_command('get_device_data')
print('Network Info')
print(response['NetworkInfo'])

timestamp, demand = gw.get_instantaneous_demand()
print('Demand {0!s} at {1!s}'.format(demand, timestamp))