Package: vgkits-vanguard
VGkits' Vanguard ToolsThe vgkits-vanguard package is published viaPip3giving users simple short commands for configuringVanguard boardsand connecting to a Vanguard board's built-in python shell.Run thispip3command from aterminalto install the tools.pip3 install vgkits-vanguardIf you don't yet have pip3, (which is installed as part of Python3) thenfollow these instructionsto install it on your laptop.See below for the commands you can run after the tools are installed.shell : send python commands over USBConnect to the python shell prompt on the Vanguard board over USB on Windows, MacOS or Linux, by running...vanguard shellThis auto-detects the Vanguard's USB device and your operating system's Terminal configuration. Then it launchesminitermwith the proper parameters to connect yourterminalto thepython
shell.brainwash : upgrade your boardAfter some experiments, you can wipe your Vanguard board to get a clean start by running...vanguard brainwashThis is equivalent tovanguard brainwash vanguardto install latest Micropython plus VGkits' pre-installed libraries. However, you can usebrainwashto wipe and install a different 'operating system' on your Vanguard board such as a cleanMicropythonbuild,CircuitPython,Espruino(to write code inJavascript) orPunyforth(to write code in theForthlanguage).There are evenBasicandLISPinterpreters designed to run on this processor!vanguard brainwash python- installs defaultpythonfirmware (equivalent tovanguard brainwash micropython)vanguard brainwash javascript- the defaultjavascriptfirmware (equivalent tovanguard brainwash espruino)vanguard brainwash lua- the defaultluafirmware (equivalent tovanguard brainwash nodemcu)vanguard brainwash basic- the defaultbasicfirmware (equivalent tovanguard brainwash esp8266basic)vanguard brainwash forth- the defaultforthfirmware (equivalent tovanguard brainwash punyforth)vanguard brainwash micropython-latest micropythonrelease from the firmwares foldervanguard brainwash circuitpython-latest circuitpythonrelease from the firmwares foldervanguard brainwash espruino-latest espruinorelease from the firmwares foldervanguard brainwash esp8266basic- latestESP8266Basicrelease from the firmwares foldervanguard brainwash nodemcu- latestNodeMCU(eLua) release from the firmwares foldervanguard brainwash punyforth-latest punyforthrelease from the firmwares folder.N.B.To connect to Punyforth tryvanguard shell --line --echo --eol CRLFas perthis issuebrainfreeze : back up the board's current configurationAfter investing time in uploading libraries, writing and testing scripts on your board, you can save an 'image' of your operating system including any installed files by running...vanguard brainfreezeThis creates a filebrainfreeze.binin the current folder. We suggest you rename this file tosomethingelse.binto help you remember the configuration you saved. Use that file to restore your board to the same configuration at a later time by running...vanguard brainwash --input somethingelse.binput : upload main.py or python moduleIf there is a main.py file in the current working directory, you can upload it using...vanguard putIf you wanted to put a module on the board, for example a thebmp180.pyfile to module to use a BMP180 pressure sensor, place the file in the current working directory, then run...vanguard put bmp180.pyYou will then be able to successfullyimport bmp180from the Vanguard board, andrun the example.rm : remove main.py or python moduleIf you no longer want the main.py startup script, then run...vanguard rm main.py...and the Vanguard board will no longer run your script on powerup.see : launch a file explorerEvery terminal has a 'current working directory', the folder it is currently using to create or find files. To see the contents of this folder, run...vanguard see...to open a graphical file explorer showing the current directory.Use the terminal commandcd(change directory) to change the directory by typing in different paths. For examplecd Desktopwill change the directory to a subfolder called Desktop.TroubleshootingThe vgkits-vanguard Pypi package (installed via pip) should install a 'vanguard' command into a local folder, which can be run on Windows, Mac OS or Linux using justvanguard.If for any reasonvanguardis not available you can run instead...python -m vgkits.vanguard...or to force the use of Python3...python3 -m vgkits.vanguardIf you encounter this issue, probably your path is not properly set up to include the files installed by pip3. Try followingthese instructionsto fix it.v0.2.0Original release, restructuring scripts which were originally under
ShrimpingIt/cockle and vgkits/vanguard intoclick-controlled command line utilities.