From 593f754446113302b0ccfa2c31982f235216ccea Mon Sep 17 00:00:00 2001 From: Oscar Frias Date: Wed, 7 Jun 2017 20:16:21 -0400 Subject: [PATCH] Updated readme Changed the description of file loading/dumping --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3b5ba77..d6953bd 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,13 @@ By Oscar Frias - September 2016 www.oscarfrias.com -__TinyTerm__, a quick script to create a terminal-like interface that allows the user to control a [tinyG](http://synthetos.myshopify.com/products/tinyg) connected via Serial to the computer. It provides a textArea to show the history of the communication between the tinyG and the computer, and a textfield to allow the user to inject GCode commands or tinyG commands to the tinyG on the fly. +__TinyTerm__, a quick [Processing](www.processing.org) script to create a terminal-like interface that allows the user to control a [tinyG](http://synthetos.myshopify.com/products/tinyg) connected via Serial to the computer. It provides a textArea to show the history of the communication between the tinyG and the computer, and a textfield to allow the user to inject GCode commands or tinyG commands to the tinyG on the fly. -TinyTerm starts by loading an init.json file from the /data folder. This JSON file contains all the desired init settings for the tinyG. For a complete list of commands and settings, please take a look at the [tinyG Wiki](https://github.com/synthetos/TinyG/wiki/TinyG-Configuration-for-Firmware-Version-0.97). The JSON file needs to have a JSONArray named _"commands"_ contained in a JSONObject: +TinyTerm allows to load and dump files into the tinyG in either text or JSON format. TinyTerm looks for the file extension and determnies if the file is a JSON or any other format. + +If a JSON, TinyTerm will try to parse it following Pensa's schema for init files. Otherwise, if not a JSON, TinyTerm will treat it as a plain text file and dump all the contents to the tinyG. + +An initialization, config, or _init_ file could be created containing all the desired init settings for the tinyG. For a complete list of commands and settings, please take a look at the [tinyG Wiki](https://github.com/synthetos/TinyG/wiki/TinyG-Configuration-for-Firmware-Version-0.97). Such file should be in JSON format and in the schema, have a JSONArray named _"commands"_ contained in a JSONObject: ```css { @@ -16,7 +20,13 @@ TinyTerm starts by loading an init.json file from the /data folder. This JSON fi } ``` -You can have as many commands as necessary. Some of our init files have dozens of commands. It all depends on how many axes and inputs you want to initialize with this file. Just make sure the JSON file is clean, and valid. Make liberal use of the [JSON lint](http://jsonlint.com). +You could have as many commands as necessary (some of our init files have dozens of commands!), all depending on how many axes and inputs you want to initialize with this file. Just make sure the JSON file is clean, and valid. Make liberal use of the [JSON lint](http://jsonlint.com). + +To run GCode scripts on your tinyG, just save them as text files (.txt, .cnc, .nc, etc) and load them with TinyTerm. + +Once a file has been loaded, a "Re-dump file" button will appear, allowing for quick re-running of the script. + +TinyTerm will wait and look for a serial device to be plugged on a USB port and hold the interface until something is connected (not checking specifically for a tinyG, though). Once a connection has been established, the interface can be used. The GUI is created with the [ControlP5](http://www.sojamo.de/libraries/controlP5/) library by [Sojamo](https://github.com/sojamo), so make sure you have this library installed before running this script.