Skip to main content

Connect to your OSBee 3-valve controller's REST API

Project description

osbee

Utilities for OSBee-3.0 device from OpenSprinkler

The OSBeeAPI class wraps an async client of the OSBee REST API to make it look like a few independent valves. Essentially split off from my HomeAssistant integration.

Can I talk to my OSBee?

My personal OSBee is a v1.0.0; I've been chatting with someone whose v1.0.2 behaves a bit differently. examples/dump_status.py can be used to connect to an OSBee and see if we can read the status of the valves and the OSBee in general.

python3 -m venv osbee_testing
source osbee_testing/bin/activate
pip install osbee
python3 examples/dump_status.py
deactivate

You should see the status of your OSBee dumped out:

$ python3 examples/dump_status.py
type of timeout/max_runtime is <class 'int'>
created OSBeeAPI at 192.168.0.1 max_runtime 30 (<class 'int'>)
{
    "cid": 5437235,
    "fwv": 100,
    "mac": "C45BBE123456",
    "mnp": 6,
    "name": "My OSBee WiFi",
    "np": 0,
    "nt": 0,
    "pid": -1,
    "prem": 0,
    "rssi": -59,
    "sot": 1,
    "tid": -1,
    "trem": 0,
    "utct": 1716967540,
    "zbits": 0,
    "zons": [
        "Zone 1",
        "Zone 2",
        "Zone 3"
    ]
}

If you see an exception and/or stack-trace, file an Issue in github and let's chat about it.

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

osbee-0.3.1.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

osbee-0.3.1-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file osbee-0.3.1.tar.gz.

File metadata

  • Download URL: osbee-0.3.1.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for osbee-0.3.1.tar.gz
Algorithm Hash digest
SHA256 7e3ec8481dbe74ec99973a4d44c356e9da4e27d023c4af60e8425906e0b71d38
MD5 ce5a2517cabb76ade46c30313ab847cf
BLAKE2b-256 ae8b0d206ca86f31dd11bbf243746f39d69745221b5dddf6aa1704256e44f0b2

See more details on using hashes here.

File details

Details for the file osbee-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: osbee-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for osbee-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1722b6ac245fdbbb1ccb30ad6898e2eac1e13a50e098117ddb8a228329c4975c
MD5 3e6130705e36151df6ed0c1f65918692
BLAKE2b-256 bf3b4ea006d22105449e99374938fede110abe50a42b7b3718df3bd99254b57d

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