Skip to main content

A simple API for RainMachine sprinkler controllers

Project description

💧 Regenmaschine: A Simple Python Library for RainMachine™

https://travis-ci.org/bachya/regenmaschine.svg?branch=master https://img.shields.io/pypi/v/regenmaschine.svg https://img.shields.io/pypi/pyversions/Regenmaschine.svg https://img.shields.io/pypi/l/Regenmaschine.svg https://codecov.io/gh/bachya/regenmaschine/branch/master/graph/badge.svg https://img.shields.io/codeclimate/github/bachya/regenmaschine.svg https://img.shields.io/badge/SayThanks-!-1EAEDB.svg

Regenmaschine (German for “rain machine”) is a simple, clean, well-tested Python library for interacting with RainMachine™ smart sprinkler controllers. It gives developers an easy API to manage their controllers over a LAN or via RainMachine™’s cloud.

💧 Installation

$ pip install regenmaschine

💧 Example

import regenmaschine as rm

# Authenticate against the local device or the remote API:
auth = rm.Authenticator.create_local('192.168.1.100', 'password', port=8080, https=True)
auth = rm.Authenticator.create_remote('email@host.com', 'password')

# Create a client:
client = rm.Client(auth)

# Get information on all programs:
program_info = client.programs.all()

# Turn on program 1:
client.programs.start(1)

# Stop program 1:
client.programs.stop(1)

# Get information on all zones:
zone_info = client.zones.all()

# Turn on zone 3 for 5 minutes:
client.zones.start(3, 300)

💧 More Information

Full documentation for Regenmaschine can be found here: http://bachya.github.io/regenmaschine

💧 Contributing

  1. Check for open features/bugs or initiate a discussion on one.

  2. Fork the repository.

  3. Install the dev environment: make init.

  4. Enter the virtual environment: pipenv shell

  5. Code your new feature or bug fix.

  6. Write a test that covers your new functionality.

  7. Run tests: make test

  8. Build new docs: make docs

  9. Add yourself to AUTHORS.rst.

  10. Submit a pull request!

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

regenmaschine-0.4.1.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

regenmaschine-0.4.1-py2.py3-none-any.whl (14.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file regenmaschine-0.4.1.tar.gz.

File metadata

File hashes

Hashes for regenmaschine-0.4.1.tar.gz
Algorithm Hash digest
SHA256 93752ffe455c384a3aa864e110609b95599ce76a5cbd361f6eb182373b1eea1d
MD5 8aefa48c9f681dd25130352b00419bb3
BLAKE2b-256 f377bd2f86b9d28e98ba3e590e9752c09fce3053bb23e4b5b3fe2d81f73ad11d

See more details on using hashes here.

File details

Details for the file regenmaschine-0.4.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for regenmaschine-0.4.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fd8e90d918fb88464669779e47e48f90806ed374dc9bd00872079c18cc9ec54d
MD5 c41d51702e6763768345c252ed860543
BLAKE2b-256 39fc363ace11964380def35329949b0a297157557953873540c3cf0ee9d1573e

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