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', 'MY_RM_PASSWORD')
auth = rm.Authenticator.create_remote('EMAIL_ADDRESS', 'MY_RM_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.2.10.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

regenmaschine-0.2.10-py2.py3-none-any.whl (13.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for regenmaschine-0.2.10.tar.gz
Algorithm Hash digest
SHA256 18f79fb5858a1a6d0be26ffba3d94abff122b5f06bf7d1ea964a7a5181d72f4c
MD5 b5de7675999a1a16152a0205a772b15e
BLAKE2b-256 80b42070de4477ad4a6354d07c6360a22745d46b81fd502e756baec96c54cd2b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for regenmaschine-0.2.10-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 39eb1763ca5e6a971c71243e658c7d217fbd869c581ebc076d4c395a5390ebe5
MD5 f3c19326dac1dfc625d485e489fe5980
BLAKE2b-256 9901ec2b864143de3381df1c9a5a25d7c2fc767ed0b93ffb2ecef6c384fa671c

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