Added C# and AutoHotkey examples for controller client DLL by DojoMike · Pull Request #7010 · nvaccess/nvda

DojoMike · 2017-03-24T01:26:18Z

Hey there,
First off, let me just say you guys are awesome!! I really appreciate your hard work to make NVDA as amazing as it is. Thank you very much!

Anyway, I'm new to contributing on GitHub, so please don't hesitate to correct me if I'm way out in left field someplace, but it's my understanding that pull requests are the way to go. This pull request provides 2 more examples of how to use the NVDA controller client DLL; the languages are C# ("c sharp") and AutoHotKey. The AutoHotKey example is similar to the other examples, and the C# is a complete wrapper class for the DLL (since C# uses classes for everything).

feerrenrut · 2017-04-10T08:24:35Z

@DojoMike Thanks for the contribution. If you haven't done so already, please take a look at the developer guide and the contributor guide.

feerrenrut

Great work! I picked up a few things but nothing major.

I understand that the other example files do not have copyright headers, but please add the following to your two new files, replacing <FILENAME.EXT> with the filename and <YOUR NAME> with your name.

#<FILENAME.EXT>
#A part of NonVisual Desktop Access (NVDA)
#Copyright (C) 2007-2017 NV Access Limited, <YOUR NAME>
#This file is covered by the GNU General Public License.
#See the file COPYING for more details.

Thanks!

feerrenrut · 2017-04-10T08:27:29Z

+        /// Tells NVDA to speak a string of text
+        /// </summary>
+        /// <param name="text">The text to speak</param>
+        /// <param name="interrupt">If true, NVDA will stop whatever it's saying at th emoment and immediately speak the string</param>


Minor: "th" needs an e to be "the"

feerrenrut · 2017-04-10T08:53:18Z

+        }
+
+        /// <summary>
+        /// Tells NVDA to braille a string of text (UNTESTED)


I assume this is labelled as untested because you do not have a braille display? To test braille output consider: https://github.com/nvaccess/nvda/wiki/Testing-braille-output-without-a-braille-display

Thanks for this great link! I don't read Braille well enough to invest in a custom device, but this should help me put the examples through some additional testing.

No problem, let me know when you are happy with this and we can incubate the changes (which is the process of merging your changes into the next branch for a period of 2 weeks to allow testing from a wider audience before merging to master)

@DojoMike did you test this? If you are happy with it, please remove the (UNTESTED) comment and we can progress this issue. Thanks!

feerrenrut · 2017-04-10T08:54:19Z

+        /// Tells NVDA to braille a string of text (UNTESTED)
+        /// </summary>
+        /// <param name="text">The text to braille</param>
+        /// <param name="interrupt">If true, NVDA will stop whatever it's brailling at th emoment and immediately braille the string</param>


Minor: The "e" from "the" is on the "emoment"

jcsteh · 2017-04-12T02:07:26Z

The controller client is covered by the GNU LGPL (not the GPL) and I think it makes sense for the examples to be covered under the LGPL as well, just in case someone wants to use them (or parts of them) as-is. So, the copyright lines should say: #Copyright (C) 2017 NV Access Limited, <YOUR NAME> #This file is covered by the GNU Lesser General Public License, version 2.1. #See the file license.txt for more details.

DojoMike · 2017-04-13T01:12:52Z

Hey there,

Sorry for the late response. I will be out of town this weekend, but will read the guides (thank for those btw) and make the requested changes as soon as possible. Thanks!

feerrenrut · 2018-04-11T07:00:16Z

+        }
+
+        /// <summary>
+        /// Tells NVDA to braille a string of text (UNTESTED)


@DojoMike did you test this? If you are happy with it, please remove the (UNTESTED) comment and we can progress this issue. Thanks!

derekriemer · 2018-04-16T18:13:07Z

