add a check to disable toggle beeping if toggle keys in ease of access is enabled, since this feature can be enabled on the system but doesn't work very well for NVDA with laptop keyboard layout.

davidacm · davidacm · commit 7707b57c0d44 · 2020-08-18T17:23:18.000-06:00
update readme with new sections.
update sconstruct to generate english readme from addonReadme.md file
diff --git a/addon/globalPlugins/beepKeyboard.py b/addon/globalPlugins/beepKeyboard.py
@@ -5,9 +5,10 @@
 # Released under GPL 2
 #globalPlugins/beepKeyboard.py
 
-import api, codecs, config, globalPluginHandler, gui, keyboardHandler, tones, ui, winUser, wx, addonHandler
+import api, codecs, config, globalPluginHandler, gui, keyboardHandler, tones, ui, winreg, winUser, wx, addonHandler
 addonHandler.initTranslation()
 
+# config schema
 confspec = {
 	"beepUpperWithCapsLock": "boolean(default=True)",
 	"beepCharacterWithShift": "boolean(default=False)",
@@ -19,23 +20,36 @@
 	"shiftedCharactersTone": "int_list(default=list(6000,10,25))",
 	"customCharactersTone": "int_list(default=list(6000,10,25))",
 	"capsLockUpperTone": "int_list(default=list(3000,40,50))",
-	"toggleOffTone": "int_list(default=list(1000,40,50))",
+	"toggleOffTone": "int_list(default=list(500,40,50))",
 	"toggleOnTone": "int_list(default=list(2000, 40, 50))"
 }
 config.conf.spec["beepKeyboard"] = confspec
 
+# Constants.
+REG_TOGGLE_KEYS = r"Control Panel\Accessibility\ToggleKeys"
+REG_KEY = "Flags"
+REG_VALUE_ON = 63
+
+# global variables
+ignoreToggleKeys = False
+
 def beep(l):
 	""" it receives a list with three arguments to beep: [pitch, length, volume]"""
-	if not (config.conf['beepKeyboard']['disableBeepingOnPasswordFields'] and api.getFocusObject().isProtected): tones.beep(*l, right=l[-1])
+	if not (config.conf['beepKeyboard']['disableBeepingOnPasswordFields'] and api.getFocusObject().isProtected):
+		tones.beep(*l, right=l[-1])
 
 #saves the original _reportToggleKey function
 origReportToggleKey = keyboardHandler.KeyboardInputGesture._reportToggleKey
+
 # alternate function to report state key.
 def _reportToggleKey(self):
-	if winUser.getKeyState(self.vkCode) & 1:
-		beep(config.conf['beepKeyboard']['toggleOnTone'])
-	else: beep(config.conf['beepKeyboard']['toggleOffTone'])
-	if config.conf['beepKeyboard']['announceToggleStatus'] or (config.conf['beepKeyboard']['disableBeepingOnPasswordFields'] and api.getFocusObject().isProtected): origReportToggleKey(self)
+	global ignoreToggleKeys
+	if not ignoreToggleKeys:
+		if winUser.getKeyState(self.vkCode) & 1:
+			beep(config.conf['beepKeyboard']['toggleOnTone'])
+		else: beep(config.conf['beepKeyboard']['toggleOffTone'])
+	if ignoreToggleKeys or config.conf['beepKeyboard']['announceToggleStatus'] or (config.conf['beepKeyboard']['disableBeepingOnPasswordFields'] and api.getFocusObject().isProtected):
+		origReportToggleKey(self)
 
 class BeepKeyboardSettingsPanel(gui.SettingsPanel):
 	# Translators: This is the label for the beepKeyboard  settings category in NVDA Settings screen.
@@ -165,6 +179,17 @@ def __init__(self):
 		gui.settingsDialogs.NVDASettingsDialog.categoryClasses.append(BeepKeyboardSettingsPanel)
 		config.post_configProfileSwitch.register(self.handleConfigProfileSwitch)
 
+	def checkEaseAccessToggleKeys(self):
+		global ignoreToggleKeys
+		# disables sounds for toggle keys if native system toggle keys is enabled.
+		try:
+			r = winreg.OpenKey(winreg.HKEY_CURRENT_USER, REG_TOGGLE_KEYS, 0, winreg.KEY_READ)
+			v, _ = winreg.QueryValueEx(r, REG_KEY)
+			if int(v) == REG_VALUE_ON: ignoreToggleKeys = True
+			else: ignoreToggleKeys = False
+		except:
+			ignoreToggleKeys = False
+
 	def event_typedCharacter(self, obj, nextHandler, ch):
 		nextHandler()
 		if config.conf['beepKeyboard']['beepUpperWithCapsLock'] and winUser.getKeyState(winUser.VK_CAPITAL)&1 and ch.isupper():
@@ -174,9 +199,13 @@ def event_typedCharacter(self, obj, nextHandler, ch):
 		elif ch in self.beepForCharacters: beep(config.conf['beepKeyboard']['customCharactersTone'])
 
 	def setExternalReportToggleStatus(self, flag):
