[ { "path": ".eslintrc.json", "content": "{\n \"root\": true,\n \"env\": {\n \"es6\": true,\n \"node\": true,\n \"mocha\": true\n },\n \"extends\": [\n \"eslint:recommended\"\n ],\n \"plugins\": [],\n \"rules\": {\n \"indent\": [\n \"error\",\n 4,\n {\n \"SwitchCase\": 1\n }\n ],\n \"no-console\": \"off\",\n \"no-var\": \"error\",\n \"no-trailing-spaces\": \"error\",\n \"prefer-const\": \"error\",\n \"quotes\": [\n \"error\",\n \"single\",\n {\n \"avoidEscape\": true,\n \"allowTemplateLiterals\": true\n }\n ],\n \"semi\": [\n \"error\",\n \"always\"\n ]\n },\n \"parserOptions\": {\n \"ecmaVersion\": 2018\n }\n}" }, { "path": ".gitattributes", "content": "# Auto detect text files and perform LF normalization\n* text=auto\n\n# Custom for Visual Studio\n*.cs diff=csharp\n\n# Standard to msysgit\n*.doc\t diff=astextplain\n*.DOC\t diff=astextplain\n*.docx diff=astextplain\n*.DOCX diff=astextplain\n*.dot diff=astextplain\n*.DOT diff=astextplain\n*.pdf diff=astextplain\n*.PDF\t diff=astextplain\n*.rtf\t diff=astextplain\n*.RTF\t diff=astextplain\n" }, { "path": ".github/FUNDING.yml", "content": "# These are supported funding model platforms\n\ngithub: Apollon77\npatreon: Apollon77\ncustom: ['https://paypal.me/Apollon77']\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.md", "content": "---\nname: Bug report\nabout: Something is not working as it should\ntitle: ''\nlabels: ''\nassignees: ''\n---\n\n**Check if the Bug maybe is with Amazon** \nThe adapter is using the same API as the Alexa mobile App. This means:\n* If you can not do this what you want with the App then the Adapter also can not do it!\n* Also if the App can do it please test if the same effect then the bug also happens with the App (e.g. a speak command do not work on a certain device ... can you do a speak via Alexa App? If not - Amazon problem!)\n\n**Describe the bug** \nA clear and concise description of what the bug is. Especially describe what you verified using the Alexa App (see above).\n\n**To Reproduce** \nSteps to reproduce the behavior:\n1. Go to '...'\n2. Click on '...'\n3. Scroll down to '....'\n4. See error\n\n**Expected behavior** \nA clear and concise description of what you expected to happen.\n\n**Screenshots & Logfiles** \nIf applicable, add screenshots and logfiles to help explain your problem.\n\n**Versions:** \n - Adapter version: \n - JS-Controller version: \n - Node version: \n - Operating system: \n\n**Additional context** \nAdd any other context about the problem here.\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.md", "content": "---\nname: Feature request\nabout: Suggest an idea for this project\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n**Consider the Reality** \nThe adapter is using the same API as the Alexa mobile App. This means:\n\nIf you can not do this what you want with the App then the Adapter also can not do it! Also a feature rewuest most likely will not be possible.\n\n**Is your feature request related to a problem? Please describe.**\nA clear and concise description of what the problem is. Ex. I'm always frustrated when [...]\n\n**Describe the solution you'd like**\nA clear and concise description of what you want to happen.\n\n**Describe alternatives you've considered**\nA clear and concise description of any alternative solutions or features you've considered.\n\n**Additional context**\nAdd any other context or screenshots about the feature request here.\n" }, { "path": ".github/auto-merge.yml", "content": "# Configure here which dependency updates should be merged automatically.\n# The recommended configuration is the following:\n- match:\n # Only merge patches for production dependencies\n dependency_type: production\n update_type: \"semver:patch\"\n- match:\n # Except for security fixes, here we allow minor patches\n dependency_type: production\n update_type: \"security:minor\"\n- match:\n # and development dependencies can have a minor update, too\n dependency_type: development\n update_type: \"semver:minor\"\n\n# The syntax is based on the legacy dependabot v1 automerged_updates syntax, see:\n# https://dependabot.com/docs/config-file/#automerged_updates" }, { "path": ".github/copilot-instructions.md", "content": "# ioBroker.alexa2 Adapter\nioBroker.alexa2 is a Node.js adapter for ioBroker that provides remote control for Amazon Alexa devices (Amazon Echo). The adapter integrates with the ioBroker home automation platform and allows control of Alexa devices, smart home devices, routines, and more.\n\nAlways reference these instructions first and fallback to search or bash commands only when you encounter unexpected information that does not match the info here.\n\n## Working Effectively\n\n### Bootstrap, Build, and Test the Repository:\n- `npm install` -- Install dependencies. Takes ~40 seconds. NEVER CANCEL.\n- `npm test` -- Run complete test suite. Takes ~55 seconds. NEVER CANCEL. Set timeout to 90+ seconds.\n- `npx eslint main.js lib/ test/ --ext .js` -- Lint main code files. Admin files have known translation issues.\n\n### Timing Expectations:\n- **NEVER CANCEL**: npm install takes 40 seconds. Wait for completion.\n- **NEVER CANCEL**: npm test takes 55 seconds total. Set timeout to 90+ seconds minimum.\n- **NEVER CANCEL**: The test includes full ioBroker js-controller setup which can take 30+ seconds just for initialization.\n\n### Manual Validation After Changes:\n- ALWAYS run `npm test` after making any code changes to ensure adapter functionality\n- ALWAYS run ESLint on modified files: `npx eslint --ext .js`\n- The adapter cannot be run standalone - it requires ioBroker infrastructure\n- Tests automatically validate adapter startup, configuration, and shutdown sequences\n- DO NOT attempt to run main.js directly - it requires ioBroker adapter-core framework\n\n## Project Structure and Navigation\n\n### Key Directories and Files:\n```\n/home/runner/work/ioBroker.alexa2/ioBroker.alexa2/\n├── main.js # Main adapter entry point (352KB, core logic)\n├── package.json # Dependencies and npm scripts\n├── io-package.json # ioBroker adapter configuration\n├── README.md # Comprehensive adapter documentation\n├── lib/\n│ ├── smarthomedevices.js # Smart home device definitions and controllers\n│ └── tools.js # Utility functions\n├── admin/ # Web UI configuration files\n│ ├── index_m.html # Material Design admin interface\n│ ├── words.js # i18n translations (has known ESLint issues)\n│ └── icons/ # Device type icons\n├── test/\n│ ├── testAdapter.js # Main adapter functionality tests\n│ ├── testPackageFiles.js # Package validation tests\n│ └── lib/setup.js # Test infrastructure and js-controller setup\n└── .github/workflows/ # CI/CD pipeline configuration\n```\n\n### Important Code Areas:\n- **main.js**: Core adapter logic, Alexa API integration, device management\n- **lib/smarthomedevices.js**: Smart home device capability definitions for various device types\n- **admin/index_m.html**: Admin configuration interface for credentials and settings \n- **test/lib/setup.js**: Complex test infrastructure that sets up js-controller environment\n\n## Validation Scenarios\n\n### Always Run These Validation Steps:\n1. **Install and Test**: `npm install && npm test` - Ensures all dependencies work and adapter can start properly\n2. **Lint Check**: `npx eslint main.js lib/ test/ --ext .js` - Check code quality (ignore admin/words.js issues)\n3. **Package Validation**: Tests automatically validate package.json and io-package.json consistency\n\n### Manual Testing Scenarios:\n- The adapter requires Amazon Alexa account credentials which cannot be tested in CI\n- Tests validate adapter initialization, configuration loading, and proper shutdown\n- Real functionality requires proxy-based authentication flow with Amazon\n- Tests use mock/stub behavior for core adapter lifecycle validation\n\n## Common Tasks\n\n### Dependencies and Requirements:\n- **Node.js**: 16+ required (package.json engines), tested with 20.x\n- **npm**: Standard package manager, uses package-lock.json\n- **@iobroker/adapter-core**: ^3.2.3 - Core ioBroker adapter framework\n- **alexa-remote2**: ^8.0.2 - Amazon Alexa API integration library\n\n### npm Scripts Available:\n```bash\nnpm test # Run mocha test suite (takes ~55s)\nnpm run release # Release automation (requires tokens)\nnpm run translate # Translation management\n```\n\n### Linting and Code Quality:\n- ESLint configured in .eslintrc.json with strict rules\n- Use single quotes, 4-space indentation, prefer const over let/var\n- Main code files should lint cleanly\n- admin/words.js has known translation format issues - ignore ESLint errors in this file\n\n### GitHub Actions Workflow:\n- Runs on Node.js 18.x, 20.x, 22.x, 24.x across Ubuntu, Windows, macOS\n- check-and-lint job: `npm ci` only (linting commented out in workflow)\n- adapter-tests job: `npm ci && npm test` \n- Deployment triggers on tagged releases\n\n## Architecture Notes\n\n### ioBroker Adapter Pattern:\n- Extends @iobroker/adapter-core.Adapter class\n- Uses state-based communication with ioBroker objects/states databases\n- Implements standard adapter lifecycle: ready, unload, stateChange, objectChange\n- Creates device/state hierarchies under adapter namespace (alexa2.0.*)\n\n### External Dependencies:\n- alexa-remote2: Amazon Alexa API integration\n- https, nearest-color, rrule: Utility libraries\n- Sentry integration for error reporting (optional)\n\n### Test Infrastructure:\n- Uses complex test setup that installs and configures js-controller\n- Creates temporary ioBroker instance with Redis backends\n- Tests adapter lifecycle, not actual Amazon Alexa functionality\n- Mock/stub approach for external API dependencies\n\n## Troubleshooting\n\n### Common Issues:\n- **Test timeouts**: Always set 90+ second timeouts for npm test\n- **ESLint errors in admin/words.js**: These are translation files with specific format requirements - ignore\n- **Cannot run main.js directly**: Requires ioBroker adapter-core framework and configuration\n- **Missing dependencies**: Always run `npm install` before any other commands\n\n### Development Environment:\n- Use any modern IDE with Node.js support\n- ESLint integration recommended for code quality\n- Git hooks not configured - manually run linting before commits\n- No TypeScript - pure JavaScript codebase\n\n### CI/CD Pipeline:\n- Tests run automatically on pushes and PRs\n- Linting step commented out in workflow due to admin file issues\n- Releases automated via @alcalzone/release-script\n- Sentry integration for production error tracking" }, { "path": ".github/dependabot.yml", "content": "# Dependabot will run on day 19 of each month at 02:38 (Europe/Berlin timezone)\nversion: 2\nupdates:\n\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n interval: \"cron\"\n timezone: \"Europe/Berlin\"\n cronjob: \"38 2 19 * *\"\n open-pull-requests-limit: 15\n\n - package-ecosystem: \"npm\"\n directory: \"/\"\n schedule:\n interval: \"cron\"\n timezone: \"Europe/Berlin\"\n cronjob: \"38 2 19 * *\"\n open-pull-requests-limit: 20\n versioning-strategy: \"increase\"\n" }, { "path": ".github/stale.yml", "content": "# Configuration for probot-stale - https://github.com/probot/stale\n\n# Number of days of inactivity before an Issue or Pull Request becomes stale\ndaysUntilStale: 90\n\n# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.\n# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.\ndaysUntilClose: 7\n\n# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)\nonlyLabels: []\n\n# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable\nexemptLabels:\n - enhancement\n - security\n - bug\n\n# Set to true to ignore issues in a project (defaults to false)\nexemptProjects: true\n\n# Set to true to ignore issues in a milestone (defaults to false)\nexemptMilestones: true\n\n# Set to true to ignore issues with an assignee (defaults to false)\nexemptAssignees: false\n\n# Label to use when marking as stale\nstaleLabel: wontfix\n\n# Comment to post when marking as stale. Set to `false` to disable\nmarkComment: >\n This issue has been automatically marked as stale because it has not had\n recent activity. It will be closed if no further activity occurs within the next 7 days.\n Please check if the issue is still relevant in the most current version of the adapter\n and tell us. Also check that all relevant details, logs and reproduction steps\n are included and update them if needed.\n Thank you for your contributions.\n\n Dieses Problem wurde automatisch als veraltet markiert, da es in letzter Zeit keine Aktivitäten gab.\n Es wird geschlossen, wenn nicht innerhalb der nächsten 7 Tage weitere Aktivitäten stattfinden.\n Bitte überprüft, ob das Problem auch in der aktuellsten Version des Adapters noch relevant ist,\n und teilt uns dies mit. Überprüft auch, ob alle relevanten Details, Logs und Reproduktionsschritte\n enthalten sind bzw. aktualisiert diese.\n Vielen Dank für Eure Unterstützung.\n\n# Comment to post when removing the stale label.\n# unmarkComment: >\n# Your comment here.\n\n# Comment to post when closing a stale Issue or Pull Request.\ncloseComment: >\n This issue has been automatically closed because of inactivity. Please open a new\n issue if still relevant and make sure to include all relevant details, logs and\n reproduction steps.\n Thank you for your contributions.\n\n Dieses Problem wurde aufgrund von Inaktivität automatisch geschlossen. Bitte öffnet ein\n neues Issue, falls dies noch relevant ist und stellt sicher das alle relevanten Details,\n Logs und Reproduktionsschritte enthalten sind.\n Vielen Dank für Eure Unterstützung.\n\n# Limit the number of actions per hour, from 1-30. Default is 30\nlimitPerRun: 30\n\n# Limit to only `issues` or `pulls`\nonly: issues\n\n# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':\n# pulls:\n# daysUntilStale: 30\n# markComment: >\n# This pull request has been automatically marked as stale because it has not had\n# recent activity. It will be closed if no further activity occurs. Thank you\n# for your contributions.\n\n# issues:\n# exemptLabels:\n# - confirmed\n" }, { "path": ".github/workflows/codeql.yml", "content": "name: \"CodeQL\"\n\non:\n push:\n branches: [ \"master\" ]\n pull_request:\n # The branches below must be a subset of the branches above\n branches: [ \"master\" ]\n schedule:\n - cron: '31 17 * * 1'\n\njobs:\n analyze:\n name: Analyze\n runs-on: ubuntu-latest\n permissions:\n actions: read\n contents: read\n security-events: write\n\n strategy:\n fail-fast: false\n matrix:\n language: [ 'javascript' ]\n\n steps:\n - name: Checkout repository\n uses: actions/checkout@v5\n\n # Initializes the CodeQL tools for scanning.\n - name: Initialize CodeQL\n uses: github/codeql-action/init@v4\n with:\n languages: ${{ matrix.language }}\n\n - name: Autobuild\n uses: github/codeql-action/autobuild@v4\n\n - name: Perform CodeQL Analysis\n uses: github/codeql-action/analyze@v4\n with:\n category: \"/language:${{matrix.language}}\"\n" }, { "path": ".github/workflows/dependabot-automerge.yml", "content": "# Automatically merge Dependabot PRs when version comparison is within the range\n# that is configured in .github/auto-merge.yml\n\nname: Auto-Merge Dependabot PRs\n\non:\n pull_request_target:\n\njobs:\n auto-merge:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout code\n uses: actions/checkout@v5\n\n - name: Check if PR should be auto-merged\n uses: ahmadnassri/action-dependabot-auto-merge@v2\n with:\n # This must be a personal access token with push access\n github-token: ${{ secrets.AUTO_MERGE_TOKEN }}\n # By default, squash and merge, so Github chooses nice commit messages\n command: squash and merge" }, { "path": ".github/workflows/test-and-release.yml", "content": "# This is a composition of lint and test scripts\n# Make sure to update this file along with the others\n\nname: Test and Release\n\n# Run this job on all pushes and pull requests\n# as well as tags with a semantic version\non:\n push:\n branches:\n - '*'\n tags:\n # normal versions\n - \"v?[0-9]+.[0-9]+.[0-9]+\"\n # pre-releases\n - \"v?[0-9]+.[0-9]+.[0-9]+-**\"\n pull_request: {}\n\n# Cancel previous PR/branch runs when a new commit is pushed\nconcurrency:\n group: ${{ github.ref }}\n cancel-in-progress: true\n\npermissions:\n id-token: write # Required for OIDC\n contents: write\n pull-requests: read\n\njobs:\n # Performs quick checks before the expensive test runs\n check-and-lint:\n if: contains(github.event.head_commit.message, '[skip ci]') == false\n\n runs-on: ubuntu-latest\n\n strategy:\n matrix:\n node-version: [22.x]\n\n steps:\n - uses: actions/checkout@v5\n - name: Use Node.js ${{ matrix.node-version }}\n uses: actions/setup-node@v6\n with:\n node-version: ${{ matrix.node-version }}\n\n\n - name: Install Dependencies\n run: npm ci\n\n# - name: Perform a type check\n# run: npm run check:ts\n# env:\n# CI: true\n # - name: Lint TypeScript code\n # run: npm run lint\n# - name: Test package files\n# run: npm run test:package\n\n # Runs adapter tests on all supported node versions and OSes\n adapter-tests:\n if: contains(github.event.head_commit.message, '[skip ci]') == false\n\n needs: [check-and-lint]\n\n runs-on: ${{ matrix.os }}\n strategy:\n matrix:\n node-version: [18.x, 20.x, 22.x, 24.x]\n os: [ubuntu-latest, windows-latest, macos-latest]\n\n steps:\n - uses: actions/checkout@v5\n - name: Use Node.js ${{ matrix.node-version }}\n uses: actions/setup-node@v6\n with:\n node-version: ${{ matrix.node-version }}\n\n - name: Install Dependencies\n run: npm ci\n\n - name: Run local tests\n run: npm test\n# - name: Run unit tests\n# run: npm run test:unit\n# - name: Run integration tests # (linux/osx)\n# if: startsWith(runner.OS, 'windows') == false\n# run: DEBUG=testing:* npm run test:integration\n# - name: Run integration tests # (windows)\n# if: startsWith(runner.OS, 'windows')\n# run: set DEBUG=testing:* & npm run test:integration\n\n # Deploys the final package to NPM\n deploy:\n needs: [adapter-tests]\n\n # Trigger this step only when a commit on master is tagged with a version number\n if: |\n contains(github.event.head_commit.message, '[skip ci]') == false &&\n github.event_name == 'push' &&\n startsWith(github.ref, 'refs/tags/')\n runs-on: ubuntu-latest\n strategy:\n matrix:\n node-version: [22.x]\n\n steps:\n - name: Checkout code\n uses: actions/checkout@v5\n\n - name: Use Node.js ${{ matrix.node-version }}\n uses: actions/setup-node@v6\n with:\n node-version: ${{ matrix.node-version }}\n\n - name: Extract the version and commit body from the tag\n shell: bash\n id: extract_release\n # The body may be multiline, therefore newlines and % need to be escaped\n run: |\n VERSION=\"${{ github.ref }}\"\n VERSION=${VERSION##*/v}\n echo \"VERSION=$VERSION\" >> $GITHUB_OUTPUT\n EOF=$(od -An -N6 -x /dev/urandom | tr -d ' ')\n BODY=$(git show -s --format=%b)\n echo \"BODY<<$EOF\" >> $GITHUB_OUTPUT\n echo \"$BODY\" >> $GITHUB_OUTPUT\n echo \"$EOF\" >> $GITHUB_OUTPUT\n if [[ $VERSION == *\"-\"* ]] ; then\n echo \"TAG=--tag next\" >> $GITHUB_OUTPUT\n fi\n\n - name: Install Dependencies\n run: npm ci\n\n# - name: Create a clean build\n# run: npm run build\n - name: Publish package to npm\n run: |\n npm install -g npm@latest\n npm publish ${{ steps.extract_release.outputs.TAG }}\n\n - name: Create Github Release\n uses: softprops/action-gh-release@v2\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n with:\n tag_name: ${{ github.ref }}\n name: Release v${{ steps.extract_release.outputs.VERSION }}\n draft: false\n # Prerelease versions create prereleases on Github\n prerelease: ${{ contains(steps.extract_release.outputs.VERSION, '-') }}\n body: ${{ steps.extract_release.outputs.BODY }}\n\n - name: Notify Sentry.io about the release\n run: |\n npm i -g @sentry/cli \n export SENTRY_AUTH_TOKEN=${{ secrets.SENTRY_AUTH_TOKEN }}\n export SENTRY_URL=https://sentry.iobroker.net\n export SENTRY_ORG=iobroker\n export SENTRY_PROJECT=iobroker-alexa2\n export SENTRY_VERSION=iobroker.alexa2@${{ steps.extract_release.outputs.VERSION }}\n sentry-cli releases new $SENTRY_VERSION\n sentry-cli releases set-commits $SENTRY_VERSION --auto\n sentry-cli releases finalize $SENTRY_VERSION\n\n # Add the following line BEFORE finalize if sourcemap uploads are needed\n # sentry-cli releases files $SENTRY_VERSION upload-sourcemaps build/\n" }, { "path": ".gitignore", "content": "# Created by .ignore support plugin (hsz.mobi)\n### Node template\n# Logs\nlogs\n*.log\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\n\n# Runtime data\npids\n*.pid\n*.seed\n*.pid.lock\nadmin/i18n/flat.txt\nadmin/i18n/*/flat.txt\n\n# Directory for instrumented libs generated by jscoverage/JSCover\nlib-cov\n\n# Coverage directory used by tools like istanbul\ncoverage\n\n# nyc test coverage\n.nyc_output\n\n# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)\n.grunt\n\n# Bower dependency directory (https://bower.io/)\nbower_components\n\n# node-waf configuration\n.lock-wscript\n\n# Compiled binary addons (https://nodejs.org/api/addons.html)\nbuild/Release\n\n# Dependency directories\nnode_modules/\njspm_packages/\n\n# Typescript v1 declaration files\ntypings/\n\n# Optional npm cache directory\n.npm\n\n# Optional eslint cache\n.eslintcache\n\n# Optional REPL history\n.node_repl_history\n\n# Output of 'npm pack'\n*.tgz\n\n# Yarn Integrity file\n.yarn-integrity\n\n# dotenv environment variables file\n.env\n\n\n.idea\n\n# ioBroker dev-server\n.dev-server/\n\n# Test temporary files\ntmp/\n\n#ignore .commitinfo created by ioBroker release script\n.commitinfo\n" }, { "path": ".mocharc.json", "content": "{\n \"require\": [\n \"./test/mocha.setup.js\"\n ]\n}\n" }, { "path": ".npmignore", "content": "# exclude all dot-files and directories\n.*\n\nadmin/i18n\ntasks\nnode_modules\n.idea\n.git\n/node_modules\ntest\n.travis.yml\nappveyor.yml\n.github\npackage-lock.json\n.gitattributes\n" }, { "path": ".releaseconfig.json", "content": "{\n \"plugins\": [\"iobroker\", \"license\"]\n}\n" }, { "path": "LICENSE", "content": "The MIT License (MIT)\n\nCopyright (c) 2018-2025 Ingo Fischer , 2017-2018 soef \n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n" }, { "path": "README.md", "content": "![Logo](admin/alexa.png)\n# ioBroker.alexa2\n\n![Number of Installations](http://iobroker.live/badges/alexa2-installed.svg)\n![Number of Installations](http://iobroker.live/badges/alexa2-stable.svg)\n[![NPM version](http://img.shields.io/npm/v/iobroker.alexa2.svg)](https://www.npmjs.com/package/iobroker.alexa2)\n\n![Test and Release](https://github.com/Apollon77/iobroker.alexa2/workflows/Test%20and%20Release/badge.svg)\n[![Translation status](https://weblate.iobroker.net/widgets/adapters/-/alexa2/svg-badge.svg)](https://weblate.iobroker.net/engage/adapters/?utm_source=widget)\n[![Downloads](https://img.shields.io/npm/dm/iobroker.alexa2.svg)](https://www.npmjs.com/package/iobroker.alexa2)\n\n**This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers.** For more details and for information how to disable the error reporting see [Sentry-Plugin Documentation](https://github.com/ioBroker/plugin-sentry#plugin-sentry)! Sentry reporting is used starting with js-controller 3.0.\n\nThis adapter allows you to remotely control your Alexa (Amazon Echo) devices.\n\nBig thanks go to soef for version 1 of the adapter and to Hauke and ruhr70 for ideas in their scripts from ioBroker-Forum (especially the media progress updates)!\nAlso, big thanks to meicker for support in documenting all of this and numerous users from ioBroker Forum for their testing support!\n\n## Disclaimer\n**All product and company names or logos are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them or any associated subsidiaries! This personal project is maintained in spare time and has no business goal.**\n**ALEXA is a trademark of AMAZON TECHNOLOGIES, INC.**\n\n## States and their meanings:\n\nIn the adapter namespace (e.g., alexa2.0) some channels are created\n\n### alexa2.0\n\n| State name | meaning |\n|----------------------|--------------------------------------------------------|\n| Echo-Devices.* | States per Echo device, see below |\n| History.* | Infos for command history, see below |\n| Smart-Home-Devices.* | States per smart home device and in general, see below |\n| info.* | General information about the adapter status |\n| requestResult | Error info for TuneIn and smart-home device requests |\n\n### alexa2.0.Contacts.ContactId.*\nAll Alexa-Contacts that can be used to send Text Messages to, including himself. The own contact gets a special \"(Self)\" after his name.\n\n| State name | meaning |\n|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------|\n| #clearOwnMessages | Only exists in own contact and a trigger deletes all messages that are send to himself (also includes messages to himself via App or devices!) |\n| textMessage | Sends this text as message to the user. It is shown on all devices of this user with a \"yellow ring\" |\n\n### alexa2.0.Echo-Devices.CommandsAll.*\nCommands to be sent to all devices in the account.\n\n| State name | meaning | Comments |\n|--------------------|-------------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| deviceStop | Stop all actions on device | Button |\n| deviceDoNotDisturb | Switch on/off \"Do not Disturb\" for all devices. | true/false, or number in seconds to enable (max 12h) or string in form \"HH:MM\" until this time it is enabled |\n\n### alexa2.0.Echo-Devices.Serialnumber.*\nUnder \"echo-devices\" every amazon echo device is listed with its serial number. Not every device shows all the states. Every device has its own states as described below:\n\n### alexa2.0.Echo-Devices.Serialnumber.Alarm.*\nAlarm (Wecker) settings for each device, if available.\n\n| State name | meaning | value |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| .customVolume | Set a custom Volume for this Reminder. The volume is set 2s before the reminder triggers and re-set to the value before as soon as the timer is (or adapter thinks!) stopped - latest after 120s! When custom volumes and trigger times overlap it will be restored at the end once! | Number 0..100 |\n| .date | Overwrite the date for existing alarm to set a new date for this alarm. In case you have an existing alarm you can change the date here by simply overwrite the time in format YYYY-MM-DD. Might have no effect when multiple-times-per-day recurring settings were used! | Date Output |\n| .delete | Button to delete the Alarm | delete with true |\n| .enabled | Shows status of alarm and allows to change it: Activate alarm with true - Deactivate alarm with false | true / false |\n| .musicEntity | Shows the track info if this alarm is a music alarm | String or null |\n| .musicProvider | Shows the provider of the music if this alarm is a music alarm | String or null |\n| .nextTriggerDate | Contains the timepoint of the next expected triggering as unix epoch in ms | Number |\n| .recurringDays | Shows the list of days configured if the Alarm has recurring settings | US notation of weekdays (e.g. MO,TU,WE,TH,FR,SA,SU) |\n| .recurringPattern | Shows the recurring pattern of alarm | 0 = one time, no recurring
P1D = daily
XXXX-WD = on weekdays
XXXX-WE = on weekends
XXXX-WXX-1 = every monday
XXXX-WXX-2 = every tuesday
XXXX-WXX-3 = every wednesday
XXXX-WXX-4 = every thursday
XXXX-WXX-5 = every friday
XXXX-WXX-6 = every saturday
XXXX-WXX-7 = every sunday |\n| .snoozed | true if the Alarm is snoozed at the moment | true/false |\n| .sound | Contains the set sound for this alarm. Can be changed. Also changing between music sound entry and \"build in sounds\" is possible. | ID from list |\n| .time | Time for alarm. Overwrite the time for existing alarm to set a new time for this alarm. In case you have an existing alarm you can change the time here by simply overwrite the time in format hh:mm:ss, seconds are not needed to set. Might have no effect when multiple-times-per-day recurring settings were used! | Time Input |\n| .triggered | true if alarm is reached and triggered. Clock must be in sync with Amazon and iobroker, Use this to trigger other action as soon as the alarm time is reached | true / false |\n| New | Data to create a new Reminder as String in following format separated by ; as \"timestamp;[label];[sound];[recurring]. timestamp as unix timestamp in ms, label as Text, sound as sound ID, recurring either empty for once, \"DAILY\" for daily or \"WEEKLY=MO,TU,WE,TH,FR,SA,SU\" with comma separated weekly day list. Fields in example above in brackets mean that they are optional! | String |\n| triggered | ID of the Alarm that triggered last on this device | ID |\n\nWhen changing an Alarm does not work, please make sure that the Alarm timepoint is in the future - so changing e.g. \"sound\" on an Alarm in the past will _not_ work!\n\n### alexa2.0.Echo-Devices.Serialnumber.Bluetooth.*\nHere you find all connected or known bluetooth device(s) with MAC address(es). The states of each device:\n\n\n| State name | meaning |\n|------------|----------------------------------------------------------------------------------------------------|\n| connected | Shows current connection status and allow connection (set to true) or disconnection (set to false) |\n| unpair | Button to unpair this device from the echo device |\n\n### alexa2.0.Echo-Devices.Serialnumber.Commands.*\nWith Commands, you can trigger some actions on your Alexa-Device. If you use these on a multiroom device, then they are executed independently and *will not* run in sync on the single devices!\n\n| State name | meaning | value |\n|---------------|----------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| doNotDisturb | Switch on/off \"Do not Disturb\" for this device or group. Value is updated with Device Configuration updates from Cloud too | true/false, or number in seconds to enable (max 12h) or string in form \"HH:MM\" until this time it is enabled |\n| flashbriefing | Briefing in 100 seconds - news etc.pp | Button |\n| goodmorning | Good morning from Alexa ... | Button |\n| funfact | Fun fact from Alexa ... (Only USA at the moment) | Button |\n| joke | Joke from Alexa ... | Button |\n| cleanup | Plays a \"gong\" tone like for start/end of listening mode ... | Button |\n| curatedtts | Random sentence from the chosen area from Alexa ... | Text (allowed: \"goodbye\", \"confirmations\", \"goodmorning\", \"compliments\", \"birthday\", \"goodnight\", \"iamhome\") |\n| singasong | Alexa sings a song ... | Button |\n| speak | Alexa says what you type in here ... | Text Input |\n| speakvolume | Adjust the speak volume of Alexa, this volume is set before the speak and reset afterwards | 0-100 |\n| skill | Launch a defined Skill | Skill-ID as String |\n| skillYours | launch a defined Skill - is prefilled with \"Your Skills\" as displayed in Alexa App too | Skill-ID as String |\n| tellstory | Alexa tells a story | Button |\n| traffic | Traffic news | Button |\n| weather | Weather news | Button |\n| deviceStop | Stop all actions on device | Button |\n| notification | Send text notification to customer of the device | Text, optionally specify title \"title;text\" |\n| announcement | Play announcement (like speak but with Bing before text)
*Note: will only work if announcements (for this device) are activated and the device is not in \"do not disturb\"-mode* | Text |\n| ssml | Speak SSML XML string
*Note: will only work if announcements (for this device) are activated and the device is not in \"do not disturb\"-mode* | Text |\n| textcommand | Send a Text command to Alexa,. Make sure to only use text (e.g. also 3 -> three and such, else Alexa might not correctly react to it!) | Text |\n| sound | Play a sound on the device. | Text |\n\nDetailed information Speak and Announcement: Type in here what you want Alexa to say. You can also adjust the volume of Alexa by giving a percentage before your text.\nExample: 10;Alexa is saying Alexa with 10% volume, while 100;Alexa is 100% volume.\nNormally, you only can send 250 characters per speak command. By using the semicolon, it is possible to write as much as you want, as long as you separate 250 characters with a semicolon.\nAlexa will then speak the text after each other with a small break. You also can use the volume together with more 255 blocks by writing #Volume;#Block1;#Block2, a.s.o A volume set here will be used over a defined speak-volume.\n\nPartially also sounds from https://developer.amazon.com/en-US/docs/alexa/custom-skills/ask-soundlibrary.html work. Specify in speak or ssml as `