EndUser_setup will now be able to accept multiple other inputs via th… #2132

Jcrash29 · 2017-10-12T02:12:51Z

Hey guys,

Feel free to tear the code apart, this is my first time making a PR to project with which I didn't know the dev team.

This code is working, but still has some debug code in there for items I was confused about.

What it does:

Allows for inputs to be added to the .html file for enduser_setup and those extra inputs can be added to a JSON file for later extraction and use.

links to similar PR's:

#1886

…e .html page generated. These inputs will be saved to the file system under a JSON file which can than be read, and used further by the system.

jmattsson

It's a feature that would be really good to have. It'll need a bit of work before it's ready for merging though.

jmattsson · 2018-01-05T01:30:42Z

app/modules/enduser_setup.c

+)
+{
+  int p_file = 0;
+  lua_State *L = NULL;


Stylistically I'd prefer to see these declared right before use rather than old-C style top-of-function.

jmattsson · 2018-01-05T01:31:27Z

app/modules/enduser_setup.c

+  ENDUSER_SETUP_DEBUG("enduser: opening enduser_custom_parameters.json for write");
+
+  // setup the file output
+  p_file = vfs_open("enduser_custom_parameters.json", "w");


May I suggest a shorted filename? Perhaps "eus_custom.json"? Feels like a lot of characters to type otherwise.

Actually, is it guaranteed to even be JSON? If not, maybe "eus_custom.txt"?

jmattsson · 2018-01-05T01:33:08Z

app/modules/enduser_setup.c

+
+    err |= enduser_setup_http_urldecode(decoded_config_str, config_str_start, config_str_len, sizeof(decoded_config_str));
+
+    enduser_setup_write_file_with_extra_configuration_data(decoded_config_str, config_str_len);


The return value of enduser_setup_write_file_with_extra_configuration_data() is being ignored here. It probably shouldn't be. Also, that's one long function name. Quite descriptive though, can't argue with that :)

jmattsson · 2018-01-05T01:35:36Z

app/modules/enduser_setup.c

+    return 1;
+  }
+
+  /* Not certain what this does */


This gets you the correct Lua context to work on. Note that this lua_State stack might already be in use, so care must be taken to ensure that the stack is left in the same condition as when the function was entered. Weird Stuff(tm) happens otherwise, of the variety that's hard to track down.

jmattsson · 2018-01-05T01:38:11Z

app/modules/enduser_setup.c

+
+  if (L != NULL) 
+  {
+    lua_pushlstring(L, configuration_string, configuration_length);


Without the lua_call() below, this will end up leaving the stack in an inconsistent state. I'd suggest moving this down to the same block, there's no reason not to from what I can see.

jmattsson · 2018-01-05T01:47:37Z

app/modules/enduser_setup.c

+    int config_str_len = enduser_setup_srch_str(config_str_start, "& ");
+    /* Create a new variable for storing the decoded string.
+     * Add one more size(char) to allow for \0 */
+    uint8 decoded_config_str[config_str_len+1];


Just a note of caution that the stack space is rather limited. It would be safer to os_malloc() this buffer (and later os_free() it. As-is, someone could smash the stack by submitting a really long config parameter.

jmattsson · 2018-01-05T01:48:29Z

app/modules/eus/enduser_setup.html

@@ -160,6 +160,8 @@ <h3>Connect device to your Wi-Fi</h3>
 				</div>
 				<input id=ssid type=text autocorrect=off autocapitalize=none placeholder='Wi-Fi Name' />
 				<input id=wifi_password type=text autocorrect=off autocapitalize=none autocomplete=off placeholder=Password />
+				<input id=TwitterAPI type=text autocorrect=off autocapitalize=none autocomplete=off placeholder='Twitter API Handler' />
+				<input id=TwitterMessage type=text autocorrect=off autocapitalize=none autocomplete=off placeholder='Twitter Message' />
 				<button id=submit type=button>Save</button>


These additions shouldn't be part of the default page.

jmattsson · 2018-01-05T01:49:27Z

app/modules/eus/enduser_setup.html

+			config.twitterAPI = $('#TwitterAPI').value;
+			config.twitterMessage = $('#TwitterMessage').value;
+			json = JSON.stringify(config);
+			var url = '/setwifi?wifi_ssid=' + encodeURIComponent($('#ssid').value) + '&wifi_password=' + encodeURIComponent($('#wifi_password').value) + '&config=' + encodeURIComponent(json);
 			clearTimeout(rs);


Likewise, these shouldn't be part of the default page. It'd be a good example in the docs though.

jmattsson · 2018-01-05T01:50:18Z

app/modules/eus/http_html_backup.def

@@ -1,205 +1,213 @@
 static const char http_html_backup[] = {


Again, changes should not be part of the default. Same goes for http_html_backup.def.

jmattsson · 2018-01-05T01:53:18Z

app/modules/enduser_setup.c

+ *
+ *
+ *
+ *


SPAAAAAAAAAAAAAAAAAAAAACE! :)

Jcrash29 · 2018-01-23T18:58:41Z

@jmattsson THANKS! I'll start making these changes. Really appreciate you taking the time to look at this!

marcelstoer · 2018-02-04T07:36:31Z

Johny, I'm really happy you took the time to review this PR. I was afraid no one else from us maintainers besides me thought this be a very useful addition to the current module.

marcelstoer · 2018-02-04T07:40:56Z

app/modules/eus/enduser_setup.html

@@ -160,6 +160,8 @@ <h3>Connect device to your Wi-Fi</h3>
 				</div>
 				<input id=ssid type=text autocorrect=off autocapitalize=none placeholder='Wi-Fi Name' />
 				<input id=wifi_password type=text autocorrect=off autocapitalize=none autocomplete=off placeholder=Password />
+				<input id=TwitterAPI type=text autocorrect=off autocapitalize=none autocomplete=off placeholder='Twitter API Handler' />
+				<input id=TwitterMessage type=text autocorrect=off autocapitalize=none autocomplete=off placeholder='Twitter Message' />
 				<button id=submit type=button>Save</button>


I agree with Johny here. I'm a bit surprised to see no changes to the documentation. I wouldn't want to change the default page but see documented how to change it in

the module documentation

or by creating a nice example at https://github.com/nodemcu/nodemcu-firmware/tree/master/lua_examples and linking documentation to it

davidcbittner · 2018-02-13T23:29:55Z

Has this been added? Is there any documentation available how to make use of this functionality? I had posted a request earlier about adding the host name as one of the parameters that should be set during the configuration. This is really a fundamental field which IMO should be added to the default HTML page but if it's not I'm certainly willing to save my own on there but not sure how to actually implement this.

marcelstoer · 2018-02-14T06:04:51Z

Has this been added?

As you can see this PR is still open i.e. the code is not available in the NodeMCU repository yet. Hence, if you wanted to use it right now you'd have to manually build from the author's repository https://github.com/Jcrash29/nodemcu-firmware.

Is there any documentation available how to make use of this functionality?

If you follow the conversation above you'll also see that we requested a couple of changes from the author before we'd merge the feature into our repo. One of the comments asks for (more/better) documentation.

marcelstoer · 2018-02-14T06:10:58Z

@Jcrash29 I just realized you based your work on master and created the PR accordingly. This is not in line with our contributing guidelines. We can continue the conversation here until everything is ready but eventually this has to land on dev. I propose you keep committing changes to your master (they'll show up here). When ready you can update your dev, carry over all changes and create a new PR.

davidcbittner · 2018-02-14T10:18:35Z

Marcel, thank you for the reply. I am a bit new to github and learning the procedures, flags, etc…

and7ey · 2018-04-11T19:18:38Z

Hi, is anyone working to get it implemented?

Jcrash29 · 2018-04-25T15:57:47Z

Sorry not currently. I've got a couple other projects I am addressing. I did implement several of the code changes recommended above, however have to sufficiently tested them to create a commit.

and7ey · 2018-04-28T18:27:51Z

I would suggest to modify the code in the following way:

change GET to POST when do /setwifi or /update. It will allow to pass more data.
modify javascript submit() function to send all text fields data instead of listing them manually in the code.

EndUser_setup will now be able to accept multiple other inputs via th…

6bea743

…e .html page generated. These inputs will be saved to the file system under a JSON file which can than be read, and used further by the system.

marcelstoer added the new feature label Oct 15, 2017

Jcrash29 mentioned this pull request Oct 23, 2017

Enduser setup (EUS) - Provide more hooks for code #1302

Closed

jmattsson requested changes Jan 5, 2018

View reviewed changes

marcelstoer self-requested a review February 4, 2018 07:34

marcelstoer requested changes Feb 4, 2018

View reviewed changes

marcelstoer mentioned this pull request Feb 4, 2018

enduser setup feature #2247

Closed

Gui13 mentioned this pull request Sep 20, 2018

End User Setup: Save the post data in a file on the filesystem #2493

Closed

4 tasks

marcelstoer closed this Sep 21, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EndUser_setup will now be able to accept multiple other inputs via th… #2132

EndUser_setup will now be able to accept multiple other inputs via th… #2132

Jcrash29 commented Oct 12, 2017 •

edited by marcelstoer

jmattsson left a comment

jmattsson Jan 5, 2018

jmattsson Jan 5, 2018

jmattsson Jan 5, 2018

jmattsson Jan 5, 2018

jmattsson Jan 5, 2018

jmattsson Jan 5, 2018

jmattsson Jan 5, 2018

jmattsson Jan 5, 2018

jmattsson Jan 5, 2018

jmattsson Jan 5, 2018

Jcrash29 commented Jan 23, 2018

marcelstoer commented Feb 4, 2018

marcelstoer Feb 4, 2018

davidcbittner commented Feb 13, 2018 •

edited by marcelstoer

marcelstoer commented Feb 14, 2018 •

edited

marcelstoer commented Feb 14, 2018

davidcbittner commented Feb 14, 2018 via email •

edited by marcelstoer

and7ey commented Apr 11, 2018

Jcrash29 commented Apr 25, 2018 via email •

edited by marcelstoer

and7ey commented Apr 28, 2018


		err \|= enduser_setup_http_urldecode(decoded_config_str, config_str_start, config_str_len, sizeof(decoded_config_str));

		enduser_setup_write_file_with_extra_configuration_data(decoded_config_str, config_str_len);

EndUser_setup will now be able to accept multiple other inputs via th… #2132

EndUser_setup will now be able to accept multiple other inputs via th… #2132

Conversation

Jcrash29 commented Oct 12, 2017 • edited by marcelstoer

jmattsson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jcrash29 commented Jan 23, 2018

marcelstoer commented Feb 4, 2018

Choose a reason for hiding this comment

davidcbittner commented Feb 13, 2018 • edited by marcelstoer

marcelstoer commented Feb 14, 2018 • edited

marcelstoer commented Feb 14, 2018

davidcbittner commented Feb 14, 2018 via email • edited by marcelstoer

and7ey commented Apr 11, 2018

Jcrash29 commented Apr 25, 2018 via email • edited by marcelstoer

and7ey commented Apr 28, 2018

Jcrash29 commented Oct 12, 2017 •

edited by marcelstoer

davidcbittner commented Feb 13, 2018 •

edited by marcelstoer

marcelstoer commented Feb 14, 2018 •

edited

davidcbittner commented Feb 14, 2018 via email •

edited by marcelstoer

Jcrash29 commented Apr 25, 2018 via email •

edited by marcelstoer