From b0b764be1056ce085cf2801584db1e57aed928f8 Mon Sep 17 00:00:00 2001 From: Jatus Date: Fri, 26 Jan 2024 23:19:14 +0100 Subject: [PATCH] add ha addon support --- .devcontainer/devcontainer.json | 36 + .github/workflows/docker-image.yml | 34 + .vscode/tasks.json | 20 + .yamlint | 0 LICENSE | 674 ++++++++++++++++++ README.md | 21 +- .../.eslintrc.json | 0 .gitignore => matter-bridge/.gitignore | 3 +- .nvmrc => matter-bridge/.nvmrc | 0 .prettierrc => matter-bridge/.prettierrc | 0 matter-bridge/Dockerfile | 35 + Makefile => matter-bridge/Makefile | 0 matter-bridge/config.yml | 18 + .../docker-compose.yml | 0 .../dockerfile.standalone | 0 matter-bridge/options.yml | 5 + .../package-lock.json | 2 +- package.json => matter-bridge/package.json | 7 +- matter-bridge/run.sh | 3 + matter-bridge/schema.yml | 5 + .../src/home-assistant}/HAmiddleware.ts | 10 +- .../src/home-assistant}/HAssTypes.ts | 0 matter-bridge/src/index.ts | 43 ++ .../src/mapper}/Mapper.ts | 11 +- .../src/mapper/devices/MapperType.ts | 14 + .../devices/lights/DimmerableLightDevice.ts | 28 +- .../devices/lights/OnOffLightDevice.ts | 22 +- .../src/mapper}/devices/lights/index.ts | 2 +- .../src/matter}/Bridge.ts | 24 +- .../src/matter}/index.ts | 13 +- {src => matter-bridge/src}/utils/utils.ts | 1 + matter-bridge/tsconfig.json | 13 + repository.yml | 1 + src/index.ts | 37 - src/matter/devices/MapperType.ts | 7 - src/matter/index.ts | 3 - tsconfig.json | 102 --- 37 files changed, 987 insertions(+), 207 deletions(-) create mode 100644 .devcontainer/devcontainer.json create mode 100644 .github/workflows/docker-image.yml create mode 100644 .vscode/tasks.json create mode 100644 .yamlint create mode 100644 LICENSE rename .eslintrc.json => matter-bridge/.eslintrc.json (100%) rename .gitignore => matter-bridge/.gitignore (70%) rename .nvmrc => matter-bridge/.nvmrc (100%) rename .prettierrc => matter-bridge/.prettierrc (100%) create mode 100644 matter-bridge/Dockerfile rename Makefile => matter-bridge/Makefile (100%) create mode 100644 matter-bridge/config.yml rename docker-compose.yml => matter-bridge/docker-compose.yml (100%) rename dockerfile => matter-bridge/dockerfile.standalone (100%) create mode 100644 matter-bridge/options.yml rename package-lock.json => matter-bridge/package-lock.json (99%) rename package.json => matter-bridge/package.json (87%) create mode 100644 matter-bridge/run.sh create mode 100644 matter-bridge/schema.yml rename {src/HA => matter-bridge/src/home-assistant}/HAmiddleware.ts (89%) rename {src/HA => matter-bridge/src/home-assistant}/HAssTypes.ts (100%) create mode 100644 matter-bridge/src/index.ts rename {src/matter => matter-bridge/src/mapper}/Mapper.ts (86%) create mode 100644 matter-bridge/src/mapper/devices/MapperType.ts rename {src/matter => matter-bridge/src/mapper}/devices/lights/DimmerableLightDevice.ts (72%) rename {src/matter => matter-bridge/src/mapper}/devices/lights/OnOffLightDevice.ts (69%) rename {src/matter => matter-bridge/src/mapper}/devices/lights/index.ts (53%) rename {src/matter/server => matter-bridge/src/matter}/Bridge.ts (85%) rename {src/matter/server => matter-bridge/src/matter}/index.ts (71%) rename {src => matter-bridge/src}/utils/utils.ts (97%) create mode 100644 matter-bridge/tsconfig.json create mode 100644 repository.yml delete mode 100644 src/index.ts delete mode 100644 src/matter/devices/MapperType.ts delete mode 100644 src/matter/index.ts delete mode 100644 tsconfig.json diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..c37cf5a --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,36 @@ +{ + "name": "devcontainer for add-on repositories", + "image": "ghcr.io/home-assistant/devcontainer:addons", + "appPort": [ + "7123:8123", + "7357:4357" + ], + "postStartCommand": "bash devcontainer_bootstrap", + "runArgs": [ + "-e", + "GIT_EDITOR=code --wait", + "--privileged" + ], + "containerEnv": { + "WORKSPACE_DIRECTORY": "${containerWorkspaceFolder}" + }, + "extensions": [ + "timonwong.shellcheck", + "esbenp.prettier-vscode" + ], + "mounts": [ + "type=volume,target=/var/lib/docker" + ], + "settings": { + "terminal.integrated.profiles.linux": { + "zsh": { + "path": "/usr/bin/zsh" + } + }, + "terminal.integrated.defaultProfile.linux": "zsh", + "editor.formatOnPaste": false, + "editor.formatOnSave": true, + "editor.formatOnType": true, + "files.trimTrailingWhitespace": true + } +} \ No newline at end of file diff --git a/.github/workflows/docker-image.yml b/.github/workflows/docker-image.yml new file mode 100644 index 0000000..42962b6 --- /dev/null +++ b/.github/workflows/docker-image.yml @@ -0,0 +1,34 @@ +name: Publish Docker image + +on: + push + +jobs: + push_to_registry: + name: Push Docker image to Docker Hub + runs-on: ubuntu-latest + steps: + - name: Check out the repo + uses: actions/checkout@v4 + + - name: Log in to the Container registry + uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GHCR }} + + - name: Extract metadata (tags, labels) for Docker + id: meta + uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 + with: + images: ghcr.io/${{ github.repository }} + + - name: Build and push Docker image + uses: docker/build-push-action@3b5e8027fcad23fda98b2e3ac259d8d67585f671 + with: + context: ./matter-bridge + file: ./matter-bridge/Dockerfile + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..36e373a --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,20 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "Start Home Assistant", + "type": "shell", + "command": "supervisor_run", + "group": { + "kind": "test", + "isDefault": true + }, + "presentation": { + "reveal": "always", + "panel": "new" + }, + "problemMatcher": [] + } + ] + } + \ No newline at end of file diff --git a/.yamlint b/.yamlint new file mode 100644 index 0000000..e69de29 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index 1d43c87..ccde059 100644 --- a/README.md +++ b/README.md @@ -8,30 +8,25 @@ This project serves as a proof of concept to connect HomeAssistant devices to Vo ### Prerequisites -- Docker installed -- Docker Compose installed -- Clone this repository +- Add this repository to your home assistant install ### Configuration -Inside the repository, create a `.env` file with the following variables set: - -- `HA_HOST`: HomeAssistant network address -- `HA_PORT`: HomeAssistant port -- `HA_ACCESS_TOKEN`: HomeAssistant access token - -Once the `.env` file is configured, run the project with `docker-compose up` for the initial setup. You'll need to scan the QR code in the terminal. +1. Start this addon, should autmatically get all your devices +2. Watch the logs for the QR code that is needed to pair it with your assistant +3. Pair it with your assistant with the matter procedure +4. Enjoy ## Key Features -- Supports two types of elements: lights and dimmable lights. +- Supports two types of elements: lights and dimmable lights. ## How to Contribute 1. Help organize the project and dependencies. 2. Add integrations for other devices. -3. Add some tests +3. Add some tests ## Known Issues and Limitations -- Currently, only lights (including dimmable lights) are working, and the system may be unstable. +- Currently, only lights (including dimmable lights) are working, and the system may be unstable. diff --git a/.eslintrc.json b/matter-bridge/.eslintrc.json similarity index 100% rename from .eslintrc.json rename to matter-bridge/.eslintrc.json diff --git a/.gitignore b/matter-bridge/.gitignore similarity index 70% rename from .gitignore rename to matter-bridge/.gitignore index bc52dc0..012de65 100644 --- a/.gitignore +++ b/matter-bridge/.gitignore @@ -1,3 +1,4 @@ node_modules deviceData -.env \ No newline at end of file +.env +build \ No newline at end of file diff --git a/.nvmrc b/matter-bridge/.nvmrc similarity index 100% rename from .nvmrc rename to matter-bridge/.nvmrc diff --git a/.prettierrc b/matter-bridge/.prettierrc similarity index 100% rename from .prettierrc rename to matter-bridge/.prettierrc diff --git a/matter-bridge/Dockerfile b/matter-bridge/Dockerfile new file mode 100644 index 0000000..24d8272 --- /dev/null +++ b/matter-bridge/Dockerfile @@ -0,0 +1,35 @@ +ARG BUILD_FROM=ghcr.io/hassio-addons/base:15.0.3 + +FROM node:18.19.0-alpine as buildbase + +COPY ./package.json ./ +COPY ./package-lock.json ./ +COPY ./src ./src +COPY ./tsconfig.json ./ +RUN npm install +RUN npm run build + +FROM node:18.19.0-alpine as deps + +COPY ./package.json ./ +COPY ./package-lock.json ./ +COPY ./src ./src +COPY ./tsconfig.json ./ +RUN npm install --production + + +FROM ${BUILD_FROM} as runenv + +COPY --from=buildbase /usr/lib /usr/lib +COPY --from=buildbase /usr/local/lib /usr/local/lib +COPY --from=buildbase /usr/local/include /usr/local/include +COPY --from=buildbase /usr/local/bin /usr/local/bin +COPY --from=buildbase ./build ./build +COPY --from=deps ./node_modules ./node_modules +COPY --from=deps ./package.json ./package.json + + +COPY run.sh / +RUN chmod a+x /run.sh + +CMD [ "/run.sh" ] \ No newline at end of file diff --git a/Makefile b/matter-bridge/Makefile similarity index 100% rename from Makefile rename to matter-bridge/Makefile diff --git a/matter-bridge/config.yml b/matter-bridge/config.yml new file mode 100644 index 0000000..83a0ba4 --- /dev/null +++ b/matter-bridge/config.yml @@ -0,0 +1,18 @@ +--- +name: 'HA Matter Bridge' +version: '1.0.0' +slug: ha-matter-bridge +description: This project serves as a proof of concept to connect HomeAssistant devices to Voice Assistants through the Matter Protocol. +init: false +arch: + - amd64 +ports: + 5540/tcp: 5540 + +host_network: true +hassio_role: homeassistant +hassio_api: true +homeassistant_api: true +auth_api: true +map: + - addon_config:rw diff --git a/docker-compose.yml b/matter-bridge/docker-compose.yml similarity index 100% rename from docker-compose.yml rename to matter-bridge/docker-compose.yml diff --git a/dockerfile b/matter-bridge/dockerfile.standalone similarity index 100% rename from dockerfile rename to matter-bridge/dockerfile.standalone diff --git a/matter-bridge/options.yml b/matter-bridge/options.yml new file mode 100644 index 0000000..9aaa603 --- /dev/null +++ b/matter-bridge/options.yml @@ -0,0 +1,5 @@ +message: "settings" + settings: + - HA_HOST: localhost + HA_PORT: 8123 + HA_ACCESS_TOKEN: "your acces token" \ No newline at end of file diff --git a/package-lock.json b/matter-bridge/package-lock.json similarity index 99% rename from package-lock.json rename to matter-bridge/package-lock.json index 67eb23f..9709d75 100644 --- a/package-lock.json +++ b/matter-bridge/package-lock.json @@ -7,7 +7,7 @@ "": { "name": "ha-matter-bridge", "version": "1.0.0", - "license": "ISC", + "license": "GPL-3.0", "dependencies": { "@project-chip/matter-node.js": "^0.7.4", "@project-chip/matter.js-tools": "^0.7.4", diff --git a/package.json b/matter-bridge/package.json similarity index 87% rename from package.json rename to matter-bridge/package.json index 4ccd19d..c64bcac 100644 --- a/package.json +++ b/matter-bridge/package.json @@ -4,10 +4,11 @@ "description": "", "main": "index.js", "scripts": { - "start": "ts-node ./src/index.ts" + "build": "tsc", + "start": "node ./build/index.js" }, "author": "", - "license": "ISC", + "license": "GPL-3.0", "dependencies": { "@project-chip/matter-node.js": "^0.7.4", "@project-chip/matter.js-tools": "^0.7.4", @@ -24,4 +25,4 @@ "eslint": "^8.56.0", "typescript": "^5.3.3" } -} +} \ No newline at end of file diff --git a/matter-bridge/run.sh b/matter-bridge/run.sh new file mode 100644 index 0000000..b6f3dbf --- /dev/null +++ b/matter-bridge/run.sh @@ -0,0 +1,3 @@ +#!/usr/bin/with-contenv bashio + +npm run start \ No newline at end of file diff --git a/matter-bridge/schema.yml b/matter-bridge/schema.yml new file mode 100644 index 0000000..92c2322 --- /dev/null +++ b/matter-bridge/schema.yml @@ -0,0 +1,5 @@ +message: str +settings: + - HA_HOST: str + HA_PORT: int + HA_ACCESS_TOKEN: str diff --git a/src/HA/HAmiddleware.ts b/matter-bridge/src/home-assistant/HAmiddleware.ts similarity index 89% rename from src/HA/HAmiddleware.ts rename to matter-bridge/src/home-assistant/HAmiddleware.ts index 68255d3..eb42dce 100644 --- a/src/HA/HAmiddleware.ts +++ b/matter-bridge/src/home-assistant/HAmiddleware.ts @@ -8,7 +8,6 @@ export class HAMiddleware { private logger = new Logger('HAMiddleware'); private hassClient: HassApi; private static instance: HAMiddleware; - private connectionOpen: boolean = false; private requestFulfilled: boolean = true; private entities: { [k: string]: HassEntity } = {}; private functionsToCallOnChange: { @@ -36,8 +35,7 @@ export class HAMiddleware { subscribe() { this.hassClient.on('state_changed', (event) => { this.logger.debug(event); - const toDo = - this.functionsToCallOnChange[event.data.entity_id]; + const toDo = this.functionsToCallOnChange[event.data.entity_id]; if (toDo) { toDo(event.data); } @@ -97,12 +95,6 @@ export class HAMiddleware { if (!HAMiddleware.instance) { const client = await hass(callerOptions); HAMiddleware.instance = new HAMiddleware(client); - let waited = 0; - const timeOut = 5000; - while (!HAMiddleware.instance.connectionOpen && waited < timeOut) { - await sleep(1000); - waited += 1000; - } } return HAMiddleware.instance; } diff --git a/src/HA/HAssTypes.ts b/matter-bridge/src/home-assistant/HAssTypes.ts similarity index 100% rename from src/HA/HAssTypes.ts rename to matter-bridge/src/home-assistant/HAssTypes.ts diff --git a/matter-bridge/src/index.ts b/matter-bridge/src/index.ts new file mode 100644 index 0000000..ac99202 --- /dev/null +++ b/matter-bridge/src/index.ts @@ -0,0 +1,43 @@ +import { getParameter } from './utils/utils'; +import { Bridge, getBridge } from './matter'; +import { Logger } from '@project-chip/matter-node.js/log'; +import { HAMiddleware } from './home-assistant/HAmiddleware'; +import { addAllDevicesToBridge } from './mapper/Mapper'; + +const LOGGER = new Logger('Main'); +let HA_MIDDLEWARE: HAMiddleware; +let BRIDGE: Bridge; + +async function run() { + LOGGER.info('Startup ...'); + const token = getParameter('SUPERVISOR_TOKEN'); + if (!token) { + throw new Error('Missing auth token cannot run without it'); + } + HA_MIDDLEWARE = await HAMiddleware.getInstance({ + host: 'supervisor', + port: 80, + path: '/core/websocket', + token, + }); + LOGGER.info('Connected to home assistant'); + BRIDGE = getBridge(); + LOGGER.info('Creating the bridge'); + await addAllDevicesToBridge(HA_MIDDLEWARE, BRIDGE); + LOGGER.info('all devices added'); + BRIDGE.start(); +} + +run() + .then() + .catch((error) => { + console.error(error); + LOGGER.error(JSON.stringify(error)); + }); + +process.on('SIGINT', () => { + HA_MIDDLEWARE.stop(); + BRIDGE.stop() + .then(() => process.exit(0)) + .catch((err) => LOGGER.error(err)); +}); diff --git a/src/matter/Mapper.ts b/matter-bridge/src/mapper/Mapper.ts similarity index 86% rename from src/matter/Mapper.ts rename to matter-bridge/src/mapper/Mapper.ts index 61d338b..38fc88e 100644 --- a/src/matter/Mapper.ts +++ b/matter-bridge/src/mapper/Mapper.ts @@ -1,12 +1,15 @@ /* eslint-disable @typescript-eslint/no-explicit-any */ -import { addDimmerableLightDevice, addOnOffLightDevice } from './devices/lights'; -import { HassEntity } from '../HA/HAssTypes'; -import { Bridge, HAMiddleware } from '.'; +import { + addDimmerableLightDevice, + addOnOffLightDevice, +} from './devices/lights'; +import { HassEntity } from '../home-assistant/HAssTypes'; +import { Bridge } from '../matter'; import { Logger } from '@project-chip/matter-node.js/log'; +import { HAMiddleware } from '../home-assistant/HAmiddleware'; const LOGGER = new Logger('Mapper'); - const lightsMap: Map< string, (haEntity: HassEntity, haMiddleware: HAMiddleware, bridge: Bridge) => void diff --git a/matter-bridge/src/mapper/devices/MapperType.ts b/matter-bridge/src/mapper/devices/MapperType.ts new file mode 100644 index 0000000..3713751 --- /dev/null +++ b/matter-bridge/src/mapper/devices/MapperType.ts @@ -0,0 +1,14 @@ +import { Device } from '@project-chip/matter-node.js/device'; +import { HassEntity } from '../../home-assistant/HAssTypes'; + +import { HAMiddleware } from '../../home-assistant/HAmiddleware'; +import { Bridge } from '../../matter'; + +export type AddHaDeviceToBridge = ( + haEntity: HassEntity, + haMiddleware: HAMiddleware, + bridge: Bridge +) => Device; + +export { HAMiddleware } from '../../home-assistant/HAmiddleware'; +export { Bridge } from '../../matter'; diff --git a/src/matter/devices/lights/DimmerableLightDevice.ts b/matter-bridge/src/mapper/devices/lights/DimmerableLightDevice.ts similarity index 72% rename from src/matter/devices/lights/DimmerableLightDevice.ts rename to matter-bridge/src/mapper/devices/lights/DimmerableLightDevice.ts index 0be6c79..d77b97c 100644 --- a/src/matter/devices/lights/DimmerableLightDevice.ts +++ b/matter-bridge/src/mapper/devices/lights/DimmerableLightDevice.ts @@ -1,12 +1,21 @@ -import { Device, DimmableLightDevice } from "@project-chip/matter-node.js/device"; -import { MD5 } from "crypto-js"; -import { HAMiddleware, Bridge } from "../.."; -import { HassEntity, StateChangedEvent } from "../../../HA/HAssTypes"; -import { AddHaDeviceToBridge } from "../MapperType"; -import { Logger } from "@project-chip/matter-node.js/log"; +import { + Device, + DimmableLightDevice, +} from '@project-chip/matter-node.js/device'; +import { MD5 } from 'crypto-js'; +import { + HassEntity, + StateChangedEvent, +} from '../../../home-assistant/HAssTypes'; +import { AddHaDeviceToBridge, Bridge, HAMiddleware } from '../MapperType'; +import { Logger } from '@project-chip/matter-node.js/log'; const LOGGER = new Logger('DimmableLight'); -export const addDimmerableLightDevice: AddHaDeviceToBridge = (haEntity: HassEntity, haMiddleware: HAMiddleware, bridge: Bridge): Device => { +export const addDimmerableLightDevice: AddHaDeviceToBridge = ( + haEntity: HassEntity, + haMiddleware: HAMiddleware, + bridge: Bridge +): Device => { const device = new DimmableLightDevice(); const serialFromId = MD5(haEntity.entity_id).toString(); device.addOnOffListener((value, oldValue) => { @@ -36,7 +45,8 @@ export const addDimmerableLightDevice: AddHaDeviceToBridge = (haEntity: HassEnti (event: StateChangedEvent) => { device.setOnOff(event.data.new_state?.state === 'on'); device.setCurrentLevel( - (event.data.new_state?.attributes as never)['brightness']); + (event.data.new_state?.attributes as never)['brightness'] + ); } ); @@ -46,4 +56,4 @@ export const addDimmerableLightDevice: AddHaDeviceToBridge = (haEntity: HassEnti serialNumber: serialFromId, }); return device; -} \ No newline at end of file +}; diff --git a/src/matter/devices/lights/OnOffLightDevice.ts b/matter-bridge/src/mapper/devices/lights/OnOffLightDevice.ts similarity index 69% rename from src/matter/devices/lights/OnOffLightDevice.ts rename to matter-bridge/src/mapper/devices/lights/OnOffLightDevice.ts index 953fabb..5805ceb 100644 --- a/src/matter/devices/lights/OnOffLightDevice.ts +++ b/matter-bridge/src/mapper/devices/lights/OnOffLightDevice.ts @@ -1,13 +1,19 @@ /* eslint-disable @typescript-eslint/no-explicit-any */ -import { Device, OnOffLightDevice } from "@project-chip/matter-node.js/device"; -import { MD5 } from "crypto-js"; -import { HAMiddleware, Bridge } from "../.."; -import { HassEntity, StateChangedEvent } from "../../../HA/HAssTypes"; -import { AddHaDeviceToBridge } from "../MapperType"; -import { Logger } from "@project-chip/matter-node.js/log"; +import { Device, OnOffLightDevice } from '@project-chip/matter-node.js/device'; +import { MD5 } from 'crypto-js'; +import { + HassEntity, + StateChangedEvent, +} from '../../../home-assistant/HAssTypes'; +import { AddHaDeviceToBridge, Bridge, HAMiddleware } from '../MapperType'; +import { Logger } from '@project-chip/matter-node.js/log'; const LOGGER = new Logger('OnOfflIght'); -export const addOnOffLightDevice: AddHaDeviceToBridge = (haEntity: HassEntity, haMiddleware: HAMiddleware, bridge: Bridge): Device => { +export const addOnOffLightDevice: AddHaDeviceToBridge = ( + haEntity: HassEntity, + haMiddleware: HAMiddleware, + bridge: Bridge +): Device => { const device = new OnOffLightDevice(); const serialFromId = MD5(haEntity.entity_id).toString(); device.addOnOffListener((value, oldValue) => { @@ -36,4 +42,4 @@ export const addOnOffLightDevice: AddHaDeviceToBridge = (haEntity: HassEntity, h serialNumber: serialFromId, }); return device; -} \ No newline at end of file +}; diff --git a/src/matter/devices/lights/index.ts b/matter-bridge/src/mapper/devices/lights/index.ts similarity index 53% rename from src/matter/devices/lights/index.ts rename to matter-bridge/src/mapper/devices/lights/index.ts index 9aade4f..39c83c6 100644 --- a/src/matter/devices/lights/index.ts +++ b/matter-bridge/src/mapper/devices/lights/index.ts @@ -1,2 +1,2 @@ export * from './DimmerableLightDevice'; -export * from './OnOffLightDevice'; \ No newline at end of file +export * from './OnOffLightDevice'; diff --git a/src/matter/server/Bridge.ts b/matter-bridge/src/matter/Bridge.ts similarity index 85% rename from src/matter/server/Bridge.ts rename to matter-bridge/src/matter/Bridge.ts index 0bc2f0a..f14e1b6 100644 --- a/src/matter/server/Bridge.ts +++ b/matter-bridge/src/matter/Bridge.ts @@ -10,7 +10,7 @@ import { } from '@project-chip/matter-node.js/device'; import { Logger } from '@project-chip/matter-node.js/log'; import { StorageManager } from '@project-chip/matter-node.js/storage'; -import { getIntParameter, getParameter } from '../../utils/utils'; +import { getIntParameter, getParameter } from '../utils/utils'; import { Time } from '@project-chip/matter-node.js/time'; import { VendorId } from '@project-chip/matter-node.js/datatype'; import { QrCode } from '@project-chip/matter-node.js/schema'; @@ -24,14 +24,16 @@ export class Bridge { getParameter('name') || 'Matter Bridge'; private static readonly deviceType = DeviceTypes.AGGREGATOR.code; private static readonly vendorName = getParameter('vendor') || 'Jatus'; - private static readonly productName = 'node-matter OnOff-Bridge'; + private static readonly productName = 'HomeAssistant'; private static readonly port = getIntParameter('port') ?? 5540; + private ready = false; private matterServer: MatterServer; private static instace: Bridge; private logger = new Logger('bridge'); private storageManager: StorageManager; private aggregator: Aggregator; + private commissioningServer: CommissioningServer | undefined; private constructor( matterServer: MatterServer, @@ -106,20 +108,22 @@ export class Bridge { typeof BridgedDeviceBasicInformationCluster.attributes > ) { - // const id = getIntParameter('uniqueid'); + if (!this.commissioningServer?.isCommissioned()) { + this.logger.warn('System not initialized, may cause crashes'); + } this.aggregator.addBridgedDevice(device, bridgedBasicInformation); } async start() { this.logger.info('Starting...'); - const commissioningServer = + this.commissioningServer = await this.setupContextAndCommissioningServer(); - commissioningServer.addDevice(this.aggregator); - this.matterServer.addCommissioningServer(commissioningServer); + this.commissioningServer.addDevice(this.aggregator); + this.matterServer.addCommissioningServer(this.commissioningServer); await this.matterServer.start(); this.logger.info('Listening'); - if (!commissioningServer.isCommissioned()) { - const pairingData = commissioningServer.getPairingCode(); + if (!this.commissioningServer.isCommissioned()) { + const pairingData = this.commissioningServer.getPairingCode(); const { qrPairingCode, manualPairingCode } = pairingData; console.log(QrCode.get(qrPairingCode)); @@ -136,5 +140,9 @@ export class Bridge { async stop() { this.matterServer.close(); + this.storageManager + .close() + .then(() => process.exit(0)) + .catch((err) => this.logger.error(err)); } } diff --git a/src/matter/server/index.ts b/matter-bridge/src/matter/index.ts similarity index 71% rename from src/matter/server/index.ts rename to matter-bridge/src/matter/index.ts index 83f32d2..d580965 100644 --- a/src/matter/server/index.ts +++ b/matter-bridge/src/matter/index.ts @@ -4,6 +4,8 @@ import { StorageManager, } from '@project-chip/matter-node.js/storage'; import { getParameter, hasParameter } from '@project-chip/matter-node.js/util'; +export { Bridge } from './Bridge'; +import { Bridge } from './Bridge'; let MATTER_SERVER: MatterServer; let STORAGE: StorageBackendDisk; @@ -14,7 +16,7 @@ export function serverSetup(): { storageManager: StorageManager; } { if (!(MATTER_SERVER && STORAGE && STORAGE_MANAGER)) { - const storageLocation = getParameter('store') || './deviceData'; + const storageLocation = getParameter('store') || '/config/deviceData'; STORAGE = new StorageBackendDisk( storageLocation, @@ -27,3 +29,12 @@ export function serverSetup(): { } return { matterServer: MATTER_SERVER, storageManager: STORAGE_MANAGER }; } + +export function getBridge(): Bridge { + const serverData = serverSetup(); + const bridge = Bridge.getInstance( + serverData.matterServer, + serverData.storageManager + ); + return bridge; +} diff --git a/src/utils/utils.ts b/matter-bridge/src/utils/utils.ts similarity index 97% rename from src/utils/utils.ts rename to matter-bridge/src/utils/utils.ts index b4fafcf..3590073 100644 --- a/src/utils/utils.ts +++ b/matter-bridge/src/utils/utils.ts @@ -2,6 +2,7 @@ import { ValidationError } from '@project-chip/matter.js/common'; import { execSync } from 'child_process'; const envVar = process.env; +console.debug({ envVar }); export function getParameter(name: string) { return envVar[name]; diff --git a/matter-bridge/tsconfig.json b/matter-bridge/tsconfig.json new file mode 100644 index 0000000..52bd7ad --- /dev/null +++ b/matter-bridge/tsconfig.json @@ -0,0 +1,13 @@ +{ + "compilerOptions": { + "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */, + "module": "Node16" /* Specify what module code is generated. */, + "rootDir": "./src", + "outDir": "./build", /* Specify the root folder within your source files. */ + "moduleResolution": "node16" /* Specify how TypeScript looks up a file from a given module specifier. */, + "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */, + "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */, + "strict": true /* Enable all strict type-checking options. */, + "skipLibCheck": true /* Skip type checking all .d.ts files. */, + }, +} diff --git a/repository.yml b/repository.yml new file mode 100644 index 0000000..7cf72e7 --- /dev/null +++ b/repository.yml @@ -0,0 +1 @@ +name: ha-matter-bridge diff --git a/src/index.ts b/src/index.ts deleted file mode 100644 index b955a4b..0000000 --- a/src/index.ts +++ /dev/null @@ -1,37 +0,0 @@ -import { Bridge, HAMiddleware, addAllDevicesToBridge } from './matter'; -import { serverSetup } from './matter/server'; -import { Logger } from '@project-chip/matter-node.js/log'; - -let LOGGER = new Logger('Main'); -let BRIDGE: Bridge; -let HA_MIDDLEWARE: HAMiddleware; -const SERVER_DATA = serverSetup(); - -async function run() { - HA_MIDDLEWARE = await HAMiddleware.getInstance({ - host: process.env.HA_HOST, - port: Number(process.env.HA_PORT), - token: process.env.HA_ACCESS_TOKEN, - }); - BRIDGE = Bridge.getInstance( - SERVER_DATA.matterServer, - SERVER_DATA.storageManager - ); - await addAllDevicesToBridge(HA_MIDDLEWARE, BRIDGE); - BRIDGE.start(); -} - -run().then().catch(LOGGER.error); - -process.on('SIGINT', () => { - HA_MIDDLEWARE.stop(); - BRIDGE.stop() - .then(() => { - // Pragmatic way to make sure the storage is correctly closed before the process ends. - SERVER_DATA.storageManager - .close() - .then(() => process.exit(0)) - .catch((err) => LOGGER.error(err)); - }) - .catch((err) => LOGGER.error(err)); -}); diff --git a/src/matter/devices/MapperType.ts b/src/matter/devices/MapperType.ts deleted file mode 100644 index 729a1f7..0000000 --- a/src/matter/devices/MapperType.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { Device } from "@project-chip/matter-node.js/device"; -import { HAMiddleware, Bridge } from ".."; -import { HassEntity } from "../../HA/HAssTypes"; - -export type AddHaDeviceToBridge = (haEntity: HassEntity, - haMiddleware: HAMiddleware, - bridge: Bridge) => Device diff --git a/src/matter/index.ts b/src/matter/index.ts deleted file mode 100644 index 9f222ee..0000000 --- a/src/matter/index.ts +++ /dev/null @@ -1,3 +0,0 @@ -export * from './server/Bridge'; -export * from '../HA/HAmiddleware'; -export * from './Mapper'; diff --git a/tsconfig.json b/tsconfig.json deleted file mode 100644 index 06f6852..0000000 --- a/tsconfig.json +++ /dev/null @@ -1,102 +0,0 @@ -{ - "compilerOptions": { - /* Visit https://aka.ms/tsconfig to read more about this file */ - /* Projects */ - // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ - // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ - // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ - // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ - // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ - // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ - /* Language and Environment */ - "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */, - // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ - // "jsx": "preserve", /* Specify what JSX code is generated. */ - // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ - // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ - // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ - // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ - // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ - // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ - // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ - // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ - // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ - /* Modules */ - // "module": "commonjs", /* Specify what module code is generated. */ - "module": "Node16" /* Specify what module code is generated. */, - // // "rootDir": "./", /* Specify the root folder within your source files. */ - "moduleResolution": "node16" /* Specify how TypeScript looks up a file from a given module specifier. */, - // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ - // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ - // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ - // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ - // "types": [], /* Specify type package names to be included without being referenced in a source file. */ - // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ - // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ - // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ - // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ - // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ - // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ - // "resolveJsonModule": true, /* Enable importing .json files. */ - // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ - // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ - /* JavaScript Support */ - // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ - // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ - // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ - /* Emit */ - // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ - // "declarationMap": true, /* Create sourcemaps for d.ts files. */ - // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ - // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ - // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ - // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ - // "outDir": "./", /* Specify an output folder for all emitted files. */ - // "removeComments": true, /* Disable emitting comments. */ - // "noEmit": true, /* Disable emitting files from a compilation. */ - // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ - // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ - // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ - // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ - // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ - // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ - // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ - // "newLine": "crlf", /* Set the newline character for emitting files. */ - // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ - // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ - // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ - // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ - // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ - // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ - /* Interop Constraints */ - // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ - // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ - // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ - "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */, - // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ - "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */, - /* Type Checking */ - "strict": true /* Enable all strict type-checking options. */, - // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ - // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ - // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ - // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ - // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ - // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ - // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ - // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ - // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ - // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ - // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ - // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ - // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ - // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ - // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ - // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ - // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ - // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ - /* Completeness */ - // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ - "skipLibCheck": true /* Skip type checking all .d.ts files. */, - }, -}