Skip to content

Latest commit

 

History

History
228 lines (178 loc) · 7.36 KB

README.md

File metadata and controls

228 lines (178 loc) · 7.36 KB
Raw

pyCKW

Access your myCKW smartmeter data.

Table of Contents

Introduction

If you have a new Smart Meter installed by CKW you can pull fresh consumption and power data from it through their API.
This package is a wrapper to ease the retrieval of this data.
I wrote this package to inegrate my electricity usage data into my home automation tools.

Requirements

  • Be a customer at CKW
  • Have a Smart Meter already installed. See Zählerwechsel.
  • Know your customer number and meter ID. These information can be found on your last invoice:
    • Customer Number = "Kunden-Nr.", a 7-digits ID.
    • Meter ID = "Zählpunkt", a 33-digits ID.

Installation

PIP

The simplest way is to use pip.

pip install pyCKW

Manual Installation

If for some reason you prefer to manually install the package you can download a fresh copy of the code with git clone.

git clone https://github.com/diaznet/pyCKW.git

There is also the possibility to download the releases from Github. See Releases page.

Usage

You create an object from class pyCKW and use the supported methods to fetch structured data from the API.

Method Description
`get_consumption(resolution = str, start_date=datetime.datetime, end_date=datetime.datetime) Returns a list of dictionaries with currently supported consumption data 
# Import datetime.datetime
from datetime import datetime

# pyCKW import
from pyckw import pyCKW

# We want to retrieved data with a resolution of a day between the 11th and 12th of January 2022
resolution = 'day'
start_date = datetime.strptime('20211211', '%Y%m%d')
end_date = datetime.strptime('20211212', '%Y%m%d')

# Instantiate a pyCKW object 
ckw = pyCKW(
    client_number='0001234567',
    meter_point='CH0009801234500000000000000054321'
    )

# Get the consumption data
consumption_data = ckw.get_consumption(
    resolution,
    start_date,
    end_date
)

Example data object returned from the code snippet above:

[
    {   
        "end_date": "Tue, 11 Jan 2022 23:00:00 GMT",
        "max_physical_power": 2.5360000133514404,
        "max_power": 2.5360000133514404,
        "qty_invoiced_offpeak": 5.169999994337559,
        "qty_invoiced_peak": 11.194000013172626,
        "qty_measured": 16.364000007510185,
        "qty_reactive_invoiced_offpeak": null,
        "qty_reactive_invoiced_peak": null,
        "qty_reactive_offpeak": null,
        "qty_reactive_peak": null,
        "start_date": "Mon, 10 Jan 2022 23:00:00 GMT"
    },
    {   
        "end_date": "Wed, 12 Jan 2022 23:00:00 GMT",
        "max_physical_power": 11.64799976348877,
        "max_power": 11.64799976348877,
        "qty_invoiced_offpeak": 9.262999959290028,
        "qty_invoiced_peak": 12.256000146269798,
        "qty_measured": 21.519000105559826,
        "qty_reactive_invoiced_offpeak": null,
        "qty_reactive_invoiced_peak": null,
        "qty_reactive_offpeak": null,
        "qty_reactive_peak": null,
        "start_date": "Tue, 11 Jan 2022 23:00:00 GMT"
    }
]

start_date and end_date are datetime.datetime object and are used to determine the day/month/year only, as the API doesn't allow more precise spans.
Therefore it is not necessary to specify the hour/minutes/seconds when creating the datetime.datetime object, at it will always resolve to 00:00:00 CET or CEST.
Data times are local to Europe/Zuricn

Companion CLI application

A CLI application is provided to demonstrate how to use the library.
It can also be used to fetch the data by yourself if you do not want to rewrite the wheel.

CLI Application usage

[user@host ~]$ python pyCKWCLI.py -h
usage: pyCKWCLI.py [-h] [-v {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}] [-V] -c CLIENT_NUMBER
                   -m METER_POINT -r {year,month,week,day,hour,minute} [-i RELATIVE_INTERVAL]
                   [--start-date START_DATE] [--end-date END_DATE]

Fetches consumption Data from myCKW and pretty-prints it.

optional arguments:
  -h, --help            show this help message and exit
  -v {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}, --log-verbosity {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}
                        Set log verbosity. Default is WARNING.
  -V, --version         Print version and exit.

required arguments:
  -c CLIENT_NUMBER, --client-number CLIENT_NUMBER
                        The client number. Example 0001234567.
  -m METER_POINT, --meter-point METER_POINT
                        A 33-chars long string representing the Meter ID.
                        Example CH0009801234500000000000000054321
  -r {year,month,week,day,hour,minute}, --resolution {year,month,week,day,hour,minute}
                        Data resolution.
  -i RELATIVE_INTERVAL, --relative-interval RELATIVE_INTERVAL
                        An interval expressed in days, relative to now.
  --start-date START_DATE
                        Start date for interval
  --end-date END_DATE   End date for interval.

[user@host ~]$

Example

[user@host ~]$ python pyCKWCLI.py                       \
                -c 0001234567                           \
                -m CH0009801234500000000000000054321    \
                -r day                                  \
                --start-date 20220111                   \
                --end-date 20220112
[   {   'end_date': 'Tue, 11 Jan 2022 23:00:00 GMT',
        'max_physical_power': 2.5360000133514404,
        'max_power': 2.5360000133514404,
        'qty_invoiced_offpeak': 5.169999994337559,
        'qty_invoiced_peak': 11.194000013172626,
        'qty_measured': 16.364000007510185,
        'qty_reactive_invoiced_offpeak': None,
        'qty_reactive_invoiced_peak': None,
        'qty_reactive_offpeak': None,
        'qty_reactive_peak': None,
        'start_date': 'Mon, 10 Jan 2022 23:00:00 GMT'},
    {   'end_date': 'Wed, 12 Jan 2022 23:00:00 GMT',
        'max_physical_power': 11.64799976348877,
        'max_power': 11.64799976348877,
        'qty_invoiced_offpeak': 9.262999959290028,
        'qty_invoiced_peak': 12.256000146269798,
        'qty_measured': 21.519000105559826,
        'qty_reactive_invoiced_offpeak': None,
        'qty_reactive_invoiced_peak': None,
        'qty_reactive_offpeak': None,
        'qty_reactive_peak': None,
        'start_date': 'Tue, 11 Jan 2022 23:00:00 GMT'}]
Fetched 2 data points in 1.06 seconds.
[user@host ~]$

Note

There seems to be at the time of writing (January 2022) a delay of 7 hours between the measures from your smart meter and the actual time they are returned by the API.
Hopefully the utility provider improves this gap soon!

Todo's

  • Finish documentation
  • Improve logging in various places

Disclaimer

This application comes without warranty. Please use with care. Any damage cannot be related back to the author. I am not affiliated in any way to CKW and its subsidiaries.

Credits

Author: Jeremy Diaz