Added configure.sh and accompanying doc #82

CodeCanna · 2019-03-13T15:21:10Z

Ready for review and testing.

…dded a config_help to display help for configure.sh.

atar-axis · 2019-03-13T15:40:24Z

will give it a try tonight, thank you very much so far :)
btw, codacy complains about an unused ARGS variable, it it a bug or is it codacy which is wrong?

atar-axis · 2019-03-13T18:03:53Z

The script is not able to detect my (installed, but not active) xpadneo instance:

flood@flood-r3:[xpadneo]$ sudo ./configure.sh 
[sudo] Passwort für flood: 
Installaion not detected, did you run install.sh?

I guess this is because I had an older version installed - therefore you should also check for older versions and complain if the version does not fit the configure script :)

Btw, there is a typo: "Installaion"

Another thing is, that we should maybe additionaly permanently change the options using modprobe, as described in the README - this does also work if the module is not loaded :)

CodeCanna · 2019-03-13T22:43:51Z

Should the script run if a different version is detected?

atar-axis · 2019-03-13T22:47:48Z

No, I think it would be enough to report an error - otherwise we would have to check if a given parameter is available in the installed version. That's too much I think :)

CodeCanna · 2019-03-13T23:10:06Z

Okay, so now the script checks if the version is the same as the number in the VERSION file in the xpadneo directory, and throws a warning before exiting.

atar-axis · 2019-03-13T23:20:28Z

Perfect, the only thing missing now is the permanent change in /etc/modprobe.d/xpadneo.conf 😊

CodeCanna · 2019-03-14T01:33:02Z

So just to be sure, in order to make changes permanent you put options hid_xpadneo debug_level=3 in xpadneo.conf. If I want to do disable_ff I would put options hid_xpadneo disable_ff=true and so on, is it all the same for each option?

atar-axis · 2019-03-14T06:06:22Z

I hope this helps: https://wiki.archlinux.org/index.php/Kernel_module#Setting_module_options

atar-axis · 2019-03-14T08:31:36Z

To take it short: yes! The only thing you need to take care about is to not overwrite existing options - you may need to parse an existing xpadneo.conf therefore in advance to preserve settings which are already there.

CodeCanna · 2019-03-14T16:24:19Z

I'm a little confused about parsing the conf file. I was thinking of using echo to put the appropriate line into the conf like:

echo "options hid_xpadneo debug_level=2" >> /etc/modprobe.d/99-xpadneo-bluetooth.conf

But I think that would cause duplicate lines if that option was changed more than once. Is that why you use tee in the example?

will give it a try tonight, thank you very much so far :)
btw, codacy complains about an unused ARGS variable, it it a bug or is it codacy which is wrong?

Also sorry, I didn't see the rest of this post, I didn't see where you asked about the variable. It was the $ARGS variable which didn't end up being used.
And thank you for letting me work on this, I this is the first thing I have found that I can put my coding to actual work, It means a LOT to me I have been stagnant and not knowing what to code; and have been trying to get into open source contributions for while.

CodeCanna · 2019-03-14T19:38:09Z

Ah looks like I can use sed for this. A new command for me.

CodeCanna · 2019-03-14T23:42:03Z

I need an opinion, should I add all of the config lines in /etc/modprobe.d/xpadneo.conf when the script runs. Because the only line that is in there by default is options bluetooth disable_ertm=y, and sed won't edit the line if it doens't exist. So I have come up with either echoing all the config lines into the file when the script is ran, or using grep to check if the line exists or not, and if not to create it so sed can edit it.

atar-axis · 2019-03-15T09:36:48Z

It means a LOT to me

I can remember that time :)
I am happy that it is fun to you too

Ah looks like I can use sed for this

Right! sed is the way to go I think, or perl - which regex syntax is a bit easier. Parsing the config file is maybe the Most difficult part of this Script

I need an opinion

options bluetooth ... has nothing to do with the xpadneo configs, it's just in the same file.
I think thats clear, right?

So I have come up with either echoing all the config lines into the file when the script is ran, or using grep to check if the line exists or not, and if not to create it so sed can edit it.

The latter option sounds better to me - in the end it is up to you, as long as the solution is robust and clean ;)

CodeCanna · 2019-03-15T20:46:45Z

options bluetooth ... has nothing to do with the xpadneo configs, it's just in the same file.
I think thats clear, right?

No the file has that line in it by default. When I opened the config file that line was already in there. Is it supposed to be empty?

EDIT: Also I agree that the best way is to use grep, but I have to put that in every option. I was thinking of making a function that does that and call that function, but I don't seem to understand how to pass parameters in functions in bash.

Do you know how I could put this:

