Skip to content

Latest commit

 

History

History
executable file
·
147 lines (114 loc) · 9.76 KB

CHANGES.md

File metadata and controls

executable file
·
147 lines (114 loc) · 9.76 KB
Raw

--- Branch 3.x ---

Refactored the codebase - make extensive use of ES6 feature like async/await

3.2.1

  • Bugfix: command mkfs did not respect --noninteractive flag - thanks to bradshjg on GitHub #72

3.2.0

  • Added: generic support for glob expressions - feature requested on GitHub #66
  • Changed: Updated the serialport package to v8.0.4
  • Changed: nodejs min version to v8

3.1.0

  • Added: support for NodeMCU-Firmware 3.X.X

3.0.2

  • Bugfix: Invalid module entry file - nodemcu-connector was not exported - thanks to LanFly on GitHub #55

3.0.1

  • Bugfix: command devices failed in case a nonexisting serial port was used (e.g. default port; command did not require a valid port) - thanks to arrowcircle on GitHub #53

3.0.0

  • Added: flag --run to upload command to run a file on NodeMCU diretly after uploading - feature requested on GitHub #19
  • Added: return codes (0-success; 1-general_error; 127-lowlevel_error) - feature requested on GitHub #48
  • Added: debug mode to show low-level error messages --debug flag
  • Added: io-debug mode to show all rx/tx messages --io-debug flag (requires enabled debug mode)
  • Added: experimental esp32 support - thanks to Spiritdude on GitHub #47
  • Added: FAQ document
  • Changed: cli arguments take presendence over config file - feature requested on GitHub #21
  • Changed: the connector API has been splitted into multiple files
  • Changed: added new cli logger
  • Changed: requires Node.js >= 7.6
  • Changed: moved images into assets/
  • Removed: lua optimizer (replaced by luamin)

--- Branch 2.x ---

2.2.1

  • Bugfix: File transfer chunk splitting used a weak regex which does not match linebreaks (slow transfer speed because of short chunks) - thanks to T-vK on GitHub #42

2.2.0

2.1.1

  • Bugfix: Uploading of empty files failed - thanks to T-vK on GitHub #37

2.1.0

  • Added: Support for native encode module to use base64 as transfer encoding (speed up the transfer by factor 4..10) - suggested by MickaelGuilloux on GitHub #32
  • Changed: Progress bar appearance (shades_classic theme of cli-progress v1.4 is used)
  • Bugfix: By uploading multiple files the transfer-encoder functions where uploaded each time

2.0.4

  • Bugfix: Download command failed because of API changes in NodeMCU Firmware v1.5.4 - thanks to verneroberts on GitHub #24

2.0.3

2.0.2

  • Bugfix: Upload command failed because of API changes in NodeMCU Firmware v1.5.4 - thanks to curioussavage on GitHub #22
  • Bugfix: Fix crash when trying to upload a folder - thanks to sakisds on GitHub #20

2.0.1

  • Bugfix: devices command was broken since the last release (refactoring issue) - thanks to otbe on GitHub #18
  • Improved: Lua is not an acronym #17

2.0.0

  • Added: reset command to Hard-Reset the NodeMCU module using DTR/RTS reset circuit (like NodeMCU DEV Kit)
  • Added: RAW output format to fsinfo command - feature requested on GitHub #13
  • Added: --connection-delay option to fix broken reset circuits which cause a immediate hard-reset on opening the serial connection (dts/rts lines) #14
  • Added: Documentation regarding to Reset-on-Connect Issues / Broken Reset Circuits
  • Changed: Default baudrate to 115200 - newer firmware versions using automatic baudrate detection which allows to use higher connection speeds by default
  • Changed: footprints of NodeMCU-Tool.js functions - port/baudrate are set globally by setOptions instead by each function
  • Changed: logging-facility is used for global log output management
  • Changed: Updated the serialport package to v4.0.0
  • Changed: Function footprint of NodeMCU-Tool.fsinfo changed to function(port, baud, format) - format can be json, raw or null
  • Bugfix: Silent mode was not completely silent - thanks to remcoder on GitHub #12
  • Deprecated: NodeMcuConnector.onError callback will be removed in the future (replaced by logging-facility)
  • Deprecated: ScriptableSerialTerminal.onError callback will be removed in the future (replaced by logging-facility)

--- Branch 1.x ---

1.6.0

  • 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
  • Added: gulp based build example - thanks to remcoder

1.5.0

  • Added: Bulk/Multi File upload
  • Added: devices command to display a list of all connected NodeMCU Devices
  • Added: noninteractive options to the mkfs command to disable user interaction (confirm dialog)
  • Added: Global --silent mode to disable log/status messages - only errors and direct outputs are displayed
  • Added: Apache ANT build script example (programmatic file upload)
  • Added: PHP Usage example (programmatic usage of fsinfo command)
  • Added: Python Usage example (programmatic usage of devices command)
  • Added: Programmatic Usage Guide
  • Added: Step-by-Step Getting-Start Guide to the Documentation
  • Added: Output handler to the middleware (separate log, error, output handler are available)
  • Changed: Cleaned up NodeMCU-Tool.js - a connection is now established within a helper function
  • Changed: The Connector.upload function will not remove a existing file anymore - it's now handled by the middleware (eliminates code redundancy)
  • Changed: The device-list is not shown anymore in case there is an error during the connection establishment - please use the devices command
  • Changed: On error, the process will now exit with return-code 1
  • Improved: Hex-Upload-Helper is only uploaded one-times during a connector session (speedup when uploading multiple files)
  • Bugfix: Upload Errors were not forwarded to the frontend
  • Bugfix: The --compile options doesn't check the file-type

1.4.0

  • Added: Ability to provide remote destination filename or keep relative path in destination filename - thanks to loicortola on GitHub
  • Added: Shortcut to the executable file to the root dir
  • Changed: fsinfo will return the total number of files as well as a No Files found message - feature requested on GitHub
  • Changed: related to the destination filename option, the arguments of the upload function has changed - third party applications require an update!

1.3.2

  • Bugfix: fsinfo operation will fail in case there are no files on the esp module - thanks to soldair on GitHub

1.3.1

  • Bugfix: Tool throws a fatal error in case .nodemcutool file is not available

1.3.0

  • Added: Project based configurations to set default options like port, baudrate within .nodemcutool file
  • Bugfix: Debugging output using --optimize flag was displayed

1.2.0

  • Added: Binary file transfer
  • Added: Download function to fetch file from NodeMCU (binary save)
  • Added: Additional check to verify the existence of a remote file for read/write operations
  • Changed: File-Content is hex-encoded before upload - this allows binary file uploads and "unlimited" line size (not longer limited to 235chars per line!)
  • Changed: All used Lua commands/functions are centralized in NodeMcuConnector
  • Changed: the --optimize flag only works for Lua files with file-type .lua

1.1.0

  • Added: NodeMCU-Tool.js to use the connector as well as all CLI functions programmatically
  • Added: Colorized terminal messages
  • Added: Low Level API for direct interactions with the Lua interpreter
  • Changed: The bin tool has been separated in two files (CLI and API layer)
  • Changed: all errors are handled as callbacks (Node.js standard)
  • Changed: moved the test.lua file to top-level and renamed it to helloworld.lua
  • Changed: Whitespaces of the beginning of each line are removed when using the optimize flag
  • Bugfix: Replaced the progress bar with cli-progress to avoid random empty lines on the terminal
  • Bugfix: Aborting the confirm dialog of the mkfs command with ctrl+c raised an error

1.0.0

Initial public release