A simple API for RainMachine sprinkler controllers
Project description
💧 Regenmaschine: A Simple Python Library for RainMachine™
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
Check for open features/bugs or initiate a discussion on one.
Install the dev environment:
make init
.Enter the virtual environment:
pipenv shell
Code your new feature or bug fix.
Write a test that covers your new functionality.
Run tests:
make test
Build new docs:
make docs
Add yourself to AUTHORS.rst.
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
Built Distribution
Hashes for regenmaschine-0.3.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eceb8f4b762f3a17a581f9c8b1e578800eace0517f2fac50712a0836cb6a8197 |
|
MD5 | 5e0ef3e226bd83cf5c5e1947c0db4a23 |
|
BLAKE2b-256 | a787b60f1932dcdaacc2af321d6a3e62031ca54af219bb0a704e9c23bbe3b4ab |