diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml index 83b26ea..22565d0 100644 --- a/.github/dependabot.yaml +++ b/.github/dependabot.yaml @@ -1,7 +1,7 @@ -version: 2 -updates: - - package-ecosystem: "github-actions" - directory: "/" - schedule: - interval: weekly - time: "06:00" +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: weekly + time: "06:00" diff --git a/.github/workflows/builder.yaml b/.github/workflows/builder.yaml index e69811d..4fd6bd7 100644 --- a/.github/workflows/builder.yaml +++ b/.github/workflows/builder.yaml @@ -1,117 +1,117 @@ -name: Builder - -env: - BUILD_ARGS: "--test" - MONITORED_FILES: "build.yaml config.yaml Dockerfile rootfs" - -on: - push: - branches: - - main - pull_request: - branches: - - main - -jobs: - init: - runs-on: ubuntu-latest - name: Initialize builds - outputs: - changed_addons: ${{ steps.changed_addons.outputs.addons }} - changed: ${{ steps.changed_addons.outputs.changed }} - steps: - - name: Check out the repository - uses: actions/checkout@v4.1.7 - - - name: Get changed files - id: changed_files - uses: jitterbit/get-changed-files@v1 - - - name: Find add-on directories - id: addons - uses: home-assistant/actions/helpers/find-addons@master - - - name: Get changed add-ons - id: changed_addons - run: | - declare -a changed_addons - for addon in ${{ steps.addons.outputs.addons }}; do - if [[ "${{ steps.changed_files.outputs.all }}" =~ $addon ]]; then - for file in ${{ env.MONITORED_FILES }}; do - if [[ "${{ steps.changed_files.outputs.all }}" =~ $addon/$file ]]; then - if [[ ! "${changed_addons[@]}" =~ $addon ]]; then - changed_addons+=("\"${addon}\","); - fi - fi - done - fi - done - - changed=$(echo ${changed_addons[@]} | rev | cut -c 2- | rev) - - if [[ -n ${changed} ]]; then - echo "Changed add-ons: $changed"; - echo "changed=true" >> $GITHUB_OUTPUT; - echo "addons=[$changed]" >> $GITHUB_OUTPUT; - else - echo "No add-on had any monitored files changed (${{ env.MONITORED_FILES }})"; - fi - build: - needs: init - runs-on: ubuntu-latest - if: needs.init.outputs.changed == 'true' - name: Build ${{ matrix.arch }} ${{ matrix.addon }} add-on - strategy: - matrix: - addon: ${{ fromJson(needs.init.outputs.changed_addons) }} - arch: ["aarch64", "amd64", "armhf", "armv7", "i386"] - permissions: - contents: read - packages: write - - steps: - - name: Check out repository - uses: actions/checkout@v4.1.7 - - - name: Get information - id: info - uses: home-assistant/actions/helpers/info@master - with: - path: "./${{ matrix.addon }}" - - - name: Check if add-on should be built - id: check - run: | - if [[ "${{ steps.info.outputs.image }}" == "null" ]]; then - echo "Image property is not defined, skipping build" - echo "build_arch=false" >> $GITHUB_OUTPUT; - elif [[ "${{ steps.info.outputs.architectures }}" =~ ${{ matrix.arch }} ]]; then - echo "build_arch=true" >> $GITHUB_OUTPUT; - echo "image=$(echo ${{ steps.info.outputs.image }} | cut -d'/' -f3)" >> $GITHUB_OUTPUT; - if [[ -z "${{ github.head_ref }}" ]] && [[ "${{ github.event_name }}" == "push" ]]; then - echo "BUILD_ARGS=" >> $GITHUB_ENV; - fi - else - echo "${{ matrix.arch }} is not a valid arch for ${{ matrix.addon }}, skipping build"; - echo "build_arch=false" >> $GITHUB_OUTPUT; - fi - - - name: Login to GitHub Container Registry - if: env.BUILD_ARGS != '--test' - uses: docker/login-action@v3.2.0 - with: - registry: ghcr.io - username: ${{ github.repository_owner }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: Build ${{ matrix.addon }} add-on - if: steps.check.outputs.build_arch == 'true' - uses: home-assistant/builder@2024.03.5 - with: - args: | - ${{ env.BUILD_ARGS }} \ - --${{ matrix.arch }} \ - --target /data/${{ matrix.addon }} \ - --image "${{ steps.check.outputs.image }}" \ - --docker-hub "ghcr.io/${{ github.repository_owner }}" \ - --addon +name: Builder + +env: + BUILD_ARGS: "--test" + MONITORED_FILES: "build.yaml config.yaml Dockerfile rootfs" + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + init: + runs-on: ubuntu-latest + name: Initialize builds + outputs: + changed_addons: ${{ steps.changed_addons.outputs.addons }} + changed: ${{ steps.changed_addons.outputs.changed }} + steps: + - name: Check out the repository + uses: actions/checkout@v4.1.7 + + - name: Get changed files + id: changed_files + uses: jitterbit/get-changed-files@v1 + + - name: Find add-on directories + id: addons + uses: home-assistant/actions/helpers/find-addons@master + + - name: Get changed add-ons + id: changed_addons + run: | + declare -a changed_addons + for addon in ${{ steps.addons.outputs.addons }}; do + if [[ "${{ steps.changed_files.outputs.all }}" =~ $addon ]]; then + for file in ${{ env.MONITORED_FILES }}; do + if [[ "${{ steps.changed_files.outputs.all }}" =~ $addon/$file ]]; then + if [[ ! "${changed_addons[@]}" =~ $addon ]]; then + changed_addons+=("\"${addon}\","); + fi + fi + done + fi + done + + changed=$(echo ${changed_addons[@]} | rev | cut -c 2- | rev) + + if [[ -n ${changed} ]]; then + echo "Changed add-ons: $changed"; + echo "changed=true" >> $GITHUB_OUTPUT; + echo "addons=[$changed]" >> $GITHUB_OUTPUT; + else + echo "No add-on had any monitored files changed (${{ env.MONITORED_FILES }})"; + fi + build: + needs: init + runs-on: ubuntu-latest + if: needs.init.outputs.changed == 'true' + name: Build ${{ matrix.arch }} ${{ matrix.addon }} add-on + strategy: + matrix: + addon: ${{ fromJson(needs.init.outputs.changed_addons) }} + arch: ["aarch64", "amd64", "armhf", "armv7", "i386"] + permissions: + contents: read + packages: write + + steps: + - name: Check out repository + uses: actions/checkout@v4.1.7 + + - name: Get information + id: info + uses: home-assistant/actions/helpers/info@master + with: + path: "./${{ matrix.addon }}" + + - name: Check if add-on should be built + id: check + run: | + if [[ "${{ steps.info.outputs.image }}" == "null" ]]; then + echo "Image property is not defined, skipping build" + echo "build_arch=false" >> $GITHUB_OUTPUT; + elif [[ "${{ steps.info.outputs.architectures }}" =~ ${{ matrix.arch }} ]]; then + echo "build_arch=true" >> $GITHUB_OUTPUT; + echo "image=$(echo ${{ steps.info.outputs.image }} | cut -d'/' -f3)" >> $GITHUB_OUTPUT; + if [[ -z "${{ github.head_ref }}" ]] && [[ "${{ github.event_name }}" == "push" ]]; then + echo "BUILD_ARGS=" >> $GITHUB_ENV; + fi + else + echo "${{ matrix.arch }} is not a valid arch for ${{ matrix.addon }}, skipping build"; + echo "build_arch=false" >> $GITHUB_OUTPUT; + fi + + - name: Login to GitHub Container Registry + if: env.BUILD_ARGS != '--test' + uses: docker/login-action@v3.2.0 + with: + registry: ghcr.io + username: ${{ github.repository_owner }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Build ${{ matrix.addon }} add-on + if: steps.check.outputs.build_arch == 'true' + uses: home-assistant/builder@2024.03.5 + with: + args: | + ${{ env.BUILD_ARGS }} \ + --${{ matrix.arch }} \ + --target /data/${{ matrix.addon }} \ + --image "${{ steps.check.outputs.image }}" \ + --docker-hub "ghcr.io/${{ github.repository_owner }}" \ + --addon diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index a46cc17..7b17465 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -1,41 +1,41 @@ -name: Lint - -on: - push: - branches: - - main - pull_request: - branches: - - main - schedule: - - cron: "0 0 * * *" - -jobs: - find: - name: Find add-ons - runs-on: ubuntu-latest - outputs: - addons: ${{ steps.addons.outputs.addons_list }} - steps: - - name: ⤵️ Check out code from GitHub - uses: actions/checkout@v4.1.7 - - - name: 🔍 Find add-on directories - id: addons - uses: home-assistant/actions/helpers/find-addons@master - - lint: - name: Lint add-on ${{ matrix.path }} - runs-on: ubuntu-latest - needs: find - strategy: - matrix: - path: ${{ fromJson(needs.find.outputs.addons) }} - steps: - - name: ⤵️ Check out code from GitHub - uses: actions/checkout@v4.1.7 - - - name: 🚀 Run Home Assistant Add-on Lint - uses: frenck/action-addon-linter@v2.15 - with: - path: "./${{ matrix.path }}" +name: Lint + +on: + push: + branches: + - main + pull_request: + branches: + - main + schedule: + - cron: "0 0 * * *" + +jobs: + find: + name: Find add-ons + runs-on: ubuntu-latest + outputs: + addons: ${{ steps.addons.outputs.addons_list }} + steps: + - name: ⤵️ Check out code from GitHub + uses: actions/checkout@v4.1.7 + + - name: 🔍 Find add-on directories + id: addons + uses: home-assistant/actions/helpers/find-addons@master + + lint: + name: Lint add-on ${{ matrix.path }} + runs-on: ubuntu-latest + needs: find + strategy: + matrix: + path: ${{ fromJson(needs.find.outputs.addons) }} + steps: + - name: ⤵️ Check out code from GitHub + uses: actions/checkout@v4.1.7 + + - name: 🚀 Run Home Assistant Add-on Lint + uses: frenck/action-addon-linter@v2.15 + with: + path: "./${{ matrix.path }}" diff --git a/LICENSE b/LICENSE index 8dada3e..c0ee812 100644 --- a/LICENSE +++ b/LICENSE @@ -1,201 +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. + 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. diff --git a/README.md b/README.md index 4c9d3fb..a103a77 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,62 @@ -# SMA Energy Meter simulator - -This home assistant add-on can emulate the existence of one or more SMA Energy Meters on the local network. This makes it possible to use the data from other meter types and integrate them in your SMA inverter. - -The add-on will subscribe to the following mqtt topic: `sma/emeter//state`. When receiving the first message the emulator wil start the emulation of the energy meter with the provided . The emulator wil send a udp packet every 1000ms. The content of the packet wil stay the same until it gets updated by the next mqtt message. - -```json -{ - "powerIn": 1200, // power consumption in W - "powerOut": 800, // power production in W - "energyIn": 500000, // consumed energy in Wh - "energyOut": 200000, // produced energy in Wh - "destinationAddresses": [ // optional ip-addresses to send the packets to. Default behaviour uses multicast. - ] -} -``` - -## Installation - -- Add the repository to the add-on repository: - -[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Froeland54%2FSMA-Energy-Meter-emulator) - -- Install the addon from the add-on store. - -# Configuration -If you have a mqtt broker configured in home assistant you do not need to configure anything. Otherwise fill in the mqtt configuration in the configuration tab. - -### [SMA Energy Meter simulator](./example) - -![Supports aarch64 Architecture][aarch64-shield] -![Supports amd64 Architecture][amd64-shield] -![Supports armhf Architecture][armhf-shield] -![Supports armv7 Architecture][armv7-shield] -![Supports i386 Architecture][i386-shield] - - - -[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg -[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg -[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg -[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg -[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg +# SMA Energy Meter simulator + +This home assistant add-on can emulate the existence of one or more SMA Energy Meters on the local network. This makes it possible to use the data from other meter types and integrate them in your SMA inverter. + +The add-on will subscribe to the following mqtt topic: `sma/emeter//state`. When receiving the first message the emulator wil start the emulation of the energy meter with the provided . The emulator wil send a udp packet every 1000ms. The content of the packet wil stay the same until it gets updated by the next mqtt message. + +```json +{ + "powerIn": 1200, // power consumption in W + "powerOut": 800, // power production in W + "energyIn": 500000, // consumed energy in Wh + "energyOut": 200000, // produced energy in Wh + "destinationAddresses": [ + // optional ip-addresses to send the packets to. Default behaviour uses multicast. + ] +} +``` + +## Installation + +- Add the repository to the add-on repository: + +[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Froeland54%2FSMA-Energy-Meter-emulator) + +- Install the addon from the add-on store. + +# Configuration + +If you have a mqtt broker configured in home assistant you do not need to configure anything. Otherwise fill in the mqtt configuration in the configuration tab. + +### [SMA Energy Meter simulator](./example) + +![Supports aarch64 Architecture][aarch64-shield] +![Supports amd64 Architecture][amd64-shield] +![Supports armhf Architecture][armhf-shield] +![Supports armv7 Architecture][armv7-shield] +![Supports i386 Architecture][i386-shield] + + + +[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg +[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg diff --git a/repository.yaml b/repository.yaml index bef2c56..7540582 100644 --- a/repository.yaml +++ b/repository.yaml @@ -1,4 +1,4 @@ -# https://developers.home-assistant.io/docs/add-ons/repository#repository-configuration -name: SMA Energy Meter emulator -url: 'https://github.com/Roeland54/SMA-Energy-Meter-emulator' +# https://developers.home-assistant.io/docs/add-ons/repository#repository-configuration +name: SMA Energy Meter emulator +url: 'https://github.com/Roeland54/SMA-Energy-Meter-emulator' maintainer: Roeland54 \ No newline at end of file diff --git a/sma/CHANGELOG.md b/sma/CHANGELOG.md index 78eb08f..98ae25d 100644 --- a/sma/CHANGELOG.md +++ b/sma/CHANGELOG.md @@ -1,5 +1,5 @@ - - -## 0.0.1 - -- Initial release + + +## 0.0.1 + +- Initial release diff --git a/sma/Dockerfile b/sma/Dockerfile index eaa70ec..346b175 100644 --- a/sma/Dockerfile +++ b/sma/Dockerfile @@ -2,10 +2,13 @@ ARG BUILD_FROM FROM $BUILD_FROM # Install requirements for add-on -RUN apk add --no-cache python3 bash py3-pip +#RUN apk add --no-cache python3 bash py3-pip + +# download requirements.txt +RUN wget --no-cache https://raw.githubusercontent.com/Roeland54/SMA-Energy-Meter-emulator/feature/initial-setup-of-the-emulator/sma/requirements.txt # install dependencies -RUN pip install paho-mqtt dynaconf --break-system-packages +RUN pip install -r requirements.txt --break-system-packages COPY / . RUN chmod a+x /src/run.sh diff --git a/sma/apparmor.txt b/sma/apparmor.txt index bc6caea..046a60b 100644 --- a/sma/apparmor.txt +++ b/sma/apparmor.txt @@ -1,57 +1,57 @@ -#include - -profile sma flags=(attach_disconnected,mediate_deleted) { - #include - - # Capabilities - file, - signal (send) set=(kill,term,int,hup,cont), - - # S6-Overlay - /init ix, - /bin/** ix, - /usr/bin/** ix, - /run/{s6,s6-rc*,service}/** ix, - /package/** ix, - /command/** ix, - /etc/services.d/** rwix, - /etc/cont-init.d/** rwix, - /etc/cont-finish.d/** rwix, - /run/{,**} rwk, - /dev/tty rw, - - # Bashio - /usr/lib/bashio/** ix, - /tmp/** rwk, - - # Access to options.json and other files within your addon - /data/** rw, - - # Start new profile for service - /usr/bin/my_program cx -> my_program, - - profile my_program flags=(attach_disconnected,mediate_deleted) { - #include - - # Receive signals from S6-Overlay - signal (receive) peer=*_example, - - # Access to options.json and other files within your addon - /data/** rw, - - # Access to mapped volumes specified in config.json - /share/** rw, - - # Access required for service functionality - # Note: List was built by doing the following: - # 1. Add what is obviously needed based on what is in the script - # 2. Add `complain` as a flag to this profile temporarily and run the addon - # 3. Review the audit log with `journalctl _TRANSPORT="audit" -g 'apparmor="ALLOWED"'` and add other access as needed - # Remember to remove the `complain` flag when you are done - /usr/bin/my_program r, - /bin/bash rix, - /bin/echo ix, - /etc/passwd r, - /dev/tty rw, - } +#include + +profile sma flags=(attach_disconnected,mediate_deleted) { + #include + + # Capabilities + file, + signal (send) set=(kill,term,int,hup,cont), + + # S6-Overlay + /init ix, + /bin/** ix, + /usr/bin/** ix, + /run/{s6,s6-rc*,service}/** ix, + /package/** ix, + /command/** ix, + /etc/services.d/** rwix, + /etc/cont-init.d/** rwix, + /etc/cont-finish.d/** rwix, + /run/{,**} rwk, + /dev/tty rw, + + # Bashio + /usr/lib/bashio/** ix, + /tmp/** rwk, + + # Access to options.json and other files within your addon + /data/** rw, + + # Start new profile for service + /usr/bin/my_program cx -> my_program, + + profile my_program flags=(attach_disconnected,mediate_deleted) { + #include + + # Receive signals from S6-Overlay + signal (receive) peer=*_example, + + # Access to options.json and other files within your addon + /data/** rw, + + # Access to mapped volumes specified in config.json + /share/** rw, + + # Access required for service functionality + # Note: List was built by doing the following: + # 1. Add what is obviously needed based on what is in the script + # 2. Add `complain` as a flag to this profile temporarily and run the addon + # 3. Review the audit log with `journalctl _TRANSPORT="audit" -g 'apparmor="ALLOWED"'` and add other access as needed + # Remember to remove the `complain` flag when you are done + /usr/bin/my_program r, + /bin/bash rix, + /bin/echo ix, + /etc/passwd r, + /dev/tty rw, + } } \ No newline at end of file diff --git a/sma/build.yaml b/sma/build.yaml index d4e3eea..d7cc825 100644 --- a/sma/build.yaml +++ b/sma/build.yaml @@ -1,12 +1,12 @@ -# https://developers.home-assistant.io/docs/add-ons/configuration#add-on-dockerfile -build_from: - aarch64: "ghcr.io/home-assistant/aarch64-base:3.15" - amd64: "ghcr.io/home-assistant/amd64-base:3.15" - armhf: "ghcr.io/home-assistant/armhf-base:3.15" - armv7: "ghcr.io/home-assistant/armv7-base:3.15" - i386: "ghcr.io/home-assistant/i386-base:3.15" -labels: - org.opencontainers.image.title: "SMA Energy Meter emulator" - org.opencontainers.image.description: "Emulate the existence of one or more SMA Energy Meters on the local network." - org.opencontainers.image.source: "https://github.com/Roeland54/SMA-Energy-Meter-emulator" - org.opencontainers.image.licenses: "Apache License 2.0" +# https://developers.home-assistant.io/docs/add-ons/configuration#add-on-dockerfile +build_from: + aarch64: "ghcr.io/home-assistant/aarch64-base-python:latest" + amd64: "ghcr.io/home-assistant/amd64-base-python:latest" + armhf: "ghcr.io/home-assistant/armhf-base-python:latest" + armv7: "ghcr.io/home-assistant/armv7-base-python:latest" + i386: "ghcr.io/home-assistant/i386-base-python:latest" +labels: + org.opencontainers.image.title: "SMA Energy Meter emulator" + org.opencontainers.image.description: "Emulate the existence of one or more SMA Energy Meters on the local network." + org.opencontainers.image.source: "https://github.com/Roeland54/SMA-Energy-Meter-emulator" + org.opencontainers.image.licenses: "Apache License 2.0" diff --git a/sma/config.yaml b/sma/config.yaml index 5174359..9a8efd4 100644 --- a/sma/config.yaml +++ b/sma/config.yaml @@ -2,6 +2,7 @@ name: "SMA Energy Meter emulator" description: "Simulate one or more SMA energy meters based on mqtt messages." version: "0.0.1" slug: "sma" +url: "https://github.com/Roeland54/SMA-Energy-Meter-emulator" arch: - aarch64 - amd64 @@ -27,4 +28,4 @@ schema: port: str username: str? password: str? -#image: "ghcr.io/roeland54/{arch}-SMA-Energy-Meter-emulator +image: "ghcr.io/roeland54/{arch}-SMA-Energy-Meter-emulator diff --git a/sma/requirements.txt b/sma/requirements.txt index 043230d..a2d5ce6 100644 --- a/sma/requirements.txt +++ b/sma/requirements.txt @@ -1,2 +1,2 @@ -dynaconf~=3.1.12 +dynaconf~=3.1.12 paho-mqtt~=1.6.1 \ No newline at end of file diff --git a/sma/src/config.py b/sma/src/config.py index a7aab89..c5150c5 100644 --- a/sma/src/config.py +++ b/sma/src/config.py @@ -1,6 +1,6 @@ -from dynaconf import Dynaconf - -settings = Dynaconf( - envvar_prefix="CONF", - settings_files=["settings.json", "/data/options.json", "settings.dev.json"], +from dynaconf import Dynaconf + +settings = Dynaconf( + envvar_prefix="CONF", + settings_files=["settings.json", "/data/options.json", "settings.dev.json"], ) \ No newline at end of file diff --git a/sma/src/emeter.py b/sma/src/emeter.py index 8f2b324..fc83759 100644 --- a/sma/src/emeter.py +++ b/sma/src/emeter.py @@ -1,94 +1,94 @@ -class emeterPacket: - SMA_POSITIVE_ACTIVE_POWER = 0x00010400 - SMA_POSITIVE_REACTIVE_POWER = 0x00030400 - SMA_NEGATIVE_ACTIVE_POWER = 0x00020400 - SMA_NEGATIVE_REACTIVE_POWER = 0x00040400 - SMA_POSITIVE_ENERGY = 0x00010800 - SMA_NEGATIVE_ENERGY = 0x00020800 - SMA_VERSION = 0x90000000 - - INITIAL_PAYLOAD_LENGTH = 12 - METER_PACKET_SIZE = 1000 - - def __init__(self, serNo=0): - self.meterPacket = bytearray(self.METER_PACKET_SIZE) - self.initEmeterPacket(serNo) - self.begin(0) - self.end() - - def init(self, serNo): - self.initEmeterPacket(serNo) - - def begin(self, timeStampMs): - self._pPacketPos = self._headerLength - self.storeU32BE(self._pMeterTime, timeStampMs) - self._length = self.INITIAL_PAYLOAD_LENGTH - - def addMeasurementValue(self, id, value): - self._pPacketPos = self.storeU32BE(self._pPacketPos, id) - self._pPacketPos = self.storeU32BE(self._pPacketPos, value) - self._length += 8 - - def addCounterValue(self, id, value): - self._pPacketPos = self.storeU32BE(self._pPacketPos, id) - self._pPacketPos = self.storeU64BE(self._pPacketPos, value) - self._length += 12 - - def end(self): - self._pPacketPos = self.storeU32BE(self._pPacketPos, self.SMA_VERSION) - self._pPacketPos = self.storeU32BE(self._pPacketPos, 0x01020452) - self._length += 8 - - self.storeU16BE(self._pDataSize, self._length) - self.storeU32BE(self._pPacketPos, 0) - self._length += 4 - - self._length = self._headerLength + self._length - self.INITIAL_PAYLOAD_LENGTH - return self._length - - def getData(self): - return self.meterPacket - - def getLength(self): - return self._length - - def storeU16BE(self, pPos, value): - self.meterPacket[pPos] = (value >> 8) & 0xFF - self.meterPacket[pPos + 1] = value & 0xFF - return pPos + 2 - - def storeU32BE(self, pPos, value): - pPos = self.storeU16BE(pPos, (value >> 16) & 0xFFFF) - return self.storeU16BE(pPos, value & 0xFFFF) - - def storeU64BE(self, pPos, value): - pPos = self.storeU32BE(pPos, (value >> 32) & 0xFFFFFFFF) - return self.storeU32BE(pPos, value & 0xFFFFFFFF) - - def offsetOf(self, pData, identifier, size): - for i in range(size): - if pData[i] == identifier: - return i - return None - - def initEmeterPacket(self, serNo): - WLEN = 0xfa - DSRC = 0xfb - DTIM = 0xfc - - SMA_METER_HEADER = bytearray([ - ord('S'), ord('M'), ord('A'), 0, - 0x00, 0x04, 0x02, 0xa0, 0x00, 0x00, 0x00, 0x01, - WLEN, WLEN, 0x00, 0x10, 0x60, 0x69, - 0x01, 0x0e, DSRC, DSRC, DSRC, DSRC, - DTIM, DTIM, DTIM, DTIM - ]) - - self._headerLength = len(SMA_METER_HEADER) - self.meterPacket[:self._headerLength] = SMA_METER_HEADER - - self._pDataSize = self.offsetOf(self.meterPacket, WLEN, self._headerLength) - self._pMeterTime = self.offsetOf(self.meterPacket, DTIM, self._headerLength) - - pSerNo = self.offsetOf(self.meterPacket, DSRC, self._headerLength) - self.storeU32BE(pSerNo, serNo) +class emeterPacket: + SMA_POSITIVE_ACTIVE_POWER = 0x00010400 + SMA_POSITIVE_REACTIVE_POWER = 0x00030400 + SMA_NEGATIVE_ACTIVE_POWER = 0x00020400 + SMA_NEGATIVE_REACTIVE_POWER = 0x00040400 + SMA_POSITIVE_ENERGY = 0x00010800 + SMA_NEGATIVE_ENERGY = 0x00020800 + SMA_VERSION = 0x90000000 + + INITIAL_PAYLOAD_LENGTH = 12 + METER_PACKET_SIZE = 1000 + + def __init__(self, serNo=0): + self.meterPacket = bytearray(self.METER_PACKET_SIZE) + self.initEmeterPacket(serNo) + self.begin(0) + self.end() + + def init(self, serNo): + self.initEmeterPacket(serNo) + + def begin(self, timeStampMs): + self._pPacketPos = self._headerLength + self.storeU32BE(self._pMeterTime, timeStampMs) + self._length = self.INITIAL_PAYLOAD_LENGTH + + def addMeasurementValue(self, id, value): + self._pPacketPos = self.storeU32BE(self._pPacketPos, id) + self._pPacketPos = self.storeU32BE(self._pPacketPos, value) + self._length += 8 + + def addCounterValue(self, id, value): + self._pPacketPos = self.storeU32BE(self._pPacketPos, id) + self._pPacketPos = self.storeU64BE(self._pPacketPos, value) + self._length += 12 + + def end(self): + self._pPacketPos = self.storeU32BE(self._pPacketPos, self.SMA_VERSION) + self._pPacketPos = self.storeU32BE(self._pPacketPos, 0x01020452) + self._length += 8 + + self.storeU16BE(self._pDataSize, self._length) + self.storeU32BE(self._pPacketPos, 0) + self._length += 4 + + self._length = self._headerLength + self._length - self.INITIAL_PAYLOAD_LENGTH + return self._length + + def getData(self): + return self.meterPacket + + def getLength(self): + return self._length + + def storeU16BE(self, pPos, value): + self.meterPacket[pPos] = (value >> 8) & 0xFF + self.meterPacket[pPos + 1] = value & 0xFF + return pPos + 2 + + def storeU32BE(self, pPos, value): + pPos = self.storeU16BE(pPos, (value >> 16) & 0xFFFF) + return self.storeU16BE(pPos, value & 0xFFFF) + + def storeU64BE(self, pPos, value): + pPos = self.storeU32BE(pPos, (value >> 32) & 0xFFFFFFFF) + return self.storeU32BE(pPos, value & 0xFFFFFFFF) + + def offsetOf(self, pData, identifier, size): + for i in range(size): + if pData[i] == identifier: + return i + return None + + def initEmeterPacket(self, serNo): + WLEN = 0xfa + DSRC = 0xfb + DTIM = 0xfc + + SMA_METER_HEADER = bytearray([ + ord('S'), ord('M'), ord('A'), 0, + 0x00, 0x04, 0x02, 0xa0, 0x00, 0x00, 0x00, 0x01, + WLEN, WLEN, 0x00, 0x10, 0x60, 0x69, + 0x01, 0x0e, DSRC, DSRC, DSRC, DSRC, + DTIM, DTIM, DTIM, DTIM + ]) + + self._headerLength = len(SMA_METER_HEADER) + self.meterPacket[:self._headerLength] = SMA_METER_HEADER + + self._pDataSize = self.offsetOf(self.meterPacket, WLEN, self._headerLength) + self._pMeterTime = self.offsetOf(self.meterPacket, DTIM, self._headerLength) + + pSerNo = self.offsetOf(self.meterPacket, DSRC, self._headerLength) + self.storeU32BE(pSerNo, serNo) diff --git a/sma/src/main.py b/sma/src/main.py index 55ca10e..f0e6e5d 100644 --- a/sma/src/main.py +++ b/sma/src/main.py @@ -1,95 +1,95 @@ -import json -import time -import threading -import socket -import logging -import util -import paho.mqtt.client as mqtt -from config import settings -from emeter import emeterPacket - -def on_connect(client, userdata, flags, rc, properties=None): - if rc == 0: - logging.info("Connected to MQTT broker") - client.subscribe("sma/emeter/+/state") - else: - logging.error(f"Failed to connect, return code {rc}") - - -def on_message(client, userdata, msg): - logging.info(f"Received message on topic {msg.topic}") - serial_number = msg.topic.split('/')[2] - data = json.loads(msg.payload) - logging.debug(f"Message data: {data}") - - packet = emeterPacket(int(serial_number)) - packet.begin(int(time.time() * 1000)) - - packet.addMeasurementValue(emeterPacket.SMA_POSITIVE_ACTIVE_POWER, data['powerIn']) - packet.addMeasurementValue(emeterPacket.SMA_NEGATIVE_ACTIVE_POWER, data['powerOut']) - packet.addMeasurementValue(emeterPacket.SMA_POSITIVE_REACTIVE_POWER, 0) - packet.addMeasurementValue(emeterPacket.SMA_NEGATIVE_REACTIVE_POWER, 0) - - packet.addCounterValue(emeterPacket.SMA_POSITIVE_ENERGY, data['energyIn']) - packet.addCounterValue(emeterPacket.SMA_NEGATIVE_ENERGY, data['energyOut']) - - packet.end() - - packet_data = packet.getData()[:packet.getLength()] - destination_addresses = data.get('destinationAddresses', []) - - with userdata['lock']: - userdata['packets'][serial_number] = (packet_data, destination_addresses) - logging.info(f"Updated packet for serial number {serial_number}") - - -def udp_sender(userdata): - udp_socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) - while True: - with userdata['lock']: - for serial_number, (packet_data, destination_addresses) in userdata['packets'].items(): - if destination_addresses: - for address in destination_addresses: - udp_socket.sendto(packet_data, (address, userdata['udp_port'])) - logging.debug(f"Sent packet to {address} for serial number {serial_number}") - else: - udp_socket.sendto(packet_data, (userdata['udp_address'], userdata['udp_port'])) - logging.debug(f"Sent multicast packet for serial number {serial_number} packet data: {packet_data}") - time.sleep(1) - - -def main(): - util.setup_logging() - util.set_mqtt_settings() - - mqtt_client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2, userdata={ - 'packets': {}, - 'lock': threading.Lock(), - 'udp_address': '239.12.255.254', - 'udp_port': 9522 - }, protocol=mqtt.MQTTv5) - - if settings["mqtt"]["username"] and settings["mqtt"]["password"]: - mqtt_client.username_pw_set(settings["mqtt"]["username"], settings["mqtt"]["password"]) - port = 1883 - if util.keys_exists(settings["mqtt"], "port"): - conf_port = settings["mqtt"]["port"] - if isinstance(conf_port, int): - if conf_port > 0: - port = settings["mqtt"]["port"] - - mqtt_client.on_connect = on_connect - mqtt_client.on_message = on_message - - mqtt_client.connect(settings["mqtt"]["broker"], port) - - udp_thread = threading.Thread(target=udp_sender, args=(mqtt_client._userdata,)) - udp_thread.daemon = True - udp_thread.start() - - logging.info("Starting MQTT loop") - mqtt_client.loop_forever() - - -if __name__ == "__main__": +import json +import time +import threading +import socket +import logging +import util +import paho.mqtt.client as mqtt +from config import settings +from emeter import emeterPacket + +def on_connect(client, userdata, flags, rc, properties=None): + if rc == 0: + logging.info("Connected to MQTT broker") + client.subscribe("sma/emeter/+/state") + else: + logging.error(f"Failed to connect, return code {rc}") + + +def on_message(client, userdata, msg): + logging.info(f"Received message on topic {msg.topic}") + serial_number = msg.topic.split('/')[2] + data = json.loads(msg.payload) + logging.debug(f"Message data: {data}") + + packet = emeterPacket(int(serial_number)) + packet.begin(int(time.time() * 1000)) + + packet.addMeasurementValue(emeterPacket.SMA_POSITIVE_ACTIVE_POWER, data['powerIn']) + packet.addMeasurementValue(emeterPacket.SMA_NEGATIVE_ACTIVE_POWER, data['powerOut']) + packet.addMeasurementValue(emeterPacket.SMA_POSITIVE_REACTIVE_POWER, 0) + packet.addMeasurementValue(emeterPacket.SMA_NEGATIVE_REACTIVE_POWER, 0) + + packet.addCounterValue(emeterPacket.SMA_POSITIVE_ENERGY, data['energyIn']) + packet.addCounterValue(emeterPacket.SMA_NEGATIVE_ENERGY, data['energyOut']) + + packet.end() + + packet_data = packet.getData()[:packet.getLength()] + destination_addresses = data.get('destinationAddresses', []) + + with userdata['lock']: + userdata['packets'][serial_number] = (packet_data, destination_addresses) + logging.info(f"Updated packet for serial number {serial_number}") + + +def udp_sender(userdata): + udp_socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) + while True: + with userdata['lock']: + for serial_number, (packet_data, destination_addresses) in userdata['packets'].items(): + if destination_addresses: + for address in destination_addresses: + udp_socket.sendto(packet_data, (address, userdata['udp_port'])) + logging.debug(f"Sent packet to {address} for serial number {serial_number}") + else: + udp_socket.sendto(packet_data, (userdata['udp_address'], userdata['udp_port'])) + logging.debug(f"Sent multicast packet for serial number {serial_number} packet data: {packet_data}") + time.sleep(1) + + +def main(): + util.setup_logging() + util.set_mqtt_settings() + + mqtt_client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2, userdata={ + 'packets': {}, + 'lock': threading.Lock(), + 'udp_address': '239.12.255.254', + 'udp_port': 9522 + }, protocol=mqtt.MQTTv5) + + if settings["mqtt"]["username"] and settings["mqtt"]["password"]: + mqtt_client.username_pw_set(settings["mqtt"]["username"], settings["mqtt"]["password"]) + port = 1883 + if util.keys_exists(settings["mqtt"], "port"): + conf_port = settings["mqtt"]["port"] + if isinstance(conf_port, int): + if conf_port > 0: + port = settings["mqtt"]["port"] + + mqtt_client.on_connect = on_connect + mqtt_client.on_message = on_message + + mqtt_client.connect(settings["mqtt"]["broker"], port) + + udp_thread = threading.Thread(target=udp_sender, args=(mqtt_client._userdata,)) + udp_thread.daemon = True + udp_thread.start() + + logging.info("Starting MQTT loop") + mqtt_client.loop_forever() + + +if __name__ == "__main__": main() \ No newline at end of file diff --git a/sma/src/settings.json b/sma/src/settings.json index ec1772f..e5da600 100644 --- a/sma/src/settings.json +++ b/sma/src/settings.json @@ -1,8 +1,8 @@ -{ - "mqtt": { - "broker": "", - "port": 1883, - "username": "", - "password": "" - } +{ + "mqtt": { + "broker": "", + "port": 1883, + "username": "", + "password": "" + } } \ No newline at end of file diff --git a/sma/src/util.py b/sma/src/util.py index 2d38b02..556ef32 100644 --- a/sma/src/util.py +++ b/sma/src/util.py @@ -1,59 +1,59 @@ -import logging -import os -import config - -def keys_exists(element, *keys): - """" - Check if *keys (nested) exists in `element` (dict). - Thanks stackoverflow: https://stackoverflow.com/questions/43491287/elegant-way-to-check-if-a-nested-key-exists-in-a-dict - """ - if not isinstance(element, dict): - raise AttributeError('keys_exists() expects dict as first argument.') - if len(keys) == 0: - raise AttributeError('keys_exists() expects at least two arguments, one given.') - - _element = element - for key in keys: - try: - _element = _element[key] - except KeyError: - return False - return True - -def set_mqtt_settings(): - if os.environ.get("IS_HA_ADDON"): - if config.settings["mqtt"]["broker"] != "auto_broker" \ - or config.settings["mqtt"]["port"] != "auto_port" \ - or config.settings["mqtt"]["username"] != "auto_user" \ - or config.settings["mqtt"]["password"] != "auto_password": - # If settings were manually set, use the manually set settings - return None - - broker_host = os.getenv("MQTTHOST", None) - broker_port = os.getenv("MQTTPORT", None) - broker_user = os.getenv("MQTTUSER", None) - broker_pass = os.getenv("MQTTPASS", None) - - if not broker_host or not broker_port: - raise Exception("MQTT connection could not be established. Please check if your MQTT Add-On is running!") - - logging.debug("MQTT Credentials - Host " + broker_host + " Port: " + str(broker_port) + - " User: " + str(broker_user) + " Pass: " + str(broker_pass)) - - config.settings["mqtt"]["broker"] = broker_host - config.settings["mqtt"]["port"] = broker_port - config.settings["mqtt"]["username"] = broker_user - config.settings["mqtt"]["password"] = broker_pass - -def setup_logging(): - logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s') - - logger = logging.getLogger() - logger.setLevel(logging.INFO) - if "debug" in config.settings: - if config.settings["debug"]: - logger.setLevel(logging.DEBUG) - - if "disable_logging" in config.settings: - if config.settings["disable_logging"]: - logger.setLevel(logging.ERROR) +import logging +import os +import config + +def keys_exists(element, *keys): + """" + Check if *keys (nested) exists in `element` (dict). + Thanks stackoverflow: https://stackoverflow.com/questions/43491287/elegant-way-to-check-if-a-nested-key-exists-in-a-dict + """ + if not isinstance(element, dict): + raise AttributeError('keys_exists() expects dict as first argument.') + if len(keys) == 0: + raise AttributeError('keys_exists() expects at least two arguments, one given.') + + _element = element + for key in keys: + try: + _element = _element[key] + except KeyError: + return False + return True + +def set_mqtt_settings(): + if os.environ.get("IS_HA_ADDON"): + if config.settings["mqtt"]["broker"] != "auto_broker" \ + or config.settings["mqtt"]["port"] != "auto_port" \ + or config.settings["mqtt"]["username"] != "auto_user" \ + or config.settings["mqtt"]["password"] != "auto_password": + # If settings were manually set, use the manually set settings + return None + + broker_host = os.getenv("MQTTHOST", None) + broker_port = os.getenv("MQTTPORT", None) + broker_user = os.getenv("MQTTUSER", None) + broker_pass = os.getenv("MQTTPASS", None) + + if not broker_host or not broker_port: + raise Exception("MQTT connection could not be established. Please check if your MQTT Add-On is running!") + + logging.debug("MQTT Credentials - Host " + broker_host + " Port: " + str(broker_port) + + " User: " + str(broker_user) + " Pass: " + str(broker_pass)) + + config.settings["mqtt"]["broker"] = broker_host + config.settings["mqtt"]["port"] = broker_port + config.settings["mqtt"]["username"] = broker_user + config.settings["mqtt"]["password"] = broker_pass + +def setup_logging(): + logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s') + + logger = logging.getLogger() + logger.setLevel(logging.INFO) + if "debug" in config.settings: + if config.settings["debug"]: + logger.setLevel(logging.DEBUG) + + if "disable_logging" in config.settings: + if config.settings["disable_logging"]: + logger.setLevel(logging.ERROR)