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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: powerplanner-lib-0.0.13.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.13.tar.gz
Algorithm Hash digest
SHA256 a54fce6f55075b49a2a51284528d62ab58aec63c2b5ee386550d16c883c67d7a
MD5 6c3b1914c51ff92af9c52cc16240900f
BLAKE2b-256 93d391a58ce543f788cd924f0541b17362bd99e64194fb2ceb4d1726bae05a72

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for powerplanner_lib-0.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 97d8697880ac259ff00f624c3dcf44b53e52337870d350716ff969014a9fdb22
MD5 0d4c33578004c7034263038b69768c07
BLAKE2b-256 6e269fc32df81a0d462d20b0b88bb1d47855ea51feec0f27efacd7e1b2f6bda2

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