@homebridge-plugins/homebridge-smarthq 0.0.1

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: donavanbecker
+custom: paypal.me/DonavanBecker

package/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,91 @@
+name: Bug-Report
+description: Report a Bug to help us improve
+title: "Bug:"
+labels: [bug]
+assignees: 'donavanbecker'
+body:
+  - type: markdown
+    attributes:
+      value: |
+        You must use the issue template below when submitting a bug.
+  - type: input
+    attributes:
+      label: Describe The Bug
+      placeholder: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: To Reproduce
+      placeholder: Steps to reproduce the behavior.
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Expected behavior
+      placeholder: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: Logs
+    attributes:
+      label: Relevant log output
+      placeholder: Bug reports that do not contain logs may be closed without warning. Show the Homebridge logs here. If using Homebridge Config-UI-X, you can easly download your log by visiting the log page on the UI and Clicking the Download Icon in the top right. Remove any sensitive information, such as your @homebridge-plugins/homebridge-smarthq api key. Please Turn on Debug Mode before submitting your Issue so more logs can be shared to fix the issue being submitted.
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    id: Config
+    attributes:
+      label: Config for @homebridge-plugins/homebridge-smarthq
+      placeholder: Paste your homebridge config.json here. Remove any sensitive information, such as your @homebridge-plugins/homebridge-smarthq api key.
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Screenshots
+      description: If applicable add screenshots to help explain your problem.
+      placeholder: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: |
+        Environment
+  - type: input
+    attributes:
+      label: Node.js Version
+      placeholder: v14.17.6
+    validations:
+      required: true  
+  - type: input
+    attributes:
+      label: NPM Version
+      placeholder: v7.22.0
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Homebridge Version
+      placeholder: If applicable, add screenshots to help explain your problem.
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Homebridge SmartHQ Plugin Version
+      placeholder: v1.1.0
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Homebridge Config UI X Plugin Version
+      placeholder: v4.41.2
+    validations:
+      required: false 
+  - type: input
+    attributes:
+      label: Operating System
+      placeholder: Raspbian / Ubuntu / Debian / Windows / macOS / Docker
+    validations:
+      required: true

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Homebridge Discord Channel for SmartHQ
+    url: https://discord.gg/8fpZA4S
+    about: Please ask and answer questions here.
+  - name: Homebridge-air - Pull Requests
+    url: https://github.com/homebridge-plugins/homebridge-smarthq/pulls
+    about: Please report security vulnerabilities here.

package/.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,34 @@
+name: Feature Request
+description: Suggest an idea for this project
+title: "Feature Request: "
+labels: [enhancement]
+assignees: 'donavanbecker'
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Is your feature request related to a problem? Please describe.
+  - type: input
+    attributes:
+      label: Problem
+      placeholder: A clear and concise description of what the problem is. Ex. I am always frustrated when [...] 
+    validations:
+      required: false
+  - type: input
+    attributes:
+      label: Solution
+      placeholder: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Alternatives
+      placeholder: A clear and concise description of any alternative solutions or features you have considered.
+    validations:
+      required: false
+  - type: input
+    attributes:
+      label: Additional context
+      placeholder: Add any other context or screenshots about the feature request here. Post devicediscovery logs here.
+    validations:
+      required: false

package/.github/ISSUE_TEMPLATE/support-request.yml

@@ -0,0 +1,85 @@
+name: Support Request
+description: Need help?
+title: "Support Request:"
+labels: [question]
+assignees: 'donavanbecker'
+body:
+  - type: markdown
+    attributes:
+      value: |
+        You must use the issue template below when submitting a support request.
+  - type: input
+    attributes:
+      label: Describe Your Problem
+      placeholder: A clear and concise description of what problem you are trying to solve.
+    validations:
+      required: true
+  - type: textarea
+    id: Logs
+    attributes:
+      label: Relevant log output
+      placeholder: Bug reports that do not contain logs may be closed without warning. Show the Homebridge logs here. If using Homebridge Config-UI-X, you can easly download your log by visiting the log page on the UI and Clicking the Download Icon in the top right. Remove any sensitive information, such as your @homebridge-plugins/homebridge-smarthq apikey and zipCode. Please Turn on Debug Mode before submitting your Issue so more logs can be shared to fix the issue being submitted.
+      render: shell
+    validations:
+      required: false
+  - type: textarea
+    id: Config
+    attributes:
+      label: Config for @homebridge-plugins/homebridge-smarthq
+      placeholder: Paste your homebridge config.json here. Remove any sensitive information, such as your @homebridge-plugins/homebridge-smarthq apikey and zipCode.
+      render: shell
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Screenshots
+      description: If applicable add screenshots to help explain your problem.
+      placeholder: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false
+  - type: input
+    attributes:
+      label: Device & Model
+      placeholder: If applicable, add screenshots to help explain your problem.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        Environment
+  - type: input
+    attributes:
+      label: Node.js Version
+      placeholder: v14.17.6
+    validations:
+      required: true  
+  - type: input
+    attributes:
+      label: NPM Version
+      placeholder: v7.22.0
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Homebridge Version
+      placeholder: If applicable, add screenshots to help explain your problem.
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Homebridge SmartHQ Plugin Version
+      placeholder: v1.1.0
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Homebridge Config UI X Plugin Version
+      placeholder: v4.41.2
+    validations:
+      required: false 
+  - type: input
+    attributes:
+      label: Operating System
+      placeholder: Raspbian / Ubuntu / Debian / Windows / macOS / Docker
+    validations:
+      required: true

