Tools to support VGkits Vanguard ESP8266 python-programmable board.
VGkits' Vanguard Tools
Run this pip3 command from a terminal to install the tools.
pip3 install vgkits-vanguard
If you don't yet have pip3, (which is installed as part of Python3) then follow these instructions to install it on your laptop.
See below for the commands you can run after the tools are installed.
shell : send python commands over USB
Connect to the python shell prompt on the Vanguard board over USB on Windows, MacOS or Linux, by running...
brainwash : upgrade your board
After some experiments, you can wipe your Vanguard board to get a clean start by running...
This is equivalent to
vanguard brainwash python - installs default python firmware (equivalent to
vanguard brainwash micropython)
vanguard brainwash espruino)
vanguard brainwash lua - the default lua firmware (equivalent to
vanguard brainwash nodemcu)
vanguard brainwash basic - the default basic firmware (equivalent to
vanguard brainwash esp8266basic)
vanguard brainwash forth - the default forth firmware (equivalent to
vanguard brainwash punyforth)
vanguard brainwash micropython - latest micropython release from the firmwares folder
vanguard brainwash circuitpython - latest circuitpython release from the firmwares folder
vanguard brainwash espruino - latest espruino release from the firmwares folder
vanguard brainwash esp8266basic - latest ESP8266Basic release from the firmwares folder
vanguard brainwash nodemcu - latest NodeMCU (eLua) release from the firmwares folder
brainfreeze : back up the board's current configuration
After 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...
This creates a file brainfreeze.bin in the current folder. We suggest you rename this file to somethingelse.bin to 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.bin
put : upload main.py or python module
If there is a main.py file in the current working directory, you can upload it using...
If you wanted to put a module on the board, for example a the bmp180.py file to module to use a BMP180 pressure sensor, place the file in the current working directory, then run...
vanguard put bmp180.py
You will then be able to successfully
import bmp180 from the Vanguard board, and run the example.
rm : remove main.py or python module
If 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 explorer
Every 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...
...to open a graphical file explorer showing the current directory.
Use the terminal command
cd (change directory) to change the directory by typing in different paths. For example
cd Desktop will change the directory to a subfolder called Desktop.
The 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 just vanguard.
If for any reason vanguard is not available you can run instead...
python -m vgkits.vanguard
...or to force the use of Python3...
python3 -m vgkits.vanguard
If you encounter this issue, probably your path is not properly set up to include the files installed by pip3. Try following these instructions to fix it.
Original release, restructuring scripts which were originally under ShrimpingIt/cockle and vgkits/vanguard into click-controlled command line utilities.