# Floodlights CLI
Floodlights CLI is a command-line interface tool for controlling floodlight devices using the TinyTuya library. It provides an easy way to turn floodlights on and off, set brightness levels, and query the status of the device.
## Features
- Turn floodlights on and off with simple commands.
- Set brightness levels for the floodlights.
- Query the current status of the floodlights.
- Utilizes a configuration file for device configuration. If the `config.ini` file is missing, the script will prompt you to create one.
## Installation
You can install Floodlights CLI using pip:
```bash
pip install floodlights
```
## Configuration
Set up the required configuration in a \`config.ini\` file:
```ini
[Floodlight]
DEVICE_ID=your_device_id
DEVICE_IP=your_device_ip
DEVICE_KEY=your_device_key
DEVICE_VERSION=your_device_version
```
## Usage
### Turn On Floodlights
```bash
floodlights on --brightness 1000
```
### Turn Off Floodlights
```bash
floodlights off
```
### Get Floodlights Status
```bash
floodlights status
```
## Dependencies
- tinytuya
- click
- logging
- configparser
- json
## Contributing
If you would like to contribute to this project, please feel free to submit a pull request or open an issue.
## License
Please refer to the LICENSE file for information on the license governing this project.
## Contact
For any questions or support, please contact the maintainer at [dddanmar@gmail.com](mailto:dddanmar@gmail.com), CEO of [OnlyDans](https://onlydans.com.au).
Raw data
{
"_id": null,
"home_page": "https://github.com/BriefcaseCo/floodlight-py",
"name": "floodlights",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6, <4",
"maintainer_email": "",
"keywords": "floodlights cli home automation",
"author": "dddanmar",
"author_email": "dddanmar@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/77/57/04edafa50be8eba81d5499486ea25928073b68b75c1c3a7893b2928778fe/floodlights-0.2.tar.gz",
"platform": null,
"description": "# Floodlights CLI\n\nFloodlights CLI is a command-line interface tool for controlling floodlight devices using the TinyTuya library. It provides an easy way to turn floodlights on and off, set brightness levels, and query the status of the device.\n\n## Features\n\n- Turn floodlights on and off with simple commands.\n- Set brightness levels for the floodlights.\n- Query the current status of the floodlights.\n- Utilizes a configuration file for device configuration. If the `config.ini` file is missing, the script will prompt you to create one.\n\n## Installation\n\nYou can install Floodlights CLI using pip:\n\n```bash\npip install floodlights\n```\n\n## Configuration\n\nSet up the required configuration in a \\`config.ini\\` file:\n\n```ini\n[Floodlight]\nDEVICE_ID=your_device_id\nDEVICE_IP=your_device_ip\nDEVICE_KEY=your_device_key\nDEVICE_VERSION=your_device_version\n```\n\n## Usage\n\n### Turn On Floodlights\n\n```bash\nfloodlights on --brightness 1000\n```\n\n### Turn Off Floodlights\n\n```bash\nfloodlights off\n```\n\n### Get Floodlights Status\n\n```bash\nfloodlights status\n```\n\n## Dependencies\n\n- tinytuya\n- click\n- logging\n- configparser\n- json\n\n## Contributing\n\nIf you would like to contribute to this project, please feel free to submit a pull request or open an issue.\n\n## License\n\nPlease refer to the LICENSE file for information on the license governing this project.\n\n## Contact\n\nFor any questions or support, please contact the maintainer at [dddanmar@gmail.com](mailto:dddanmar@gmail.com), CEO of [OnlyDans](https://onlydans.com.au).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI for controlling floodlight devices using the TinyTuya library.",
"version": "0.2",
"project_urls": {
"Homepage": "https://github.com/BriefcaseCo/floodlight-py"
},
"split_keywords": [
"floodlights",
"cli",
"home",
"automation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27137047976c82cb7fd7a6320437552d8c1b6cfee312391e69444883ae56c443",
"md5": "85339c5c4271de4aedb9650ad6b5d0e3",
"sha256": "e2fedfcb3111d266eb980d22e8157768a23a4969c9c4b4570cd85699038f3fc8"
},
"downloads": -1,
"filename": "floodlights-0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "85339c5c4271de4aedb9650ad6b5d0e3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6, <4",
"size": 2155,
"upload_time": "2023-08-20T14:12:11",
"upload_time_iso_8601": "2023-08-20T14:12:11.038536Z",
"url": "https://files.pythonhosted.org/packages/27/13/7047976c82cb7fd7a6320437552d8c1b6cfee312391e69444883ae56c443/floodlights-0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "775704edafa50be8eba81d5499486ea25928073b68b75c1c3a7893b2928778fe",
"md5": "bc41a8afe83de05a28a9f873346e5c60",
"sha256": "f711e08d7d43a028790fc5b836b4a30046a6ee50949da37b5a6b0156ac00d13b"
},
"downloads": -1,
"filename": "floodlights-0.2.tar.gz",
"has_sig": false,
"md5_digest": "bc41a8afe83de05a28a9f873346e5c60",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6, <4",
"size": 2181,
"upload_time": "2023-08-20T14:12:13",
"upload_time_iso_8601": "2023-08-20T14:12:13.907467Z",
"url": "https://files.pythonhosted.org/packages/77/57/04edafa50be8eba81d5499486ea25928073b68b75c1c3a7893b2928778fe/floodlights-0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-20 14:12:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BriefcaseCo",
"github_project": "floodlight-py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "floodlights"
}
JSON
