Skip to main content

API for the Sense Energy Monitor

Project description

sense_api

Sense Energy Monitor API Interface

The Sense API provides access to the unofficial API for the Sense Energy Monitor. Through the API, one can retrieve both realtime and trend data including individual devices.

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

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

Local Device Emulation

The SenseLink class emulates the energy monitoring functionality of TP-Link Kasa HS110 Smart Plugs and allows you to report "custom" power usage to your Sense Home Energy Monitor. This requires enabling "TP-Link HS110/HS300 Smart Plug" in the Sense app.

Based off the work of https://github.com/cbpowell/SenseLink

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

Web API Example Usage:

    from sense_energy import Senseable
    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, "KWh")
    print ("Daily Solar:", sense.daily_production, "KWh")
    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.

Local emulation Example Usage:

	async def test():
		import time
		def test_devices():
			devices = [PlugInstance("lamp1", start_time=time()-20, alias="Lamp", power=10), 
					   PlugInstance("fan1", start_time=time()-300, alias="Fan", power=140)]
			for d in devices:
				yield d
		sl = SenseLink(test_devices)
		await sl.start()
		try:
			await asyncio.sleep(180)  # Serve for 3 minutes
		finally:
			await sl.stop()

	if __name__ == "__main__":
		asyncio.run(test())

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.13.8.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

sense_energy-0.13.8-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

Details for the file sense_energy-0.13.8.tar.gz.

File metadata

  • Download URL: sense_energy-0.13.8.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for sense_energy-0.13.8.tar.gz
Algorithm Hash digest
SHA256 ad95fb674f6407116cedeedceba594d0d9e3daf3f80a3024815a13ea8789c8be
MD5 2e260e6d35b299f2191a7a1d96609fde
BLAKE2b-256 ce504d753fc19e0004e84ecbb615db9b7d11068808e135b879cbdfd3264860a5

See more details on using hashes here.

File details

Details for the file sense_energy-0.13.8-py3-none-any.whl.

File metadata

  • Download URL: sense_energy-0.13.8-py3-none-any.whl
  • Upload date:
  • Size: 15.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for sense_energy-0.13.8-py3-none-any.whl
Algorithm Hash digest
SHA256 493830ba68d3c915cae0b84c3ec872a93ef1b2c469f073a56b9cd7ac94b878ea
MD5 d92b5fc55e9ceb72caebfb09d5846beb
BLAKE2b-256 84ceab3b23f1228e5d7e64d6595a5ca2e1f5471c8357e79fe32d4886197f7761

See more details on using hashes here.

Supported by

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