| Name | vivosun-thermo JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Python library and CLI tool for interacting with Vivosun Thermo devices via Bluetooth |
| upload_time | 2025-01-05 01:11:17 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Copyright 2025 Artem Butusov <art.sormy@gmail.com> 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 |
vivosun
aerolab
hygrometer
thermometer
thermo
vs-thb1s
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
bleak
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Vivosun Thermo Python Library and CLI
Vivosun Thermo is a Python library and CLI tool for interacting with Vivosun Thermo devices via
Bluetooth. It allows you to:
- Read the current temperature, humidity, and computed VPD from your device.
- Scan for nearby devices.
- Use a simple API for custom integrations.
The library supports both a command-line interface (CLI) and a Python API. It is licensed under the
MIT License.
## Features
- **CLI**: Command-line interface to scan and read data from Vivosun Thermo devices.
- **API**: A Python interface for programmatic access to temperature, humidity, and VPD readings.
- **Flexible Output**: Supports text and JSON output formats for integration with other tools.
## Supported Devices
- **VS-THB1S**: VIVOSUN AeroLab Hygrometer Thermometer
## CLI Usage
### Installation
```sh
# see details for your OS: https://github.com/pypa/pipx
brew install pipx
# install as CLI
pipx install vivosun_thermo
```
### Scan for Nearby Devices
Use the `list` command to scan for nearby devices:
```sh
vivosun-thermo list
```
Options:
- `-f`, `--format`: Output format (text or json). Default: text.
- `--scan-timeout`: Duration (in seconds) for scanning devices.
- `--adapter`: Bluetooth adapter name (e.g., hci0 on Linux).
NOTE: Already connected devices won't show up in the list.
### Read Status from a Device
Use the `status` command to read temperature, humidity, and VPD:
```sh
vivosun-thermo status <device_address>
```
Options:
- `-u`, `--unit`: Temperature unit (c for Celsius, f for Fahrenheit). Default: c.
- `-f`, `--format`: Output format (text or json). Default: text.
- `--connect-timeout`: Timeout for connecting to the device. Default: 15 seconds.
- `--read-timeout`: Timeout for reading data. Default: 0.5 seconds.
- `--adapter`: Bluetooth adapter name (e.g., hci0 on Linux).
NOTE: Enable pairing mode on device for initial connection.
## Python API Usage
Example:
```python
import asyncio
from vivosun_thermo import VivosunThermoClient, PROBE_MAIN, UNIT_CELSIUS
async def main():
async with VivosunThermoClient("device_address") as client:
temperature = await client.current_temperature(PROBE_MAIN, UNIT_CELSIUS)
humidity = await client.current_humidity(PROBE_MAIN)
vpd = await client.current_vpd(PROBE_MAIN)
print(f"Temperature: {temperature}°C")
print(f"Humidity: {humidity}%")
print(f"VPD: {vpd} kPa")
asyncio.run(main())
```
## License
This project is licensed under the **MIT License**. See the `LICENSE` file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "vivosun-thermo",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "Vivosun, AeroLab, Hygrometer, Thermometer, Thermo, VS-THB1S",
"author": null,
"author_email": "Artem Butusov <art.sormy@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fa/86/7492224259160694bd807881b1c81204f79337859d39113222d5d5749be7/vivosun_thermo-1.0.0.tar.gz",
"platform": null,
"description": "# Vivosun Thermo Python Library and CLI\n\nVivosun Thermo is a Python library and CLI tool for interacting with Vivosun Thermo devices via\nBluetooth. It allows you to:\n\n- Read the current temperature, humidity, and computed VPD from your device.\n- Scan for nearby devices.\n- Use a simple API for custom integrations.\n\nThe library supports both a command-line interface (CLI) and a Python API. It is licensed under the\nMIT License.\n\n## Features\n\n- **CLI**: Command-line interface to scan and read data from Vivosun Thermo devices.\n- **API**: A Python interface for programmatic access to temperature, humidity, and VPD readings.\n- **Flexible Output**: Supports text and JSON output formats for integration with other tools.\n\n## Supported Devices\n\n- **VS-THB1S**: VIVOSUN AeroLab Hygrometer Thermometer\n\n## CLI Usage\n\n### Installation\n\n```sh\n# see details for your OS: https://github.com/pypa/pipx\nbrew install pipx\n# install as CLI\npipx install vivosun_thermo\n```\n\n### Scan for Nearby Devices\n\nUse the `list` command to scan for nearby devices:\n\n```sh\nvivosun-thermo list\n```\n\nOptions:\n\n- `-f`, `--format`: Output format (text or json). Default: text.\n- `--scan-timeout`: Duration (in seconds) for scanning devices.\n- `--adapter`: Bluetooth adapter name (e.g., hci0 on Linux).\n\nNOTE: Already connected devices won't show up in the list.\n\n### Read Status from a Device\n\nUse the `status` command to read temperature, humidity, and VPD:\n\n```sh\nvivosun-thermo status <device_address>\n```\n\nOptions:\n\n- `-u`, `--unit`: Temperature unit (c for Celsius, f for Fahrenheit). Default: c.\n- `-f`, `--format`: Output format (text or json). Default: text.\n- `--connect-timeout`: Timeout for connecting to the device. Default: 15 seconds.\n- `--read-timeout`: Timeout for reading data. Default: 0.5 seconds.\n- `--adapter`: Bluetooth adapter name (e.g., hci0 on Linux).\n\nNOTE: Enable pairing mode on device for initial connection.\n\n## Python API Usage\n\nExample:\n\n```python\nimport asyncio\nfrom vivosun_thermo import VivosunThermoClient, PROBE_MAIN, UNIT_CELSIUS\n\nasync def main():\n async with VivosunThermoClient(\"device_address\") as client:\n temperature = await client.current_temperature(PROBE_MAIN, UNIT_CELSIUS)\n humidity = await client.current_humidity(PROBE_MAIN)\n vpd = await client.current_vpd(PROBE_MAIN)\n print(f\"Temperature: {temperature}\u00b0C\")\n print(f\"Humidity: {humidity}%\")\n print(f\"VPD: {vpd} kPa\")\n\nasyncio.run(main())\n```\n\n## License\n\nThis project is licensed under the **MIT License**. See the `LICENSE` file for details.\n",
"bugtrack_url": null,
"license": "Copyright 2025 Artem Butusov <art.sormy@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), 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 \u201cAS IS\u201d, 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": "Python library and CLI tool for interacting with Vivosun Thermo devices via Bluetooth",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/sormy/vivosun-thermo",
"Issues": "https://github.com/sormy/vivosun-thermo/issues"
},
"split_keywords": [
"vivosun",
" aerolab",
" hygrometer",
" thermometer",
" thermo",
" vs-thb1s"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6e0bd145c3329ad11d8696b7cae3f5c7547ffcb86b1a2030724d0200764c9164",
"md5": "7087263256059c00972317242c5c70d6",
"sha256": "9e1f0943779cdb632be44aa55fa561327e722c75dcc22047fb6376ae822bcc4b"
},
"downloads": -1,
"filename": "vivosun_thermo-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7087263256059c00972317242c5c70d6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8969,
"upload_time": "2025-01-05T01:11:14",
"upload_time_iso_8601": "2025-01-05T01:11:14.623018Z",
"url": "https://files.pythonhosted.org/packages/6e/0b/d145c3329ad11d8696b7cae3f5c7547ffcb86b1a2030724d0200764c9164/vivosun_thermo-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fa867492224259160694bd807881b1c81204f79337859d39113222d5d5749be7",
"md5": "8b5dfe515fd6b972e188ef33126f625f",
"sha256": "36d23da4c2567c22b664293cb05aff21504a400fc1624281460186bec12e3153"
},
"downloads": -1,
"filename": "vivosun_thermo-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "8b5dfe515fd6b972e188ef33126f625f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 8466,
"upload_time": "2025-01-05T01:11:17",
"upload_time_iso_8601": "2025-01-05T01:11:17.255881Z",
"url": "https://files.pythonhosted.org/packages/fa/86/7492224259160694bd807881b1c81204f79337859d39113222d5d5749be7/vivosun_thermo-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-05 01:11:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sormy",
"github_project": "vivosun-thermo",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "bleak",
"specs": [
[
"~=",
"0.22.3"
]
]
}
],
"tox": true,
"lcname": "vivosun-thermo"
}