I'm about to embark on a project with school and I need the controller client from c# for this (it's for an a11y class actually and we're prototyping some pretty neat things, more info on that later). I'm happy to provide you with a test of the braille code if you want.

DojoMike · 2018-04-17T00:33:28Z

@derekriemer Yes, please do test this! Things kinda went sideways with my workload and I almost forgot all about this. But fans of the DLL (like myself lol) should definitely have access to the examples. Thanks!

PS: Just out of curiosity, where is the source code for the DLL itself? Someday when I've studied up on all the guides I still have to read, and have a better understanding of how it all works under the hood, I'd like to see if I can contribute to that too. :)

feerrenrut · 2018-04-17T02:25:08Z

@DojoMike In anticipation of derekriemer's testing, could you please remove the "untested" comment? As for the source code of the DLL, I believe this is implemented in python, within source/NVDAHelper.py.

DojoMike · 2018-04-20T02:11:16Z

Okay, so... noobie question here... how I get my repo caught up with all the latest changes since I last worked on this? Sorry, this is suuuuper new territory for me, cuz I have a repo on my desktop that has a remote (here on github) which has another remote (NVDA) so it's a bit more convoluted than a simple "git pull", especially since github has a completely different UI from Git GUI (or even Git Bash). I've Googled around for a bit but mostly found unrelated forum posts. At this point the best strategy I can dream up is:

Copy my existing code to text files
Delete this repo
Create a new fork
Make my changes to the updated repo
Re-submit the pull request? lol idk... so sorry about all this
Or, much easier:
You guys copy my code and do with it what you will. I don't even care if it has my screen name on it; it's the contribution to NVDA that matters most IMO. :)

PS: DLLs in Python? How is that even possible? I've written DLLs in C, C++, and C#, and I know there's a ".pyd" file (conceptually similar to a DLL but not the same thing). Anyway thanks for hangin' in there with me.

derekriemer · 2018-04-20T06:50:56Z

The code @feerrenrut is seeing is a callback in NVDAHelper.dll (or one of the helper dll's. I think it uses rpc under the hood, although I don't know where the controller source lives.

derekriemer · 2018-04-20T06:54:28Z

For git, you need to do the following.
Assume you have two remotes, one called nvaccess and origin. nvaccess points at the nvaccess repo and origin is your branch.

git checkout master 
git fetch nvaccess
git merge nvaccess/master
or, instead of those two steps, do this.
git pull nvaccess master
git checkout <your topic branch>
git merge master
//make changes
git add source/foo source/bar source/baz
git commit -m "blah blah blah blah blah"
git push -u origin <branch name> #only need -u once, to set the topic branches upstream remote to origin.

Now in future, git push suffices.
Be careful, I've done a git push origin master on several occasions. It will protect you unless you do a force push (don't do that).

ehollig · 2018-10-03T17:18:47Z

Any progress on this PR @DojoMike or do you need any assistance?

Adriani90 · 2019-01-05T15:24:00Z

@DojoMike do you have any update on this?

LeonarddeR · 2019-05-14T09:53:05Z

@DojoMike: This is a last heads up to kindly ask you whether you're intending to finish your work on this. If not, I'm afraid we have to close this. Having said that, happy for anyone who wants to take this.

Adriani90 · 2019-05-14T13:58:57Z

cc: @abdel792, @DataTriny, @dglee42, @codeofdusk maybe anyone of you could be interested in taking this over?

abdel792 · 2019-05-14T16:20:38Z

Hi @DojoMike,

I join Reef in thanking you for this interesting contribution.

I hope it will be added soon.

Kind regards.

DataTriny · 2019-05-16T13:39:56Z

Hello, I can definitely work on the C# part. Le mar. 14 mai 2019 à 18:20, abdel792 <notifications@github.com> a écrit :

…