package/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,48 @@
+---
+name: Bug Report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+<!-- You must use the issue template below when submitting a bug -->
+
+**Describe The Bug:**
+<!-- A clear and concise description of what the bug is. -->
+
+**To Reproduce:**
+<!-- Steps to reproduce the behavior. -->
+
+**Expected behavior:**
+<!-- A clear and concise description of what you expected to happen. -->
+
+**Logs:**
+<!-- Bug reports that do not contain logs may be closed without warning. -->
+
+```
+Show the Homebridge / Homebridge Config UI X logs here.
+```
+
+**Homebridge Config:**
+
+```json
+Show your homebridge config.json here
+```
+
+**Screenshots:**
+<!-- If applicable, add screenshots to help explain your problem. -->
+
+**Environment:**
+
+* **Node.js Version**: <!-- node -v -->
+* **NPM Version**: <!-- npm -v -->
+* **Homebridge Version**: <!-- homebridge -V -->
+* **Homebridge SmartHQ Plugin Version**:
+* **Homebridge Config UI X Version**:
+* **Operating System**: Raspbian / Ubuntu / Debian / Windows / macOS / Docker
+* **Process Supervisor**: Docker / Systemd / init.d / pm2 / launchctl / hb-service / other / none
+
+
+<!-- Click the "Preview" tab before you submit to ensure the formatting is correct. -->

package/.github/PULL_REQUEST_TEMPLATE/pull_request.md

@@ -0,0 +1,27 @@
+---
+name: Enhancement
+about: Contribute to Plugin through Pull Request
+title: ''
+labels: 'enhancement'
+assignees: 'donavanbecker'
+---
+
+**Is your enhancement related to a problem? Please describe.**
+
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+**Describe the solution you are addding**
+
+<!-- A clear and concise description of what you want to happen. -->
+
+**Changes Proposed in this Pull Request**
+
+<!-- A clear and concise description of what is being changed. -->
+
+**Describe alternatives you've considered**
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+**Additional context**
+
+<!-- Add any other context or screenshots about the feature request here. -->

package/.github/dependabot.yml

@@ -0,0 +1,17 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: 'npm' # See documentation for possible values
+    directory: '/' # Location of package manifests
+    target-branch: 'beta-*.*.*'
+    schedule:
+      interval: 'daily'
+  - package-ecosystem: 'github-actions' # See documentation for possible values
+    directory: '/' # Location of package manifests
+    target-branch: 'beta-*.*.*'
+    schedule:
+      interval: 'daily'

package/.github/labeler.yml

