Skip to main content

Client package to access powerplanner API

Project description

PowerPlanner API Lib

Library to support accessing the powerplanner API Mainly used for the Home assistant integration

Create an instance with your api key from powerplanner

update()

Fetches all schedules from the powerplanner API and returns the raw json result

If there is removed or added plans these will be available in the "new_plans" & "old_plans" variable The "plans_changed" variable will also be true.

toggle(plan_id: str, enabled:bool)

Enables or disables a plan and updates the schedules

set_property(plan_id: str, property_key: str, value: any)

Updates a dynamic rule value on a plan

get_next_change(name: str)

returns when a plan will change its enabled status

add_sensor(sensor)

Adds a sensor to the collection and triggers the assigned callback

remove_sensor(sensor_name: str)

Removes a sensor from the collection

time_to_change(name: str)

Returns how many seconds left it is before the plan changes status

is_on(name: str)

Returns the current status for a plan by checking the schedule

authenticate():

Checks if the api key is correct

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

powerplanner-lib-0.0.14.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

powerplanner_lib-0.0.14-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file powerplanner-lib-0.0.14.tar.gz.

File metadata

  • Download URL: powerplanner-lib-0.0.14.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for powerplanner-lib-0.0.14.tar.gz
Algorithm Hash digest
SHA256 dab733b6a6b9dee532f2950571bb9af01f56fdfe2ded00c4374c3173f45abdce
MD5 59fffb62894ad1d8790cdbc7eefcdd09
BLAKE2b-256 bf4938f96910f6ba135ecdf0e612e72882e6e2b65bdb42bbeb85b27370075d91

See more details on using hashes here.

File details

Details for the file powerplanner_lib-0.0.14-py3-none-any.whl.

File metadata

File hashes

Hashes for powerplanner_lib-0.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 3f9ee81d416c454ee1c6785930773b63a087ba80e58a5d4080fe1b4611394f9b
MD5 97ffbe6dbd0b5a493c88d3af46ea6fea
BLAKE2b-256 8614cb4b6a096cd18968bec5dc6aba72ef8cf45088a10bef97d63c6c3fd39e6e

See more details on using hashes here.

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