pax_global_header00006660000000000000000000000064142427043140014513gustar00rootroot0000000000000052 comment=a56d9082f09b3b8599abd5f29a9239d937247812 pluggable-monitor-protocol-handler-0.9.2/000077500000000000000000000000001424270431400204245ustar00rootroot00000000000000pluggable-monitor-protocol-handler-0.9.2/.codespellrc000066400000000000000000000007701424270431400227300ustar00rootroot00000000000000# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check/.codespellrc # See: https://github.com/codespell-project/codespell#using-a-config-file [codespell] # In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here: ignore-words-list = , builtin = clear,informal,en-GB_to_en-US check-filenames = check-hidden = skip = ./.git,./.licenses,./go.mod,./go.sum,./package-lock.json,./poetry.lock,./yarn.lock pluggable-monitor-protocol-handler-0.9.2/.ecrc000066400000000000000000000001211424270431400213330ustar00rootroot00000000000000{ "Exclude": [ "LICENSE.txt", "poetry.lock", "^\\.licenses/" ] } pluggable-monitor-protocol-handler-0.9.2/.editorconfig000066400000000000000000000023251424270431400231030ustar00rootroot00000000000000# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/general/.editorconfig # See: https://editorconfig.org/ # The formatting style defined in this file is the official standardized style to be used in all Arduino Tooling # projects and should not be modified. # Note: indent style for each file type is defined even when it matches the universal config in order to make it clear # that this type has an official style. [*] charset = utf-8 end_of_line = lf indent_size = 2 indent_style = space insert_final_newline = true trim_trailing_whitespace = true [*.{adoc,asc,asciidoc}] indent_size = 2 indent_style = space [*.{bash,sh}] indent_size = 2 indent_style = space [*.{c,cc,cp,cpp,cxx,h,hh,hpp,hxx,ii,inl,ino,ixx,pde,tpl,tpp,txx}] indent_size = 2 indent_style = space [*.{go,mod}] indent_style = tab [*.java] indent_size = 2 indent_style = space [*.{js,jsx,json,jsonc,json5,ts,tsx}] indent_size = 2 indent_style = space [*.{md,mdx,mkdn,mdown,markdown}] indent_size = unset indent_style = space [*.proto] indent_size = 2 indent_style = space [*.py] indent_size = 4 indent_style = space [*.svg] indent_size = 2 indent_style = space [*.{yaml,yml}] indent_size = 2 indent_style = space pluggable-monitor-protocol-handler-0.9.2/.github/000077500000000000000000000000001424270431400217645ustar00rootroot00000000000000pluggable-monitor-protocol-handler-0.9.2/.github/ISSUE_TEMPLATE/000077500000000000000000000000001424270431400241475ustar00rootroot00000000000000pluggable-monitor-protocol-handler-0.9.2/.github/ISSUE_TEMPLATE/bug-report.yml000066400000000000000000000037601424270431400267660ustar00rootroot00000000000000# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/general/bug-report.yml # See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms name: Bug report description: Report a problem with the code or documentation in this repository. labels: - "type: imperfection" body: - type: textarea id: description attributes: label: Describe the problem validations: required: true - type: textarea id: reproduce attributes: label: To reproduce description: Provide the specific set of steps we can follow to reproduce the problem. validations: required: true - type: textarea id: expected attributes: label: Expected behavior description: What would you expect to happen after following those instructions? validations: required: true - type: input id: project-version attributes: label: "'github.com/arduino/pluggable-monitor-protocol-handler' version" description: | Which version of `github.com/arduino/pluggable-monitor-protocol-handler` are you using? _This should be the most recent version available._ validations: required: true - type: textarea id: additional attributes: label: Additional context description: Add any additional information here. validations: required: false - type: checkboxes id: checklist attributes: label: Issue checklist description: Please double-check that you have done each of the following things before submitting the issue. options: - label: I searched for previous reports in [the issue tracker](https://github.com/arduino/pluggable-monitor-protocol-handler/issues?q=) required: true - label: I verified the problem still occurs when using the latest version required: true - label: My report contains all necessary details required: true pluggable-monitor-protocol-handler-0.9.2/.github/ISSUE_TEMPLATE/config.yml000066400000000000000000000014351424270431400261420ustar00rootroot00000000000000# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/template-choosers/general/config.yml # See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser blank_issues_enabled: true contact_links: - name: Learn about using this project url: https://github.com/arduino/pluggable-monitor-protocol-handler#readme about: Detailed usage documentation is available here. - name: Support request url: https://forum.arduino.cc/ about: We can help you out on the Arduino Forum! - name: Discuss development work on the project url: https://groups.google.com/a/arduino.cc/g/developers about: Arduino Developers Mailing List pluggable-monitor-protocol-handler-0.9.2/.github/ISSUE_TEMPLATE/feature-request.yml000066400000000000000000000035771424270431400300270ustar00rootroot00000000000000# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/general/bug-report.yml # See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms name: Feature request description: Suggest an enhancement to this project. labels: - "type: enhancement" body: - type: textarea id: description attributes: label: Describe the request validations: required: true - type: textarea id: current attributes: label: Describe the current behavior description: | What is the current behavior of `github.com/arduino/pluggable-monitor-protocol-handler` in relation to your request? How can we reproduce that behavior? validations: required: true - type: input id: project-version attributes: label: "'github.com/arduino/pluggable-monitor-protocol-handler' version" description: | Which version of `github.com/arduino/pluggable-monitor-protocol-handler` are you using? _This should be the most recent version available._ validations: required: true - type: textarea id: additional attributes: label: Additional context description: Add any additional information here. validations: required: false - type: checkboxes id: checklist attributes: label: Issue checklist description: Please double-check that you have done each of the following things before submitting the issue. options: - label: I searched for previous requests in [the issue tracker](https://github.com/arduino/pluggable-monitor-protocol-handler/issues?q=) required: true - label: I verified the feature was still missing when using the latest version required: true - label: My request contains all necessary details required: true pluggable-monitor-protocol-handler-0.9.2/.github/dependabot.yml000066400000000000000000000012721424270431400246160ustar00rootroot00000000000000# See: https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#about-the-dependabotyml-file version: 2 updates: # Configure check for outdated GitHub Actions actions in workflows. # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/dependabot/README.md # See: https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot - package-ecosystem: github-actions directory: / # Check the repository's workflows under /.github/workflows/ schedule: interval: daily labels: - "topic: infrastructure" pluggable-monitor-protocol-handler-0.9.2/.github/workflows/000077500000000000000000000000001424270431400240215ustar00rootroot00000000000000pluggable-monitor-protocol-handler-0.9.2/.github/workflows/build-dummy-monitor.yaml000066400000000000000000000010111424270431400306130ustar00rootroot00000000000000name: Build dummy monitor on: push: pull_request: jobs: test: runs-on: ubuntu-20.04 steps: - name: checkout uses: actions/checkout@v3 with: fetch-depth: 0 - name: Install Taskfile uses: arduino/setup-task@v1 with: repo-token: ${{ secrets.GITHUB_TOKEN }} version: 3.x - name: Install Go uses: actions/setup-go@v3 with: go-version: "1.16" - name: Build run: task build-dummy-monitor pluggable-monitor-protocol-handler-0.9.2/.github/workflows/check-general-formatting-task.yml000066400000000000000000000036241424270431400323510ustar00rootroot00000000000000# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-general-formatting-task.md name: Check General Formatting # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows on: push: pull_request: schedule: # Run every Tuesday at 8 AM UTC to catch breakage caused by changes to tools. - cron: "0 8 * * TUE" workflow_dispatch: repository_dispatch: jobs: check: runs-on: ubuntu-latest steps: - name: Set environment variables run: | # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable echo "EC_INSTALL_PATH=${{ runner.temp }}/editorconfig-checker" >> "$GITHUB_ENV" - name: Checkout repository uses: actions/checkout@v3 - name: Install Task uses: arduino/setup-task@v1 with: repo-token: ${{ secrets.GITHUB_TOKEN }} version: 3.x - name: Download latest editorconfig-checker release binary package id: download uses: MrOctopus/download-asset-action@1.0 with: repository: editorconfig-checker/editorconfig-checker excludes: prerelease, draft asset: linux-amd64.tar.gz target: ${{ env.EC_INSTALL_PATH }} - name: Install editorconfig-checker run: | cd "${{ env.EC_INSTALL_PATH }}" tar --extract --file="${{ steps.download.outputs.name }}" # Give the binary a standard name mv "${{ env.EC_INSTALL_PATH }}/bin/ec-linux-amd64" "${{ env.EC_INSTALL_PATH }}/bin/ec" # Add installation to PATH: # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path echo "${{ env.EC_INSTALL_PATH }}/bin" >> "$GITHUB_PATH" - name: Check formatting run: task --silent general:check-formatting pluggable-monitor-protocol-handler-0.9.2/.github/workflows/check-go-dependencies-task.yml000066400000000000000000000100271424270431400316100ustar00rootroot00000000000000# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-go-dependencies-task.md name: Check Go Dependencies env: # See: https://github.com/actions/setup-go/tree/v3#readme GO_VERSION: "1.16" # See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: create: push: paths: - ".github/workflows/check-go-dependencies-task.ya?ml" - ".licenses/**" - ".licensed.json" - ".licensed.ya?ml" - "Taskfile.ya?ml" - "**/.gitmodules" - "**/go.mod" - "**/go.sum" pull_request: paths: - ".github/workflows/check-go-dependencies-task.ya?ml" - ".licenses/**" - ".licensed.json" - ".licensed.ya?ml" - "Taskfile.ya?ml" - "**/.gitmodules" - "**/go.mod" - "**/go.sum" schedule: # Run periodically to catch breakage caused by external changes. - cron: "0 8 * * WED" workflow_dispatch: repository_dispatch: jobs: run-determination: runs-on: ubuntu-latest outputs: result: ${{ steps.determination.outputs.result }} steps: - name: Determine if the rest of the workflow should run id: determination run: | RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x" # The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead. if [[ "${{ github.event_name }}" != "create" || "${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX ]]; then # Run the other jobs. RESULT="true" else # There is no need to run the other jobs. RESULT="false" fi echo "::set-output name=result::$RESULT" check-cache: needs: run-determination if: needs.run-determination.outputs.result == 'true' runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v3 with: submodules: recursive - name: Install licensed uses: jonabc/setup-licensed@v1 with: github_token: ${{ secrets.GITHUB_TOKEN }} version: 3.x - name: Install Go uses: actions/setup-go@v3 with: go-version: ${{ env.GO_VERSION }} - name: Install Task uses: arduino/setup-task@v1 with: repo-token: ${{ secrets.GITHUB_TOKEN }} version: 3.x - name: Update dependencies license metadata cache run: task --silent general:cache-dep-licenses - name: Check for outdated cache id: diff run: | git add . if ! git diff --cached --color --exit-code; then echo echo "::error::Dependency license metadata out of sync. See: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-go-dependencies-task.md#metadata-cache" exit 1 fi # Some might find it convenient to have CI generate the cache rather than setting up for it locally - name: Upload cache to workflow artifact if: failure() && steps.diff.outcome == 'failure' uses: actions/upload-artifact@v3 with: if-no-files-found: error name: dep-licenses-cache path: .licenses/ check-deps: needs: run-determination if: needs.run-determination.outputs.result == 'true' runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v3 with: submodules: recursive - name: Install licensed uses: jonabc/setup-licensed@v1 with: github_token: ${{ secrets.GITHUB_TOKEN }} version: 3.x - name: Install Go uses: actions/setup-go@v3 with: go-version: ${{ env.GO_VERSION }} - name: Install Task uses: arduino/setup-task@v1 with: repo-token: ${{ secrets.GITHUB_TOKEN }} version: 3.x - name: Check for dependencies with unapproved licenses run: task --silent general:check-dep-licenses pluggable-monitor-protocol-handler-0.9.2/.github/workflows/check-go-task.yml000066400000000000000000000063401424270431400271670ustar00rootroot00000000000000# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-go-task.md name: Check Go env: # See: https://github.com/actions/setup-go/tree/v3#readme GO_VERSION: "1.16" # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows on: push: paths: - ".github/workflows/check-go-task.ya?ml" - "Taskfile.ya?ml" - "go.mod" - "go.sum" - "**.go" pull_request: paths: - ".github/workflows/check-go-task.ya?ml" - "Taskfile.ya?ml" - "go.mod" - "go.sum" - "**.go" workflow_dispatch: repository_dispatch: jobs: check-errors: runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v3 - name: Install Go uses: actions/setup-go@v3 with: go-version: ${{ env.GO_VERSION }} - name: Install Task uses: arduino/setup-task@v1 with: repo-token: ${{ secrets.GITHUB_TOKEN }} version: 3.x - name: Check for errors run: task go:vet check-outdated: runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v3 - name: Install Go uses: actions/setup-go@v3 with: go-version: ${{ env.GO_VERSION }} - name: Install Task uses: arduino/setup-task@v1 with: repo-token: ${{ secrets.GITHUB_TOKEN }} version: 3.x - name: Modernize usages of outdated APIs run: task go:fix - name: Check if any fixes were needed run: git diff --color --exit-code check-style: runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v3 - name: Install Go uses: actions/setup-go@v3 with: go-version: ${{ env.GO_VERSION }} - name: Install Task uses: arduino/setup-task@v1 with: repo-token: ${{ secrets.GITHUB_TOKEN }} version: 3.x - name: Install golint run: go install golang.org/x/lint/golint@latest - name: Check style run: task --silent go:lint check-formatting: runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v3 - name: Install Go uses: actions/setup-go@v3 with: go-version: ${{ env.GO_VERSION }} - name: Install Task uses: arduino/setup-task@v1 with: repo-token: ${{ secrets.GITHUB_TOKEN }} version: 3.x - name: Format code run: task go:format - name: Check formatting run: git diff --color --exit-code check-config: name: check-config (${{ matrix.module.path }}) runs-on: ubuntu-latest strategy: fail-fast: false matrix: module: - path: ./ steps: - name: Checkout repository uses: actions/checkout@v3 - name: Install Go uses: actions/setup-go@v3 with: go-version: ${{ env.GO_VERSION }} - name: Run go mod tidy working-directory: ${{ matrix.module.path }} run: go mod tidy - name: Check whether any tidying was needed run: git diff --color --exit-code pluggable-monitor-protocol-handler-0.9.2/.github/workflows/check-taskfiles.yml000066400000000000000000000033601424270431400276060ustar00rootroot00000000000000# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-taskfiles.md name: Check Taskfiles # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows on: push: paths: - ".github/workflows/check-taskfiles.ya?ml" - "**/Taskfile.ya?ml" pull_request: paths: - ".github/workflows/check-taskfiles.ya?ml" - "**/Taskfile.ya?ml" schedule: # Run every Tuesday at 8 AM UTC to catch breakage resulting from changes to the JSON schema. - cron: "0 8 * * TUE" workflow_dispatch: repository_dispatch: jobs: validate: name: Validate ${{ matrix.file }} runs-on: ubuntu-latest strategy: fail-fast: false matrix: file: # TODO: add paths to any additional Taskfiles here - ./**/Taskfile.yml steps: - name: Checkout repository uses: actions/checkout@v3 - name: Download JSON schema for Taskfiles id: download-schema uses: carlosperate/download-file-action@v1 with: # See: https://github.com/SchemaStore/schemastore/blob/master/src/schemas/json/taskfile.json file-url: https://json.schemastore.org/taskfile.json location: ${{ runner.temp }}/taskfile-schema - name: Install JSON schema validator run: | sudo npm install \ --global \ ajv-cli \ ajv-formats - name: Validate ${{ matrix.file }} run: | # See: https://github.com/ajv-validator/ajv-cli#readme ajv validate \ --all-errors \ --strict=false \ -c ajv-formats \ -s "${{ steps.download-schema.outputs.file-path }}" \ -d "${{ matrix.file }}" pluggable-monitor-protocol-handler-0.9.2/.github/workflows/check-workflows-task.yml000066400000000000000000000016311424270431400306150ustar00rootroot00000000000000# Source: https://github.com/arduino/tooling-project-assets/blob/master/workflow-templates/check-workflows-task.md name: Check Workflows # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows on: push: paths: - ".github/workflows/*.ya?ml" - "Taskfile.ya?ml" pull_request: paths: - ".github/workflows/*.ya?ml" - "Taskfile.ya?ml" schedule: # Run every Tuesday at 8 AM UTC to catch breakage resulting from changes to the JSON schema. - cron: "0 8 * * TUE" workflow_dispatch: repository_dispatch: jobs: validate: runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v3 - name: Install Task uses: arduino/setup-task@v1 with: repo-token: ${{ secrets.GITHUB_TOKEN }} version: 3.x - name: Validate workflows run: task --silent ci:validate pluggable-monitor-protocol-handler-0.9.2/.github/workflows/release-tag.yml000066400000000000000000000042171424270431400267410ustar00rootroot00000000000000# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/release-tag.md name: Release on: push: tags: - "v[0-9]+.[0-9]+.[0-9]+*" jobs: release: runs-on: ubuntu-latest env: # See: https://github.com/fsaintjacques/semver-tool/releases SEMVER_TOOL_VERSION: 3.2.0 steps: - name: Set environment variables run: | # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable echo "CHANGELOG_PATH=${{ runner.temp }}/CHANGELOG.md" >> "$GITHUB_ENV" echo "SEMVER_TOOL_PATH=${{ runner.temp }}/semver" >> "$GITHUB_ENV" - name: Checkout repository uses: actions/checkout@v3 with: fetch-depth: 0 - name: Create changelog uses: arduino/create-changelog@v1 with: tag-regex: '^v[0-9]+\.[0-9]+\.[0-9]+.*$' filter-regex: '^\[(skip|changelog)[ ,-](skip|changelog)\].*' case-insensitive-regex: true changelog-file-path: ${{ env.CHANGELOG_PATH }} - name: Download semver tool id: download-semver-tool uses: carlosperate/download-file-action@v1 with: file-url: https://github.com/fsaintjacques/semver-tool/archive/${{ env.SEMVER_TOOL_VERSION }}.zip location: ${{ runner.temp }}/semver-tool - name: Install semver tool run: | unzip \ -p \ "${{ steps.download-semver-tool.outputs.file-path }}" \ semver-tool-${{ env.SEMVER_TOOL_VERSION }}/src/semver > \ "${{ env.SEMVER_TOOL_PATH }}" chmod +x "${{ env.SEMVER_TOOL_PATH }}" - name: Identify Prerelease id: prerelease run: | if [[ "$("${{ env.SEMVER_TOOL_PATH }}" get prerel "${GITHUB_REF/refs\/tags\//}")" ]]; then echo "::set-output name=IS_PRE::true"; fi - name: Create Github release uses: ncipollo/release-action@v1 with: token: ${{ secrets.GITHUB_TOKEN }} bodyFile: ${{ env.CHANGELOG_PATH }} draft: false prerelease: ${{ steps.prerelease.outputs.IS_PRE }} pluggable-monitor-protocol-handler-0.9.2/.github/workflows/spell-check-task.yml000066400000000000000000000017131424270431400277000ustar00rootroot00000000000000# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/spell-check-task.md name: Spell Check # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows on: push: pull_request: schedule: # Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates. - cron: "0 8 * * TUE" workflow_dispatch: repository_dispatch: jobs: spellcheck: runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v3 - name: Install Python uses: actions/setup-python@v3 with: python-version: "3.9" - name: Install Poetry run: pip install poetry - name: Install Task uses: arduino/setup-task@v1 with: repo-token: ${{ secrets.GITHUB_TOKEN }} version: 3.x - name: Spell check run: task general:check-spelling pluggable-monitor-protocol-handler-0.9.2/.github/workflows/sync-labels.yml000066400000000000000000000111341424270431400267600ustar00rootroot00000000000000# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/sync-labels.md name: Sync Labels # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows on: push: paths: - ".github/workflows/sync-labels.ya?ml" - ".github/label-configuration-files/*.ya?ml" pull_request: paths: - ".github/workflows/sync-labels.ya?ml" - ".github/label-configuration-files/*.ya?ml" schedule: # Run daily at 8 AM UTC to sync with changes to shared label configurations. - cron: "0 8 * * *" workflow_dispatch: repository_dispatch: env: CONFIGURATIONS_FOLDER: .github/label-configuration-files CONFIGURATIONS_ARTIFACT: label-configuration-files jobs: check: runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v3 - name: Download JSON schema for labels configuration file id: download-schema uses: carlosperate/download-file-action@v1 with: file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/arduino-tooling-gh-label-configuration-schema.json location: ${{ runner.temp }}/label-configuration-schema - name: Install JSON schema validator run: | sudo npm install \ --global \ ajv-cli \ ajv-formats - name: Validate local labels configuration run: | # See: https://github.com/ajv-validator/ajv-cli#readme ajv validate \ --all-errors \ -c ajv-formats \ -s "${{ steps.download-schema.outputs.file-path }}" \ -d "${{ env.CONFIGURATIONS_FOLDER }}/*.{yml,yaml}" download: needs: check runs-on: ubuntu-latest strategy: matrix: filename: # Filenames of the shared configurations to apply to the repository in addition to the local configuration. # https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/sync-labels - universal.yml - tooling.yml steps: - name: Download uses: carlosperate/download-file-action@v1 with: file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }} - name: Pass configuration files to next job via workflow artifact uses: actions/upload-artifact@v2 with: path: | *.yaml *.yml if-no-files-found: error name: ${{ env.CONFIGURATIONS_ARTIFACT }} sync: needs: download runs-on: ubuntu-latest steps: - name: Set environment variables run: | # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >> "$GITHUB_ENV" - name: Determine whether to dry run id: dry-run if: > github.event_name == 'pull_request' || ( ( github.event_name == 'push' || github.event_name == 'workflow_dispatch' ) && github.ref != format('refs/heads/{0}', github.event.repository.default_branch) ) run: | # Use of this flag in the github-label-sync command will cause it to only check the validity of the # configuration. echo "::set-output name=flag::--dry-run" - name: Checkout repository uses: actions/checkout@v3 - name: Download configuration files artifact uses: actions/download-artifact@v3 with: name: ${{ env.CONFIGURATIONS_ARTIFACT }} path: ${{ env.CONFIGURATIONS_FOLDER }} - name: Remove unneeded artifact uses: geekyeggo/delete-artifact@v1 with: name: ${{ env.CONFIGURATIONS_ARTIFACT }} - name: Merge label configuration files run: | # Merge all configuration files shopt -s extglob cat "${{ env.CONFIGURATIONS_FOLDER }}"/*.@(yml|yaml) > "${{ env.MERGED_CONFIGURATION_PATH }}" - name: Install github-label-sync run: sudo npm install --global github-label-sync - name: Sync labels env: GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | # See: https://github.com/Financial-Times/github-label-sync github-label-sync \ --labels "${{ env.MERGED_CONFIGURATION_PATH }}" \ ${{ steps.dry-run.outputs.flag }} \ ${{ github.repository }} pluggable-monitor-protocol-handler-0.9.2/.gitignore000066400000000000000000000000071424270431400224110ustar00rootroot00000000000000dist/ pluggable-monitor-protocol-handler-0.9.2/.licensed.yml000066400000000000000000000044701424270431400230200ustar00rootroot00000000000000# See: https://github.com/github/licensed/blob/master/docs/configuration.md sources: go: true apps: - source_path: ./ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-dependencies/GPL-3.0/.licensed.yml allowed: # The following are based on: https://www.gnu.org/licenses/license-list.html#GPLCompatibleLicenses - gpl-1.0-or-later - gpl-1.0+ # Deprecated ID for `gpl-1.0-or-later` - gpl-2.0-or-later - gpl-2.0+ # Deprecated ID for `gpl-2.0-or-later` - gpl-3.0-only - gpl-3.0 # Deprecated ID for `gpl-3.0-only` - gpl-3.0-or-later - gpl-3.0+ # Deprecated ID for `gpl-3.0-or-later` - lgpl-2.0-or-later - lgpl-2.0+ # Deprecated ID for `lgpl-2.0-or-later` - lgpl-2.1-only - lgpl-2.1 # Deprecated ID for `lgpl-2.1-only` - lgpl-2.1-or-later - lgpl-2.1+ # Deprecated ID for `lgpl-2.1-or-later` - lgpl-3.0-only - lgpl-3.0 # Deprecated ID for `lgpl-3.0-only` - lgpl-3.0-or-later - lgpl-3.0+ # Deprecated ID for `lgpl-3.0-or-later` - fsfap - apache-2.0 - artistic-2.0 - clartistic - sleepycat - bsl-1.0 - bsd-3-clause - cecill-2.0 - bsd-3-clause-clear # "Cryptix General License" - no SPDX ID (https://github.com/spdx/license-list-XML/issues/456) - ecos-2.0 - ecl-2.0 - efl-2.0 - eudatagrid - mit - bsd-2-clause # Subsumed by `bsd-2-clause-views` - bsd-2-clause-netbsd # Deprecated ID for `bsd-2-clause` - bsd-2-clause-views # This is the version linked from https://www.gnu.org/licenses/license-list.html#FreeBSD - bsd-2-clause-freebsd # Deprecated ID for `bsd-2-clause-views` - ftl - hpnd - imatix - imlib2 - ijg # "Informal license" - this is a general class of license - intel - isc - mpl-2.0 - ncsa # "License of Netscape JavaScript" - no SPDX ID - oldap-2.7 # "License of Perl 5 and below" - possibly `Artistic-1.0-Perl` ? - cc0-1.0 - cc-pddc - psf-2.0 - ruby - sgi-b-2.0 - smlnj - standardml-nj # Deprecated ID for `smlnj` - unicode-dfs-2015 - upl-1.0 - unlicense - vim - w3c - wtfpl - lgpl-2.0-or-later with wxwindows-exception-3.1 - wxwindows # Deprecated ID for `lgpl-2.0-or-later with wxwindows-exception-3.1` - x11 - xfree86-1.1 - zlib - zpl-2.0 - zpl-2.1 # The following are based on individual license text - eupl-1.2 - liliq-r-1.1 - liliq-rplus-1.1 pluggable-monitor-protocol-handler-0.9.2/.licenses/000077500000000000000000000000001424270431400223075ustar00rootroot00000000000000pluggable-monitor-protocol-handler-0.9.2/.licenses/pluggable-monitor-protocol-handler/000077500000000000000000000000001424270431400312105ustar00rootroot00000000000000pluggable-monitor-protocol-handler-0.9.2/.licenses/pluggable-monitor-protocol-handler/go/000077500000000000000000000000001424270431400316155ustar00rootroot00000000000000pluggable-monitor-protocol-handler-0.9.2/.licenses/pluggable-monitor-protocol-handler/go/github.com/000077500000000000000000000000001424270431400336545ustar00rootroot00000000000000hashicorp/000077500000000000000000000000001424270431400355555ustar00rootroot00000000000000pluggable-monitor-protocol-handler-0.9.2/.licenses/pluggable-monitor-protocol-handler/go/github.comerrwrap.dep.yml000066400000000000000000000415671424270431400405460ustar00rootroot00000000000000pluggable-monitor-protocol-handler-0.9.2/.licenses/pluggable-monitor-protocol-handler/go/github.com/hashicorp--- name: github.com/hashicorp/errwrap version: v1.0.0 type: go summary: Package errwrap implements methods to formalize error wrapping in Go. homepage: https://pkg.go.dev/github.com/hashicorp/errwrap license: mpl-2.0 licenses: - sources: LICENSE text: |+ Mozilla Public License, version 2.0 1. Definitions 1.1. “Contributor” means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software. 1.2. “Contributor Version” means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor’s Contribution. 1.3. “Contribution” means Covered Software of a particular Contributor. 1.4. “Covered Software” means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof. 1.5. “Incompatible With Secondary Licenses” means a. that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or b. that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License. 1.6. “Executable Form” means any form of the work other than Source Code Form. 1.7. “Larger Work” means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software. 1.8. “License” means this document. 1.9. “Licensable” means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License. 1.10. “Modifications” means any of the following: a. any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or b. any new file in Source Code Form that contains any Covered Software. 1.11. “Patent Claims” of a Contributor means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version. 1.12. “Secondary License” means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses. 1.13. “Source Code Form” means the form of the work preferred for making modifications. 1.14. “You” (or “Your”) means an individual or a legal entity exercising rights under this License. For legal entities, “You” includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, “control” means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity. 2. License Grants and Conditions 2.1. Grants Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license: a. under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and b. under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version. 2.2. Effective Date The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution. 2.3. Limitations on Grant Scope The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor: a. for any code that a Contributor has removed from Covered Software; or b. for infringements caused by: (i) Your and any other third party’s modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or c. under Patent Claims infringed by Covered Software in the absence of its Contributions. This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4). 2.4. Subsequent Licenses No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3). 2.5. Representation Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License. 2.6. Fair Use This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents. 2.7. Conditions Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1. 3. Responsibilities 3.1. Distribution of Source Form All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients’ rights in the Source Code Form. 3.2. Distribution of Executable Form If You distribute Covered Software in Executable Form then: a. such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and b. You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients’ rights in the Source Code Form under this License. 3.3. Distribution of a Larger Work You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s). 3.4. Notices You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies. 3.5. Application of Additional Terms You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction. 4. Inability to Comply Due to Statute or Regulation If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it. 5. Termination 5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice. 5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate. 5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination. 6. Disclaimer of Warranty Covered Software is provided under this License on an “as is” basis, without warranty of any kind, either expressed, implied, or statutory, including, without limitation, warranties that the Covered Software is free of defects, merchantable, fit for a particular purpose or non-infringing. The entire risk as to the quality and performance of the Covered Software is with You. Should any Covered Software prove defective in any respect, You (not any Contributor) assume the cost of any necessary servicing, repair, or correction. This disclaimer of warranty constitutes an essential part of this License. No use of any Covered Software is authorized under this License except under this disclaimer. 7. Limitation of Liability Under no circumstances and under no legal theory, whether tort (including negligence), contract, or otherwise, shall any Contributor, or anyone who distributes Covered Software as permitted above, be liable to You for any direct, indirect, special, incidental, or consequential damages of any character including, without limitation, damages for lost profits, loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if such party shall have been informed of the possibility of such damages. This limitation of liability shall not apply to liability for death or personal injury resulting from such party’s negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You. 8. Litigation Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party’s ability to bring cross-claims or counter-claims. 9. Miscellaneous This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor. 10. Versions of the License 10.1. New Versions Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number. 10.2. Effect of New Versions You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward. 10.3. Modified Versions If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License). 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached. Exhibit A - Source Code Form License Notice This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice. You may add additional accurate notices of copyright ownership. Exhibit B - “Incompatible With Secondary Licenses” Notice This Source Code Form is “Incompatible With Secondary Licenses”, as defined by the Mozilla Public License, v. 2.0. notices: [] go-multierror.dep.yml000066400000000000000000000414741424270431400416700ustar00rootroot00000000000000pluggable-monitor-protocol-handler-0.9.2/.licenses/pluggable-monitor-protocol-handler/go/github.com/hashicorp--- name: github.com/hashicorp/go-multierror version: v1.1.1 type: go summary: homepage: https://pkg.go.dev/github.com/hashicorp/go-multierror license: mpl-2.0 licenses: - sources: LICENSE text: | Mozilla Public License, version 2.0 1. Definitions 1.1. “Contributor” means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software. 1.2. “Contributor Version” means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor’s Contribution. 1.3. “Contribution” means Covered Software of a particular Contributor. 1.4. “Covered Software” means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof. 1.5. “Incompatible With Secondary Licenses” means a. that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or b. that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License. 1.6. “Executable Form” means any form of the work other than Source Code Form. 1.7. “Larger Work” means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software. 1.8. “License” means this document. 1.9. “Licensable” means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License. 1.10. “Modifications” means any of the following: a. any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or b. any new file in Source Code Form that contains any Covered Software. 1.11. “Patent Claims” of a Contributor means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version. 1.12. “Secondary License” means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses. 1.13. “Source Code Form” means the form of the work preferred for making modifications. 1.14. “You” (or “Your”) means an individual or a legal entity exercising rights under this License. For legal entities, “You” includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, “control” means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity. 2. License Grants and Conditions 2.1. Grants Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license: a. under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and b. under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version. 2.2. Effective Date The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution. 2.3. Limitations on Grant Scope The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor: a. for any code that a Contributor has removed from Covered Software; or b. for infringements caused by: (i) Your and any other third party’s modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or c. under Patent Claims infringed by Covered Software in the absence of its Contributions. This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4). 2.4. Subsequent Licenses No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3). 2.5. Representation Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License. 2.6. Fair Use This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents. 2.7. Conditions Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1. 3. Responsibilities 3.1. Distribution of Source Form All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients’ rights in the Source Code Form. 3.2. Distribution of Executable Form If You distribute Covered Software in Executable Form then: a. such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and b. You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients’ rights in the Source Code Form under this License. 3.3. Distribution of a Larger Work You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s). 3.4. Notices You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies. 3.5. Application of Additional Terms You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction. 4. Inability to Comply Due to Statute or Regulation If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it. 5. Termination 5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice. 5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate. 5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination. 6. Disclaimer of Warranty Covered Software is provided under this License on an “as is” basis, without warranty of any kind, either expressed, implied, or statutory, including, without limitation, warranties that the Covered Software is free of defects, merchantable, fit for a particular purpose or non-infringing. The entire risk as to the quality and performance of the Covered Software is with You. Should any Covered Software prove defective in any respect, You (not any Contributor) assume the cost of any necessary servicing, repair, or correction. This disclaimer of warranty constitutes an essential part of this License. No use of any Covered Software is authorized under this License except under this disclaimer. 7. Limitation of Liability Under no circumstances and under no legal theory, whether tort (including negligence), contract, or otherwise, shall any Contributor, or anyone who distributes Covered Software as permitted above, be liable to You for any direct, indirect, special, incidental, or consequential damages of any character including, without limitation, damages for lost profits, loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if such party shall have been informed of the possibility of such damages. This limitation of liability shall not apply to liability for death or personal injury resulting from such party’s negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You. 8. Litigation Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party’s ability to bring cross-claims or counter-claims. 9. Miscellaneous This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor. 10. Versions of the License 10.1. New Versions Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number. 10.2. Effect of New Versions You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward. 10.3. Modified Versions If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License). 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached. Exhibit A - Source Code Form License Notice This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice. You may add additional accurate notices of copyright ownership. Exhibit B - “Incompatible With Secondary Licenses” Notice This Source Code Form is “Incompatible With Secondary Licenses”, as defined by the Mozilla Public License, v. 2.0. notices: [] pluggable-monitor-protocol-handler-0.9.2/LICENSE.txt000066400000000000000000001060011424270431400222450ustar00rootroot00000000000000This file includes licensing information for serial-monitor Copyright (c) 2018 ARDUINO SA (www.arduino.cc) The software is released under the GNU General Public License, which covers the main body of the serial-monitor code. The terms of this license can be found at: https://www.gnu.org/licenses/gpl-3.0.en.html You can be released from the requirements of the above licenses by purchasing a commercial license. Buying such a license is mandatory if you want to modify or otherwise use the software for commercial activities involving the Arduino software without disclosing the source code of your own applications. To purchase a commercial license, send an email to license@arduino.cc 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 . pluggable-monitor-protocol-handler-0.9.2/README.md000066400000000000000000000024661424270431400217130ustar00rootroot00000000000000# Pluggable Monitor Protocol Handler [![Go Reference](https://pkg.go.dev/badge/github.com/arduino/pluggable-monitor-protocol-handler.svg)](https://pkg.go.dev/github.com/arduino/pluggable-monitor-protocol-handler/) This project is a library to ease implementation of pluggable discoveries for the [Arduino CLI](https://github.com/arduino/arduino-cli) following the [official specification](https://arduino.github.io/arduino-cli/latest/platform-specification/#pluggable-monitor). ## Reference implementation The [`dummy-monitor` folder](dummy-monitor) contains a reference pluggable monitor implementation. ## Security If you think you found a vulnerability or other security-related bug in this project, please read our [security policy](https://github.com/arduino/serial-monitor/security/policy) and report the bug to our Security Team 🛡️ Thank you! e-mail contact: security@arduino.cc ## License Copyright (c) 2021 ARDUINO SA (www.arduino.cc) The software is released under the GNU General Public License, which covers the main body of the serial-monitor code. The terms of this license can be found at: https://www.gnu.org/licenses/gpl-3.0.en.html See [LICENSE.txt](https://github.com/arduino/serial-monitor/blob/master/LICENSE.txt) for details. pluggable-monitor-protocol-handler-0.9.2/Taskfile.yml000077500000000000000000000132651424270431400227230ustar00rootroot00000000000000version: "3" vars: DIST_DIR: "dist" DUMMY_MONITOR_VERSION: sh: echo "$(git describe --tags --dirty --broken)" DUMMY_MONITOR_TIMESTAMP: sh: echo "$(date -u +"%Y-%m-%dT%H:%M:%SZ")" DUMMY_MONITOR_LDFLAGS: > -X github.com/arduino/pluggable-monitor-protocol-handler/dummy-monitor/args.Tag={{.DUMMY_MONITOR_VERSION}} -X github.com/arduino/pluggable-monitor-protocol-handler/dummy-monitor/args.Timestamp={{.DUMMY_MONITOR_TIMESTAMP}} DEFAULT_GO_PACKAGES: sh: echo $(go list ./... | tr '\n' ' ') tasks: build-dummy-monitor: desc: Build the dummy-monitor client example vars: EXECUTABLE: dummy-monitor{{if eq OS "windows"}}.exe{{end}} cmds: - go build -o dist/{{.EXECUTABLE}} -v -ldflags '{{.DUMMY_MONITOR_LDFLAGS}}' ./dummy-monitor # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-workflows-task/Taskfile.yml ci:validate: desc: Validate GitHub Actions workflows against their JSON schema vars: # Source: https://github.com/SchemaStore/schemastore/blob/master/src/schemas/json/github-workflow.json WORKFLOW_SCHEMA_URL: https://json.schemastore.org/github-workflow WORKFLOW_SCHEMA_PATH: sh: mktemp -t workflow-schema-XXXXXXXXXX.json WORKFLOWS_DATA_PATH: "./.github/workflows/*.{yml,yaml}" cmds: - | wget \ --quiet \ --output-document="{{.WORKFLOW_SCHEMA_PATH}}" \ {{.WORKFLOW_SCHEMA_URL}} - | npx \ --package=ajv-cli \ --package=ajv-formats \ ajv validate \ --all-errors \ --strict=false \ -c ajv-formats \ -s "{{.WORKFLOW_SCHEMA_PATH}}" \ -d "{{.WORKFLOWS_DATA_PATH}}" # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-dependencies-task/Taskfile.yml general:cache-dep-licenses: desc: Cache dependency license metadata cmds: - | if ! which licensed &>/dev/null; then if [[ "{{OS}}" == "windows" ]]; then echo "Licensed does not have Windows support." echo "Please use Linux/macOS or download the dependencies cache from the GitHub Actions workflow artifact." else echo "licensed not found or not in PATH. Please install: https://github.com/github/licensed#as-an-executable" fi exit 1 fi - licensed cache # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-dependencies-task/Taskfile.yml general:check-dep-licenses: desc: Check for unapproved dependency licenses deps: - task: general:cache-dep-licenses cmds: - licensed status # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-general-formatting-task/Taskfile.yml general:check-formatting: desc: Check basic formatting style of all files cmds: - | if ! which ec &>/dev/null; then echo "ec not found or not in PATH. Please install: https://github.com/editorconfig-checker/editorconfig-checker#installation" exit 1 fi - ec # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check-task/Taskfile.yml general:check-spelling: desc: Check for commonly misspelled words deps: - task: poetry:install-deps cmds: - poetry run codespell # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check-task/Taskfile.yml general:correct-spelling: desc: Correct commonly misspelled words where possible deps: - task: poetry:install-deps cmds: - poetry run codespell --write-changes # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/poetry-task/Taskfile.yml poetry:install-deps: desc: Install dependencies managed by Poetry cmds: - poetry install --no-root # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/poetry-task/Taskfile.yml poetry:update-deps: desc: Update all dependencies managed by Poetry to their newest versions cmds: - poetry update # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml go:check: desc: Check for problems with Go code deps: - task: go:vet - task: go:lint # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml go:vet: desc: Check for errors in Go code cmds: - go vet {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}} # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml go:fix: desc: Modernize usages of outdated APIs cmds: - go fix {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}} # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml go:lint: desc: Lint Go code cmds: - | if ! which golint &>/dev/null; then echo "golint not installed or not in PATH. Please install: https://github.com/golang/lint#installation" exit 1 fi - | golint \ {{default "-min_confidence 0.8 -set_exit_status" .GO_LINT_FLAGS}} \ {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}} # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml go:format: desc: Format Go code cmds: - go fmt {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}} pluggable-monitor-protocol-handler-0.9.2/dummy-monitor/000077500000000000000000000000001424270431400232445ustar00rootroot00000000000000pluggable-monitor-protocol-handler-0.9.2/dummy-monitor/README.md000066400000000000000000000202451424270431400245260ustar00rootroot00000000000000# Arduino pluggable monitor reference implementation The `dummy-monitor` tool is a command line program that interacts via stdio. It accepts commands as plain ASCII strings terminated with LF `\n` and sends response as JSON. The "communication ports" returned by the tool are fake, this monitor is intenteded only for educational and testing purposes. ## How to build Install a recent go environment and run `go build`. The executable `dummy-monitor` will be produced in your working directory. ## Usage After startup, the tool will just stay idle waiting for commands. The available commands are: HELLO, DESCRIBE, CONFIGURE, OPEN, CLOSE and QUIT. #### HELLO command The `HELLO` command is used to establish the pluggable monitor protocol between client and monitor. The format of the command is: `HELLO ""` for example: `HELLO 1 "Arduino IDE"` or: `HELLO 1 "arduino-cli"` in this case the protocol version requested by the client is `1` (at the moment of writing there were no other revisions of the protocol). The response to the command is: ```json { "eventType": "hello", "protocolVersion": 1, "message": "OK" } ``` `protocolVersion` is the protocol version that the monitor is going to use in the remainder of the communication. #### DESCRIBE command The `DESCRIBE` command returns a description of the communication port. The description will have metadata about the port configuration, and which parameters are available: ```json { "event": "describe", "message": "ok", "port_description": { "protocol": "serial", "configuration_parameters": { "baudrate": { "label": "Baudrate", "type": "enum", "values": [ "300", "600", "750", "1200", "2400", "4800", "9600", "19200", "38400", "57600", "115200", "230400", "460800", "500000", "921600", "1000000", "2000000" ], "selected": "9600" }, "parity": { "label": "Parity", "type": "enum", "values": [ "N", "E", "O", "M", "S" ], "selected": "N" }, "bits": { "label": "Data bits", "type": "enum", "values": [ "5", "6", "7", "8", "9" ], "selected": "8" }, "stop_bits": { "label": "Stop bits", "type": "enum", "values": [ "1", "1.5", "2" ], "selected": "1" } } } } ``` Each parameter has a unique name (`baudrate`, `parity`, etc...), a `type` (in this case only enum but more types will be added in the future), and the `selected` value for each parameter. The parameter name can not contain spaces, and the allowed characters in the name are alphanumerics, underscore `_`, dot `.`, and dash `-`. The `enum` types must have a list of possible `values`. The client/IDE may expose these configuration values to the user via a config file or a GUI, in this case the `label` field may be used for a user readable description of the parameter. #### CONFIGURE command The `CONFIGURE` command sets configuration parameters for the communication port. The parameters can be changed one at a time and the syntax is: `CONFIGURE ` The response to the command is: ```JSON { "event": "configure", "message": "ok", } ``` or if there is an error: ```JSON { "event": "configure", "error": true, "message": "invalid value for parameter baudrate: 123456" } ``` The currently selected parameters may be obtained using the `DESCRIBE` command. #### OPEN command The `OPEN` command opens a communication with the board, the data exchanged with the board will be transferred to the Client/IDE via TCP/IP. The Client/IDE must first TCP-Listen to a randomly selected port and send it to the monitor tool as part of the OPEN command. The syntax of the OPEN command is: `OPEN ` For example, let's suppose that the Client/IDE wants to communicate with the serial port `/dev/ttyACM0` then the sequence of actions to perform will be the following: 1. the Client/IDE must first listen to a random TCP port (let's suppose it chose `32123`) 1. the Client/IDE sends the command `OPEN 127.0.0.1:32123 /dev/ttyACM0` to the monitor tool 1. the monitor tool opens `/dev/ttyACM0` 1. the monitor tool connects via TCP/IP to `127.0.0.1:32123` and start streaming data back and forth The answer to the `OPEN` command is: ```JSON { "event": "open", "message": "ok" } ``` If the monitor tool cannot communicate with the board, or if the tool can not connect back to the TCP port, or if any other error condition happens: ```JSON { "event": "open", "error": true, "message": "unknown port /dev/ttyACM23" } ``` The board port will be opened using the parameters previously set through the `CONFIGURE` command. Once the port is opened, it may be unexpectedly closed at any time due to hardware failure, or because the Client/IDE closes the TCP/IP connection. In this case an asynchronous `port_closed` message must be generated from the monitor tool: ```JSON { "event": "port_closed", "message": "serial port disappeared!" } ``` or ```JSON { "event": "port_closed", "message": "lost TCP/IP connection with the client!" } ``` #### CLOSE command The `CLOSE` command will close the currently opened port and close the TCP/IP connection used to communicate with the Client/IDE. The answer to the command is: ```JSON { "event": "close", "message": "ok" } ``` or in case of error ```JSON { "event": "close", "error": true, "message": "port already closed" } ``` #### QUIT command The `QUIT` command terminates the monitor. The response to `QUIT` is: ```JSON { "eventType": "quit", "message": "OK" } ``` after this output the monitor exits. This command is supposed to always succeed. #### Invalid commands If the client sends an invalid or malformed command, the monitor should answer with: ```JSON { "eventType": "command_error", "error": true, "message": "Unknown command XXXX" } ``` fis ### Example of usage A possible transcript of the monitor usage: ``` HELLO 1 "test" { "eventType": "hello", "message": "OK", "protocolVersion": 1 } DESCRIBE { "eventType": "describe", "message": "OK", "port_description": { "protocol": "test", "configuration_parameters": { "echo": { "label": "echo", "type": "enum", "value": [ "on", "off" ], "selected": "on" }, "speed": { "label": "Baudrate", "type": "enum", "value": [ "9600", "19200", "38400", "57600", "115200" ], "selected": "9600" } } } } CONFIGURE speed 19200 { "eventType": "configure", "message": "OK" } DESCRIBE { "eventType": "describe", "message": "OK", "port_description": { "protocol": "test", "configuration_parameters": { "echo": { "label": "echo", "type": "enum", "value": [ "on", "off" ], "selected": "on" }, "speed": { "label": "Baudrate", "type": "enum", "value": [ "9600", "19200", "38400", "57600", "115200" ], "selected": "19200" } } } } OPEN 127.0.0.1:5678 "test" { "eventType": "open", "message": "OK" } CLOSE { "eventType": "close", "message": "OK" } QUIT $ ``` On another terminal tab to test it you can run `nc -l -p 5678` before running the `OPEN 127.0.0.1:5678 "test"` command. After that you can write messages in that terminal tab and see them being echoed. ## Security If you think you found a vulnerability or other security-related bug in this project, please read our [security policy](https://github.com/arduino/pluggable-monitor-protocol-handler/security/policy) and report the bug to our Security Team 🛡️ Thank you! e-mail contact: security@arduino.cc ## License Copyright (c) 2021 ARDUINO SA (www.arduino.cc) The software is released under the GNU General Public License, which covers the main body of the serial-monitor code. The terms of this license can be found at: https://www.gnu.org/licenses/gpl-3.0.en.html See [LICENSE.txt](https://github.com/arduino/pluggable-monitor-protocol-handler/blob/master/LICENSE.txt) for details. pluggable-monitor-protocol-handler-0.9.2/dummy-monitor/args/000077500000000000000000000000001424270431400242005ustar00rootroot00000000000000pluggable-monitor-protocol-handler-0.9.2/dummy-monitor/args/args.go000066400000000000000000000022611424270431400254640ustar00rootroot00000000000000// // This file is part of dummy-monitor. // // Copyright 2021 ARDUINO SA (http://www.arduino.cc/) // // This software is released under the GNU General Public License version 3, // which covers the main part of arduino-cli. // The terms of this license can be found at: // https://www.gnu.org/licenses/gpl-3.0.en.html // // You can be released from the requirements of the above licenses by purchasing // a commercial license. Buying such a license is mandatory if you want to modify or // otherwise use the software for commercial activities involving the Arduino // software without disclosing the source code of your own applications. To purchase // a commercial license, send an email to license@arduino.cc. // package args import ( "fmt" "os" ) // Tag is the current git tag var Tag = "snapshot" // Timestamp is the current timestamp var Timestamp = "unknown" // Parse arguments passed by the user func Parse() { for _, arg := range os.Args[1:] { if arg == "" { continue } if arg == "-v" || arg == "--version" { fmt.Printf("dummy-monitor %s (build timestamp: %s)\n", Tag, Timestamp) os.Exit(0) } fmt.Fprintf(os.Stderr, "invalid argument: %s\n", arg) os.Exit(1) } } pluggable-monitor-protocol-handler-0.9.2/dummy-monitor/dummy_port.go000066400000000000000000000011261424270431400257720ustar00rootroot00000000000000package main import ( "io" ) type dummyPort struct { echo chan string portName string } func newDummyPort(portName string) *dummyPort { return &dummyPort{ echo: make(chan string, 20), portName: portName, } } func (d *dummyPort) Close() error { close(d.echo) return nil } func (d *dummyPort) Read(p []byte) (int, error) { data, ok := <-d.echo if !ok { return 0, io.EOF } n := copy(p, []byte(data)) // if p is too small data loss may happen.. ¯\_(ツ)_/¯ return n, nil } func (d *dummyPort) Write(p []byte) (int, error) { d.echo <- string(p) return len(p), nil } pluggable-monitor-protocol-handler-0.9.2/dummy-monitor/main.go000066400000000000000000000061251424270431400245230ustar00rootroot00000000000000// // This file is part of dummy-monitor. // // Copyright 2021 ARDUINO SA (http://www.arduino.cc/) // // This software is released under the GNU General Public License version 3, // which covers the main part of arduino-cli. // The terms of this license can be found at: // https://www.gnu.org/licenses/gpl-3.0.en.html // // You can be released from the requirements of the above licenses by purchasing // a commercial license. Buying such a license is mandatory if you want to modify or // otherwise use the software for commercial activities involving the Arduino // software without disclosing the source code of your own applications. To purchase // a commercial license, send an email to license@arduino.cc. // package main import ( "errors" "fmt" "io" "os" monitor "github.com/arduino/pluggable-monitor-protocol-handler" "github.com/arduino/pluggable-monitor-protocol-handler/dummy-monitor/args" ) // dummyMonitor is an example implementation of a Monitor. // It simulates a real implementation of a Monitor by generating // connected ports deterministically, it can also be used for testing // purposes. type dummyMonitor struct { startSyncCount int closeChan chan<- bool } var settings = &monitor.PortDescriptor{ Protocol: "test", ConfigurationParameter: map[string]*monitor.PortParameterDescriptor{ "speed": { Label: "Baudrate", Type: "enum", Values: []string{"9600", "19200", "38400", "57600", "115200"}, Selected: "9600", }, "echo": { Label: "echo", Type: "enum", Values: []string{"on", "off"}, Selected: "on", }, }, } var openedPort *dummyPort func main() { args.Parse() dummy := &dummyMonitor{} server := monitor.NewServer(dummy) if err := server.Run(os.Stdin, os.Stdout); err != nil { os.Exit(1) } } // Hello does nothing. // In a real implementation it could setup background processes // or other kind of resources necessary to discover Ports. func (d *dummyMonitor) Hello(userAgent string, protocol int) error { return nil } func (d *dummyMonitor) Describe() (*monitor.PortDescriptor, error) { return settings, nil } func (d *dummyMonitor) Configure(parameterName string, value string) error { if settings.ConfigurationParameter[parameterName] == nil { return fmt.Errorf("could not find parameter named %s", parameterName) } values := settings.ConfigurationParameter[parameterName].Values for _, i := range values { if i == value { settings.ConfigurationParameter[parameterName].Selected = value return nil } } return fmt.Errorf("invalid value for parameter %s: %s", parameterName, value) } func (d *dummyMonitor) Open(boardPort string) (io.ReadWriter, error) { if openedPort != nil { return nil, fmt.Errorf("port already opened: %s", openedPort.portName) } openedPort = newDummyPort(boardPort) return openedPort, nil } func (d *dummyMonitor) Close() error { if openedPort == nil { return errors.New("port already closed") } openedPort.Close() openedPort = nil return nil } // Quit does nothing. // In a real implementation it can be used to tear down resources // used to monitor Ports. func (d *dummyMonitor) Quit() {} pluggable-monitor-protocol-handler-0.9.2/go.mod000066400000000000000000000001711424270431400215310ustar00rootroot00000000000000module github.com/arduino/pluggable-monitor-protocol-handler go 1.16 require github.com/hashicorp/go-multierror v1.1.1 pluggable-monitor-protocol-handler-0.9.2/go.sum000066400000000000000000000005521424270431400215610ustar00rootroot00000000000000github.com/hashicorp/errwrap v1.0.0 h1:hLrqtEDnRye3+sgx6z4qVLNuviH3MR5aQ0ykNJa/UYA= github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo= github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM= pluggable-monitor-protocol-handler-0.9.2/message.go000066400000000000000000000035601424270431400224030ustar00rootroot00000000000000// // This file is part of pluggable-monitor-protocol-handler. // // Copyright 2021 ARDUINO SA (http://www.arduino.cc/) // // This software is released under the GNU General Public License version 3, // which covers the main part of arduino-cli. // The terms of this license can be found at: // https://www.gnu.org/licenses/gpl-3.0.en.html // // You can be released from the requirements of the above licenses by purchasing // a commercial license. Buying such a license is mandatory if you want to modify or // otherwise use the software for commercial activities involving the Arduino // software without disclosing the source code of your own applications. To purchase // a commercial license, send an email to license@arduino.cc. // package monitor type message struct { EventType string `json:"eventType"` Message string `json:"message,omitempty"` Error bool `json:"error,omitempty"` ProtocolVersion int `json:"protocolVersion,omitempty"` PortDescription *PortDescriptor `json:"port_description,omitempty"` } // PortDescriptor is a struct to describe the characteristic of a port type PortDescriptor struct { Protocol string `json:"protocol,omitempty"` ConfigurationParameter map[string]*PortParameterDescriptor `json:"configuration_parameters,omitempty"` } // PortParameterDescriptor contains characteristics for every parameter type PortParameterDescriptor struct { Label string `json:"label,omitempty"` Type string `json:"type,omitempty"` Values []string `json:"value,omitempty"` Selected string `json:"selected,omitempty"` } func messageOk(event string) *message { return &message{ EventType: event, Message: "OK", } } func messageError(event, msg string) *message { return &message{ EventType: event, Error: true, Message: msg, } } pluggable-monitor-protocol-handler-0.9.2/monitor.go000066400000000000000000000203111424270431400224370ustar00rootroot00000000000000// // This file is part of pluggable-monitor-protocol-handler. // // Copyright 2021 ARDUINO SA (http://www.arduino.cc/) // // This software is released under the GNU General Public License version 3, // which covers the main part of arduino-cli. // The terms of this license can be found at: // https://www.gnu.org/licenses/gpl-3.0.en.html // // You can be released from the requirements of the above licenses by purchasing // a commercial license. Buying such a license is mandatory if you want to modify or // otherwise use the software for commercial activities involving the Arduino // software without disclosing the source code of your own applications. To purchase // a commercial license, send an email to license@arduino.cc. // // Package monitor is a library for handling the Arduino Pluggable-Monitor protocol // (https://github.com/arduino/tooling-rfcs/blob/main/RFCs/0004-pluggable-monitor.md#pluggable-monitor-api-via-stdinstdout) // // The library implements the state machine and the parsing logic to communicate with a pluggable-monitor client. // All the commands issued by the client are conveniently translated into function calls, in particular // the Monitor interface are the only functions that must be implemented to get a fully working pluggable monitor // using this library. // // A usage example is provided in the dummy-monitor package. package monitor import ( "bufio" "encoding/json" "fmt" "io" "net" "regexp" "strconv" "strings" "sync" "github.com/hashicorp/go-multierror" ) // Monitor is an interface that represents the business logic that // a pluggable monitor must implement. The communication protocol // is completely hidden and it's handled by a MonitorServer. type Monitor interface { // Hello is called once at startup to provide the userAgent string // and the protocolVersion negotiated with the client. Hello(userAgent string, protocolVersion int) error // Describe is called to obtain the description of the communication port Describe() (*PortDescriptor, error) // Configure allows to set the configuration parameters for the communication port Configure(parameterName string, value string) error // Open allows to open a communication with the board using TCP/IP Open(boardPort string) (io.ReadWriter, error) // Close will close the currently open port and TCP/IP connection Close() error // Quit is called just before the server terminates. This function can be // used by the monitor as a last chance to gracefully close resources. Quit() } // A Server is a pluggable monitor protocol handler, // it must be created using the NewServer function. type Server struct { impl Monitor out io.Writer outMutex sync.Mutex userAgent string reqProtocolVersion int initialized bool clientConn net.Conn closeFuncMutex sync.Mutex } // NewServer creates a new monitor server backed by the // provided pluggable monitor implementation. To start the server // use the Run method. func NewServer(impl Monitor) *Server { return &Server{ impl: impl, } } // Run starts the protocol handling loop on the given input and // output stream, usually `os.Stdin` and `os.Stdout` are used. // The function blocks until the `QUIT` command is received or // the input stream is closed. In case of IO error the error is // returned. func (d *Server) Run(in io.Reader, out io.Writer) error { d.out = out reader := bufio.NewReader(in) for { fullCmd, err := reader.ReadString('\n') if err != nil { d.outputMessage(messageError("command_error", err.Error())) return err } fullCmd = strings.TrimSpace(fullCmd) split := strings.Split(fullCmd, " ") cmd := strings.ToUpper(split[0]) if !d.initialized && cmd != "HELLO" && cmd != "QUIT" { d.outputMessage(messageError("command_error", fmt.Sprintf("First command must be HELLO, but got '%s'", cmd))) continue } switch cmd { case "HELLO": d.hello(fullCmd[6:]) case "DESCRIBE": d.describe() case "CONFIGURE": d.configure(fullCmd[10:]) case "OPEN": d.open(fullCmd[5:]) case "CLOSE": d.close("") case "QUIT": d.impl.Quit() d.outputMessage(messageOk("quit")) return nil default: d.outputMessage(messageError("command_error", fmt.Sprintf("Command %s not supported", cmd))) } } } func (d *Server) hello(cmd string) { if d.initialized { d.outputMessage(messageError("hello", "HELLO already called")) return } re := regexp.MustCompile(`^(\d+) "([^"]+)"$`) matches := re.FindStringSubmatch(cmd) if len(matches) != 3 { d.outputMessage(messageError("hello", "Invalid HELLO command")) return } d.userAgent = matches[2] v, err := strconv.ParseInt(matches[1], 10, 64) if err != nil { d.outputMessage(messageError("hello", "Invalid protocol version: "+matches[2])) return } d.reqProtocolVersion = int(v) if err := d.impl.Hello(d.userAgent, 1); err != nil { d.outputMessage(messageError("hello", err.Error())) return } d.outputMessage(&message{ EventType: "hello", ProtocolVersion: 1, // Protocol version 1 is the only supported for now... Message: "OK", }) d.initialized = true } func (d *Server) describe() { if !d.initialized { d.outputMessage(messageError("describe", "Monitor not initialized")) return } portDescription, err := d.impl.Describe() if err != nil { d.outputMessage(messageError("describe", err.Error())) return } d.outputMessage(&message{ EventType: "describe", Message: "OK", PortDescription: portDescription, }) } func (d *Server) configure(cmd string) { if !d.initialized { d.outputMessage(messageError("configure", "Monitor not initialized")) return } re := regexp.MustCompile(`^([\w.-]+) (.+)$`) matches := re.FindStringSubmatch(cmd) if len(matches) != 3 { d.outputMessage(messageError("configure", "Invalid CONFIGURE command")) return } parameterName := matches[1] value := matches[2] if err := d.impl.Configure(parameterName, value); err != nil { d.outputMessage(messageError("configure", err.Error())) return } d.outputMessage(&message{ EventType: "configure", Message: "OK", }) } func (d *Server) open(cmd string) { if !d.initialized { d.outputMessage(messageError("open", "Monitor not initialized")) return } parameters := strings.SplitN(cmd, " ", 2) if len(parameters) != 2 { d.outputMessage(messageError("open", "Invalid OPEN command")) return } address := parameters[0] portName := parameters[1] port, err := d.impl.Open(portName) if err != nil { d.outputMessage(messageError("open", err.Error())) return } d.clientConn, err = net.Dial("tcp", address) if err != nil { d.impl.Close() d.outputMessage(messageError("open", err.Error())) return } // io.Copy is used to bridge the Client's TCP connection to the port one and vice versa go func() { _, err := io.Copy(port, d.clientConn) // Copy is blocking, so we run it insiede a gorutine if err != nil { d.close(err.Error()) } else { d.close("lost TCP/IP connection with the client!") } }() go func() { _, err := io.Copy(d.clientConn, port) // Copy is blocking, so we run it insiede a gorutine if err != nil { d.close(err.Error()) } else { d.close("lost connection with the port") } }() d.outputMessage(&message{ EventType: "open", Message: "OK", }) } func (d *Server) close(messageErr string) { d.closeFuncMutex.Lock() defer d.closeFuncMutex.Unlock() if d.clientConn == nil { if messageErr == "" { d.outputMessage(messageError("close", "port already closed")) } return } connErr := d.clientConn.Close() portErr := d.impl.Close() d.clientConn = nil if messageErr != "" { d.outputMessage(messageError("port_closed", messageErr)) return } if connErr != nil || portErr != nil { var errs *multierror.Error errs = multierror.Append(errs, connErr, portErr) d.outputMessage(messageError("close", errs.Error())) return } d.outputMessage(&message{ EventType: "close", Message: "OK", }) } func (d *Server) outputMessage(msg *message) { data, err := json.MarshalIndent(msg, "", " ") if err != nil { // We are certain that this will be marshalled correctly so we don't handle the error data, _ = json.MarshalIndent(messageError("command_error", err.Error()), "", " ") } d.outMutex.Lock() fmt.Fprintln(d.out, string(data)) d.outMutex.Unlock() } pluggable-monitor-protocol-handler-0.9.2/poetry.lock000066400000000000000000000012711424270431400226210ustar00rootroot00000000000000[[package]] name = "codespell" version = "2.1.0" description = "Codespell" category = "dev" optional = false python-versions = ">=3.5" [package.extras] dev = ["check-manifest", "flake8", "pytest", "pytest-cov", "pytest-dependency"] hard-encoding-detection = ["chardet"] [metadata] lock-version = "1.1" python-versions = "^3.9" content-hash = "9b82f653df8b27353719532dec8326a8882ac694180086bb6c404dbd6863f4f7" [metadata.files] codespell = [ {file = "codespell-2.1.0-py3-none-any.whl", hash = "sha256:b864c7d917316316ac24272ee992d7937c3519be4569209c5b60035ac5d569b5"}, {file = "codespell-2.1.0.tar.gz", hash = "sha256:19d3fe5644fef3425777e66f225a8c82d39059dcfe9edb3349a8a2cf48383ee5"}, ] pluggable-monitor-protocol-handler-0.9.2/pyproject.toml000066400000000000000000000005041424270431400233370ustar00rootroot00000000000000[tool.poetry] name = "pluggable-monitor-protocol-handler" version = "0.1.0" description = "" authors = ["Your Name "] [tool.poetry.dependencies] python = "^3.9" [tool.poetry.dev-dependencies] codespell = "^2.1.0" [build-system] requires = ["poetry-core>=1.0.0"] build-backend = "poetry.core.masonry.api"