| Name | osbee JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | Connect to your OSBee 3-valve controller's REST API |
| upload_time | 2024-08-10 22:09:18 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT License Copyright (c) 2022 Allan Clark Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
osbee
opensprinkler
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "osbee",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "osbee, opensprinkler",
"author": null,
"author_email": "Allan Clark <allanc@chickenandpork.com>",
"download_url": "https://files.pythonhosted.org/packages/ae/8b/0d206ca86f31dd11bbf243746f39d69745221b5dddf6aa1704256e44f0b2/osbee-0.3.1.tar.gz",
"platform": null,
"description": "# osbee\nUtilities for OSBee-3.0 device from OpenSprinkler\n\nThe OSBeeAPI class wraps an async client of the OSBee REST API to make it look like a few\nindependent valves. Essentially split off from my HomeAssistant integration.\n\n\n## Can I talk to my OSBee?\n\nMy personal OSBee is a v1.0.0; I've been chatting with someone whose v1.0.2 behaves a bit\ndifferently. examples/dump_status.py can be used to connect to an OSBee and see if we can read the\nstatus of the valves and the OSBee in general.\n\n python3 -m venv osbee_testing\n source osbee_testing/bin/activate\n pip install osbee\n python3 examples/dump_status.py\n deactivate\n\nYou *should* see the status of your OSBee dumped out:\n\n $ python3 examples/dump_status.py\n type of timeout/max_runtime is <class 'int'>\n created OSBeeAPI at 192.168.0.1 max_runtime 30 (<class 'int'>)\n {\n \"cid\": 5437235,\n \"fwv\": 100,\n \"mac\": \"C45BBE123456\",\n \"mnp\": 6,\n \"name\": \"My OSBee WiFi\",\n \"np\": 0,\n \"nt\": 0,\n \"pid\": -1,\n \"prem\": 0,\n \"rssi\": -59,\n \"sot\": 1,\n \"tid\": -1,\n \"trem\": 0,\n \"utct\": 1716967540,\n \"zbits\": 0,\n \"zons\": [\n \"Zone 1\",\n \"Zone 2\",\n \"Zone 3\"\n ]\n }\n\nIf you see an exception and/or stack-trace, file an Issue in github and let's chat about it.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Allan Clark Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Connect to your OSBee 3-valve controller's REST API",
"version": "0.3.1",
"project_urls": {
"Changelog": "https://github.com/chickenandpork/osbee/blob/master/CHANGELOG.md",
"Homepage": "https://github.com/chickenandpork/osbee",
"Issues": "https://github.com/chickenandpork/osbee/issues",
"Repository": "https://github.com/chickenandpork/osbee.git"
},
"split_keywords": [
"osbee",
" opensprinkler"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bf3b4ea006d22105449e99374938fede110abe50a42b7b3718df3bd99254b57d",
"md5": "3e6130705e36151df6ed0c1f65918692",
"sha256": "1722b6ac245fdbbb1ccb30ad6898e2eac1e13a50e098117ddb8a228329c4975c"
},
"downloads": -1,
"filename": "osbee-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3e6130705e36151df6ed0c1f65918692",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6065,
"upload_time": "2024-08-10T22:09:16",
"upload_time_iso_8601": "2024-08-10T22:09:16.627378Z",
"url": "https://files.pythonhosted.org/packages/bf/3b/4ea006d22105449e99374938fede110abe50a42b7b3718df3bd99254b57d/osbee-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ae8b0d206ca86f31dd11bbf243746f39d69745221b5dddf6aa1704256e44f0b2",
"md5": "ce5a2517cabb76ade46c30313ab847cf",
"sha256": "7e3ec8481dbe74ec99973a4d44c356e9da4e27d023c4af60e8425906e0b71d38"
},
"downloads": -1,
"filename": "osbee-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "ce5a2517cabb76ade46c30313ab847cf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5326,
"upload_time": "2024-08-10T22:09:18",
"upload_time_iso_8601": "2024-08-10T22:09:18.037734Z",
"url": "https://files.pythonhosted.org/packages/ae/8b/0d206ca86f31dd11bbf243746f39d69745221b5dddf6aa1704256e44f0b2/osbee-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-10 22:09:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chickenandpork",
"github_project": "osbee",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "osbee"
}