+		global ignoreToggleKeys
 		if flag:
-			keyboardHandler.KeyboardInputGesture._reportToggleKey = _reportToggleKey
-		else: keyboardHandler.KeyboardInputGesture._reportToggleKey = origReportToggleKey
+			self.checkEaseAccessToggleKeys()
+			if not ignoreToggleKeys:
+				keyboardHandler.KeyboardInputGesture._reportToggleKey = _reportToggleKey
+				return
+		keyboardHandler.KeyboardInputGesture._reportToggleKey = origReportToggleKey
 
 	def handleConfigProfileSwitch(self):
 		self.setExternalReportToggleStatus(config.conf['beepKeyboard']['beepToggleKeyChanges'])
@@ -187,4 +216,4 @@ def terminate(self):
 		super(GlobalPlugin, self).terminate()
 		self.setExternalReportToggleStatus(False)
 		gui.settingsDialogs.NVDASettingsDialog.categoryClasses.remove(BeepKeyboardSettingsPanel)
-		config.post_configProfileSwitch.unregister(self.handleConfigProfileSwitch)
+		config.post_configProfileSwitch.unregister(self.handleConfigProfileSwitch)
diff --git a/addonReadme.md b/addonReadme.md
@@ -0,0 +1,41 @@
+# Beep keyboard NVDA Add-on #
+This add-on allows the user to configure NVDA to beeps with some keyboard events.
+
+Copyright (C) 2019 David CM <dhf360@gmail.com>
+
+This package is distributed under the terms of the GNU General Public License, version 2 or later.
+
+## Features
+  This add-on provides the following features you can use to adapt NVDA keyboard behavior:
+
+* Beep for uppercases  when caps lock is on: if this feature is enabled, NVDA will beep when you typing an uppercase and caps lock is on. Don't make any more uppercase mistakes!
+* Beep for typed characters when shift is pressed: with this feature NVDA will beep if you type a character with shift key pressed.
+* Beep for toggle keys changes: with this feature, NVDA will beep higher if a toggle key goes on, and lower tone if it goes off. Please note that Windows has a toggle keis beep function built-in on Ease of Access Center. This native feature works well if you don't use laptop keyboard layout setting.
+* Announce toggle keys changes: just when "Beep for toggle keys changes" is on. You can enable or disable NVDA to announce toggle key status.
+* Beep for specified characters: NVDA will beep for all characters that you set in advanced settings.
+* Disable beeping on password fields: this feature is enabled by default to aboid security risks. Disable it if you want to hear beeps on password fields.
+## Requirements
+  You need NVDA 2018.2 or later.
+
+## Installation
+  Just install it as a NVDA add-on.
+
+## Usage
+  To enable or disable features, go to NVDA settings and select beep keyboard category. In that category you can configure all  supported features by this add-on.  
+  "Beep for uppercases  when caps lock is on" is enabled by default. 
+  If you need more settings, open the advanced settings dialog that contains the following options:
+
+* Ignored characters with shift pressed: all characters here will be ignored to beeping when shift is pressed. Escape Sequences are allowed, e.g. "\t" for tab, "\r" for carriage return.
+* Beep always for the following characters: set here all characters that you want NVDA beeps for. Escape Sequences are allowed, e.g. "\t" for tab, "\r" for carriage return.
+* Select tone to configure: you can configure parameters for all tones. Select one here, and set the parameters in the next text boxes. When change selection, NVDA will beep for the current selected tone with the current parameters set in the dialog.
+* Tone pitch: tone pitch for the current selected tone.
+* Tone length: tone length for the current selected tone.
+* Tone volume: tone volume for the current selected tone.
+* Test tone: this button lets you to play a test with the current set parameters.
+* Press OK button to save settings or cancel to discard.
+
+## Issues and suggestions reports.
+  Please report your issues and suggestions on the github repository of this project:
+  [Beep keyboard on GitHub](https://github.com/davidacm/beepKeyboard)
+
+    You can get the latest release in that repository.
diff --git a/beepKeyboard.code-workspace b/beepKeyboard.code-workspace
@@ -0,0 +1,41 @@
+{
+    "folders": [
+        {
+            "path": "."
+        }
+    ],
+    "settings": {
+        "editor.accessibilitySupport": "on",
+        "python.linting.enabled": true,
+        "python.linting.maxNumberOfProblems": 10000,
+        "python.linting.flake8Args": [
+            "--config=..\\..\\nvda\\tests\\lint\\flake8.ini",
+    "--use-flake8-tabs=true"
+        ],
+        "python.linting.flake8Enabled": true,
+        "python.linting.pylintEnabled": false,
+        "python.autoComplete.extraPaths": [
+            "addon", 
+            "../../nvda/source",
+            "../../nvda/include/comtypes",
+            "../../nvda/include/configobj/src",
+            "../../nvda/include/pyserial",
+            "../../nvda/include/wxPython",
+            "../../nvda/miscDeps/python"
+        ],
+        "files.insertFinalNewline": true,
+        "files.trimFinalNewlines": true,
+        "editor.insertSpaces": false,
+        "python.testing.unittestArgs": [
+            "-v",
+            "-s",
+            "tests.unit",
+            "-p",
+            "test_*.py"
+        ],
+        "python.testing.pytestEnabled": false,
+        "python.testing.nosetestsEnabled": false,
+        "python.testing.unittestEnabled": false
+    }
+    
+}
diff --git a/buildVars.py b/buildVars.py
@@ -19,7 +19,7 @@
 	# Translators: Long description to be shown for this add-on on add-on information from add-ons manager
 	"addon_description" : _("""This add-on beeps with some keyboard events."""),
 	# version
-	"addon_version" : "1.3",
+	"addon_version" : "1.6b",
 	# Author(s)
 	"addon_author" : u"David CM <dhf360@gmail.com>",
 	# URL for the add-on documentation support
@@ -29,7 +29,7 @@
 	# Minimum NVDA version supported (e.g. "2018.3.0")
 	"addon_minimumNVDAVersion" : "2018.3.0",
 	# Last NVDA version supported/tested (e.g. "2018.4.0", ideally more recent than minimum version)
-	"addon_lastTestedNVDAVersion" : "2019.3.0",
+	"addon_lastTestedNVDAVersion" : "2020.2.0",
 	# Add-on update channel (default is stable or None)
 	"addon_updateChannel" : None,
 }