@@ -0,0 +1,38 @@
+# Add 'branding' label to any changes within 'docs' folder or any subfolders
+branding:
+- changed-files:
+  - any-glob-to-any-file: branding/**
+
+# Add 'docs' label to any change to .md files within the entire repository 
+docs:
+- changed-files:
+  - any-glob-to-any-file: '**/*.md'
+
+# Add 'enhancement' label to any change to src files within the source dir EXCEPT for the docs sub-folder
+enhancement:
+  - changed-files:
+    - any-glob-to-any-file: 'src/**/*'
+    - any-glob-to-any-file: 'config.schema.json'
+
+# Add 'dependencies' label to any change to src files within the source dir EXCEPT for the docs sub-folder
+dependencies:
+  - changed-files:
+    - any-glob-to-any-file: 'package.json'
+    - any-glob-to-any-file: 'package-lock.json'
+
+# Add 'beta' label to any PR that is opened against the `beta` branch
+beta:
+- base-branch: 'beta*'
+
+# Add 'alpha' label to any PR that is opened against the `alpha` branch
+alpha:
+- base-branch: 'alpha*'
+
+# Add 'latest' label to any PR that is opened against the `latest` branch
+latest:
+- base-branch: 'latest'
+
+# Add 'workflow' to any changes within 'workflow' folder or any subfolders
+workflow:
+- changed-files:
+  - any-glob-to-any-file: .github/**

package/.github/release-drafter.yml

@@ -0,0 +1,33 @@
+name-template: 'v$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+
+categories:
+  - title: 'Workflow Changes'
+    labels:
+      - 'workflow'
+  - title: 'Enhancements'
+    labels:
+      - 'enhancement'
+  - title: 'Updated Dependencies'
+    labels:
+      - 'dependencies'
+  - title: 'Documentation'
+    labels:
+      - 'docs'
+
+change-template: '- $TITLE @$AUTHOR [#$NUMBER]'
+version-resolver:
+  major:
+    labels:
+      - 'major'
+  minor:
+    labels:
+      - 'minor'
+  patch:
+    labels:
+      - 'patch'
+  default: patch
+template: |
+  ## Changes
+
+  $CHANGES

package/.github/workflows/beta-release.yml

@@ -0,0 +1,55 @@
+name: Beta Release
+
+on:
+  push:
+    branches: [beta-*.*.*, beta]
+  workflow_dispatch:
+
+jobs:
+  build_and_test:
+    uses: homebridge/.github/.github/workflows/nodejs-build-and-test.yml@latest
+    with:
+      enable_coverage: false
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
+  lint:
+    needs: build_and_test
+    uses: homebridge/.github/.github/workflows/eslint.yml@latest
+
+  publish:
+    needs: lint
+    if: ${{ github.repository == 'homebridge-plugins/homebridge-smarthq' }}
+    permissions:
+      id-token: write
+    uses: homebridge/.github/.github/workflows/npm-publish-esm.yml@latest
+    with:
+      tag: 'beta'
+      dynamically_adjust_version: true
+      npm_version_command: 'pre'
+      pre_id: 'beta'
+    secrets:
+      npm_auth_token: ${{ secrets.npm_token }}
+
+  pre-release:
+    needs: publish
+    if: ${{ github.repository == 'homebridge-plugins/homebridge-smarthq' }}
+    uses: homebridge/.github/.github/workflows/pre-release.yml@latest
+    with:
+      npm_version: ${{ needs.publish.outputs.NPM_VERSION }}
+      body: |
+        **Beta Release**
+        **Version**: v${{ needs.publish.outputs.NPM_VERSION }}
+        [How To Test Beta Releases](https://github.com/homebridge-plugins/homebridge-smarthq/wiki/Beta-Version)
+
+  github-releases-to-discord:
+    name: Discord Webhooks
+    needs: [build_and_test,publish]
+    if: ${{ github.repository == 'homebridge-plugins/homebridge-smarthq' }}
+    uses: homebridge/.github/.github/workflows/discord-webhooks.yml@latest
+    with:
+      title: "SmartHQ Beta Release"
+      description: |
+        Version `v${{ needs.publish.outputs.NPM_VERSION }}`
+      url: "https://github.com/homebridge-plugins/homebridge-smarthq/releases/tag/v${{ needs.publish.outputs.NPM_VERSION }}"
+    secrets:
+      DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_URL_BETA || secrets.DISCORD_WEBHOOK_URL_LATEST }}

package/.github/workflows/build.yml

@@ -0,0 +1,18 @@
+name: Node Build
+
+on:
+  push:
+    branches: [latest]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build_and_test:
+    uses: homebridge/.github/.github/workflows/nodejs-build-and-test.yml@latest
+    with:
+      enable_coverage: flase
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
+  lint:
+    needs: build_and_test
+    uses: homebridge/.github/.github/workflows/eslint.yml@latest

package/.github/workflows/changerelease.yml

@@ -0,0 +1,11 @@
+name: Changelog to Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  changerelease:
+      uses: homebridge/.github/.github/workflows/change-release.yml@latest
+      secrets:
+          token: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/labeler.yml

@@ -0,0 +1,9 @@
+name: Labeler
+
+on: [pull_request]
+
+jobs:
+  labeler:
+    uses: homebridge/.github/.github/workflows/labeler.yml@latest
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/release-drafter.yml

@@ -0,0 +1,14 @@
+name: Release Drafter
+
+on:
+  push:
+    branches: [latest]
+  pull_request_target: # required for autolabeler
+    types: [opened, reopened, synchronize]
+  workflow_dispatch:
+
+jobs:
+  release-drafter:
+    uses: homebridge/.github/.github/workflows/release-drafter.yml@latest
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build_and_test:
+    uses: homebridge/.github/.github/workflows/nodejs-build-and-test.yml@latest
+    with:
+      enable_coverage: flase
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
+
+  publish:
+    needs: build_and_test
+    if: ${{ github.repository == 'homebridge-plugins/homebridge-smarthq' }}
+    permissions:
+      id-token: write
+    uses: homebridge/.github/.github/workflows/npm-publish-esm.yml@latest
+    secrets:
+      npm_auth_token: ${{ secrets.npm_token }}
+
+  github-releases-to-discord:
+    name: Discord Webhooks
+    needs: [build_and_test,publish]
+    if: ${{ github.repository == 'homebridge-plugins/homebridge-smarthq' }}
+    uses: homebridge/.github/.github/workflows/discord-webhooks.yml@latest
+    with:
+      title: "SmartHQ Release"
+      description: |
+        Version `v${{ needs.publish.outputs.NPM_VERSION }}`
+      url: "https://github.com/homebridge-plugins/homebridge-smarthq/releases/tag/v${{ needs.publish.outputs.NPM_VERSION }}"
+    secrets:
+      DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_URL_LATEST }}

package/.github/workflows/stale.yml

@@ -0,0 +1,12 @@
+name: Stale workflow
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '45 11 * * *'
+
+jobs:
+  stale:
+    uses: homebridge/.github/.github/workflows/stale.yml@latest
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. This project uses [Semantic Versioning](https://semver.org/)
+
+## [1.0.0](https://github.com/homebridge-plugins/homebridge-smarthq/compare/v0.1.0...v1.0.0) (2024-XX-XX)
+
+### What's Changes
+
+- Release of [@homebridge-plugins/homebridge-smarthq](https://github.com/homebridge-plugins/homebridge-smarthq) which allows you to update your see the air qualiry from SmartHQ Web API.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-smarthq/compare/v0.1.0...v1.0.0
+
+## [0.1.0](https://github.com/homebridge-plugins/homebridge-smarthq/releases/tag/v0.1.0) (2024-09-07)
+
+### What's Changes
+
+- Initial Release

package/LICENSE

@@ -0,0 +1,14 @@
+ISC License (ISC)
+Copyright (c) 2023 donavanbecker
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+<span align="center">
+
+<a href="https://github.com/homebridge/verified/blob/master/verified-plugins.json"><img alt="homebridge-verified" src="https://raw.githubusercontent.com/homebridge-plugins/homebridge-smarthq/latest/branding/Homebridge_x_Air.svg?sanitize=true" width="350px"></a>
+
+# Homebridge SmartHQ
+
+<a href="https://www.npmjs.com/package/@homebridge-plugins/homebridge-smarthq"><img title="npm version" src="https://badgen.net/npm/v/@homebridge-plugins/homebridge-smarthq?icon=npm&label" ></a>
+<a href="https://www.npmjs.com/package/@homebridge-plugins/homebridge-smarthq"><img title="npm downloads" src="https://badgen.net/npm/dt/@homebridge-plugins/homebridge-smarthq?label=downloads" ></a>
+<a href="https://discord.gg/8fpZA4S"><img title="discord-air" src="https://badgen.net/discord/online-members/8fpZA4S?icon=discord&label=discord" ></a>
+<a href="https://paypal.me/donavanbecker"><img title="donate" src="https://badgen.net/badge/donate/paypal/yellow" ></a>
+
+<p>The Homebridge <a href="https://airnow.gove">SmartHQ</a>
+plugin allows you monitor the current AirQuality for your Zip Code from HomeKit and Siri.
+</p>
+
+</span>
+
+## Installation
+
+1. Search for "SmartHQ" on the plugin screen of [Homebridge Config UI X](https://github.com/oznu/homebridge-config-ui-x).
+2. Click **Install**.
+
+## Configuration
+
+1. Login / create an account at https://airnow.gove/
+
+<p align="center">
+
+<img src="https://user-images.githubusercontent.com/9875439/133934622-05a9c19e-c5ba-46ee-b0db-0748420813d7.png" width="450px">
+
+</p>
+
+2. Type in your SmartHQ.gov API Key and Zip Code
+3. Click Save
+4. Restart Homebridge
+
+## Supported SmartHQ Quality Providers
+
+Currently supports AQI Services:
+
+- [SmartHQ](https://www.airnow.gov/) which is limited to the USA. A valid ZipCode is required.
+- [Aqicn](https://www.aqicn.org/) which has international support, provided by the [World SmartHQ Quality Index Project](http://waqi.info/).
+
+Depending on where exactly you would like to monitor AQI, one service may be more appropriate than the other.
+
+## Supported SmartHQ Quality Features
+
+This plugin will create an DishWasher element. The Home app works well, but the Eve app seems to show more measurements. Measurements retrieved are PM2.5, PM10, & O3 for SmartHQ. Aqicn adds NO2, SO2, CO...
+
+## Thanks
+
+Thank you to [ToddGreenfield](https://github.com/ToddGreenfield) for the the work done on the accesorry based plugin [homebridge-airnow](https://github.com/ToddGreenfield/homebridge-airnow/blob/master/README.md).

package/SECURITY.md

@@ -0,0 +1,19 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.0.0   | :white_check_mark: |
+| < 0.1.0 | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.