{"id":1358,"date":"2016-01-21T13:29:33","date_gmt":"2016-01-21T21:29:33","guid":{"rendered":"http:\/\/internetofhomethings.com\/homethings\/?p=1358"},"modified":"2016-01-21T13:37:47","modified_gmt":"2016-01-21T21:37:47","slug":"mqtt-for-app-inventor-adding-configurable-settings","status":"publish","type":"post","link":"https:\/\/internetofhomethings.com\/homethings\/?p=1358","title":{"rendered":"MQTT for App Inventor – Adding Configurable Settings"},"content":{"rendered":"

App Inventor to MQTT Communication<\/strong><\/h2>\n

In my last post<\/a>, a basic MQTT client portal for App Inventor\u00a0was introduced. As result, there has been some interest expressed for TCP socket support. Note that the\u00a0implementation presented relies on WebSockets. Due to security vulnerabilities, pure TCP sockets are simply not possible with this design. If TCP sockets are needed for MQTT communication at your IoT device, a broker capable of both WebSockets and TCP sockets should be used – Websockets on the App Inventor side, and TCP sockets on the IoT device end.<\/p>\n

Adding Configurable Setting<\/strong><\/h2>\n

My\u00a0next step was to refine the App Inventor project<\/a> to support configurable MQTT setting.<\/p>\n

NOTE: If you just want to review and use the updated App Inventor project without the walk-through\u00a0that follows, simply use the files provided in this Github\u00a0repository<\/a>.<\/strong><\/p>\n

The first challenge while adding this capability was the inability to grant file system access to the JavaScript code. Native Android Apps can overcome this with a change to the App’s manifest file. But App Inventor does not expose this application setting.<\/p>\n

So the App Inventor file component had to be used to read and write to the file system. The configuration file settings are then passed on to the JavaScript to update the MQTT connection parameters.<\/p>\n

\"mqtt_cfg\"<\/a><\/p>\n

App File Location<\/strong><\/h2>\n

This App now uses two\u00a0files stored on the Android device. These files have been moved to a common location which should be the same\u00a0on most Android devices:<\/p>\n

[wptg_comparison_table id=”15″]<\/p>\n

Configuration file<\/strong><\/h2>\n

For this example, 3 parameters are configurable:<\/p>\n

    \n
  1. Broker: This can be any on-line broker, on your own network or either publicly or privately provided.<\/li>\n
  2. Request Topic:\u00a0MQTT topic used to send a client request<\/li>\n
  3. Reply Topic: MQTT topic used to reply results to the client.<\/li>\n<\/ol>\n

    Since this example uses the publicly available broker ‘test.mosquitto.org’, username\/password authentication is not provided. You could easily be add this to the example provided here, however, if you are using a broker requiring authentication.<\/p>\n

    The file is formatted as a JSON string. This makes it very easy for the JavaScript to parse the values. The first time the App is run, these configurable parameters are set to the values shown in this JSON string:<\/p>\n

    {
    \n“mqtt_broker”:”ws:\/\/test.mosquitto.org:8080\/mqtt”,
    \n“mqtt_txtopic”:”MyMqttSvrRqst”,
    \n“mqtt_rxtopic”:”MyMqttSvrRply”
    \n}<\/p>\n

    App Inventor File Read\/Write<\/strong><\/h2>\n

    When the screen used to edit the configurable parameters is open, it first reads the cfg.txt file, extracts the parameter setting, and uses those values to populate the screen fields.<\/p>\n

    But when using App Inventor, there are no (at least none that I am aware) libraries available for parsing JSON. So I created the procedure “GetParam”, which extracts the cfg.txt values with 3 calls, one for each parameter.<\/p>\n

    \"readfile\"<\/a><\/p>\n

    Two values are determined initially\u00a0in order to extract the value. First is the position in the string that the value starts. The other value is the string length. These values are determined by using App Inventor’s string search (starts at) feature to find something unique (StartPiece and LenPiece) around the value wanted, and an offset from the parameter value’s exact position in the string.<\/p>\n

    \"getparam\"<\/a><\/p>\n

    Once extracted, the “Edit Configuration” screen is populated with the values from this file.<\/p>\n

    \"cfg_gui\"<\/a><\/p>\n

    Saving the values is just the opposite. The values from the screen are formatted into a JSON string and then saved back to the same file, cfg.txt.<\/p>\n

    \"save\"<\/a><\/p>\n

    When this screen is exited, the new configuration values are sent to the JavaScript code. The JavaScript uses these new values and closes, then opens the MQTT connection with the new values. Here is how that has been implemented…<\/p>\n

    Updated Main Screen<\/strong><\/h2>\n

    As I have gained knowledge coding with the App Inventor, it became obvious that meaningful names were needed for project components. Much to my surprise, this does not extend to the main screen. It is called “Screen1” by default, and cannot be changed.<\/p>\n

    The screen GUI was changed somewhat for this update. Two new buttons were added. One to open the configuration screen and one to exit the application. The components were also move to the bottom of the screen (don’t want to cover the mosquito, do we?).<\/p>\n

    \"main\"<\/a><\/p>\n

    Every time the main screen is open, it’s 100 ms timer restarts. That is where the command\u00a0is sent to the JavaScript to update the configuration settings.<\/p>\n

    Once.<\/p>\n

    It is sent 1\/2 second (500 ms) after the screen is open. An important note:<\/strong> I found that the command did not execute if initiated concurrently with the opening of the screen. So the 500 ms delay (5 timer iterations) was introduced using a timer, which works every time.<\/p>\n

    \"timer\"<\/a><\/p>\n

    At 500 ms, the cfg.txt file is read. “CFG:” is inserted at the beginning of the string before being sent to JavaScript via the WebViewString.<\/p>\n

    \"sendcfg\"<\/a><\/p>\n

    A handler is also included for the first time this application is run. In that case, the cfg.txt file does not exists. As result, an exception is thrown when attempting to “ReadFrom”\u00a0the file. An error handler was added for this condition.<\/p>\n

    \"error2\"<\/a><\/p>\n

    Error 2101 occurs when the file does not exist. In this case, a file is created with default\u00a0values for the configurable parameters.<\/p>\n

    JavaScript for Configurable MQTT<\/strong><\/h2>\n

    The JavaScript also required revisions to support MQTT configurable parameters. The original version only handled IoT requests. These were identified with ‘GET:’ as the first 4 characters. Similarly, the added configuration command is now recognized as WebViewStrings beginning\u00a0with “CFG:”<\/p>\n

    \/\/\u00a010\u00a0Hz\u00a0WebViewString\u00a0polling\u00a0timer\u00a0function\u00a0-------------------------------------->\r\nfunction\u00a0AppInventorServer()\u00a0{\r\n    var\u00a0request\u00a0=\u00a0window.AppInventor.getWebViewString();\u00a0\/\/\u00a0Get\u00a0WebViewString\r\n\u00a0\u00a0\u00a0\u00a0if(request.substring(0,\u00a04)==\"GET:\")\u00a0{\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/\u00a0Validate\u00a0request\r\n\u00a0\u00a0\u00a0\u00a0    window.AppInventor.setWebViewString(\"\");\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/\u00a0Reset\u00a0String\u00a0(process\u00a0once)\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$(\"#request\").val(request.substring(4,\u00a0request.length));\u00a0\/\/set\u00a0request\u00a0html\u00a0textbox\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0SendMqttRequest();\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/\u00a0Send\u00a0Mqtt\u00a0Request\r\n\u00a0\u00a0\u00a0\u00a0}\r\n\u00a0\u00a0\u00a0\u00a0if(request.substring(0,\u00a04)==\"CFG:\")\u00a0{\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/\u00a0Validate\u00a0request\r\n\u00a0\u00a0\u00a0\u00a0    window.AppInventor.setWebViewString(\"\");\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/\u00a0Reset\u00a0String\u00a0(process\u00a0once)\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0var\u00a0cfgpar\u00a0=\u00a0JSON.parse(request.substring(4,\u00a0request.length));\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0txtopic\u00a0=\u00a0cfgpar.mqtt_txtopic;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0rxtopic\u00a0=\u00a0cfgpar.mqtt_rxtopic;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0mqtturl\u00a0=\u00a0cfgpar.mqtt_broker;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0client.disconnect();\r\n\u00a0\u00a0\u00a0\u00a0}\r\n\u00a0\u00a0\u00a0\u00a0setTimeout(AppInventorServer,\u00a0100);\u00a0\u00a0\u00a0\/\/\u00a0run\u00a0AppInventorServer()\u00a0in\u00a0100\u00a0ms\r\n}<\/pre>\n
    As you can see, parsing and extracting values from a JSON string is very simple and straight-forward with JavaScript. Once the new values are set, the MQTT broker connection is updated with a call to ‘client.disconnect()’.<\/p>\n
    \/\/\u00a0Callback\u00a0executed\u00a0upon\u00a0MQTT\u00a0broker\u00a0disconnection\u00a0-------------------------------->\r\nclient.ondisconnect\u00a0=\u00a0function(rc){\r\n    client.connect(mqtturl);\r\n};\r\n\/\/ Callback executed upon MQTT broker connection ----------------------------------->\r\nclient.onconnect = function(rc){\r\n    client.subscribe(rxtopic, 0);\r\n};\r\n\r\n<\/pre>\n
    Improving the Arduino Digital Commands<\/strong><\/h2>\n
    The original project used hard-coded values for the Digital Get and Set commands. Ok for an example, but not so good if you need access to a channel outside the card-coded value. That was rectified with this update, which now supports digital channel selection.<\/p>\n
    \"dig_new2\"<\/a><\/p>\n
    Select “Set Arduino Digital Channel” and a new screen is open. This screen allows you to select the channel to set.<\/p>\n
    \"digital_sel\"<\/a><\/p>\n
    This screen is open with a “start value” received from the main screen that called it.<\/p>\n
    \"select_digit\"<\/a><\/p>\n
    The value returned when OK is clicked depends on the startValue. If it is a “Set” command, an Arduino SetDigital request string is returned. The selected channel and logic state from the screen’s selections are also returned with the request.<\/p>\n
    Notice that a call to close the screen is made before the main screen (Screen1) is re-opened. That is necessary when returning a startValue. If the screen is not closed, it remains open for the duration of the App execution.<\/p>\n
    Another call to this window will open another instance of the window. This is effectively a memory leak which will crash you Android device eventually. Takeaway: Close the screen before opening a new screen when passing a start value to avoid memory leaks.<\/p>\n
    As you can see, a similar value is returned for “Get” requests.\u00a0But when “Get” requests are received, the channel state is not selected, it is returned from the request. When this screen is open with a “Get” request, the channel state selection GUI is suppressed.<\/p>\n
    \"get_digit\"<\/a><\/p>\n
    Sending the Arduino Digital\u00a0Request<\/strong><\/h2>\n
    When the Digital channel selection screen is closed, the main screen is reopened. But how does it know to send the Arduino command to MQTT? After all, the screen is opened fresh, just like when the app is started.<\/p>\n
    Not quite. Remember the ‘startValue’ returned from the digital selection? That is checked to determine whether an arduino request is needed. It is done in the 100ms timer callback.<\/p>\n
    \"timer\"<\/a><\/p>\n
    At 500 ms after the screen is open, the MQTT configuration is sent to the JavaScript. But then, at 1000 ms (10 100 ms intervals), the startval string is check for a non-null value. If a string is present, it is sent to the JavaScript via the WebViewString, by calling the SendRequest procedure.<\/p>\n
    \"send_request\"<\/a><\/p>\n
    Exiting the Application<\/strong><\/h2>\n
    Just one more thing and we are done with this update. I thought it would be nice to add an ‘Exit’ button to close the app. What I found was that it required several clicks before the app would actually close. What was happening was that every time a different screen returned to the main screen, the previous main screen remained open and a new main screen instance was created.<\/p>\n
    Not exactly what I had in mind. Another memory leak!<\/p>\n
    This was corrected by adding a ‘close screen’ before each time one of the two added screens was open. This guarantees only one screen is open at a time while the app is running.<\/p>\n
    \"cfg_mqttt\"<\/a><\/p>\n
    With this correction, the Exit button works as intended, with only one click required.<\/p>\n
    In Closing<\/strong><\/h2>\n
    This example should provide a framework for anyone needing to use MQTT with an App Inventor project. The main caveat is that a broker that supports WebSockets is required. I leave it up to you as an exercise to add username and password credentials to the mqtt connection settings. The basic structure is here. And it should also be a simple task to add “GetAnalog” to the Arduino request options. Go ahead, you can do it! If you need it.<\/p>\n
    Again, here\u00a0are the project files.<\/a><\/p>\n
    I hope you find this information useful…<\/p>\n","protected":false},"excerpt":{"rendered":"
    App Inventor to MQTT Communication In my last post, a basic MQTT client portal for App Inventor\u00a0was introduced. As result, there has been some interest expressed for TCP socket support. …<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1,64,10,19],"tags":[109,110],"class_list":["post-1358","post","type-post","status-publish","format-standard","hentry","category-alltheposts","category-arduino","category-esp8266","category-internet-of-things","tag-app-inventor-configurable-mqtt","tag-configuring-app-inventor"],"_links":{"self":[{"href":"https:\/\/internetofhomethings.com\/homethings\/index.php?rest_route=\/wp\/v2\/posts\/1358","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/internetofhomethings.com\/homethings\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/internetofhomethings.com\/homethings\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/internetofhomethings.com\/homethings\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/internetofhomethings.com\/homethings\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1358"}],"version-history":[{"count":18,"href":"https:\/\/internetofhomethings.com\/homethings\/index.php?rest_route=\/wp\/v2\/posts\/1358\/revisions"}],"predecessor-version":[{"id":1397,"href":"https:\/\/internetofhomethings.com\/homethings\/index.php?rest_route=\/wp\/v2\/posts\/1358\/revisions\/1397"}],"wp:attachment":[{"href":"https:\/\/internetofhomethings.com\/homethings\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1358"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/internetofhomethings.com\/homethings\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1358"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/internetofhomethings.com\/homethings\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1358"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}