edgeloom 0.1.0__tar.gz

edgeloom-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+.pytest_cache/
+.ruff_cache/
+__pycache__/
+*.pyc
+.DS_Store
+*.egg-info/
+build/
+dist/
+.venv/
+venv/
+discovery/catalog*.json
+discovery/catalog*.yaml

edgeloom-0.1.0/CHANGELOG.md

@@ -0,0 +1,73 @@
+# Changelog
+
+All notable changes to this project are documented here.
+
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and
+this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-08-23
+
+First release under the EdgeLoom name. Unifies the SmartThings Edge driver
+patcher and the Home Assistant translator into one installable toolchain with a
+published schema between them.
+
+### Added
+
+- **Unified `edgeloom` CLI** with four subcommands: `patch`, `translate`,
+  `discover`, and `validate`.
+- **Schema v0.1** — two JSON Schemas (draft 2020-12) published under `schema/`:
+  `profile.schema.json` for device profiles and `capability-map.schema.json` for
+  attribute-to-capability bindings. Both ship inside the installed package.
+- **`edgeloom validate`** as a CI-ready assurance gate. It checks profiles
+  emitted by either toolchain path against one contract, and exits non-zero both
+  on a violation and on finding nothing to check.
+- **`auto_patch/capability-map.yaml`**, generated from the legacy INI pair and
+  validated in CI, so the schema is grounded in the mapping actually in use.
+- **Python packaging** via hatchling. `pip install edgeloom` provides the CLI;
+  the distribution spans `edgeloom`, `auto_patch`, `discovery`, and
+  `ha2st_edge`.
+- **Home Assistant translator** merged from
+  [HA2ST-Translator](https://github.com/edgeloom-oss/HA2ST-Translator) with its
+  commit history preserved, now at `translator/` and reachable as
+  `edgeloom translate`.
+- **`SECURITY.md`** with a private disclosure path and an explicit statement of
+  the tool's by-design behaviour.
+- **First tests for the shell entrypoint**, covering backup creation, reuse,
+  dry-run, and argument rejection.
+
+### Fixed
+
+- **`auto_patch.sh` never created the driver backup.** The guard used `else:`
+  rather than the bash reserved word `else`, so it parsed as a command inside
+  the then-list and the if-statement had no else-branch. On a first run the
+  backup step was skipped entirely and the driver was patched destructively,
+  contradicting the documented safety guarantee; when a backup did exist the
+  stray command aborted the run at exit 127. `bash -n` reports the file clean,
+  and CI linted only Python, so nothing caught it.
+- **A failed patch could delete the driver.** `restore_backup` ran
+  `rm -rf "$DRIVER"` before moving the backup into place, without checking the
+  backup existed — which, given the bug above, it never did. Restore now refuses
+  to remove anything when no backup is present.
+- **`auto_patch.sh` failed on macOS.** The three step invocations expanded
+  `"${COMMON_ARGS[@]}"` directly, and bash 3.2 treats expansion of an empty
+  array under `set -u` as an unbound variable error, so every run without an
+  optional flag — including the documented Quickstart command — died at step 1.
+- **`auto_patch.sh` was not executable** (mode 644), so the documented
+  `./auto_patch.sh` failed on a fresh clone.
+- **Two wrong assertions** in the translator's `test_generate_profiles_and_config`,
+  which expected device entries to be de-duplicated the way profiles are.
+
+### Changed
+
+- Minimum Python is now **3.11**. `discovery` imports `datetime.UTC`, which does
+  not exist earlier, so the previously documented "Python 3.10+" was inaccurate.
+- `edgeloom patch` orchestrates the three patch steps in Python rather than
+  through bash, so patching runs on native Windows and is directly testable.
+  `auto_patch/auto_patch.sh` remains available.
+- The README is now an umbrella; component detail moved to `docs/`.
+- The merged translator is covered by the repository's `ruff` and pytest gates.
+
+[Unreleased]: https://github.com/edgeloom-oss/edgeloom/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/edgeloom-oss/edgeloom/releases/tag/v0.1.0

edgeloom-0.1.0/CITATION.cff

@@ -0,0 +1,57 @@
+cff-version: 1.2.0
+title: "EdgeLoom"
+abstract: >-
+  An open toolchain for validating, patching, and translating smart-home edge
+  drivers across platforms.
+type: software
+version: 0.1.0
+date-released: 2026-08-23
+license: Apache-2.0
+repository-code: https://github.com/edgeloom-oss/edgeloom
+url: https://github.com/edgeloom-oss/edgeloom
+keywords:
+  - smart home
+  - internet of things
+  - SmartThings
+  - Home Assistant
+  - Zigbee
+  - edge drivers
+  - security
+authors:
+  - family-names: Xu
+    given-names: Xuening
+    affiliation: Stevens Institute of Technology
+  - family-names: Fu
+    given-names: Chenglong
+    affiliation: University of North Carolina at Charlotte
+  - family-names: Du
+    given-names: Xiaojiang
+    affiliation: Stevens Institute of Technology
+  - family-names: Luo
+    given-names: Bo
+    affiliation: University of Kansas
+  - family-names: Wu
+    given-names: Chuxiong
+    affiliation: Southern Illinois University Carbondale
+preferred-citation:
+  type: conference-paper
+  title: "Discovering and Exploiting IoT Device Hidden Attributes: A New Vulnerability in Smart Homes"
+  authors:
+    - family-names: Xu
+      given-names: Xuening
+    - family-names: Fu
+      given-names: Chenglong
+    - family-names: Du
+      given-names: Xiaojiang
+    - family-names: Luo
+      given-names: Bo
+  collection-title: "Proceedings of the ACM Conference on Computer and Communications Security (CCS)"
+  conference:
+    name: "ACM Conference on Computer and Communications Security (CCS)"
+    date-start: 2025-11-10
+    date-end: 2025-11-14
+  year: 2025
+  month: 11
+message: |
+  If you use this software, please cite our CCS 2025 paper:
+  "Discovering and Exploiting IoT Device Hidden Attributes: A New Vulnerability in Smart Homes."

edgeloom-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" text 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 [yyyy] [name of copyright owner]
+
+   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.

edgeloom-0.1.0/PKG-INFO

@@ -0,0 +1,217 @@
+Metadata-Version: 2.5
+Name: edgeloom
+Version: 0.1.0
+Summary: An open toolchain for validating, patching, and translating smart-home edge drivers across platforms
+Project-URL: Homepage, https://github.com/edgeloom-oss/edgeloom
+Project-URL: Repository, https://github.com/edgeloom-oss/edgeloom
+Project-URL: Issues, https://github.com/edgeloom-oss/edgeloom/issues
+Project-URL: Changelog, https://github.com/edgeloom-oss/edgeloom/blob/main/CHANGELOG.md
+Author-email: Chenglong Fu <chenglong.fu@charlotte.edu>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: edge-drivers,home-assistant,iot,security,smarthome,smartthings,zigbee
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.11
+Requires-Dist: jsonschema>=4.18
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: requests>=2.28
+Provides-Extra: dev
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# EdgeLoom
+
+[![CI](https://github.com/edgeloom-oss/edgeloom/actions/workflows/ci.yml/badge.svg)](https://github.com/edgeloom-oss/edgeloom/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.11%2B-blue.svg)](pyproject.toml)
+
+**An open toolchain for validating, patching, and translating smart-home edge
+drivers across platforms.**
+
+Smart-home hubs decide what a device is allowed to be. A lock that reports nine
+configurable attributes over Zigbee may surface two of them, because the stock
+driver's *profile* — the declared set of capabilities — never mentions the rest.
+The device is not the limit; the driver is. EdgeLoom is the toolchain for
+inspecting, rewriting, and checking those drivers.
+
+The three tools do different jobs, but they all produce or consume the same
+artifact: a device profile. EdgeLoom's position is that this artifact should be
+a **checked contract** rather than a file each tool invents privately. So the
+schema sits at the centre, and `edgeloom validate` is the gate everything passes
+through.
+
+```mermaid
+flowchart TD
+    subgraph inputs [Inputs]
+        A["Stock SmartThings<br/>Edge driver"]
+        B["Home Assistant<br/>instance"]
+        C["Driver catalog<br/>(GitHub or local)"]
+    end
+
+    A --> P["edgeloom patch<br/><i>expose hidden attributes</i>"]
+    B --> T["edgeloom translate<br/><i>project HA entities onto Edge</i>"]
+    C --> D["edgeloom discover<br/><i>enumerate drivers + fingerprints</i>"]
+
+    P --> S
+    T --> S
+    D -.->|"flags drivers with<br/>no mapping"| S
+
+    S{{"schema/ v0.1<br/><b>profile · capability-map</b>"}}
+
+    S --> V["edgeloom validate<br/><i>assurance gate, CI-ready</i>"]
+    V --> O["Hub-installable driver<br/>with a checked profile"]
+```
+
+Because both paths converge on one schema, a profile rewritten by the patcher
+and a profile emitted by the translator are checked against identical rules —
+which is what makes `validate` an assurance layer and not just a linter.
+
+## Install
+
+```bash
+pip install edgeloom
+```
+
+From a checkout:
+
+```bash
+git clone https://github.com/edgeloom-oss/edgeloom.git
+cd edgeloom
+pip install -e ".[dev]"
+```
+
+Requires Python 3.11 or newer.
+
+## Commands
+
+```
+edgeloom patch      DRIVER MODEL MANUFACTURER [ATTRIBUTES]  Expose hidden device attributes
+edgeloom translate  --ha-url URL --output DIR               Bridge Home Assistant to SmartThings
+edgeloom discover   [--source github|local]                 Enumerate drivers and fingerprints
+edgeloom validate   [PATHS...]                              Check artifacts against the schema
+```
+
+Patch a Zigbee lock so its language and auto-relock settings become visible,
+previewing first:
+
+```bash
+edgeloom patch auto_patch/zigbee-lock "YRD226 TSDB" Yale Language:AutoRelockTime --dry-run
+edgeloom patch auto_patch/zigbee-lock "YRD226 TSDB" Yale Language:AutoRelockTime
+```
+
+The original driver is copied to `<driver>-backup` before anything is written,
+and restored automatically if any step fails.
+
+Generate SmartThings Edge proxy artifacts for your Home Assistant entities:
+
+```bash
+export HA_TOKEN=...   # a long-lived access token
+edgeloom translate --ha-url http://homeassistant.local:8123 --output ./generated_edge
+```
+
+Check every profile and capability map in a tree:
+
+```bash
+edgeloom validate .
+```
+
+`validate` exits non-zero when a document violates the schema, and also when it
+finds nothing to check — a silent pass over zero files would otherwise read as
+success.
+
+## Components
+
+| Path | Component | Command | Documentation |
+| --- | --- | --- | --- |
+| `auto_patch/` | Edge driver patcher | `edgeloom patch` | [docs/patching.md](docs/patching.md) |
+| `translator/` | Home Assistant bridge | `edgeloom translate` | [translator/README.md](translator/README.md) |
+| `discovery/` | Driver catalog scanner | `edgeloom discover` | [docs/discovery.md](docs/discovery.md) |
+| `schema/` | Published contracts | `edgeloom validate` | [schema/](schema/) |
+
+The translator began life as
+[HA2ST-Translator](https://github.com/edgeloom-oss/HA2ST-Translator), written by
+Chuxiong Wu, and was merged here with its history intact. That repository is now
+archived and redirects to this one.
+
+## Schema
+
+Version 0.1 publishes two JSON Schemas (draft 2020-12):
+
+- **[`schema/profile.schema.json`](schema/profile.schema.json)** — a device
+  profile: the capabilities a driver exposes for one device, and the categories
+  describing it.
+- **[`schema/capability-map.schema.json`](schema/capability-map.schema.json)** —
+  which hidden attributes a driver may surface, and the capability each binds
+  to. Capability IDs must be namespaced, so a vendor attribute cannot silently
+  claim a standard identifier.
+
+[`auto_patch/capability-map.yaml`](auto_patch/capability-map.yaml) is the live
+map for the drivers shipped here, and is validated in CI on every push.
+
+Both schemas are versioned and shipped inside the installed package, so
+`edgeloom validate` works without a checkout.
+
+## Development
+
+```bash
+make install   # dependencies
+make lint      # ruff
+make test      # pytest
+```
+
+CI runs lint, the full test suite, `edgeloom validate`, and shellcheck on every
+push and pull request. See [docs/development.md](docs/development.md) for the
+container workflow.
+
+## Roadmap
+
+- Expand the library of subdrivers and handler templates.
+- Broaden the capability map beyond Zigbee locks, switches, and sensors.
+- Grow the schema toward Matter and Home Assistant capability namespaces.
+- Native Windows validation (the Python `patch` path no longer needs bash).
+- Device reports from real hardware — see the
+  [device report template](.github/ISSUE_TEMPLATE/device_report.yml).
+
+## Security
+
+Please report vulnerabilities privately. See [SECURITY.md](SECURITY.md).
+
+Patching a driver changes what a device exposes on your own hub. EdgeLoom is
+research tooling: review a diff before installing anything on a hub you depend
+on, and keep the backup it creates.
+
+## How to Cite
+
+If this project aids your research, cite the following work:
+
+```bibtex
+@inproceedings{xu2025hiddenattributes,
+  title     = {Discovering and Exploiting IoT Device Hidden Attributes: A New Vulnerability in Smart Homes},
+  author    = {Xuening Xu and Chenglong Fu and Xiaojiang Du and Bo Luo},
+  booktitle = {Proceedings of the ACM Conference on Computer and Communications Security (CCS)},
+  year      = {2025}
+}
+```
+
+Machine-readable metadata is in [CITATION.cff](CITATION.cff).
+
+## Contributing
+
+Bug reports, device reports, and pull requests are welcome. Start with
+[CONTRIBUTING.md](CONTRIBUTING.md) and the
+[Code of Conduct](CODE_OF_CONDUCT.md). Changes are recorded in
+[CHANGELOG.md](CHANGELOG.md).
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE).