pyminleon 0.1.0__tar.gz

pyminleon-0.1.0/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+
+[*.py]
+indent_size = 4

pyminleon-0.1.0/.gitattributes

@@ -0,0 +1,2 @@
+*.bin binary
+tests/fixtures/** -text

pyminleon-0.1.0/.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# Default reviewers for everything in this repository (review routing).
+# Seed-once: refine per-path ownership as the project grows.
+* @amattas

pyminleon-0.1.0/.github/dependabot.yml

@@ -0,0 +1,25 @@
+# Standard Dependabot config (mattas-net security standard): monthly, 7-day cooldown,
+# one grouped PR per ecosystem. Security updates are separate and stay immediate.
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: /
+  schedule:
+    interval: monthly
+  cooldown:
+    default-days: 7
+  groups:
+    pip:
+      patterns:
+      - '*'
+
+- package-ecosystem: github-actions
+  directory: /
+  schedule:
+    interval: monthly
+  cooldown:
+    default-days: 7
+  groups:
+    github-actions:
+      patterns:
+      - '*'

pyminleon-0.1.0/.github/workflows/checks.yml

@@ -0,0 +1,63 @@
+# Checks — automatic on push to main; on pull requests the run waits at the
+# `approve` job until a reviewer approves it in the `approval` environment. The
+# Release workflow requires a successful run of this workflow on main HEAD.
+#
+# Required checks (default-branch ruleset): "checks" and "security" (alias jobs below).
+# Until the ruleset flips (WP-1 pass 2) it still requires "python / checks (<python>)" and
+# "python / security", which the `python` job keeps producing. See mattas-net/.github STANDARD.md.
+name: Checks
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: checks-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  approve:
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+    environment: approval
+    steps:
+      - run: echo "Checks approved by ${GITHUB_TRIGGERING_ACTOR}"
+
+  python:
+    needs: approve
+    if: always() && needs.approve.result != 'failure' && needs.approve.result != 'cancelled'
+    uses: mattas-net/.github/.github/workflows/python-ci.yml@main
+    permissions:
+      contents: read
+    with:
+      python-versions: '["3.12", "3.13", "3.14"]'
+      extra-lint: bandit -q -r src
+      audit: strict
+
+  checks:
+    needs: python
+    if: always() # a skipped required check counts as passing, so always run and assert
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+    steps:
+      - name: Require the shared checks job
+        env:
+          RESULT: ${{ needs.python.outputs.checks-result }}
+        run: test "$RESULT" = success
+
+  security:
+    needs: python
+    if: always()
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+    steps:
+      - name: Require the shared security job
+        env:
+          RESULT: ${{ needs.python.outputs.security-result }}
+        run: test "$RESULT" = success

pyminleon-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: Docs
+
+# Docs: build every documented version with Zensical and publish the versioned site (mike) to the
+# gh-pages branch with the shared mattas-net/.github docs.yml (scripts/publish_versioned_docs.py):
+#   dev = main, X.Y = newest patch tag of each documented minor line, latest = highest stable release.
+# Public repos serve gh-pages with Pages; private repos build gh-pages and keep Pages disabled.
+# Triggers: push to main, manual dispatch, and workflow_call (release.yml calls it after tagging).
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+  workflow_call:
+    inputs:
+      version:
+        description: Release version that triggered the publish (informational)
+        type: string
+        default: ""
+
+permissions:
+  contents: read
+
+jobs:
+  docs:
+    uses: mattas-net/.github/.github/workflows/docs.yml@main
+    permissions:
+      contents: write # the publish script pushes the gh-pages branch
+    with:
+      version: ${{ inputs.version }}
+      python-version: "3.13"
+      install: python -m pip install --disable-pip-version-check -e ".[docs]" -r requirements-docs.txt

pyminleon-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,71 @@
+# Release procedure and the create-release checks: see mattas-net/.github STANDARD.md (Release).
+# Release: bump [project].version in pyproject.toml, merge to main, then
+# Actions -> Release -> Run workflow -> enter that version (bare semver, e.g. 0.2.0
+# or 0.2.0-beta1). create-release.yml verifies the manifest and the passing Checks
+# run on main HEAD, then tags main and creates the GitHub release; python-build.yml
+# builds the tag and verifies the wheel version. Publishing runs in the `pypi`
+# environment (required reviewer gate); PyPI trusted publishing must be registered
+# for workflow `release.yml` + environment `pypi`. The built files are attached to
+# the release after a successful publish; the final `docs` job then rebuilds the
+# versioned docs.
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: Version to release (bare semver, e.g. 1.4.2)
+        required: true
+        type: string
+
+permissions:
+  contents: read
+
+jobs:
+  release:
+    uses: mattas-net/.github/.github/workflows/create-release.yml@main
+    permissions:
+      contents: write
+      actions: read
+    with:
+      version: ${{ inputs.version }}
+      manifest: pyproject.toml
+      require-workflow: Checks
+
+  build:
+    needs: release
+    uses: mattas-net/.github/.github/workflows/python-build.yml@main
+    permissions:
+      contents: read
+    with:
+      ref: ${{ inputs.version }}
+
+  publish:
+    needs: build
+    runs-on: ubuntu-24.04
+    environment: pypi # must match the PyPI trusted publisher
+    permissions:
+      contents: write # attach the files to the release
+      id-token: write # trusted publishing
+      attestations: write
+    steps:
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: dist
+          path: dist/
+      - uses: actions/attest-build-provenance@4d101475d8b20a2381f78447822ac1eab6504dd8 # v4.2.2
+        with:
+          subject-path: dist/*
+      - uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3
+      - env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ inputs.version }}
+        run: gh release upload "$TAG" dist/* --repo "$GITHUB_REPOSITORY"
+
+  docs:
+    needs: publish
+    permissions:
+      contents: write # docs.yml: the publish script pushes the gh-pages branch
+    uses: ./.github/workflows/docs.yml
+    with:
+      version: ${{ inputs.version }}

pyminleon-0.1.0/.gitignore

@@ -0,0 +1,31 @@
+# OS / editor
+.DS_Store
+*.swp
+.idea/
+.vscode/
+
+# Build / dependency output
+dist/
+build/
+*.egg-info/
+.venv/
+__pycache__/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+coverage/
+.coverage
+.build/
+
+htmlcov/
+coverage.xml
+*.py[cod]
+.env
+
+
+coverage.json
+
+# Zensical docs: built site, cache, and generated API reference
+/site
+.cache/
+docs/api/reference.md

pyminleon-0.1.0/AGENTS.md

@@ -0,0 +1,61 @@
+# pyminleon - Python Library for Minleon NDB-Pro Control
+
+## Project Overview
+
+**Purpose**: Standalone asyncio Python library that controls Minleon NDB-Pro LED controllers' built-in effects over the
+HTTP endpoints the controller's web UI uses. Extracted from aioddp so aioddp stays a pure DDP (UDP pixel) library.
+
+**Features**: `NDBController` (`state`, `presets`, `set_effect`, `set_intensity`, `recall_preset`, `config`,
+`status`), `identify(host)`, `SUPPORTED_MODELS`. Zero runtime dependencies.
+
+### What This Is NOT
+- Not a DDP sender (aioddp is) and not a Home Assistant integration (hass-ddp is; it imports pyminleon)
+- Not a writer of controller settings: no saved config, no preset saves
+
+## Architecture
+
+```
+src/pyminleon/
+├── __init__.py     # Public exports; consumers import only from `pyminleon`
+├── ndb.py          # NDBController, NDBState, NDBPreset, identify, SUPPORTED_MODELS
+├── _http.py        # Private minimal asyncio HTTP/1.0 client (chunked decoding, size caps, host validation)
+└── exceptions.py   # MinleonError > ConfigError, ControllerError
+```
+
+## Safety invariants (tested; do not weaken)
+
+- Never request `?s=N` on `/pshows.html` (saves a preset slot); never send `saveon`
+- Only `POST /api/control`, `GET /pshows.html?r=N`, and read-only pages
+- Unparsable HTML/JSON is a `ControllerError`, never a guess
+- No redirects followed; bodies capped at 64 KiB; one deadline per call
+
+## Development
+
+Python env is the conda env `pyminleon` (never base, never venv).
+
+```bash
+conda run -n pyminleon python -m pytest -q
+conda run -n pyminleon ruff check .
+conda run -n pyminleon ruff format --check .
+conda run -n pyminleon mypy
+conda run -n pyminleon bandit -q -r src
+```
+
+Coverage gate: 90% total branch coverage (`fail_under` in pyproject.toml; every pytest run enforces it).
+
+## Testing Approach
+
+- pytest + pytest-asyncio (`asyncio_mode = "auto"`). TDD; parametrize variations of one behavior
+- `http_controller` fixture: real asyncio HTTP server on loopback serving pages captured from a real NDB-Pro
+  (`tests/fixtures/ndbpro/`), with slow, chunked, unframed, and redirect modes; no mocking of the client
+- `no_leaked_tasks` autouse fixture enforces no orphaned asyncio tasks
+
+## Technical Decisions
+
+- `src/pyminleon` layout, hatchling, `requires-python >=3.12`, `dependencies = []`, extra: `dev`
+- ruff (lint + format) line length 120, rules `E, F, I, B, UP, SIM, S`; mypy strict; bandit
+- Standard `logging`; the Checks workflow runs on push to main and on approved pull requests
+
+## License
+
+Apache-2.0

pyminleon-0.1.0/CLAUDE.md

@@ -0,0 +1,61 @@
+# pyminleon - Python Library for Minleon NDB-Pro Control
+
+## Project Overview
+
+**Purpose**: Standalone asyncio Python library that controls Minleon NDB-Pro LED controllers' built-in effects over the
+HTTP endpoints the controller's web UI uses. Extracted from aioddp so aioddp stays a pure DDP (UDP pixel) library.
+
+**Features**: `NDBController` (`state`, `presets`, `set_effect`, `set_intensity`, `recall_preset`, `config`,
+`status`), `identify(host)`, `SUPPORTED_MODELS`. Zero runtime dependencies.
+
+### What This Is NOT
+- Not a DDP sender (aioddp is) and not a Home Assistant integration (hass-ddp is; it imports pyminleon)
+- Not a writer of controller settings: no saved config, no preset saves
+
+## Architecture
+
+```
+src/pyminleon/
+├── __init__.py     # Public exports; consumers import only from `pyminleon`
+├── ndb.py          # NDBController, NDBState, NDBPreset, identify, SUPPORTED_MODELS
+├── _http.py        # Private minimal asyncio HTTP/1.0 client (chunked decoding, size caps, host validation)
+└── exceptions.py   # MinleonError > ConfigError, ControllerError
+```
+
+## Safety invariants (tested; do not weaken)
+
+- Never request `?s=N` on `/pshows.html` (saves a preset slot); never send `saveon`
+- Only `POST /api/control`, `GET /pshows.html?r=N`, and read-only pages
+- Unparsable HTML/JSON is a `ControllerError`, never a guess
+- No redirects followed; bodies capped at 64 KiB; one deadline per call
+
+## Development
+
+Python env is the conda env `pyminleon` (never base, never venv).
+
+```bash
+conda run -n pyminleon python -m pytest -q
+conda run -n pyminleon ruff check .
+conda run -n pyminleon ruff format --check .
+conda run -n pyminleon mypy
+conda run -n pyminleon bandit -q -r src
+```
+
+Coverage gate: 90% total branch coverage (`fail_under` in pyproject.toml; every pytest run enforces it).
+
+## Testing Approach
+
+- pytest + pytest-asyncio (`asyncio_mode = "auto"`). TDD; parametrize variations of one behavior
+- `http_controller` fixture: real asyncio HTTP server on loopback serving pages captured from a real NDB-Pro
+  (`tests/fixtures/ndbpro/`), with slow, chunked, unframed, and redirect modes; no mocking of the client
+- `no_leaked_tasks` autouse fixture enforces no orphaned asyncio tasks
+
+## Technical Decisions
+
+- `src/pyminleon` layout, hatchling, `requires-python >=3.12`, `dependencies = []`, extra: `dev`
+- ruff (lint + format) line length 120, rules `E, F, I, B, UP, SIM, S`; mypy strict; bandit
+- Standard `logging`; the Checks workflow runs on push to main and on approved pull requests
+
+## License
+
+Apache-2.0

pyminleon-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 PyDMP Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pyminleon-0.1.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.5
+Name: pyminleon
+Version: 0.1.0
+Summary: Asyncio control of Minleon NDB-Pro LED controllers' built-in effects over HTTP
+Project-URL: Documentation, https://amattas.github.io/pyminleon/
+Project-URL: Source, https://github.com/amattas/pyminleon
+Author-email: Anthony Mattas <anthony@mattas.net>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: home-automation,led,lighting,minleon,ndb-pro
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Home Automation
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Provides-Extra: dev
+Requires-Dist: bandit==1.9.4; extra == 'dev'
+Requires-Dist: build==1.6.1; extra == 'dev'
+Requires-Dist: mypy==2.3.0; extra == 'dev'
+Requires-Dist: pre-commit==4.7.0; extra == 'dev'
+Requires-Dist: pytest-asyncio==1.4.0; extra == 'dev'
+Requires-Dist: pytest-cov==7.1.0; extra == 'dev'
+Requires-Dist: pytest==9.1.1; extra == 'dev'
+Requires-Dist: pyyaml==6.0.3; extra == 'dev'
+Requires-Dist: ruff==0.17.2; extra == 'dev'
+Requires-Dist: types-pyyaml==6.0.12.20260906; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: pydoc-markdown==4.8.2; extra == 'docs'
+Requires-Dist: zensical==0.0.50; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# pyminleon
+
+Asyncio Python library that controls the built-in effects of Minleon NDB-Pro LED controllers over the HTTP endpoints
+the controller's own web UI uses. Zero runtime dependencies (stdlib only), Python 3.12+.
+
+It does not send pixel data. For that, use a DDP sender such as [aioddp](https://github.com/amattas/aioddp). While DDP
+data flows it overrides the built-in effect; about 20 s after DDP stops the controller falls back to it.
+
+## Quick start
+
+```python
+import asyncio
+
+from pyminleon import NDBController, identify
+
+
+async def main() -> None:
+    host = "10.0.40.20"  # placeholder
+    if await identify(host) is None:
+        raise SystemExit("not a supported Minleon controller")
+
+    ndb = NDBController(host)
+    state = await ndb.state()  # NDBState(effect="Glow", intensity=100, effects=("Off", ..., "Worms"))
+    await ndb.set_effect("Color Wave")
+    await ndb.set_intensity(60)
+    await ndb.recall_preset(3)  # slots 0-9 are "Show 1", 10-19 "Show 2"
+    layout = await ndb.config()  # raw JSON from GET /api/config (DDP-spec layout document)
+    print(state, layout["config"]["ports"][0], (await ndb.status())["status"]["mod"])
+
+
+asyncio.run(main())
+```
+
+## API
+
+- `NDBController(host, *, port=80, timeout=3.0)`
+  - `await state() -> NDBState` selected effect, intensity, and every effect the controller offers
+  - `await presets() -> tuple[NDBPreset, ...]` stored show slots
+  - `await set_effect(name)`, `await set_intensity(percent)`, `await recall_preset(slot)`
+  - `await config() -> dict[str, Any]`, `await status() -> dict[str, Any]` raw `/api/config` and `/api/status` documents
+- `await identify(host, *, port=80, timeout=3.0) -> str | None` the model id (e.g. `"NDBPRO"`) if the host reports a
+  model in `SUPPORTED_MODELS`; `None` if it answers but is not a supported Minleon, or does not answer in time
+- Errors: `MinleonError` > `ConfigError` (bad host, port, timeout, or argument), `ControllerError` (unreachable,
+  timed out, non-200, or an unreadable page or document)
+
+## Safety
+
+- Nothing is ever written to the controller's saved settings. The library never requests `/pshows.html?s=N` (which
+  overwrites a preset slot) and never sends `saveon`. The only requests it makes are `POST /api/control`,
+  `GET /pshows.html?r=N` (recall), and read-only pages (`/pfx2.html`, `/pcolors.html`, `/pshows.html`,
+  `/api/config`, `/api/status`).
+- `state()` and `presets()` parse the web UI's HTML with strict patterns written against firmware 2.0 and raise
+  `ControllerError` on anything else rather than guessing.
+- HTTP responses are size-capped (64 KiB), redirects are never followed, and each call is bounded by `timeout`.
+- Hosts are validated (hostname, IPv4, or IPv6 literal only) so a value can never steer the path, port, or scheme.
+
+## Documentation
+
+https://amattas.github.io/pyminleon/
+
+## Development
+
+```bash
+conda create -n pyminleon -c conda-forge python=3.14
+conda run -n pyminleon python -m pip install -e ".[dev]"
+conda run -n pyminleon python -m pytest -q
+conda run -n pyminleon ruff check . && conda run -n pyminleon ruff format --check . && conda run -n pyminleon mypy
+conda run -n pyminleon bandit -q -r src
+```
+
+## License
+
+Apache-2.0