if grep -q "trigger_rumble_damping" "$CONF_PATH"
    then
      # If line exists modify it.
      echo $NAME:"Value written to $CONF_PATH"
      sed -i 's/options hid_xpadneo trigger_rumble_damping=.*/options hid_xpadneo trigger_rumble_damping='$val'/' $CONF_PATH
    else
      # If line does not exist, create it.
      echo $NAME:"Value written to $CONF_PATH"
      echo "options hid_xpadneo trigger_rumble_damping=$val" >> $CONF_PATH
    fi

in a function so I don't have to type this out for each option. I know how to basically make a function in bash but I don't know how to make this function work with all the different options because I can't pass parameters like in a normal programming language.

EDIT: Something like this seems to work, for figuring out what argument was passed to the script:

function change_line() {
	case $ARG in
		"Noodle" | "noodle")
			echo "This function will work on Noodle";;

		"Crayon" | "crayon")

			echo "This function will work on Crayon";;

		"Apples" | "apples")

			echo "This function will work on Apples";;

		"Spaghetti" | "spaghetti")

			echo "This function will work on Spaghetti";;

		"Cereal" | "cereal")

			echo "This function will work on Cereal";;

			*)

			echo "Arg not recognized"
	esac
}

But I need to see if I can use grep to recognize what line to edit based on the argument passed, which is where my dilemma is.

atar-axis · 2019-03-15T23:22:34Z

Everything is alright, this Line is in there to disable the faulty ERTM in Linux which prevents a sucessful connection with the gamepad 😊

CodeCanna · 2019-03-16T19:57:35Z

I might have found a better aproach to using bash to parse the config file. I have seen that Python has a good library for this. What do you think?

atar-axis · 2019-03-16T20:35:02Z

I don't like the idea of adding another dependency for this little script - not everybody has Python installed. If you don't like Shell scripts, then I would suggest perl, which is installed in most (all?) Distributions. 😊

CodeCanna · 2019-03-16T21:17:22Z

Hmm never thought about perl. Is it a big language in linux? I'll look into it. If that doesn't work and time isn't an issue I will figure something out. If time is an issue I have a method that will work, it will just be redundant. I'm just really trying to use a function instead of writing the same code for each option to parse the config file.

atar-axis · 2019-03-16T21:25:06Z

Time is not a problem - don't worry, that's the good thing in open source projects like this 😊

CodeCanna · 2019-03-16T22:36:35Z

Awesome, I felt like I was taking too long. I'm glad, now I can take time to really learn some of these concepts. 😌

atar-axis · 2019-03-16T23:01:01Z

I opened this issue two month ago, take your time ;)

CodeCanna · 2019-03-19T07:11:22Z

Alright!! Give that a try, I rewrote the entire thing. I discovered this awesome handy tool that everyone else probably knows about already called getopt. Made it soooo much easier and cleaner. And I stuck everything into functions this time. I had a good time writing this one! 😃

atar-axis · 2019-04-03T20:20:36Z

Yeah, just give the suggestion a try - it's not super important to do it this way but it looks a bit clearer.
I will give it a try a bit later

CodeCanna · 2019-04-03T20:22:15Z

No really a reason, that's just the way I grabbed the version number from the file name. I will use the one in update.sh. It doesn't seem to be working for me though.

DETECTED_VERSION=$(dkms status 2>/dev/null | grep '^hid-xpadneo' 2>/dev/null | sed -E 's/^hid-xpadneo, ([0-9]+.[0-9]+.[0-9]+).*installed/\1/')

when i echo $DETECTED_VERSION, its empty. I'll fiddle with it, and see what happens :)

EDIT: I echoed the $INSTALLED in update.sh and it's also blank, I think I'm missing something. No rush though get back to me when you can :)

atar-axis · 2019-04-03T20:35:10Z

that's not so important, keep your way - we can do that later ;)

atar-axis · 2019-04-07T07:10:49Z

Hey hey, I will give it a try today :) Thank you for your work!

atar-axis · 2019-04-07T08:20:25Z

I like it! It works like a charm so far :)
Haven't had a look into the code but I will do that later.
Thank you for your contribution so far!

One thing I would like to mention:
combined_z_axis=0 is the default value which you are echoing, but combined_z_axis=y/n is the one which you are replacing. both are fine, but just keep it consistent please :)

Are you going to fix the Shellcheck issues? Tell me if there is a reason to prefer the existing way over the one mentioned by codacy/code climate

Ah and another thing: If the user does run the script without any option then - at least in my eyes - the help message should be shown too, right? So ./configure.sh -h should behave the same as ./configure.sh

CodeCanna · 2019-04-07T16:11:56Z

I like it! It works like a charm so far :)

That is so great to hear!!

Thank you for your contribution so far!

It was my pleasure and my joy, I have learned SO much in the past month or so working on this. It's been great!

