Skip to main content

Interface Library for QuickSmart Etherrain/8 irrigation controller

Project description

# Python3 API for QuickSmart Etherrain/8

The EtherRain/8 from [QuickSmart](http://www.quicksmart.com/qs_etherrain.html) is an Ethernet based irrigation controller with a custom web API. This is a simple Python3 API for talking to it.

## Limitations
* The ER8 maintains its authentication state by IP address. So if another process or client on your system has authenticated with the ER8, then the login() function will succeed even with an invalid password.
* Due to the above limitation, a client with an invalid username/password on the same host can issue watering commands and retrieve state, etc.
* This API Assumes an Etherrain/8 and doesn't anticipate anything as regards the Etherrain/7P

```Python
class EtherRain:
def __init__(self, addr, user, pw, timeout):
```

Class instantiation requires an IP address or hostname, username, and password with an optional timeout.

## API
* login() - Authenticate. Returns true or false
* stop() - Full stop to all watering operations
* update_status() - Call this before checking the operating status or any other status attributes.
* get_status() - Return the current operating status. Call ```update_status()``` first. Returns:
* BZ - Busy
* WT - Waiting
* RD - Ready
* rain() - Is the rain sensor reporting that it is wet?
* last_valve() - Returns which valve is currently turned on or has more recently been turned on. Returns 0-8
* irrigate(valve, time) - Turn on an irrigation valve. Time is in Minutes. Valve is 1-8.



Project details


Download files

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

Source Distribution

etherrain-0.5.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

etherrain-0.5-py2.py3-none-any.whl (5.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file etherrain-0.5.tar.gz.

File metadata

  • Download URL: etherrain-0.5.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.19.9 CPython/3.6.5

File hashes

Hashes for etherrain-0.5.tar.gz
Algorithm Hash digest
SHA256 226ed9d6768f5b21026adb5c0b12abb5f0de941ab15e34579ec0b52bbd83e0c7
MD5 f8133e8587622f0a095366ea2abd0cfb
BLAKE2b-256 0ea810a262fa41d268416cad856ca615aebd8008a6fde605534d31d5e6c36cf2

See more details on using hashes here.

Provenance

File details

Details for the file etherrain-0.5-py2.py3-none-any.whl.

File metadata

  • Download URL: etherrain-0.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.19.9 CPython/3.6.5

File hashes

Hashes for etherrain-0.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 232ffc0e1ac30b038c5aa97cad832f8575b44304c122aea2660de006aeb10aee
MD5 3539dbb1a147a9836ea0c7c080c6c194
BLAKE2b-256 caea4224635286f991bd45de902f7ac0689c1b16f71ef8ea420ce7a6664a386d

See more details on using hashes here.

Provenance

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