diff --git a/readme.md b/readme.md
@@ -5,6 +5,46 @@ Copyright (C) 2019 David CM <dhf360@gmail.com>
 
 This package is distributed under the terms of the GNU General Public License, version 2 or later.
 
+## Download.
+ The latest release is available to [download in this link](https://davidacm.github.io/getlatest/gh/davidacm/beepKeyboard)
+
+# Contributing to this project.
+### Donations.
+  If you like my project or this software is useful for you in your daily life and you would like to contribute in some way, you can donate via paypal in the
+  [donate link.](https://paypal.me/davicm)
+
+  let me know if you want to write a message or promote a link in the collaboration section.
+
+### fixing bugs and new features.
+  If you want to fix a bug or add new feature, You will need to fork this repository.
+
+  #### Forking the repository.
+  If this is your first contribution, you will first need to "fork" the BeepKeyboard repository on GitHub:
+
+  1. Fork this repo in your github account.
+  2. Clone your forked repo locally: "git clone yourRepoUrl".
+  3. Add this repo in your forked repo from the command line:  
+  "git remote add davidacm https://github.com/davidacm/beepKeyboard.git".
+  4. fetch my branches:  
+  "git fetch davidacm".
+  5. Switch to the local master branch: "git checkout master".
+  6. Set the local master to use the davidacm  master as its upstream:  
+  "git branch -u davidacm/master".  
+
+#### Steps before coding.
+  You must use a separate "topic" branch for each issue or feature. All code should usually be based on the latest commit in the official master branch at the time you start the work.
+  So, before begin to work, do the following:
+
+  1. Remember the steps of "Forking the repository" section.
+  2. Checkout to master branch: "git checkout master".
+  3. Update the local master: "git pull".
+  4. Create a new branch based on the updated master branch: "git checkout -b YourNewBranch".
+  5. write your code.
+  6. Add your work to be commited (clean unwanted files first): git "add ."
+  7. create a commit: "git commit" and write the commit message.
+  8. push your branch in your repository: "git push". if the branch doesn't exist, git will tell you how to deal with this.
+  9. Request a pull request on my repository.
+
 ## Features
   This add-on provides the following features you can use to adapt NVDA keyboard behavior:
 
@@ -32,4 +72,4 @@ This package is distributed under the terms of the GNU General Public License, v
 * Tone length: tone length for the current selected tone.
 * Tone volume: tone volume for the current selected tone.
 * Test tone: this button lets you to play a test with the current set parameters.
-* Press OK button to save settings or cancel to discard.
+* Press OK button to save settings or cancel to discard.
diff --git a/sconstruct b/sconstruct
@@ -97,9 +97,9 @@ def createAddonHelp(dir):
 		cssPath = os.path.join(docsDir, "style.css")
 		cssTarget = env.Command(cssPath, "style.css", Copy("$TARGET", "$SOURCE"))
 		env.Depends(addon, cssTarget)
-	if os.path.isfile("readme.md"):
+	if os.path.isfile("addonReadme.md"):
 		readmePath = os.path.join(docsDir, "en", "readme.md")
-		readmeTarget = env.Command(readmePath, "readme.md", Copy("$TARGET", "$SOURCE"))
+		readmeTarget = env.Command(readmePath, "addonReadme.md", Copy("$TARGET", "$SOURCE"))
 		env.Depends(addon, readmeTarget)
 
 def createAddonBundleFromPath(path, dest):
