added run option to the terminal command

AndiDittrich · May 28, 2016 · 761348b · 761348b
1 parent 9cdcc40
commit 761348b
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 5 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,3 +1,7 @@
+### 1.6.0-BETA1 ###
+* Added: `--run` option to the terminal command to execute a file on the nodemcu when opening a new terminal session - feature requested by [blezek on GitHub](https://github.com/AndiDittrich/NodeMCU-Tool/issues/11)
+* Added: [gulp](http://gulpjs.com/) based build example - thanks to [remcoder](https://github.com/AndiDittrich/NodeMCU-Tool/commits/master?author=remcoder)
+
 ### 1.5.0 ###
 * Added: Bulk/Multi File upload
 * Added: `devices` command to display a list of all connected NodeMCU Devices

diff --git a/README.md b/README.md
@@ -519,7 +519,11 @@ You can quit the terminal session by pressing <kbd>ctrl+c</kbd>
 
 **Syntax** `nodemcu-tool [options] terminal`
 
-**Example**
+**Options**
+
+  * `--run <filename>` | Executes a command on start of the terminal session - useful for testing/debugging
+
+**Example 1**
 
 ```shell
 $ nodemcu-tool terminal
@@ -532,6 +536,29 @@ String: Lorem ipsum dolor sit amet, consetetur sadipscing elitr
 > [SerialTerminal] Connection closed
 ```
 
+**Example 2**
+```shell
+$ nodemcu-tool terminal --run helloworld.lua
+[SerialTerminal] Starting Terminal Mode - press ctrl+c to exit
+dofile("helloworld.lua")
+Hello World!
+|---|
+| H |
+| E |
+| L |
+| L |
+| O |
+| | |
+| W |
+| O |
+| R |
+| L |
+| D |
+|---|
+YEAH!!! HELLO WORLD!!!
+String: Lorem ipsum dolor sit amet, consetetur sadipscing elitr
+```
+
 Behind the Scene
 ----------------
 Many beginners may ask how the tool is working because there is no binary interface documented like FTP to access files.

diff --git a/bin/nodemcu-tool.js b/bin/nodemcu-tool.js
@@ -8,6 +8,7 @@ var _progressbar = require('cli-progress');
 var _pkg = require('../package.json')
 var _prompt = require('prompt')
 var _nodemcutool = require('../lib/NodeMCU-Tool');
+var _luaCommandBuilder = require('../lib/LuaCommandBuilder');
 var _colors = require('colors');
 var _fs = require('fs');
 
@@ -263,11 +264,19 @@ _cli
 _cli
     .command('terminal')
     .description('Opens a Terminal connection to NodeMCU')
-    .action(function(){
+    .option('--run <filename>', 'Running a file on NodeMCU before starting the terminal session', false)
+    .action(function(options){
         // silent mode ?
         SilentMode(_cli.silent===true);
 
-        _nodemcutool.terminal(_cli.port, _cli.baud);
+        // run a initial command on startup ?
+        var initialCommand = null;
+        if (options.run){
+            initialCommand = _luaCommandBuilder.prepare('run', [options.run]);
+        }
+
+        // start terminal session
+        _nodemcutool.terminal(_cli.port, _cli.baud, initialCommand);
     });
 
 _cli

diff --git a/lib/NodeMCU-Tool.js b/lib/NodeMCU-Tool.js
@@ -371,7 +371,7 @@ Tool.mkfs = function(port, baud){
 };
 
 // serial terminal <> console session
-Tool.terminal = function(port, baud){
+Tool.terminal = function(port, baud, initialCommand){
     // create new connector
     var terminal = new _serialTerminal();
 
@@ -380,6 +380,13 @@ Tool.terminal = function(port, baud){
 
     logStatus('SerialTerminal', 'Starting Terminal Mode - press ctrl+c to exit');
 
+    // run initial command before starting terminal session ?
+    if (initialCommand){
+        terminal.onConnect(function(device){
+            device.write(initialCommand + '\n');
+        });
+    }
+
     // start
     terminal.passthrough(port, baud, function(err){
         if (err){

diff --git a/lib/SerialTerminal.js b/lib/SerialTerminal.js
@@ -7,13 +7,18 @@ var _serialport = require('serialport');
 function SerialTerminal(){
     this.device = null;
     this.errorHandler = null;
+    this.connectHandler = null;
     this.encoding = 'utf8';
 }
 
 SerialTerminal.prototype.onError = function(cb){
     this.errorHandler = cb;
 };
 
+SerialTerminal.prototype.onConnect = function(cb){
+    this.connectHandler = cb;
+};
+
 SerialTerminal.prototype.passthrough = function(devicename, baudrate, cb){
 
     // try to open the serial port
@@ -46,9 +51,11 @@ SerialTerminal.prototype.passthrough = function(devicename, baudrate, cb){
             cb(error);
         }else{
 
+            // prepare
             process.stdin.setRawMode(true);
             process.stdin.setEncoding('utf8');
 
+            // pass-through
             process.stdin.on('data', function(data){
                 // ctrl-c
                 if (data == '\u0003'){
@@ -58,6 +65,11 @@ SerialTerminal.prototype.passthrough = function(devicename, baudrate, cb){
                 }
                 this.device.write(data);
             }.bind(this));
+
+            // run connect handler ?
+            if (this.connectHandler){
+                this.connectHandler.apply(this.connectHandler, [this.device]);
+            }
         }
     }.bind(this));
 };

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "nodemcu-tool",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "Command line tool to upload and manage files on your NodeMCU / ESP8266 Module.",
   "keywords": [
     "cli",