Are you going to fix the Shellcheck issues? Tell me if there is a reason to prefer the existing way over the one mentioned by codacy/code climate

There is no preference, that's just the only way I know to do it, but I would love to learn a better way. I tried copying this line from update.sh:

VERSIONS=($(dkms status 2>/dev/null | grep '^hid-xpadneo,' 2>/dev/null | sed -E 's/^hid-xpadneo, ([0-9]+.[0-9]+.[0-9]+).*/\1/'))

however I could not get it to work right. When I echo $VERSIONS its empty, I am probably not doing it right. I'll mess around with it again and show you what I am trying.

combined_z_axis=0 is the default value which you are echoing, but combined_z_axis=y/n is the one which you are replacing. both are fine, but just keep it consistent please :)

I can fix that no problem.

Ah and another thing: If the user does run the script without any option then - at least in my eyes - the help message should be shown too, right? So ./configure.sh -h should behave the same as ./configure.sh

This is a great idea, I will add this as well. I never thought of it but it is true that most commands show the help menu when no arguments are called.

CodeCanna · 2019-04-07T17:09:17Z

So I took that line from the update.sh and put it in my script and echoed it and it is empty.

atar-axis · 2019-04-07T18:52:18Z

What's the Output of dkms status in your system

CodeCanna · 2019-04-07T19:41:14Z

I'm out and about, I'll message you when I get home.

CodeCanna · 2019-04-07T21:33:48Z

Output of dkms status:

Error! Could not locate dkms.conf file.
File: /var/lib/dkms/hid-xpadneo/0.5.4/source/dkms.conf does not exist.

Looks like I'm missing something. I'll see what I can find as far as a fix.

CodeCanna · 2019-04-07T21:37:19Z

A few possible fixes are this and this. Unfortunately I don't know much about dkms yet, but I'll read through these to see if I can find anything.

…no args passed to display the help doc

codeclimate · 2019-04-07T21:39:57Z

configure.sh

+NAME="$0"
+OPTS=$(getopt -n "$NAME" -o hz:d:f:v:r: -l help,version,combined-z-axis:,debug-level:,disable-ff:,fake-dev-version:,trigger-rumble-damping: -- "$@")  # Use getopt NOT getopts to parse arguments.
+
+echo "$VERSIONS"


Expanding an array without an index only gives the first element.

atar-axis · 2019-04-07T21:44:21Z

Run the Uninstall Script
Remove /var/lib/dkms/xpadneo...
Run dkms Status again

CodeCanna · 2019-04-07T21:49:11Z

Ok I ran the uninstall script and it said it found 0 instances of xpadneo.
I removed /var/lib/dkms/hid-xpadneo/
I ran dkms status and now it outputs nothing.

atar-axis · 2019-04-07T21:50:15Z

Perfect, run the Install Script now - it should Work then

CodeCanna · 2019-04-07T21:52:33Z

Nice! It works now. I will replace that line and push that.

codeclimate · 2019-04-07T21:54:48Z

configure.sh

+NAME="$0"
+OPTS=$(getopt -n "$NAME" -o hz:d:f:v:r: -l help,version,combined-z-axis:,debug-level:,disable-ff:,fake-dev-version:,trigger-rumble-damping: -- "$@")  # Use getopt NOT getopts to parse arguments.
+
+echo "$VERSIONS"


Possible misspelling: VERSIONS may not be assigned, but VERSION is.

codeclimate · 2019-04-07T21:54:48Z

configure.sh

+
+# Check if version is out of date.
+function check_version {
+  if [[ "$VERSION" != "$DETECTED_VERSION" ]];


Expanding an array without an index only gives the first element.

codeclimate · 2019-04-07T21:54:48Z

configure.sh

+  then
+    echo "$NAME:Your version of xpadneo seems to be out of date."
+    echo "$NAME:Please run ./update.sh from the git directory to update to the latest version."
+    echo "$DETECTED_VERSION"


Expanding an array without an index only gives the first element.

codeclimate · 2019-04-07T21:54:48Z

configure.sh

+
+## Version ##
+function display_version {
+  echo "Xpadneo Version: $DETECTED_VERSION"


Expanding an array without an index only gives the first element.

codeclimate · 2019-04-07T21:59:34Z

Code Climate has analyzed commit b0d0c1a and detected 0 issues on this pull request.

View more on Code Climate.

atar-axis · 2019-04-07T22:06:28Z

Perfect :) I will merge your work into master tomorrow/later - I think it is ready now :) See ya later!

CodeCanna · 2019-04-07T22:10:33Z

Sounds great to me, thanks for you patience and letting me work on this. If I have an idea for your driver do I open a new issue? You might already be working on what I am thinking though. I was thinking that it would be great if this worked with the wireless USB dongle instead of just bluetooth. Let me know what you think.