Hi @DojoMike <https://github.com/DojoMike>, I join Reef in thanking you for this interesting contribution. I hope it will be added soon. Kind regards. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#7010?email_source=notifications&email_token=AC3JTEDXV5WLBQ7PUTKEDZLPVLRFVA5CNFSM4DE6IIW2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODVMANRA#issuecomment-492308164>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AC3JTEHPNUZY3WWVQBZNSLLPVLRFVANCNFSM4DE6IIWQ> .

DataTriny · 2019-05-20T13:20:28Z

Hello everyone,
As I promissed, I worked on the C# example and just submitted #9600.

Adriani90 · 2019-05-21T19:03:45Z

@feerrenrut you closed this one, as far as I understand there are also AutoHotkey examples for controller client to be added. It this not intended? PR #9600 adds the C# examples which is one part of this work. @DataTriny many thanks for your work.

feerrenrut · 2019-05-22T10:27:56Z

@Adriani90 That is true, but we seem to have lost contact with the author of this, and we don't have access to push to this branch (and thus rectify this PR). I can't see any point in keeping a PR open that we can not merge. Anyone who is willing to create a new PR for the autoHotKey examples is welcome to do so.

DataTriny · 2019-05-22T11:28:41Z

You're welcome @Adriani90.
Just to clarify: I wont work on the AutoHotkey example because I am not familiar with it, and don't have the time to do so.

Added C# and AutoHotkey examples for controller client DLL

ba65210

feerrenrut self-requested a review April 10, 2017 08:16

feerrenrut suggested changes Apr 10, 2017

View reviewed changes

Fixed typo and added required copyright notice

d32552b

feerrenrut suggested changes Apr 11, 2018

View reviewed changes

LeonarddeR added AfterPython3Transition and removed AfterPython3Transition labels Apr 24, 2019

feerrenrut removed AfterPython3Transition labels May 8, 2019

DataTriny mentioned this pull request May 20, 2019

Added C# example for NVDA controller client DLL #9600

Merged

feerrenrut closed this May 21, 2019

Uh oh!

Conversation

DojoMike commented Mar 24, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

feerrenrut commented Apr 10, 2017

Uh oh!

feerrenrut left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

feerrenrut Apr 10, 2017

Choose a reason for hiding this comment

Uh oh!

feerrenrut Apr 10, 2017

Choose a reason for hiding this comment

Uh oh!

DojoMike Apr 24, 2017

Choose a reason for hiding this comment

Uh oh!

feerrenrut Apr 25, 2017

Choose a reason for hiding this comment

Uh oh!

feerrenrut Apr 11, 2018

Choose a reason for hiding this comment

Uh oh!

feerrenrut Apr 10, 2017

Choose a reason for hiding this comment

Uh oh!

jcsteh commented Apr 12, 2017 via email

Uh oh!

DojoMike commented Apr 13, 2017

Uh oh!

feerrenrut Apr 11, 2018

Choose a reason for hiding this comment

Uh oh!

derekriemer commented Apr 16, 2018

Uh oh!

DojoMike commented Apr 17, 2018

Uh oh!

feerrenrut commented Apr 17, 2018

Uh oh!

DojoMike commented Apr 20, 2018

Uh oh!

derekriemer commented Apr 20, 2018

Uh oh!

derekriemer commented Apr 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ehollig commented Oct 3, 2018

Uh oh!

Adriani90 commented Jan 5, 2019

Uh oh!

LeonarddeR commented May 14, 2019

Uh oh!

Adriani90 commented May 14, 2019

Uh oh!

abdel792 commented May 14, 2019

Uh oh!

DataTriny commented May 16, 2019 via email

Uh oh!

DataTriny commented May 20, 2019

Uh oh!

Adriani90 commented May 21, 2019

Uh oh!

feerrenrut commented May 22, 2019

Uh oh!

DataTriny commented May 22, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

DojoMike commented Mar 24, 2017 •

edited

Loading

feerrenrut left a comment •

edited

Loading

derekriemer commented Apr 20, 2018 •

edited

Loading