python-mystrom

Python API for controlling myStrom switches

Project description

Python API for controlling myStrom switches/plugs.

Requirements

You need to have Python installed.

myStrom switch
requests
Network connection

Details

At the moment the following endpoints are covered:

/report: for getting the current state and the power consumption
/relay: for setting the relay state

You will still be able to use your device with the smartphone application, curl, or other tools. The samples below shows how to use the switch with httpie and curl along with python-mystrom.

$ http http://IP_ADDRESS_PLUG/report
HTTP/1.1 200 OK
Content-Length: 39
Content-Type: application/json
Date: Mon, 15 Feb 2016 17:52:21 GMT

{
    "power": 51.630947,
    "relay": true
}

$ curl -X GET http://IP_ADDRESS_PLUG/relay?state=1

Example

The sample below shows how to use this Python module.

plug = pymystrom.MyStromPlug('IP_ADDRESS_PLUG')

# Preserve state
STATE_ON = plug.get_relay_state()

# Switch relay on if the plug is currently off
if not STATE_ON:
    print('Relay will be switched on.')
    plug.set_relay_on()
    # Wait a few seconds to get a reading of the power consumption
    print('Waiting for a couple of seconds...')
    time.sleep(10)

# Get the new state of the switch
print('Relay state: ', plug.get_relay_state())
print('Power consumption:', plug.get_consumption())

# Switch relay off if it was off.
if not STATE_ON:
    plug.set_relay_off()

License

python-mystrom licensed under MIT, for more details check LICENSE.

Project details

Release history Release notifications | RSS feed

2.2.0

May 21, 2023

2.1.0

Nov 26, 2022

2.0.0

Nov 12, 2020

1.1.3

Jun 8, 2020

1.1.2

Apr 11, 2020

1.1.1

Apr 11, 2020

1.1.0

Apr 11, 2020

1.0.0

Jan 5, 2020

0.5.0

Feb 27, 2019

0.4.4

Jun 7, 2018

0.4.3

Jun 7, 2018

0.4.2

Mar 27, 2018

0.4.1

Mar 27, 2018

0.4.0

Jan 23, 2018

0.3.8

Apr 17, 2017

0.3.7

Apr 8, 2017

0.3.6

Jul 15, 2016

0.3.5

Jul 15, 2016

0.3.4

Jul 15, 2016

0.3.3

Jul 15, 2016

0.3.2

Jun 29, 2016

0.3.1

Jun 29, 2016

0.2.4

Jun 27, 2016

This version

0.2.3

Mar 25, 2016

0.2.2

Feb 17, 2016

0.2.1

Feb 17, 2016

Download files

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

Source Distribution

python-mystrom-0.2.3.tar.gz (2.5 kB view details)

Uploaded Mar 25, 2016 Source

File details

Details for the file python-mystrom-0.2.3.tar.gz.

File metadata

Download URL: python-mystrom-0.2.3.tar.gz
Upload date: Mar 25, 2016
Size: 2.5 kB
Tags: Source
Uploaded using Trusted Publishing? No

File hashes

Hashes for python-mystrom-0.2.3.tar.gz
Algorithm	Hash digest
SHA256	`0f00136fb5908842d5396af513d94b0c8c4cbdac6fd16f7fb24f322843b1e33d`
MD5	`6f18c2fca5a9f8bcce598264477f7576`
BLAKE2b-256	`4878d95caba887a49d116b44033405672d8e96a48992214a272860caee471c1a`