atar-axis · 2019-04-08T08:50:15Z

Merged by 769429b
Congratulations!

CodeCanna added 2 commits March 13, 2019 09:10

Wrote a configure.sh script to assist users with configuration, and a…

86a1ac2

…dded a config_help to display help for configure.sh.

Added some comments

74834db

Removed unused variable

f2933ac

Fixed a problem with differing versions, added version check.

95384ad

Rewrote configure.sh, and config_help

db70a5e

CodeCanna added 3 commits March 19, 2019 01:16

Added version check

20ac2ab

Switched the order of some variables around

fd49494

Added comments

c1161a6

Trimmed up code, removed uneeded comments

8848fd4

atar-axis self-requested a review April 7, 2019 08:27

Put y or n instead of 0 and 1 for some bool options, and checked for …

2258b9e

…no args passed to display the help doc

codeclimate bot reviewed Apr 7, 2019

View reviewed changes

Grabbed version number with DKMS instead of echo and sed

21ba052

codeclimate bot reviewed Apr 7, 2019

View reviewed changes

CodeCanna added 2 commits April 7, 2019 15:56

Removed uneeded test code

a533c74

Fixed typos

b0d0c1a

atar-axis mentioned this pull request Apr 8, 2019

Add a configure.sh sript #69

Closed

atar-axis closed this Apr 8, 2019

habakuk1979 mentioned this pull request Jul 18, 2021

CSR8510 A10 - BLE dongle stability issues #304

Closed

This pull request was closed.

Added configure.sh and accompanying doc #82

Added configure.sh and accompanying doc #82

Conversation

CodeCanna commented Mar 13, 2019

atar-axis commented Mar 13, 2019 • edited Loading

atar-axis commented Mar 13, 2019 • edited Loading

CodeCanna commented Mar 13, 2019

atar-axis commented Mar 13, 2019

CodeCanna commented Mar 13, 2019 • edited Loading

atar-axis commented Mar 13, 2019

CodeCanna commented Mar 14, 2019

atar-axis commented Mar 14, 2019

atar-axis commented Mar 14, 2019 • edited Loading

CodeCanna commented Mar 14, 2019 • edited Loading

CodeCanna commented Mar 14, 2019

CodeCanna commented Mar 14, 2019

atar-axis commented Mar 15, 2019 • edited Loading

CodeCanna commented Mar 15, 2019 • edited Loading

atar-axis commented Mar 15, 2019

CodeCanna commented Mar 16, 2019

atar-axis commented Mar 16, 2019 • edited Loading

CodeCanna commented Mar 16, 2019

atar-axis commented Mar 16, 2019

CodeCanna commented Mar 16, 2019

atar-axis commented Mar 16, 2019

CodeCanna commented Mar 19, 2019

atar-axis commented Apr 3, 2019

CodeCanna commented Apr 3, 2019 • edited Loading

atar-axis commented Apr 3, 2019

atar-axis commented Apr 7, 2019

atar-axis commented Apr 7, 2019 • edited Loading

CodeCanna commented Apr 7, 2019

CodeCanna commented Apr 7, 2019

atar-axis commented Apr 7, 2019

CodeCanna commented Apr 7, 2019

CodeCanna commented Apr 7, 2019

CodeCanna commented Apr 7, 2019

codeclimate bot Apr 7, 2019

Choose a reason for hiding this comment

atar-axis commented Apr 7, 2019

CodeCanna commented Apr 7, 2019

atar-axis commented Apr 7, 2019

CodeCanna commented Apr 7, 2019

codeclimate bot Apr 7, 2019

Choose a reason for hiding this comment

codeclimate bot Apr 7, 2019

Choose a reason for hiding this comment

codeclimate bot Apr 7, 2019

Choose a reason for hiding this comment

codeclimate bot Apr 7, 2019

Choose a reason for hiding this comment

codeclimate bot commented Apr 7, 2019

atar-axis commented Apr 7, 2019

CodeCanna commented Apr 7, 2019

atar-axis commented Apr 8, 2019 • edited Loading

atar-axis commented Mar 13, 2019 •

edited

Loading

atar-axis commented Mar 13, 2019 •

edited

Loading

CodeCanna commented Mar 13, 2019 •

edited

Loading

atar-axis commented Mar 14, 2019 •

edited

Loading

CodeCanna commented Mar 14, 2019 •

edited

Loading

atar-axis commented Mar 15, 2019 •

edited

Loading

CodeCanna commented Mar 15, 2019 •

edited

Loading

atar-axis commented Mar 16, 2019 •

edited

Loading

CodeCanna commented Apr 3, 2019 •

edited

Loading

atar-axis commented Apr 7, 2019 •

edited

Loading

atar-axis commented Apr 8, 2019 •

edited

Loading