From 8746996ea18b905cbb4afef2bcda493f5b4099e6 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 13 Dec 2023 01:28:20 +0000 Subject: [PATCH] Update TOC --- Installation.md | 76 +++++++++++++++++++------------------- README.md | 92 +++++++++++++++++++++++----------------------- Troubleshooting.md | 64 ++++++++++++++++---------------- 3 files changed, 116 insertions(+), 116 deletions(-) diff --git a/Installation.md b/Installation.md index 9c85384..52d17b1 100644 --- a/Installation.md +++ b/Installation.md @@ -2,46 +2,46 @@ Installation and Configuration of Homebridge Alexa ================================================== -- [Installation and Configuration of Homebridge Alexa](#installation-and-configuration-of-homebridge-alexa) -- [Setup Instructions](#setup-instructions) - - [Create Homebridge-Alexa Cloud Services Account](#create-homebridge-alexa-cloud-services-account) - - [Install and Configure the Plugin](#install-and-configure-the-plugin) - - [Installation in Homebridge UI](#installation-in-homebridge-ui) - - [Configuration in Homebridge UI](#configuration-in-homebridge-ui) - - [Enabling and linking the Homebridge Smart Home Skill](#enabling-and-linking-the-homebridge-smart-home-skill) - - [Viewing Account Status](#viewing-account-status) -- [Advanced Setup Instructions, including advanced configuration options](#advanced-setup-instructions-including-advanced-configuration-options) - - [Prepare Homebridge for plugin installation](#prepare-homebridge-for-plugin-installation) - - [Install Plugin](#install-plugin) - - [Create homebridge-alexa account](#create-homebridge-alexa-account) - - [HomeBridge-alexa plugin configuration](#homebridge-alexa-plugin-configuration) - - [Required Settings](#required-settings) - - [Optional Settings](#optional-settings) - - [debug](#debug) - - [pin](#pin) - - [routines](#routines) - - [deviceList \& deviceListHandling - Filtering of devices by name, either allow or allow](#devicelist--devicelisthandling---filtering-of-devices-by-name-either-allow-or-allow) - - [Advanced Settings](#advanced-settings) - - [CloudTransport - Cloud Server Connection Transport](#cloudtransport---cloud-server-connection-transport) - - [keepalive - Cloud Server Connection Keepalive](#keepalive---cloud-server-connection-keepalive) - - [refresh - Accessory Cache Refresh Interval](#refresh---accessory-cache-refresh-interval) - - [filter - Homebridge Instance Filter](#filter---homebridge-instance-filter) - - [mergeServiceName - Alternate device naming](#mergeservicename---alternate-device-naming) - - [blind](#blind) - - [door](#door) - - [Speaker Settings](#speaker-settings) - - [speakers](#speakers) - - [Combine Accessories](#combine-accessories) - - [combine](#combine) - - [Inputs](#inputs) - - [Apple TV](#apple-tv) - - [Yamaha Spotify Controls](#yamaha-spotify-controls) - - [Initial Testing and confirming configuration](#initial-testing-and-confirming-configuration) - - [Enable Homebridge smarthome skill and link accounts](#enable-homebridge-smarthome-skill-and-link-accounts) - - [Discover Devices](#discover-devices) +* [Installation and Configuration of Homebridge Alexa](#installation-and-configuration-of-homebridge-alexa) +* [Setup Instructions](#setup-instructions) + * [Create Homebridge-Alexa Cloud Services Account](#create-homebridge-alexa-cloud-services-account) + * [Install and Configure the Plugin](#install-and-configure-the-plugin) + * [Installation in Homebridge UI](#installation-in-homebridge-ui) + * [Configuration in Homebridge UI](#configuration-in-homebridge-ui) + * [Enabling and linking the Homebridge Smart Home Skill](#enabling-and-linking-the-homebridge-smart-home-skill) + * [Viewing Account Status](#viewing-account-status) +* [Advanced Setup Instructions, including advanced configuration options](#advanced-setup-instructions-including-advanced-configuration-options) + * [Prepare Homebridge for plugin installation](#prepare-homebridge-for-plugin-installation) + * [Install Plugin](#install-plugin) + * [Create homebridge-alexa account](#create-homebridge-alexa-account) + * [HomeBridge-alexa plugin configuration](#homebridge-alexa-plugin-configuration) + * [Required Settings](#required-settings) + * [Optional Settings](#optional-settings) + * [debug](#debug) + * [pin](#pin) + * [routines](#routines) + * [deviceList & deviceListHandling - Filtering of devices by name, either allow or allow](#devicelist--devicelisthandling---filtering-of-devices-by-name-either-allow-or-allow) + * [Advanced Settings](#advanced-settings) + * [CloudTransport - Cloud Server Connection Transport](#cloudtransport---cloud-server-connection-transport) + * [keepalive - Cloud Server Connection Keepalive](#keepalive---cloud-server-connection-keepalive) + * [refresh - Accessory Cache Refresh Interval](#refresh---accessory-cache-refresh-interval) + * [filter - Homebridge Instance Filter](#filter---homebridge-instance-filter) + * [mergeServiceName - Alternate device naming](#mergeservicename---alternate-device-naming) + * [blind](#blind) + * [door](#door) + * [Speaker Settings](#speaker-settings) + * [speakers](#speakers) + * [Combine Accessories](#combine-accessories) + * [combine](#combine) + * [Inputs](#inputs) + * [Apple TV](#apple-tv) + * [Yamaha Spotify Controls](#yamaha-spotify-controls) + * [Initial Testing and confirming configuration](#initial-testing-and-confirming-configuration) + * [Enable Homebridge smarthome skill and link accounts](#enable-homebridge-smarthome-skill-and-link-accounts) + * [Discover Devices](#discover-devices) - + diff --git a/README.md b/README.md index a3c596d..de258de 100644 --- a/README.md +++ b/README.md @@ -37,54 +37,54 @@ Country availability - The plugin is available in these countries, English (AU), # Table of Contents -- [Note to users of the service](#note-to-users-of-the-service) - - [New Users](#new-users) -- [Availability](#availability) -- [Features](#features) -- [Table of Contents](#table-of-contents) -- [Supported devices](#supported-devices) - - [HomeKit/Homebridge Devices supported](#homekithomebridge-devices-supported) - - [Native Support](#native-support) - - [Supported as Other Types](#supported-as-other-types) - - [Non-Homebridge Devices](#non-homebridge-devices) - - [Unsupported device types](#unsupported-device-types) -- [Alexa Voice Commands](#alexa-voice-commands) - - [Setup](#setup) - - [Light bulbs / Switches / Dimmer Switches](#light-bulbs--switches--dimmer-switches) - - [Color lights](#color-lights) - - [Color temperature](#color-temperature) - - [Color Temperatures](#color-temperatures) - - [Garage door, Blinds and Window Coverings](#garage-door-blinds-and-window-coverings) - - [Garage Door With door = false](#garage-door-with-door--false) - - [Window coverings / blinds With blind = false](#window-coverings--blinds-with-blind--false) - - [Garage Door With blind = true ( Not supported in all countries )](#garage-door-with-blind--true--not-supported-in-all-countries-) - - [Window coverings / blinds With blind = true ( Not supported in all countries )](#window-coverings--blinds-with-blind--true--not-supported-in-all-countries-) - - [Thermostat's and Heater / Cooler's](#thermostats-and-heater--coolers) - - [Lock / Unlock Doors](#lock--unlock-doors) - - [Temperature sensors](#temperature-sensors) - - [AppleTV ( homebridge-apple-tv or homebridge-apple-tv-remote )](#appletv--homebridge-apple-tv-or-homebridge-apple-tv-remote-) - - [HomeKit Television](#homekit-television) - - [HomeKit Television - Tested plugins](#homekit-television---tested-plugins) - - [Television Inputs and Channels](#television-inputs-and-channels) - - [Speakers](#speakers) - - [Bose SoundLink - Change preset](#bose-soundlink---change-preset) - - [Yamaha Receiver/Spotify control](#yamaha-receiverspotify-control) - - [Contact and Motion Sensors](#contact-and-motion-sensors) - - [Door bell devices](#door-bell-devices) -- [Installation of homebridge-alexa](#installation-of-homebridge-alexa) -- [Service Availability and Issues](#service-availability-and-issues) - - [Homebridge cloud service monitoring ( homebridge.ca )](#homebridge-cloud-service-monitoring--homebridgeca-) - - [Raising Issues and Troubleshooting](#raising-issues-and-troubleshooting) - - [Troubleshooting](#troubleshooting) - - [Known Issues](#known-issues) - - [Discord Channel](#discord-channel) - - [Debug logs](#debug-logs) - - [Homebridge Accessory Dump](#homebridge-accessory-dump) -- [Roadmap](#roadmap) -- [Credits](#credits) +* [Note to users of the service](#note-to-users-of-the-service) + * [New Users](#new-users) +* [Availability](#availability) +* [Features](#features) +* [Table of Contents](#table-of-contents) +* [Supported devices](#supported-devices) + * [HomeKit/Homebridge Devices supported](#homekithomebridge-devices-supported) + * [Native Support](#native-support) + * [Supported as Other Types](#supported-as-other-types) + * [Non-Homebridge Devices](#non-homebridge-devices) + * [Unsupported device types](#unsupported-device-types) +* [Alexa Voice Commands](#alexa-voice-commands) + * [Setup](#setup) + * [Light bulbs / Switches / Dimmer Switches](#light-bulbs--switches--dimmer-switches) + * [Color lights](#color-lights) + * [Color temperature](#color-temperature) + * [Color Temperatures](#color-temperatures) + * [Garage door, Blinds and Window Coverings](#garage-door-blinds-and-window-coverings) + * [Garage Door With door = false](#garage-door-with-door--false) + * [Window coverings / blinds With blind = false](#window-coverings--blinds-with-blind--false) + * [Garage Door With blind = true ( Not supported in all countries )](#garage-door-with-blind--true--not-supported-in-all-countries-) + * [Window coverings / blinds With blind = true ( Not supported in all countries )](#window-coverings--blinds-with-blind--true--not-supported-in-all-countries-) + * [Thermostat's and Heater / Cooler's](#thermostats-and-heater--coolers) + * [Lock / Unlock Doors](#lock--unlock-doors) + * [Temperature sensors](#temperature-sensors) + * [AppleTV ( homebridge-apple-tv or homebridge-apple-tv-remote )](#appletv--homebridge-apple-tv-or-homebridge-apple-tv-remote-) + * [HomeKit Television](#homekit-television) + * [HomeKit Television - Tested plugins](#homekit-television---tested-plugins) + * [Television Inputs and Channels](#television-inputs-and-channels) + * [Speakers](#speakers) + * [Bose SoundLink - Change preset](#bose-soundlink---change-preset) + * [Yamaha Receiver/Spotify control](#yamaha-receiverspotify-control) + * [Contact and Motion Sensors](#contact-and-motion-sensors) + * [Door bell devices](#door-bell-devices) +* [Installation of homebridge-alexa](#installation-of-homebridge-alexa) +* [Service Availability and Issues](#service-availability-and-issues) + * [Homebridge cloud service monitoring ( homebridge.ca )](#homebridge-cloud-service-monitoring--homebridgeca-) + * [Raising Issues and Troubleshooting](#raising-issues-and-troubleshooting) + * [Troubleshooting](#troubleshooting) + * [Known Issues](#known-issues) + * [Discord Channel](#discord-channel) + * [Debug logs](#debug-logs) + * [Homebridge Accessory Dump](#homebridge-accessory-dump) +* [Roadmap](#roadmap) +* [Credits](#credits) - + diff --git a/Troubleshooting.md b/Troubleshooting.md index dd6189a..75860b3 100644 --- a/Troubleshooting.md +++ b/Troubleshooting.md @@ -1,40 +1,40 @@ **Troubleshooting Tips** -- [Initial Setup](#initial-setup) - - [\[Alexa\] ERROR: ( homebridge-alexa) Login to homebridge.ca failed, please validate your credentials in config.json and restart homebridge.](#alexa-error--homebridge-alexa-login-to-homebridgeca-failed-please-validate-your-credentials-in-configjson-and-restart-homebridge) - - [- Bad login or password in your config.json for https://www.homebridge.ca](#--bad-login-or-password-in-your-configjson-for-httpswwwhomebridgeca) - - [\[Alexa\] ERROR: ( homebridge-alexa) You have an issue with your installation, please review the README.](#alexa-error--homebridge-alexa-you-have-an-issue-with-your-installation-please-review-the-readme) - - [- Cloud Server DDOS Protection has blocked your IP address](#--cloud-server-ddos-protection-has-blocked-your-ip-address) - - [- Multiple copies of homebridge-alexa on your network](#--multiple-copies-of-homebridge-alexa-on-your-network) - - [- VPN Software interfering with homebridge-alexa to homebridge.ca communications](#--vpn-software-interfering-with-homebridge-alexa-to-homebridgeca-communications) - - [\[Alexa\] ERROR: ( homebridge-alexa) Stopping Home Skill connection due to excessive reconnects, please review the README.](#alexa-error--homebridge-alexa-stopping-home-skill-connection-due-to-excessive-reconnects-please-review-the-readme) - - [\[Alexa\] WARNING: Duplicate device name xxxxx](#alexa-warning-duplicate-device-name-xxxxx) -- [Initial Setup Messages from DEBUG mode](#initial-setup-messages-from-debug-mode) - - [alexaHAP HAP Discover failed ... is not running in insecure mode](#alexahap-hap-discover-failed--is-not-running-in-insecure-mode) - - [HAP Discover failed ..... error code 470](#hap-discover-failed--error-code-470) - - [Upgraded from old version and am seeing this error message](#upgraded-from-old-version-and-am-seeing-this-error-message) - - [\[Alexa\] ERROR: HAP Discovery failed, please review config](#alexa-error-hap-discovery-failed-please-review-config) - - [alexaLocal ERROR: connect ECONNREFUSED 35.169.132.61:1883 -\> ECONNREFUSED](#alexalocal-error-connect-econnrefused-35169132611883----econnrefused) - - [alexaLocal error { Error: connect ECONNREFUSED 35.169.132.61:8883](#alexalocal-error--error-connect-econnrefused-35169132618883) -- [Device Discovery](#device-discovery) - - [Device discovery fails and the plugin logs show no issues.](#device-discovery-fails-and-the-plugin-logs-show-no-issues) - - [Device discovery fails, and this message is in the logs `ERROR: Empty accessory name, parsing failed.`](#device-discovery-fails-and-this-message-is-in-the-logs-error-empty-accessory-name-parsing-failed) - - [Device discovery fails, and this message is in the logs `ERROR: Maximum devices/accessories of 300 exceeded.`](#device-discovery-fails-and-this-message-is-in-the-logs-error-maximum-devicesaccessories-of-300-exceeded) - - [Device discovery fails, and this message is in the logs `ERROR: Parsing failed, duplicate endpointID.`](#device-discovery-fails-and-this-message-is-in-the-logs-error-parsing-failed-duplicate-endpointid) - - [After restarting homebridge Alexa can't find devices and needs to discover them again. Or you have duplicate devices in Alexa](#after-restarting-homebridge-alexa-cant-find-devices-and-needs-to-discover-them-again--or-you-have-duplicate-devices-in-alexa) -- [Controlling devices](#controlling-devices) - - [\[Alexa\] PowerController TurnOff 192.168.1.226 51826 undefined Error: Homebridge auth failed, invalid PIN](#alexa-powercontroller-turnoff-1921681226-51826-undefined-error-homebridge-auth-failed-invalid-pin) -- [Event error messages](#event-error-messages) - - [\[Alexa\] WARNING: ( homebridge-alexa) Dropped event message, message rate too high.](#alexa-warning--homebridge-alexa-dropped-event-message-message-rate-too-high) - - [ERROR: Error: getAccessToken No data Error: XXXXXXXXXX](#error--error-getaccesstoken-no-data-error-xxxxxxxxxx) - - [ERROR: Error: getAccessToken Token not found](#error--error-getaccesstoken-token-not-found) - - [Unsuccessful event message ( No event gateway token )](#unsuccessful-event-message--no-event-gateway-token-) - - [Successful event message being sent to Alexa](#successful-event-message-being-sent-to-alexa) - - [\[Alexa\] ERROR: Event gateway token refresh error: 400](#alexa-error--event-gateway-token-refresh-error-400) +* [Initial Setup](#initial-setup) + * [[Alexa] ERROR: ( homebridge-alexa) Login to homebridge.ca failed, please validate your credentials in config.json and restart homebridge.](#alexa-error--homebridge-alexa-login-to-homebridgeca-failed-please-validate-your-credentials-in-configjson-and-restart-homebridge) + * [- Bad login or password in your config.json for https://www.homebridge.ca](#--bad-login-or-password-in-your-configjson-for-httpswwwhomebridgeca) + * [[Alexa] ERROR: ( homebridge-alexa) You have an issue with your installation, please review the README.](#alexa-error--homebridge-alexa-you-have-an-issue-with-your-installation-please-review-the-readme) + * [- Cloud Server DDOS Protection has blocked your IP address](#--cloud-server-ddos-protection-has-blocked-your-ip-address) + * [- Multiple copies of homebridge-alexa on your network](#--multiple-copies-of-homebridge-alexa-on-your-network) + * [- VPN Software interfering with homebridge-alexa to homebridge.ca communications](#--vpn-software-interfering-with-homebridge-alexa-to-homebridgeca-communications) + * [[Alexa] ERROR: ( homebridge-alexa) Stopping Home Skill connection due to excessive reconnects, please review the README.](#alexa-error--homebridge-alexa-stopping-home-skill-connection-due-to-excessive-reconnects-please-review-the-readme) + * [[Alexa] WARNING: Duplicate device name xxxxx](#alexa-warning-duplicate-device-name-xxxxx) +* [Initial Setup Messages from DEBUG mode](#initial-setup-messages-from-debug-mode) + * [alexaHAP HAP Discover failed ... is not running in insecure mode](#alexahap-hap-discover-failed--is-not-running-in-insecure-mode) + * [HAP Discover failed ..... error code 470](#hap-discover-failed--error-code-470) + * [Upgraded from old version and am seeing this error message](#upgraded-from-old-version-and-am-seeing-this-error-message) + * [[Alexa] ERROR: HAP Discovery failed, please review config](#alexa-error-hap-discovery-failed-please-review-config) + * [alexaLocal ERROR: connect ECONNREFUSED 35.169.132.61:1883 -> ECONNREFUSED](#alexalocal-error-connect-econnrefused-35169132611883----econnrefused) + * [alexaLocal error { Error: connect ECONNREFUSED 35.169.132.61:8883](#alexalocal-error--error-connect-econnrefused-35169132618883) +* [Device Discovery](#device-discovery) + * [Device discovery fails and the plugin logs show no issues.](#device-discovery-fails-and-the-plugin-logs-show-no-issues) + * [Device discovery fails, and this message is in the logs ERROR: Empty accessory name, parsing failed.](#device-discovery-fails-and-this-message-is-in-the-logs-error-empty-accessory-name-parsing-failed) + * [Device discovery fails, and this message is in the logs ERROR: Maximum devices/accessories of 300 exceeded.](#device-discovery-fails-and-this-message-is-in-the-logs-error-maximum-devicesaccessories-of-300-exceeded) + * [Device discovery fails, and this message is in the logs ERROR: Parsing failed, duplicate endpointID.](#device-discovery-fails-and-this-message-is-in-the-logs-error-parsing-failed-duplicate-endpointid) + * [After restarting homebridge Alexa can't find devices and needs to discover them again. Or you have duplicate devices in Alexa](#after-restarting-homebridge-alexa-cant-find-devices-and-needs-to-discover-them-again--or-you-have-duplicate-devices-in-alexa) +* [Controlling devices](#controlling-devices) + * [[Alexa] PowerController TurnOff 192.168.1.226 51826 undefined Error: Homebridge auth failed, invalid PIN](#alexa-powercontroller-turnoff-1921681226-51826-undefined-error-homebridge-auth-failed-invalid-pin) +* [Event error messages](#event-error-messages) + * [[Alexa] WARNING: ( homebridge-alexa) Dropped event message, message rate too high.](#alexa-warning--homebridge-alexa-dropped-event-message-message-rate-too-high) + * [ERROR: Error: getAccessToken No data Error: XXXXXXXXXX](#error--error-getaccesstoken-no-data-error-xxxxxxxxxx) + * [ERROR: Error: getAccessToken Token not found](#error--error-getaccesstoken-token-not-found) + * [Unsuccessful event message ( No event gateway token )](#unsuccessful-event-message--no-event-gateway-token-) + * [Successful event message being sent to Alexa](#successful-event-message-being-sent-to-alexa) + * [[Alexa] ERROR: Event gateway token refresh error: 400](#alexa-error--event-gateway-token-refresh-error-400) - +