Skip to main content

API for the Sense Energy Monitor

Project description

sense_api

Sense Energy Monitor API Interface [WIP]

Systematic access to the Sense monitor data. Exploratory work on pulling data from Sense to be used in other tools - Smartthings, ActiveTiles, etc.

Python version based on the work done here in Powershell: https://gist.github.com/mbrownnycnyc/db3209a1045746f5e287ea6b6631e19c

Contributors

Feel free to fork and PR!

https://github.com/kbickar

Todo

  • Add POST/PUT where/if applicable
  • CLI
  • Improved error handling

Install

pip install sense_energy

Example Usage:

    sense = Senseable()
    sense.authenticate(username, password)
    sense.update_realtime()
    sense.update_trend_data()
    print ("Active:",sense.active_power,"W")
    print ("Active Solar:",sense.active_solar_power,"W")
    print ("Daily:",sense.daily_usage,"KW")
    print ("Daily Solar:",sense.daily_production,"KW")
    print ("Active Devices:",", ".join(sense.active_devices))

There are plenty of methods for you to call so modify however you see fit

If using the API to log data, you should only create one instance of Senseable and then reuse that to get the updated stats. Creating the instance authenticates with the Sense API which should only be once every 15-20 minutes at most.
Calling the update_trend_data() function will update all the trend stats and get_realtime() will retrieve the latest real time stats.

The get_realtime() is by default rate limited to one call per 30 seconds. This can be modified by setting the Senseable object attribute rate_limit to a different value.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sense_energy-0.7.1.tar.gz (4.9 kB view hashes)

Uploaded Source

Built Distribution

sense_energy-0.7.1-py3-none-any.whl (7.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page