neewer-cli 0.1.1__py3-none-any.whl

neewer_cli-0.1.1.dist-info/METADATA

@@ -0,0 +1,251 @@
+Metadata-Version: 2.4
+Name: neewer-cli
+Version: 0.1.1
+Summary: Standalone Neewer BLE CLI utility
+Author: Sergei Dubovsky
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/SergeDubovsky/neewer-cli
+Project-URL: Repository, https://github.com/SergeDubovsky/neewer-cli
+Project-URL: Issues, https://github.com/SergeDubovsky/neewer-cli/issues
+Keywords: neewer,ble,bluetooth,lighting,cli
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Environment :: Console
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: bleak>=0.20
+Provides-Extra: yaml
+Requires-Dist: PyYAML>=6.0; extra == "yaml"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Dynamic: license-file
+
+# neewer-cli
+
+[![CI](https://github.com/SergeDubovsky/neewer-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/SergeDubovsky/neewer-cli/actions/workflows/ci.yml)
+[![Release](https://github.com/SergeDubovsky/neewer-cli/actions/workflows/release.yml/badge.svg)](https://github.com/SergeDubovsky/neewer-cli/actions/workflows/release.yml)
+[![License: MIT](https://img.shields.io/github/license/SergeDubovsky/neewer-cli)](LICENSE)
+
+Standalone Neewer BLE command-line utility focused on fast and reliable control without a GUI.
+
+## Why This Tool
+
+- CLI-only workflow for scripting and automation.
+- Reliability controls for unstable BLE environments (retries, passes, bounded parallelism).
+- Fast fixed-rig operation with config-driven `--skip-discovery`.
+- Presets, groups, and per-light command overrides keyed by MAC.
+
+## Attribution
+
+This project is based on and derives protocol/model support from:
+
+- **NeewerLite-Python** by **Zach Glenwright**
+- https://github.com/taburineagle/NeewerLite-Python
+
+## Requirements
+
+- Python `3.9+`
+- Bluetooth adapter with BLE support
+
+The runtime BLE dependency (`bleak`) is installed automatically by package install commands below.
+
+## Installation
+
+Current recommended install (GitHub source):
+
+```bash
+# one-time install of pipx
+python -m pip install --user pipx
+python -m pipx ensurepath
+
+# install neewer-cli from GitHub
+pipx install git+https://github.com/SergeDubovsky/neewer-cli.git
+```
+
+Alternative user install:
+
+```bash
+python -m pip install --user git+https://github.com/SergeDubovsky/neewer-cli.git
+```
+
+After install:
+
+```bash
+neewer-cli --help
+neewer-cli --version
+```
+
+PyPI publishing is handled by GitHub Actions using Trusted Publishing (OIDC).
+
+## Quick Start
+
+```bash
+# 1) discover lights
+neewer-cli --list
+
+# 2) copy example config to default config path
+# Windows (PowerShell/CMD)
+copy neewer.example.json %USERPROFILE%\.neewer
+
+# macOS/Linux
+cp neewer.example.json ~/.neewer
+
+# 3) run presets
+neewer-cli --preset all_on
+neewer-cli --preset all_off
+neewer-cli --preset key_cct_5600_30
+```
+
+## Common Commands
+
+```bash
+# turn configured lights on/off quickly
+neewer-cli --preset all_on
+neewer-cli --preset all_off
+
+# send direct command to specific MACs
+neewer-cli --light D2:E2:75:8B:36:45,F8:46:85:EF:47:70 --mode CCT --temp 5600 --bri 30
+
+# fast fixed-rig mode (no scan)
+neewer-cli --light group:studio --preset all_on --skip-discovery
+
+# persistent low-latency mode (keep connections open)
+neewer-cli --serve --light group:studio --skip-discovery --debug
+```
+
+## Configuration
+
+Default config path:
+
+- `~/.neewer` (Windows: `%USERPROFILE%\.neewer`)
+
+Top-level config keys:
+
+- `defaults`: default CLI flags
+- `lights`: per-MAC metadata (`name`, `cct_only`, `infinity_mode`, `hw_mac`, optional feature flags)
+- `groups`: named MAC sets
+- `presets`: reusable command sets
+- `presets.<name>.per_light`: per-light command overrides in one run
+
+Optional per-light feature flags in `lights`:
+
+- `supports_status_query`: override model detection for `--status` query commands
+- `supports_extended_scene`: override model detection for extended scene payloads
+
+Reference material:
+
+- Example config: [neewer.example.json](neewer.example.json)
+- Wiki configuration guide: https://github.com/SergeDubovsky/neewer-cli/wiki/Configuration
+
+## Reliability Tuning
+
+For flaky BLE environments, tune:
+
+- `--scan-attempts`
+- `--resolve-timeout` (short BLE handle resolve scan for `--skip-discovery`)
+- `--connect-retries`
+- `--write-retries`
+- `--passes` (adaptive retries for failed lights only)
+- `--parallel`
+
+For stable fixed setups, keep `lights` fully defined in config and use `--skip-discovery` to reduce latency.
+
+## Advanced Protocol (Experimental)
+
+Advanced commands are opt-in behind feature flags and still gated by per-model support.
+
+Status query (power/channel):
+
+```bash
+neewer-cli --light group:studio --status --enable-status-query --skip-discovery
+```
+
+Extended scene arguments (supported models only):
+
+```bash
+neewer-cli --light group:studio --mode SCENE --scene 12 --bri 40 \
+  --scene-hue-min 20 --scene-hue-max 240 --scene-speed 7 \
+  --enable-extended-scene
+```
+
+If auto-detection is wrong for a specific light, set `supports_status_query` or
+`supports_extended_scene` for that MAC in config.
+
+### Serve Mode
+
+`--serve` keeps BLE connections open and accepts commands from stdin:
+
+```bash
+neewer-cli --serve --light group:studio --skip-discovery --debug
+```
+
+Interactive commands:
+
+- `on`
+- `off`
+- `cct <temp> <bri> [gm]`
+- `hsi <hue> <sat> <bri>`
+- `scene <effect> <bri>`
+- `preset <name>`
+- `help`
+- `exit`
+
+## Security
+
+- Private vulnerability reporting is enabled.
+- Code scanning (CodeQL) is enabled for `python` and `actions`.
+- Secret scanning and push protection are enabled.
+
+Please report security issues privately per [SECURITY.md](SECURITY.md).
+
+## Releases
+
+GitHub releases include wheel and source distribution artifacts:
+
+- https://github.com/SergeDubovsky/neewer-cli/releases
+
+Maintainer release flow:
+
+1. Update `version` in `pyproject.toml`.
+2. Run local checks (`ruff`, `pytest`, `build`, `twine check`).
+3. Commit and push to `main`.
+4. Tag and push (`git tag vX.Y.Z && git push origin vX.Y.Z`).
+5. Release workflow:
+   - builds + tests
+   - publishes to TestPyPI (`testpypi` environment)
+   - publishes to PyPI (`pypi` environment)
+   - creates a GitHub Release with built artifacts
+
+Trusted Publishing setup requirement:
+
+- In both TestPyPI and PyPI project settings, add this repository/workflow as a Trusted Publisher for:
+  - owner/repo: `SergeDubovsky/neewer-cli`
+  - workflow: `.github/workflows/release.yml`
+  - environments: `testpypi` and `pypi`
+
+## Project Docs
+
+- Wiki home: https://github.com/SergeDubovsky/neewer-cli/wiki
+- Developer guide: https://github.com/SergeDubovsky/neewer-cli/wiki/Developer-Guide
+- Contributing: [CONTRIBUTING.md](CONTRIBUTING.md)
+- Release process: [RELEASING.md](RELEASING.md)
+- Security policy: [SECURITY.md](SECURITY.md)
+- Support policy: [SUPPORT.md](SUPPORT.md)
+- Code of conduct: [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
+
+## License
+
+MIT. See [LICENSE](LICENSE).

neewer_cli-0.1.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+neewer_cli.py,sha256=d9IR1tz5uKcFLvxWxoqP1F4AYaoqU2Nu41NWPQ4H3Vo,72622
+neewer_cli-0.1.1.dist-info/licenses/LICENSE,sha256=-Sntk_TxE7-TE0nHwnk0-h9fAIsh0EwObXkrO0mz22E,1112
+neewer_cli-0.1.1.dist-info/licenses/NOTICE,sha256=ZE88yURko4383rkSaG_eENLjUqlMEPm5jboviT_UT5M,229
+neewer_cli-0.1.1.dist-info/METADATA,sha256=z-Kr_ipy22yzjW4OXJgtP123OJDFK818AiB50hsAOtc,7437
+neewer_cli-0.1.1.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+neewer_cli-0.1.1.dist-info/entry_points.txt,sha256=UIjtuQ_yYE2Bbv_sHznWEkUFAkUCyUh8LgKn9xO_-kQ,47
+neewer_cli-0.1.1.dist-info/top_level.txt,sha256=sBWnEsqDvncWtcIvfNUV8td_Dm5eA57oyClVE05jpkM,11
+neewer_cli-0.1.1.dist-info/RECORD,,

neewer_cli-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

neewer_cli-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+neewer-cli = neewer_cli:main

neewer_cli-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2021-2022 Zach Glenwright
+Copyright (c) 2026 Sergei Dubovsky
+
+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.

neewer_cli-0.1.1.dist-info/licenses/NOTICE

@@ -0,0 +1,8 @@
+This project contains work derived from:
+
+NeewerLite-Python
+Copyright (c) 2021-2022 Zach Glenwright
+https://github.com/taburineagle/NeewerLite-Python
+
+Modifications and standalone CLI refactor:
+Copyright (c) 2026 Sergei Dubovsky

neewer_cli-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+neewer_cli